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

Offen

#465 erstellt am 29.9.2023 0 Kommentare 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 5/5
Geschätzter Aufwand: Über eine Woche
Anfängerfreundlichkeit: 30/100

Issue-Typ: Feature
Klarheit: Muss geklärt werden
Aktivitätsstatus: Veraltet
Tech-Stack: python
Bereich: cli

Rechercherichtung

Das Issue nennt keine Dateien, Tests oder Einstiegspunkte. Beginne damit, den Code zu lokalisieren, der Hilfezusammenfassungen, Argumente und Flags erstellt, und vergleiche dann die vorgeschlagenen Ansätze zum Ausschluss von Unterstrichen, nur Literalen sowie Typen/Modulen. Für den Abschluss sind eine vereinbarte API zum Ausschließen und Tests erforderlich, die zeigen, dass ausgeschlossene Schlüsselwortargumente nicht mehr in jedem Hilfeabschnitt erscheinen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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:

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

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

prefix the argument name with an underscore, e.g.

def my_function(a: bool, _complex_type: ComplexType = ComplexType()):
  ...

limit args and kwargs to literal types

fire.Fire(help_include_literals_only=True)

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]
)

Vorherrschende Sprache: Python
Sterne: 28.2k
Forks: 1.5k
PR-Merge-Kennzahlen: Keine gemergten PRs in 30 T.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus google/python-fire

Test suite fails on Windows: unescaped path regex in testArgPassing, NamedTemporaryFile reopen in testFileNameFire Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100

google/python-fire#693 · Erstellt am 16.8.2026
Release 0.7.2? Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 38/100

google/python-fire#698 · Erstellt am 30.8.2026
Uncaught exception when a component has a property whose getter raises (intended?) Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 58/100

google/python-fire#672 · 5 Kommentare · Erstellt am 06.6.2026
python-fire: (1) PAGER+shell=True RCE in console_io.More (2) bash $(...) runs when sourcing --completion from maliciously named .py file. PoC verified. Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 45/100

google/python-fire#665 · 2 Kommentare · Erstellt am 05.5.2026
**kwargs unexpectedly parses flags for later chained method Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 55/100

google/python-fire#659 · 1 Kommentar · Erstellt am 03.4.2026

Alle Issues in google/python-fire