Skip to content

Disable argument abbreviation in Python #34934

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
damccorm merged 3 commits into from
May 15, 2025
Merged

Disable argument abbreviation in Python #34934

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e87bee2
Disable argument abbreviation in Python
damccorm May 13, 2025
c9c10f1
Merge branch 'master' of https://github.com/apache/beam into users/da…
damccorm May 13, 2025
a337303
Grammar
damccorm May 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@
* X behavior was changed ([#X](https://github.com/apache/beam/issues/X)).
* Yapf version upgraded to 0.43.0 for formatting (Python) ([#34801](https://github.com/apache/beam/pull/34801/)).
* Python: Added JupyterLab 4.x extension compatibility for enhanced notebook integration ([#34495](https://github.com/apache/beam/pull/34495)).
* Python: Argument abbreviation is no longer enabled within Beam. If you previously abbreviated arguments (e.g. `--r` for `--runner`), you will now need to specify the whole argument ([#34934](https://github.com/apache/beam/pull/34934)).

## Deprecations

Expand Down
4 changes: 2 additions & 2 deletions sdks/python/apache_beam/options/pipeline_options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ def __init__(self, flags: Optional[Sequence[str]] = None, **kwargs) -> None:

# 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)
Copy link
Contributor

@rakeshcusat rakeshcusat May 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we also checking documentation and test cases where the abbreviation is used?

Copy link
Contributor Author

@damccorm damccorm May 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Test cases are run as part of this PR. As far as I know, we do not use abbreviations in our docs

for cls in type(self).mro():
if cls == PipelineOptions:
break
Expand Down Expand Up @@ -405,7 +405,7 @@ def get_all_options(
# sub-classes in the main session might be repeated. Pick last unique
# instance of each subclass to avoid conflicts.
subset = {}
parser = _BeamArgumentParser()
parser = _BeamArgumentParser(allow_abbrev=False)
for cls in PipelineOptions.__subclasses__():
subset[str(cls)] = cls
for cls in subset.values():
Expand Down
Loading