You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by "Polber (via GitHub)" <gi...@apache.org> on 2024/08/08 19:36:00 UTC

[PR] [yaml] explicitly define beam imports for callables in docs [beam]

Polber opened a new pull request, #32117:
URL: https://github.com/apache/beam/pull/32117

   PR adds explicit beam import statements to inlined python callables. This is technically redundant as 'apache_beam' already gets imported as 'beam' in several places along the codepath, so it is already imported when the callable is run. However, this is not guaranteed to stay this way, and it is more clear to the user than they must import dependencies which are not included on the hidden code path.
   
   ------------------------
   
   Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
   
    - [ ] Mention the appropriate issue in your description (for example: `addresses #123`), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment `fixes #<ISSUE NUMBER>` instead.
    - [ ] Update `CHANGES.md` with noteworthy changes.
    - [ ] 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://github.com/apache/beam/blob/master/CONTRIBUTING.md#make-the-reviewers-job-easier).
   
   To check the build health, please visit [https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md](https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md)
   
   GitHub Actions Tests Status (on master branch)
   ------------------------------------------------------------------------------------------------
   [![Build python source distribution and wheels](https://github.com/apache/beam/workflows/Build%20python%20source%20distribution%20and%20wheels/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
   [![Python tests](https://github.com/apache/beam/workflows/Python%20tests/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
   [![Java tests](https://github.com/apache/beam/workflows/Java%20Tests/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
   [![Go tests](https://github.com/apache/beam/workflows/Go%20tests/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Go+tests%22+branch%3Amaster+event%3Aschedule)
   
   See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI or the [workflows README](https://github.com/apache/beam/blob/master/.github/workflows/README.md) to see a list of phrases to trigger workflows.
   


-- 
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.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [yaml] Doc improvements [beam]

Posted by "Polber (via GitHub)" <gi...@apache.org>.
Polber commented on code in PR #32117:
URL: https://github.com/apache/beam/pull/32117#discussion_r1712056720


##########
website/www/site/content/en/documentation/sdks/yaml-inline-python.md:
##########
@@ -123,6 +123,8 @@ define a `beam.PTransform` inline, e.g.
     constructor: __constructor__
     kwargs:
       source: |
+        import apache_beam as beam

Review Comment:
   Ah I wasn't sure where the import was added so thanks for the link. In that case, I went the other direction and removed an import statement from one of the examples



-- 
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.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [yaml] Doc improvements [beam]

Posted by "robertwb (via GitHub)" <gi...@apache.org>.
robertwb commented on code in PR #32117:
URL: https://github.com/apache/beam/pull/32117#discussion_r1711722268


##########
sdks/python/apache_beam/yaml/yaml_combine.py:
##########
@@ -70,7 +70,7 @@ def normalize_combine(spec):
     def normalize_agg(dest, agg):
       if isinstance(agg, str):
         agg = {'fn': agg}
-      if 'value' not in agg and spec.get('language') != 'sql':
+      if 'value' not in agg and config.get('language') != 'sql':

Review Comment:
   Nice catch.



##########
website/www/site/content/en/documentation/sdks/yaml-inline-python.md:
##########
@@ -123,6 +123,8 @@ define a `beam.PTransform` inline, e.g.
     constructor: __constructor__
     kwargs:
       source: |
+        import apache_beam as beam

Review Comment:
   Beam is explicitly and intentionally in the namespace for convenience: https://github.com/apache/beam/blob/release-2.41.0/sdks/python/apache_beam/utils/python_callable.py#L105 so imports are superfluous and shouldn't be added. (There aren't any other "hidden" imports we have to worry about.)



-- 
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.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [yaml] Doc improvements [beam]

Posted by "damccorm (via GitHub)" <gi...@apache.org>.
damccorm commented on PR #32117:
URL: https://github.com/apache/beam/pull/32117#issuecomment-2288291624

   @Polber @robertwb is this ready to merge? The test failure looks like a flake to me, though I'll rerun to see if we can get green


-- 
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.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [yaml] Doc improvements [beam]

Posted by "Polber (via GitHub)" <gi...@apache.org>.
Polber commented on PR #32117:
URL: https://github.com/apache/beam/pull/32117#issuecomment-2276567296

   R: @robertwb 


-- 
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.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [yaml] Doc improvements [beam]

Posted by "damccorm (via GitHub)" <gi...@apache.org>.
damccorm merged PR #32117:
URL: https://github.com/apache/beam/pull/32117


-- 
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.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [yaml] Doc improvements [beam]

Posted by "Polber (via GitHub)" <gi...@apache.org>.
Polber commented on PR #32117:
URL: https://github.com/apache/beam/pull/32117#issuecomment-2292349009

   > @Polber @robertwb is this ready to merge? The test failure looks like a flake to me, though I'll rerun to see if we can get green
   
   @damccorm Yes it is ready to merge


-- 
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.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [yaml] Doc improvements [beam]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #32117:
URL: https://github.com/apache/beam/pull/32117#issuecomment-2276569002

   Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment `assign set of reviewers`


-- 
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.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org