You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by GitBox <gi...@apache.org> on 2020/05/28 18:44:31 UTC
[GitHub] [beam] davidcavazos opened a new pull request #11851: [BEAM-10144] Update PipelineOptions snippets for best practices
davidcavazos opened a new pull request #11851:
URL: https://github.com/apache/beam/pull/11851
Updating `PipelineOptions` snippets to mirror best practices. Making setting pipeline options programmatically less cumbersome, and adding the necessary imports to each snippet.
R: @aaltay
------------------------
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] [**Choose reviewer(s)**](https://beam.apache.org/contribute/#make-your-change) and mention them in a comment (`R: @username`).
- [x] Format the pull request title like `[BEAM-XXX] Fixes bug in ApproximateQuantiles`, where you replace `BEAM-XXX` with the appropriate JIRA issue, if applicable. This will automatically link the pull request to the issue.
- [x] Update `CHANGES.md` with noteworthy changes.
- [x] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://beam.apache.org/contribute/#make-reviewers-job-easier).
Post-Commit Tests Status (on master branch)
------------------------------------------------------------------------------------------------
Lang | SDK | Apex | Dataflow | Flink | Gearpump | Samza | Spark
--- | --- | --- | --- | --- | --- | --- | ---
Go | [](https://builds.apache.org/job/beam_PostCommit_Go/lastCompletedBuild/) | --- | --- | [](https://builds.apache.org/job/beam_PostCommit_Go_VR_Flink/lastCompletedBuild/) | --- | --- | [](https://builds.apache.org/job/beam_PostCommit_Go_VR_Spark/lastCompletedBuild/)
Java | [](https://builds.apache.org/job/beam_PostCommit_Java/lastCompletedBuild/) | [](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Apex/lastCompletedBuild/) | [](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Dataflow/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Dataflow_Java11/lastCompletedBuild/) | [](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Flink/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Flink_Java11/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Java_PVR_Flink_Batch/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Java_PVR_Flink_Streaming/lastCompletedBuild/) | [](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Gearpump/lastCompletedBuild/) | [](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Samza/lastCompletedBuild/) | [](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Spark/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Java_PVR_Spark_Batch/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_SparkStructuredStreaming/lastCompletedBuild/)
Python | [](https://builds.apache.org/job/beam_PostCommit_Python2/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Python35/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Python36/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Python37/lastCompletedBuild/) | --- | [](https://builds.apache.org/job/beam_PostCommit_Py_VR_Dataflow/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Py_VR_Dataflow_V2/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Py_ValCont/lastCompletedBuild/) | [](https://builds.apache.org/job/beam_PreCommit_Python2_PVR_Flink_Cron/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PostCommit_Python35_VR_Flink/lastCompletedBuild/) | --- | --- | [](https://builds.apache.org/job/beam_PostCommit_Python_VR_Spark/lastCompletedBuild/)
XLang | --- | --- | --- | [](https://builds.apache.org/job/beam_PostCommit_XVR_Flink/lastCompletedBuild/) | --- | --- | [](https://builds.apache.org/job/beam_PostCommit_XVR_Spark/lastCompletedBuild/)
Pre-Commit Tests Status (on master branch)
------------------------------------------------------------------------------------------------
--- |Java | Python | Go | Website
--- | --- | --- | --- | ---
Non-portable | [](https://builds.apache.org/job/beam_PreCommit_Java_Cron/lastCompletedBuild/) | [](https://builds.apache.org/job/beam_PreCommit_Python_Cron/lastCompletedBuild/)<br>[](https://builds.apache.org/job/beam_PreCommit_PythonLint_Cron/lastCompletedBuild/) | [](https://builds.apache.org/job/beam_PreCommit_Go_Cron/lastCompletedBuild/) | [](https://builds.apache.org/job/beam_PreCommit_Website_Cron/lastCompletedBuild/)
Portable | --- | [](https://builds.apache.org/job/beam_PreCommit_Portable_Python_Cron/lastCompletedBuild/) | --- | ---
See [.test-infra/jenkins/README](https://github.com/apache/beam/blob/master/.test-infra/jenkins/README.md) for trigger phrase, status and link of all Jenkins jobs.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] aaltay commented on pull request #11851: [BEAM-10144] Update PipelineOptions snippets for best practices
Posted by GitBox <gi...@apache.org>.
aaltay commented on pull request #11851:
URL: https://github.com/apache/beam/pull/11851#issuecomment-641482781
retest this please
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] davidcavazos commented on pull request #11851: [BEAM-10144] Update PipelineOptions snippets for best practices
Posted by GitBox <gi...@apache.org>.
davidcavazos commented on pull request #11851:
URL: https://github.com/apache/beam/pull/11851#issuecomment-635618216
Run Python PreCommit
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] aaltay commented on pull request #11851: [BEAM-10144] Update PipelineOptions snippets for best practices
Posted by GitBox <gi...@apache.org>.
aaltay commented on pull request #11851:
URL: https://github.com/apache/beam/pull/11851#issuecomment-637024752
Run Python PreCommit
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] aaltay merged pull request #11851: [BEAM-10144] Update PipelineOptions snippets for best practices
Posted by GitBox <gi...@apache.org>.
aaltay merged pull request #11851:
URL: https://github.com/apache/beam/pull/11851
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] aaltay commented on pull request #11851: [BEAM-10144] Update PipelineOptions snippets for best practices
Posted by GitBox <gi...@apache.org>.
aaltay commented on pull request #11851:
URL: https://github.com/apache/beam/pull/11851#issuecomment-641621183
retest this please
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] davidcavazos commented on a change in pull request #11851: [BEAM-10144] Update PipelineOptions snippets for best practices
Posted by GitBox <gi...@apache.org>.
davidcavazos commented on a change in pull request #11851:
URL: https://github.com/apache/beam/pull/11851#discussion_r432049685
##########
File path: sdks/python/apache_beam/examples/snippets/snippets.py
##########
@@ -226,35 +227,33 @@ def _add_argparse_args(cls, parser):
# [END pipeline_options_define_custom]
- from apache_beam.options.pipeline_options import GoogleCloudOptions
- from apache_beam.options.pipeline_options import StandardOptions
-
# [START pipeline_options_dataflow_service]
- # Create and set your PipelineOptions.
- options = PipelineOptions(flags=argv)
+ import apache_beam as beam
+ from apache_beam.options.pipeline_options import PipelineOptions
+ # Create and set your PipelineOptions.
# For Cloud execution, specify DataflowRunner and set the Cloud Platform
- # project, job name, staging file location, temp file location, and region.
- options.view_as(StandardOptions).runner = 'DataflowRunner'
- google_cloud_options = options.view_as(GoogleCloudOptions)
- google_cloud_options.project = 'my-project-id'
- google_cloud_options.job_name = 'myjob'
- google_cloud_options.staging_location = 'gs://my-bucket/binaries'
- google_cloud_options.temp_location = 'gs://my-bucket/temp'
- google_cloud_options.region = 'us-central1'
+ # project, job name, temporary files location, and region.
+ # For more information about regions, check:
+ # https://cloud.google.com/dataflow/docs/concepts/regional-endpoints
+ options = PipelineOptions(
+ flags=argv,
+ runner='DataflowRunner',
+ project='my-project-id',
+ job_name='unique-job-name',
+ temp_location='gs://my-bucket/temp',
+ region='us-central1')
# Create the Pipeline with the specified options.
- p = Pipeline(options=options)
+ # with beam.Pipeline(options=options) as pipeline:
Review comment:
*Note:* This is commented out because if we leave it uncommented, even if it doesn't do anything, it makes the test fail with an error.
```
subprocess.CalledProcessError: Command '['/Users/dcavazos/src/beam/env/bin/python', '-m', 'pip', 'download', '--dest', '/var/folders/z2/zp_k4l5n2cq84fsn4y633mg400dsyy/T/tmpdv09ddqk', 'apache-beam==2.22.0.dev0', '--no-deps', '--no-binary', ':all:']' returned non-zero exit status 1.
Pip install failed for package: apache-beam==2.22.0.dev0
Output from execution of subprocess: b''
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] aaltay commented on pull request #11851: [BEAM-10144] Update PipelineOptions snippets for best practices
Posted by GitBox <gi...@apache.org>.
aaltay commented on pull request #11851:
URL: https://github.com/apache/beam/pull/11851#issuecomment-635587627
retest this please
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] aaltay commented on pull request #11851: [BEAM-10144] Update PipelineOptions snippets for best practices
Posted by GitBox <gi...@apache.org>.
aaltay commented on pull request #11851:
URL: https://github.com/apache/beam/pull/11851#issuecomment-635648807
Run Python PreCommit
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] davidcavazos commented on pull request #11851: [BEAM-10144] Update PipelineOptions snippets for best practices
Posted by GitBox <gi...@apache.org>.
davidcavazos commented on pull request #11851:
URL: https://github.com/apache/beam/pull/11851#issuecomment-637014124
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] davidcavazos commented on a change in pull request #11851: [BEAM-10144] Update PipelineOptions snippets for best practices
Posted by GitBox <gi...@apache.org>.
davidcavazos commented on a change in pull request #11851:
URL: https://github.com/apache/beam/pull/11851#discussion_r432049685
##########
File path: sdks/python/apache_beam/examples/snippets/snippets.py
##########
@@ -226,35 +227,33 @@ def _add_argparse_args(cls, parser):
# [END pipeline_options_define_custom]
- from apache_beam.options.pipeline_options import GoogleCloudOptions
- from apache_beam.options.pipeline_options import StandardOptions
-
# [START pipeline_options_dataflow_service]
- # Create and set your PipelineOptions.
- options = PipelineOptions(flags=argv)
+ import apache_beam as beam
+ from apache_beam.options.pipeline_options import PipelineOptions
+ # Create and set your PipelineOptions.
# For Cloud execution, specify DataflowRunner and set the Cloud Platform
- # project, job name, staging file location, temp file location, and region.
- options.view_as(StandardOptions).runner = 'DataflowRunner'
- google_cloud_options = options.view_as(GoogleCloudOptions)
- google_cloud_options.project = 'my-project-id'
- google_cloud_options.job_name = 'myjob'
- google_cloud_options.staging_location = 'gs://my-bucket/binaries'
- google_cloud_options.temp_location = 'gs://my-bucket/temp'
- google_cloud_options.region = 'us-central1'
+ # project, job name, temporary files location, and region.
+ # For more information about regions, check:
+ # https://cloud.google.com/dataflow/docs/concepts/regional-endpoints
+ options = PipelineOptions(
+ flags=argv,
+ runner='DataflowRunner',
+ project='my-project-id',
+ job_name='unique-job-name',
+ temp_location='gs://my-bucket/temp',
+ region='us-central1')
# Create the Pipeline with the specified options.
- p = Pipeline(options=options)
+ # with beam.Pipeline(options=options) as pipeline:
Review comment:
*Note:* This is commented out because if we leave it uncommented, even if it doesn't do anything, it makes the test fail with an error. But I still wanted it here for reference.
```
subprocess.CalledProcessError: Command '['/Users/dcavazos/src/beam/env/bin/python', '-m', 'pip', 'download', '--dest', '/var/folders/z2/zp_k4l5n2cq84fsn4y633mg400dsyy/T/tmpdv09ddqk', 'apache-beam==2.22.0.dev0', '--no-deps', '--no-binary', ':all:']' returned non-zero exit status 1.
Pip install failed for package: apache-beam==2.22.0.dev0
Output from execution of subprocess: b''
ERROR: Could not find a version that satisfies the requirement apache-beam==2.22.0.dev0 (from versions: 0.6.0, 2.0.0, 2.1.0, 2.1.1, 2.2.0, 2.11.0, 2.12.0, 2.13.0, 2.14.0, 2.15.0, 2.16.0, 2.17.0, 2.18.0, 2.19.0, 2.20.0, 2.21.0)
ERROR: No matching distribution found for apache-beam==2.22.0.dev0
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] davidcavazos commented on a change in pull request #11851: [BEAM-10144] Update PipelineOptions snippets for best practices
Posted by GitBox <gi...@apache.org>.
davidcavazos commented on a change in pull request #11851:
URL: https://github.com/apache/beam/pull/11851#discussion_r432049685
##########
File path: sdks/python/apache_beam/examples/snippets/snippets.py
##########
@@ -226,35 +227,33 @@ def _add_argparse_args(cls, parser):
# [END pipeline_options_define_custom]
- from apache_beam.options.pipeline_options import GoogleCloudOptions
- from apache_beam.options.pipeline_options import StandardOptions
-
# [START pipeline_options_dataflow_service]
- # Create and set your PipelineOptions.
- options = PipelineOptions(flags=argv)
+ import apache_beam as beam
+ from apache_beam.options.pipeline_options import PipelineOptions
+ # Create and set your PipelineOptions.
# For Cloud execution, specify DataflowRunner and set the Cloud Platform
- # project, job name, staging file location, temp file location, and region.
- options.view_as(StandardOptions).runner = 'DataflowRunner'
- google_cloud_options = options.view_as(GoogleCloudOptions)
- google_cloud_options.project = 'my-project-id'
- google_cloud_options.job_name = 'myjob'
- google_cloud_options.staging_location = 'gs://my-bucket/binaries'
- google_cloud_options.temp_location = 'gs://my-bucket/temp'
- google_cloud_options.region = 'us-central1'
+ # project, job name, temporary files location, and region.
+ # For more information about regions, check:
+ # https://cloud.google.com/dataflow/docs/concepts/regional-endpoints
+ options = PipelineOptions(
+ flags=argv,
+ runner='DataflowRunner',
+ project='my-project-id',
+ job_name='unique-job-name',
+ temp_location='gs://my-bucket/temp',
+ region='us-central1')
# Create the Pipeline with the specified options.
- p = Pipeline(options=options)
+ # with beam.Pipeline(options=options) as pipeline:
Review comment:
This is commented out because if we leave it uncommented, even if it doesn't do anything, it makes the test fail with an error.
```
subprocess.CalledProcessError: Command '['/Users/dcavazos/src/beam/env/bin/python', '-m', 'pip', 'download', '--dest', '/var/folders/z2/zp_k4l5n2cq84fsn4y633mg400dsyy/T/tmpdv09ddqk', 'apache-beam==2.22.0.dev0', '--no-deps', '--no-binary', ':all:']' returned non-zero exit status 1.
Pip install failed for package: apache-beam==2.22.0.dev0
Output from execution of subprocess: b''
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] davidcavazos commented on pull request #11851: [BEAM-10144] Update PipelineOptions snippets for best practices
Posted by GitBox <gi...@apache.org>.
davidcavazos commented on pull request #11851:
URL: https://github.com/apache/beam/pull/11851#issuecomment-641474131
Forgot to use `argv` to parse the pipeline options in `pipeline_options_local`. Tests should pass now.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] davidcavazos commented on a change in pull request #11851: [BEAM-10144] Update PipelineOptions snippets for best practices
Posted by GitBox <gi...@apache.org>.
davidcavazos commented on a change in pull request #11851:
URL: https://github.com/apache/beam/pull/11851#discussion_r432049685
##########
File path: sdks/python/apache_beam/examples/snippets/snippets.py
##########
@@ -226,35 +227,33 @@ def _add_argparse_args(cls, parser):
# [END pipeline_options_define_custom]
- from apache_beam.options.pipeline_options import GoogleCloudOptions
- from apache_beam.options.pipeline_options import StandardOptions
-
# [START pipeline_options_dataflow_service]
- # Create and set your PipelineOptions.
- options = PipelineOptions(flags=argv)
+ import apache_beam as beam
+ from apache_beam.options.pipeline_options import PipelineOptions
+ # Create and set your PipelineOptions.
# For Cloud execution, specify DataflowRunner and set the Cloud Platform
- # project, job name, staging file location, temp file location, and region.
- options.view_as(StandardOptions).runner = 'DataflowRunner'
- google_cloud_options = options.view_as(GoogleCloudOptions)
- google_cloud_options.project = 'my-project-id'
- google_cloud_options.job_name = 'myjob'
- google_cloud_options.staging_location = 'gs://my-bucket/binaries'
- google_cloud_options.temp_location = 'gs://my-bucket/temp'
- google_cloud_options.region = 'us-central1'
+ # project, job name, temporary files location, and region.
+ # For more information about regions, check:
+ # https://cloud.google.com/dataflow/docs/concepts/regional-endpoints
+ options = PipelineOptions(
+ flags=argv,
+ runner='DataflowRunner',
+ project='my-project-id',
+ job_name='unique-job-name',
+ temp_location='gs://my-bucket/temp',
+ region='us-central1')
# Create the Pipeline with the specified options.
- p = Pipeline(options=options)
+ # with beam.Pipeline(options=options) as pipeline:
Review comment:
*Note:* This is commented out because if we leave it uncommented, even if it doesn't do anything, it makes the test fail with an error. But I still wanted it here for reference.
```
subprocess.CalledProcessError: Command '['/Users/dcavazos/src/beam/env/bin/python', '-m', 'pip', 'download', '--dest', '/var/folders/z2/zp_k4l5n2cq84fsn4y633mg400dsyy/T/tmpdv09ddqk', 'apache-beam==2.22.0.dev0', '--no-deps', '--no-binary', ':all:']' returned non-zero exit status 1.
Pip install failed for package: apache-beam==2.22.0.dev0
Output from execution of subprocess: b''
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] davidcavazos commented on pull request #11851: [BEAM-10144] Update PipelineOptions snippets for best practices
Posted by GitBox <gi...@apache.org>.
davidcavazos commented on pull request #11851:
URL: https://github.com/apache/beam/pull/11851#issuecomment-641474784
retest this please
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org