[feature request] Exclude function (kw)args from synopsis, arguments and flags in help output

Aperta
#465 0 commenti 3 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
30/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
python
Ambito
cli

Direzione di ricerca

La issue non indica file, test o punti di ingresso. Inizia individuando il codice che costruisce i riepiloghi della guida, gli argomenti e i flag, quindi confronta gli approcci proposti per l’esclusione degli underscore, dei soli literal e di tipi/moduli. Per considerarlo completato, servono un’API di esclusione concordata e test che dimostrino che gli argomenti con parole chiave esclusi non compaiono più in ogni sezione della guida.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement

The help output lists all function (keyword) arguments in the synopsis, arguments and flags.

In my specific use case, I would like to exclude some of those arguments, because they are:

  1. of non-literal type, and therefore not easily provided through the means of CLI
  2. injected by a dependency injection decorator

The option to exclude (keyword) arguments could be done in a couple of ways:

  1. prefix the argument name with an underscore, e.g.
def my_function(a: bool, _complex_type: ComplexType = ComplexType()):
  ...
  1. limit args and kwargs to literal types
fire.Fire(help_include_literals_only=True)
  1. provide the means to exclude arguments based on module or instance type, e.g.
def my_function(a: bool, s: service.ComplexType):
  ...

fire.Fire(
  help_exclude_arg_types=[service.ComplexType],
  help_exclude_arg_modules=[service]
)
Lingua principale
Python
Stelle
28.2k
Fork
1.5k
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di google/python-fire

Tutte le issue di google/python-fire

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.