Disable argument abbreviation in Python #34934
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…mccorm/abbreviation
Contributor
|
Fixes #34101 |
rakeshcusat
reviewed
May 14, 2025
| # Build parser that will parse options recognized by the [sub]class of | ||
| # PipelineOptions whose object is being instantiated. | ||
| parser = _BeamArgumentParser() | ||
| parser = _BeamArgumentParser(allow_abbrev=False) |
Contributor
There was a problem hiding this comment.
Are we also checking documentation and test cases where the abbreviation is used?
Contributor
Author
There was a problem hiding this comment.
Test cases are run as part of this PR. As far as I know, we do not use abbreviations in our docs
17 tasks
tvalentyn
reviewed
May 14, 2025
tvalentyn
approved these changes
May 14, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Today, you can abbreviate arguments in Beam. This is generally convenient since you can do things like specify
--rinstead of--runner, and Beam will infer your intent.Unfortunately, it also has unintended side effects. For example, specifying
--uwill impact not just--update, but also--update_compatibility_version(caused bug fixed by #34083), and specifying--outputlike we do in most examples will impact--output_executable_pathas well (notably, this cannot be fixed in an easy way likeupdate_compatibility_versionsince bothoutputandoutput_executable_pathmight be expecting strings). There is not an easy way to resolve this, and it only gets worse as we add more flags over time.To resolve this, this PR makes a one time breaking change to get rid of argument abbreviation. This will cause existing pipelines which are using this feature to no longer pick up abbreviated flags. In most cases, this will lead to obvious changes in behavior or failures (e.g. a runner is not specified correctly and now tries to run with the local runner), but in some cases the issue may be more subtle. I do not think there is a great way around this.
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
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, commentfixes #<ISSUE NUMBER>instead.CHANGES.mdwith noteworthy changes.See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.