Skip to content

Improve cli help somewhat #19073

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

Jump to bottom
Open
wants to merge 31 commits into
base: master
Choose a base branch
from
Open

Improve cli help somewhat #19073

wants to merge 31 commits into from

Conversation

wyattscarpenter
Copy link
Contributor

@wyattscarpenter wyattscarpenter commented May 11, 2025 •
edited
Loading

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 removes the --experimental flag (completing a TODO from 2018-03-16) and 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!

wyattscarpenter and others added 30 commits May 11, 2025 14:38
@wyattscarpenter
failed attempt, very regex-heavy
c95306e
@wyattscarpenter
ok I mean it works now but it doubles up insertions
5dbb010
@wyattscarpenter
works perfectly
c5c0857
@pre-commit-ci @wyattscarpenter
[pre-commit.ci] auto fixes from pre-commit.com hooks
82eb394 
for more information, see https://pre-commit.ci
@wyattscarpenter
get the strict flags another way, to make all the tests pass
15236bd
@pre-commit-ci @wyattscarpenter
[pre-commit.ci] auto fixes from pre-commit.com hooks
4081906 
for more information, see https://pre-commit.ci
@wyattscarpenter
generate the strict list in the build dir, so there won't be any funk…
b415f0f 
…y path trouble
@pre-commit-ci @wyattscarpenter
[pre-commit.ci] auto fixes from pre-commit.com hooks
00580de 
for more information, see https://pre-commit.ci
@wyattscarpenter
um, I meant srcdir. Sure.
98bc704
@wyattscarpenter
bruh
a546416
@wyattscarpenter
refactor out define_options
c044f80
@pre-commit-ci @wyattscarpenter
[pre-commit.ci] auto fixes from pre-commit.com hooks
6a47e7d 
for more information, see https://pre-commit.ci
@wyattscarpenter
remove --experimental from dmypy's options after 'a short transition'…
9ba2c9b 
… (five years)
@wyattscarpenter
move --use-fine-grained-cache to Incremental group
8087150
@wyattscarpenter
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
@wyattscarpenter
rename Optional arguments to Utility arguments, since all arguments a…
4f1e460 
…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.
@wyattscarpenter
The metavar overrides the default of displaying the choices, so we ha…
2a8a8e2 
…ve to explicitly display them.
@wyattscarpenter
update documentation
8c61a64
@wyattscarpenter
update documentation so it's clear that an int field doesn't need to …
350fd38 
…be called int
@wyattscarpenter
begin to enforce rules, although it's surprisingly failing
c0aa284
@wyattscarpenter
continue automating, and correcting
c76183d
@wyattscarpenter
blacken
72f1e5c
@wyattscarpenter
remove the concern about links as it no longer seems to be useful
31dc2ff
@wyattscarpenter
improve cli formatting error message and also linewrapping
2c45a29
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
67dd115 
for more information, see https://pre-commit.ci
@wyattscarpenter
readd link I accidentally deleted
185371a
@wyattscarpenter
name that occurs in python 3.9
91233ca
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
52d2a4c 
for more information, see https://pre-commit.ci
@wyattscarpenter
fix ci problems (type errors)
26e221d
@wyattscarpenter
hold on a minute, this needs an s
9706862
@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@github-actions GitHub Actions
Copy link
Contributor

According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅

@wyattscarpenter wyattscarpenter marked this pull request as ready for review July 31, 2025 08:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@wyattscarpenter
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy