[BEAM-1345] Clearly delineate public api in runners package.
Project: http://git-wip-us.apache.org/repos/asf/beam/repo Commit: http://git-wip-us.apache.org/repos/asf/beam/commit/aeeefc17 Tree: http://git-wip-us.apache.org/repos/asf/beam/tree/aeeefc17 Diff: http://git-wip-us.apache.org/repos/asf/beam/diff/aeeefc17 Branch: refs/heads/release-2.0.0 Commit: aeeefc1725bca11f765f57bf2833d606a0e6d6ba Parents: 6d77f95 Author: Robert Bradshaw <rober...@gmail.com> Authored: Thu May 11 13:41:24 2017 -0700 Committer: Ahmet Altay <al...@google.com> Committed: Thu May 11 16:20:36 2017 -0700 ---------------------------------------------------------------------- sdks/python/apache_beam/runners/api/__init__.py | 4 +++- sdks/python/apache_beam/runners/common.py | 5 ++++- sdks/python/apache_beam/runners/dataflow/__init__.py | 9 +++++++++ sdks/python/apache_beam/runners/dataflow/dataflow_runner.py | 3 +++ .../apache_beam/runners/dataflow/test_dataflow_runner.py | 3 +++ sdks/python/apache_beam/runners/direct/__init__.py | 6 +++++- sdks/python/apache_beam/runners/direct/direct_runner.py | 3 +++ sdks/python/apache_beam/runners/pipeline_context.py | 6 ++++++ sdks/python/apache_beam/runners/portability/__init__.py | 2 ++ sdks/python/apache_beam/runners/runner.py | 3 +++ sdks/python/apache_beam/runners/worker/__init__.py | 2 ++ 11 files changed, 43 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/beam/blob/aeeefc17/sdks/python/apache_beam/runners/api/__init__.py ---------------------------------------------------------------------- diff --git a/sdks/python/apache_beam/runners/api/__init__.py b/sdks/python/apache_beam/runners/api/__init__.py index e94673c..bf95208 100644 --- a/sdks/python/apache_beam/runners/api/__init__.py +++ b/sdks/python/apache_beam/runners/api/__init__.py @@ -15,7 +15,9 @@ # limitations under the License. # -"""Checked in to avoid protoc dependency for Python development. +"""For internal use only; no backwards-compatibility guarantees. + +Checked in to avoid protoc dependency for Python development. Regenerate files with:: http://git-wip-us.apache.org/repos/asf/beam/blob/aeeefc17/sdks/python/apache_beam/runners/common.py ---------------------------------------------------------------------- diff --git a/sdks/python/apache_beam/runners/common.py b/sdks/python/apache_beam/runners/common.py index 86db711..8453569 100644 --- a/sdks/python/apache_beam/runners/common.py +++ b/sdks/python/apache_beam/runners/common.py @@ -17,7 +17,10 @@ # cython: profile=True -"""Worker operations executor.""" +"""Worker operations executor. + +For internal use only; no backwards-compatibility guarantees. +""" import sys import traceback http://git-wip-us.apache.org/repos/asf/beam/blob/aeeefc17/sdks/python/apache_beam/runners/dataflow/__init__.py ---------------------------------------------------------------------- diff --git a/sdks/python/apache_beam/runners/dataflow/__init__.py b/sdks/python/apache_beam/runners/dataflow/__init__.py index cce3aca..6674ba5 100644 --- a/sdks/python/apache_beam/runners/dataflow/__init__.py +++ b/sdks/python/apache_beam/runners/dataflow/__init__.py @@ -14,3 +14,12 @@ # See the License for the specific language governing permissions and # limitations under the License. # + +"""The DataflowRunner executes pipelines on Google Cloud Dataflow. + +Anything in this package not imported here is an internal implementation detail +with no backwards-compatibility guarantees. +""" + +from apache_beam.runners.dataflow.dataflow_runner import DataflowRunner +from apache_beam.runners.dataflow.test_dataflow_runner import TestDataflowRunner http://git-wip-us.apache.org/repos/asf/beam/blob/aeeefc17/sdks/python/apache_beam/runners/dataflow/dataflow_runner.py ---------------------------------------------------------------------- diff --git a/sdks/python/apache_beam/runners/dataflow/dataflow_runner.py b/sdks/python/apache_beam/runners/dataflow/dataflow_runner.py index 796a67b..3d8437c 100644 --- a/sdks/python/apache_beam/runners/dataflow/dataflow_runner.py +++ b/sdks/python/apache_beam/runners/dataflow/dataflow_runner.py @@ -46,6 +46,9 @@ from apache_beam.typehints import typehints from apache_beam.options.pipeline_options import StandardOptions +__all__ = ['DataflowRunner'] + + class DataflowRunner(PipelineRunner): """A runner that creates job graphs and submits them for remote execution. http://git-wip-us.apache.org/repos/asf/beam/blob/aeeefc17/sdks/python/apache_beam/runners/dataflow/test_dataflow_runner.py ---------------------------------------------------------------------- diff --git a/sdks/python/apache_beam/runners/dataflow/test_dataflow_runner.py b/sdks/python/apache_beam/runners/dataflow/test_dataflow_runner.py index 4fd1026..b339882 100644 --- a/sdks/python/apache_beam/runners/dataflow/test_dataflow_runner.py +++ b/sdks/python/apache_beam/runners/dataflow/test_dataflow_runner.py @@ -22,6 +22,9 @@ from apache_beam.options.pipeline_options import TestOptions, GoogleCloudOptions from apache_beam.runners.dataflow.dataflow_runner import DataflowRunner +__all__ = ['TestDataflowRunner'] + + class TestDataflowRunner(DataflowRunner): def run(self, pipeline): """Execute test pipeline and verify test matcher""" http://git-wip-us.apache.org/repos/asf/beam/blob/aeeefc17/sdks/python/apache_beam/runners/direct/__init__.py ---------------------------------------------------------------------- diff --git a/sdks/python/apache_beam/runners/direct/__init__.py b/sdks/python/apache_beam/runners/direct/__init__.py index 0d64513..0f82756 100644 --- a/sdks/python/apache_beam/runners/direct/__init__.py +++ b/sdks/python/apache_beam/runners/direct/__init__.py @@ -15,5 +15,9 @@ # limitations under the License. # -"""Inprocess runner executes pipelines locally in a single process.""" +"""Inprocess runner executes pipelines locally in a single process. + +Anything in this package not imported here is an internal implementation detail +with no backwards-compatibility guarantees. +""" from apache_beam.runners.direct.direct_runner import DirectRunner http://git-wip-us.apache.org/repos/asf/beam/blob/aeeefc17/sdks/python/apache_beam/runners/direct/direct_runner.py ---------------------------------------------------------------------- diff --git a/sdks/python/apache_beam/runners/direct/direct_runner.py b/sdks/python/apache_beam/runners/direct/direct_runner.py index 535aac3..ecf5114 100644 --- a/sdks/python/apache_beam/runners/direct/direct_runner.py +++ b/sdks/python/apache_beam/runners/direct/direct_runner.py @@ -36,6 +36,9 @@ from apache_beam.options.pipeline_options import DirectOptions from apache_beam.options.value_provider import RuntimeValueProvider +__all__ = ['DirectRunner'] + + class DirectRunner(PipelineRunner): """Executes a single pipeline on the local machine.""" http://git-wip-us.apache.org/repos/asf/beam/blob/aeeefc17/sdks/python/apache_beam/runners/pipeline_context.py ---------------------------------------------------------------------- diff --git a/sdks/python/apache_beam/runners/pipeline_context.py b/sdks/python/apache_beam/runners/pipeline_context.py index d3d3c24..1c89d06 100644 --- a/sdks/python/apache_beam/runners/pipeline_context.py +++ b/sdks/python/apache_beam/runners/pipeline_context.py @@ -15,6 +15,12 @@ # limitations under the License. # +"""Utility class for serializing pipelines via the runner API. + +For internal use only; no backwards-compatibility guarantees. +""" + + from apache_beam import pipeline from apache_beam import pvalue from apache_beam import coders http://git-wip-us.apache.org/repos/asf/beam/blob/aeeefc17/sdks/python/apache_beam/runners/portability/__init__.py ---------------------------------------------------------------------- diff --git a/sdks/python/apache_beam/runners/portability/__init__.py b/sdks/python/apache_beam/runners/portability/__init__.py index cce3aca..7af93ed 100644 --- a/sdks/python/apache_beam/runners/portability/__init__.py +++ b/sdks/python/apache_beam/runners/portability/__init__.py @@ -14,3 +14,5 @@ # See the License for the specific language governing permissions and # limitations under the License. # + +"""This runner is experimental; no backwards-compatibility guarantees.""" http://git-wip-us.apache.org/repos/asf/beam/blob/aeeefc17/sdks/python/apache_beam/runners/runner.py ---------------------------------------------------------------------- diff --git a/sdks/python/apache_beam/runners/runner.py b/sdks/python/apache_beam/runners/runner.py index d875fdc..af00d8f 100644 --- a/sdks/python/apache_beam/runners/runner.py +++ b/sdks/python/apache_beam/runners/runner.py @@ -26,6 +26,9 @@ import shutil import tempfile +__all__ = ['PipelineRunner', 'PipelineState', 'PipelineResult'] + + def _get_runner_map(runner_names, module_path): """Create a map of runner name in lower case to full import path to the runner class. http://git-wip-us.apache.org/repos/asf/beam/blob/aeeefc17/sdks/python/apache_beam/runners/worker/__init__.py ---------------------------------------------------------------------- diff --git a/sdks/python/apache_beam/runners/worker/__init__.py b/sdks/python/apache_beam/runners/worker/__init__.py index cce3aca..0bce5d6 100644 --- a/sdks/python/apache_beam/runners/worker/__init__.py +++ b/sdks/python/apache_beam/runners/worker/__init__.py @@ -14,3 +14,5 @@ # See the License for the specific language governing permissions and # limitations under the License. # + +"""For internal use only; no backwards-compatibility guarantees."""