Defaults conditionally omitted from help message when using ArgumentDefaultsHelpFormatter
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 77.2k
- Fork
- 36k
- Metriche di merge delle PR
- Metriche PR in attesa
Descrizione
Bug report
Using ArgumentDefaultsHelpFormatter as formatter_class of ArgumentParser doesn't always shows default even if the default for argument is set. It's expected to show default if provided.
Example:
parser = ArgumentParser(formatter_class=ArgumentDefaultsHelpFormatter)
parser.add_argument('foo', default=1)
parser.add_argument('bar', nargs='*', default=1)
parser.add_argument('baz', nargs='*', default=1, help='baz help')
parser.add_argument('-a', default=1)
parser.add_argument('-b', default=1, help='b_help')
parser.print_help()
provides
positional arguments:
foo
bar
baz baz help (default: 1)
options:
-h, --help show this help message and exit
-a A
-b B b_help (default: 1)
Though I see no reason to not show default for -a, foo and bar.
Making help argument mandatory to show default is necessary imho, but what is really strange is that it's enough for an option, but requires nargs for a positional argument.
Your environment
- CPython versions tested on: 3.10.5
- Operating system and architecture: Arch Linux x86_64 5.15.55-1-lts
Linked PRs
- gh-112682
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia riproducendo l’esempio fornito di ArgumentParser con ArgumentDefaultsHelpFormatter ed esamina il comportamento del formatter per gli argomenti posizionali e opzionali. Controlla il PR collegato gh-112682 per il lavoro già esistente; il lavoro è completo quando l’output dell’help mostra coerentemente i valori predefiniti forniti nei casi segnalati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- cli
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 35/100