Optional type args are mistyped in help

Offen

#508 erstellt am 19.4.2024 5 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 3/5
Geschätzter Aufwand: 1-2 Tage
Anfängerfreundlichkeit: 45/100

Issue-Typ: Bug
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: python
Bereich: cli

Rechercherichtung

Beginne damit, die beiden Beispiele über fire.Fire(main) zu reproduzieren und die erzeugte --help-Ausgabe zu prüfen. Verfolge, wie die Optional-Annotation in den angezeigten Typ umgewandelt wird, und überprüfe anschließend, dass beide Standardwerte die erwartete Formulierung Optional[str] erzeugen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

bug

Type annotations that use typing.Optional are incorrectly documented when showing help.

Example 1

from typing import Optional

import fire

def main(arg: Optional[str] = 'something'):
    """Do something with arg."""


if __name__ == '__main__':
    fire.Fire(main)

The corresponding help output is:

INFO: Showing help with the command 'firetest.py -- --help'.

NAME
    firetest.py - Do something with arg.

SYNOPSIS
    firetest.py <flags>

DESCRIPTION
    Do something with arg.

FLAGS
    -a, --arg=ARG
        Type: Optional
        Default: 'something'

Here, Type: Optional is totally incorrect. It should be Optional[str]. My use of str is just an example and it can be anything.

Example 2

from typing import Optional

import fire


def main(arg: Optional[str] = None):
    """Do something with arg."""


if __name__ == '__main__':
    fire.Fire(main)

The corresponding help output is:

INFO: Showing help with the command 'firetest.py -- --help'.

NAME
    firetest.py - Do something with arg.

SYNOPSIS
    firetest.py <flags>

DESCRIPTION
    Do something with arg.

FLAGS
    -a, --arg=ARG
        Type: Optional[Optional]
        Default: None

Here, Type: Optional[Optional] is even more incorrect. It should be Optional[str]. My use of str is just an example and it can be anything.

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