Improve cli help somewhat #19073

wyattscarpenter · 2025-05-11T22:34:53Z

This PR rearranges a couple of command line flag categorizations to make more sense and not leave any uncategorized — which is debatable, if someone really liked how the current top of mypy --help is

options:
  --enable-incomplete-feature {InlineTypedDict,PreciseTupleTypes}
                            Enable support of incomplete/experimental features for early preview

Optional arguments:
  -h, --help                Show this help message and exit
  -v, --verbose             More verbose messages
  -V, --version             Show program's version number and exit
  -O FORMAT, --output FORMAT
                            Set a custom output format

Config file:

instead of

Utility arguments:
  -h, --help                Show this help message and exit
  -v, --verbose             More verbose messages
  -V, --version             Show program's version number and exit
  -O FORMAT, --output FORMAT
                            Set a custom output format (choices: {'json'})

Config file:

This PR also programmatically enforces the cli help style guide (from which it removes the advice about links that seemed misguided).

This PR builds on #19062, to save time fixing merge conflicts later, and so you should probably merge that first!

for more information, see https://pre-commit.ci

…y path trouble

for more information, see https://pre-commit.ci

… (five years)

… from being ungrouped also, take another experimental group from the misc group into this group, and rename the misc group to misc

…re optional although, arguably, they all provide Utility as well. wait, was this 'Optional arguments' header supposed to introduce *all* of the arguments, and just has a couple misc ones under it, as a sort of pun? Well, whatever.

…ve to explicitly display them.

…be called int

for more information, see https://pre-commit.ci

hauntsaninja · 2025-08-02T21:44:15Z

I merged #19062 as instructed, this now has merge conflicts as anticipated :-)

wyattscarpenter · 2025-08-03T21:07:52Z

Hmm, that's actually the opposite of what I expected, but I guess there are just a couple places where these two had diverged...

wyattscarpenter · 2025-08-03T21:29:54Z

Well, the new merge conflicts were pretty easy to merge, as expected, at least... 😌

I was so real for this...

wyattscarpenter

It seems I accidentally double-included strict_list.rst at some point in this process.

docs/source/command_line.rst

wyattscarpenter · 2025-09-11T17:23:12Z

Notes to self:

While this PR could be merged as-is (unless subsequent other commits have invalidated it (which will inevitably happen eventually)), I'm going to try to split parts of it off for the ease of reviewers, since it can be chunked naturally like that, and very small PRs are trivial to accept in a way that bigger PRs aren't. I may edit this comment later to record things I took out of OP and put into a different PR.
- "This PR also removes the --experimental flag (completing a TODO from 2018-03-16)" Update main.py: remove superfluous --experimental flag #19831
I presume that reorganizing the documentation like I did makes it flow in a logical/corresponding order, but this makes the diff much harder to examine (since there are a couple of non-moving changes in the moved section as well, and they all just render as plus or minus lines). That will be a priority to break up into multiple steps (viz: not re-order it here). Another priority for splitting is removing the --experimental flag, which is probably best done as its own PR anyway. I'm also thinking the rename of the misc group variable can be a freestanding PR, as can the invention of the experimental group.
With the release of 1.18, there is probably a new experimental option related to Fixed‑Format Cache, and possibly one related to --allow-redefinition-new. And I should collect those into the right new sections that I am inventing, unless they fit better in their own sections. d33c147, fd05265

github-actions · 2025-09-13T17:00:05Z

Diff from mypy_primer, showing the effect of this PR on open source code:

scipy-stubs (https://github.com/scipy/scipy-stubs)
-   File "/tmp/mypy_primer/mypy_old/venv/bin/mypy", line 7, in <module>
+   File "/tmp/mypy_primer/mypy_new/venv/bin/mypy", line 7, in <module>
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/__main__.py", line 15, in console_entry
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/__main__.py", line 15, in console_entry
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/main.py", line 127, in main
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/main.py", line 127, in main
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/main.py", line 211, in run_build
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/main.py", line 211, in run_build
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/build.py", line 196, in build
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/build.py", line 196, in build
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/build.py", line 272, in _build
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/build.py", line 272, in _build
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/build.py", line 2946, in dispatch
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/build.py", line 2946, in dispatch
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/build.py", line 3346, in process_graph
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/build.py", line 3346, in process_graph
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/build.py", line 3475, in process_stale_scc
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/build.py", line 3475, in process_stale_scc
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/build.py", line 2493, in write_cache
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/build.py", line 2493, in write_cache
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/cache.py", line 28, in __init__
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/cache.py", line 28, in __init__

AutoSplit (https://github.com/Toufool/AutoSplit)
-   File "/tmp/mypy_primer/mypy_old/venv/bin/mypy", line 7, in <module>
+   File "/tmp/mypy_primer/mypy_new/venv/bin/mypy", line 7, in <module>
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/__main__.py", line 15, in console_entry
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/__main__.py", line 15, in console_entry
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/main.py", line 127, in main
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/main.py", line 127, in main
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/main.py", line 211, in run_build
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/main.py", line 211, in run_build
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/build.py", line 196, in build
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/build.py", line 196, in build
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/build.py", line 272, in _build
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/build.py", line 272, in _build
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/build.py", line 2946, in dispatch
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/build.py", line 2946, in dispatch
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/build.py", line 3346, in process_graph
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/build.py", line 3346, in process_graph
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/build.py", line 3475, in process_stale_scc
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/build.py", line 3475, in process_stale_scc
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/build.py", line 2493, in write_cache
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/build.py", line 2493, in write_cache
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/cache.py", line 28, in __init__
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/cache.py", line 28, in __init__

wyattscarpenter and others added 30 commits May 11, 2025 14:38

failed attempt, very regex-heavy

c95306e

ok I mean it works now but it doubles up insertions

5dbb010

works perfectly

c5c0857

[pre-commit.ci] auto fixes from pre-commit.com hooks

82eb394

for more information, see https://pre-commit.ci

get the strict flags another way, to make all the tests pass

15236bd

[pre-commit.ci] auto fixes from pre-commit.com hooks

4081906

for more information, see https://pre-commit.ci

generate the strict list in the build dir, so there won't be any funk…

b415f0f

…y path trouble

[pre-commit.ci] auto fixes from pre-commit.com hooks

00580de

for more information, see https://pre-commit.ci

um, I meant srcdir. Sure.

98bc704

bruh

a546416

refactor out define_options

c044f80

[pre-commit.ci] auto fixes from pre-commit.com hooks

6a47e7d

for more information, see https://pre-commit.ci

remove --experimental from dmypy's options after 'a short transition'…

9ba2c9b

… (five years)

move --use-fine-grained-cache to Incremental group

8087150

create new 'experimental' group, rescuing --enable-incomplete-feature…

3a75ee6

… from being ungrouped also, take another experimental group from the misc group into this group, and rename the misc group to misc

The metavar overrides the default of displaying the choices, so we ha…

2a8a8e2

…ve to explicitly display them.

update documentation

8c61a64

update documentation so it's clear that an int field doesn't need to …

350fd38

…be called int

begin to enforce rules, although it's surprisingly failing

c0aa284

continue automating, and correcting

c76183d

blacken

72f1e5c

remove the concern about links as it no longer seems to be useful

31dc2ff

improve cli formatting error message and also linewrapping

2c45a29

[pre-commit.ci] auto fixes from pre-commit.com hooks

67dd115

for more information, see https://pre-commit.ci

readd link I accidentally deleted

185371a

name that occurs in python 3.9

91233ca

[pre-commit.ci] auto fixes from pre-commit.com hooks

52d2a4c

for more information, see https://pre-commit.ci

fix ci problems (type errors)

26e221d

hold on a minute, this needs an s

9706862

This comment has been minimized.

Sign in to view

my arguments were in the wrong order

01324aa

This comment has been minimized.

Sign in to view

wyattscarpenter marked this pull request as ready for review July 31, 2025 08:05

Merge branch 'master' into cli

e07a90a

Update main.py: fix terminal punctuation

a3b62b5

I was so real for this...

This comment has been minimized.

Sign in to view

wyattscarpenter commented Sep 9, 2025

View reviewed changes

docs/source/command_line.rst Outdated Show resolved Hide resolved

docs/source/command_line.rst Outdated Show resolved Hide resolved

docs/source/command_line.rst Outdated Show resolved Hide resolved

docs/source/command_line.rst Outdated Show resolved Hide resolved

don't double-include strict_list.rst

bf0b9a2

This comment has been minimized.

Sign in to view

wyattscarpenter mentioned this pull request Sep 11, 2025

Don't let help formatter line-wrap URLs #19825

Open

Merge branch 'master' into cli

66823b5

wyattscarpenter mentioned this pull request Sep 13, 2025

mysterious spurious diff hauntsaninja/mypy_primer#203

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Improve cli help somewhat #19073

Improve cli help somewhat #19073

wyattscarpenter commented May 11, 2025 •

edited

Loading

Uh oh!

This comment has been minimized.

This comment has been minimized.

hauntsaninja commented Aug 2, 2025

Uh oh!

wyattscarpenter commented Aug 3, 2025

Uh oh!

wyattscarpenter commented Aug 3, 2025

Uh oh!

This comment has been minimized.

wyattscarpenter left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

wyattscarpenter commented Sep 11, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Sep 13, 2025

Uh oh!

Uh oh!

Uh oh!

Improve cli help somewhat #19073

Are you sure you want to change the base?

Improve cli help somewhat #19073

Conversation

wyattscarpenter commented May 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

hauntsaninja commented Aug 2, 2025

Uh oh!

wyattscarpenter commented Aug 3, 2025

Uh oh!

wyattscarpenter commented Aug 3, 2025

Uh oh!

This comment has been minimized.

wyattscarpenter left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

wyattscarpenter commented Sep 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Sep 13, 2025

Uh oh!

Uh oh!

wyattscarpenter commented May 11, 2025 •

edited

Loading

wyattscarpenter commented Sep 11, 2025 •

edited

Loading