You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by al...@apache.org on 2017/05/12 00:11:57 UTC

[03/19] beam git commit: [BEAM-1345] Mark Pipeline as public.

[BEAM-1345] Mark Pipeline as public.


Project: http://git-wip-us.apache.org/repos/asf/beam/repo
Commit: http://git-wip-us.apache.org/repos/asf/beam/commit/0ce25430
Tree: http://git-wip-us.apache.org/repos/asf/beam/tree/0ce25430
Diff: http://git-wip-us.apache.org/repos/asf/beam/diff/0ce25430

Branch: refs/heads/release-2.0.0
Commit: 0ce25430ffec49fb2d94271e4af6225cee20388c
Parents: aeeefc1
Author: Robert Bradshaw <ro...@gmail.com>
Authored: Thu May 11 13:30:32 2017 -0700
Committer: Ahmet Altay <al...@google.com>
Committed: Thu May 11 16:20:36 2017 -0700

----------------------------------------------------------------------
 sdks/python/apache_beam/pipeline.py | 7 +++++++
 1 file changed, 7 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/beam/blob/0ce25430/sdks/python/apache_beam/pipeline.py
----------------------------------------------------------------------
diff --git a/sdks/python/apache_beam/pipeline.py b/sdks/python/apache_beam/pipeline.py
index 83c7287..ec8dde4 100644
--- a/sdks/python/apache_beam/pipeline.py
+++ b/sdks/python/apache_beam/pipeline.py
@@ -67,6 +67,9 @@ from apache_beam.options.pipeline_options_validator import PipelineOptionsValida
 from apache_beam.utils.annotations import deprecated
 
 
+__all__ = ['Pipeline']
+
+
 class Pipeline(object):
   """A pipeline object that manages a DAG of PValues and their PTransforms.
 
@@ -182,6 +185,8 @@ class Pipeline(object):
   def visit(self, visitor):
     """Visits depth-first every node of a pipeline's DAG.
 
+    Runner-internal implementation detail; no backwards-compatibility guarantees
+
     Args:
       visitor: PipelineVisitor object whose callbacks will be called for each
         node visited. See PipelineVisitor comments.
@@ -333,6 +338,7 @@ class Pipeline(object):
     return Visitor.ok
 
   def to_runner_api(self):
+    """For internal use only; no backwards-compatibility guarantees."""
     from apache_beam.runners import pipeline_context
     from apache_beam.runners.api import beam_runner_api_pb2
     context = pipeline_context.PipelineContext()
@@ -346,6 +352,7 @@ class Pipeline(object):
 
   @staticmethod
   def from_runner_api(proto, runner, options):
+    """For internal use only; no backwards-compatibility guarantees."""
     p = Pipeline(runner=runner, options=options)
     from apache_beam.runners import pipeline_context
     context = pipeline_context.PipelineContext(proto.components)