Skip to content

Use argparse's choices= to display OUTPUT_CHOICES #19869

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
+4 −6
Open

Use argparse's choices= to display OUTPUT_CHOICES #19869

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d07c7da
use raw choices. needs further tweaks
wyattscarpenter Sep 17, 2025
db50b14
partial revert
wyattscarpenter Sep 17, 2025
8074591
add comment about why experimental features doesn't use choices
wyattscarpenter Sep 17, 2025
6b5fc1f
sorted for stability
wyattscarpenter Sep 17, 2025
9d6cce2
update rst to match help
wyattscarpenter Sep 17, 2025
4c2601a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 17, 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
2 changes: 1 addition & 1 deletion docs/source/command_line.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Optional arguments

Show program's version number and exit.

.. option:: -O FORMAT, --output FORMAT {json}
.. option:: -O {json}, --output {json}

Set a custom output format.

Expand Down
8 changes: 3 additions & 5 deletions mypy/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -568,11 +568,7 @@ def add_invertible_flag(
)

general_group.add_argument(
"-O",
"--output",
metavar="FORMAT",
help="Set a custom output format",
choices=OUTPUT_CHOICES,
"-O", "--output", help="Set a custom output format", choices=sorted(OUTPUT_CHOICES)
Copy link
Contributor Author

@wyattscarpenter wyattscarpenter Nov 3, 2025

Choose a reason for hiding this comment

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

(Informational:) an alternate form I considered for this code was

        "-O",
        "--output",
        metavar="FORMAT",
        # The metavar overrides the default of displaying the choices,
        # so we have to explicitly display them.
        help=f"Set a custom output format (choices: {set(OUTPUT_CHOICES.keys())})",
        choices=OUTPUT_CHOICES,

However, I ultimately decided that just letting it do its default thing was better.

)

config_group = parser.add_argument_group(
Expand Down Expand Up @@ -1108,6 +1104,8 @@ def add_invertible_flag(
parser.add_argument(
"--enable-incomplete-feature",
action="append",
# We can't just use choices= here because we actually accept more than this;
# see process_incomplete_features.
metavar="{" + ",".join(sorted(INCOMPLETE_FEATURES)) + "}",
help="Enable support of incomplete/experimental features for early preview",
)
Expand Down
Loading