Improve error message when required argument is missing

Offen

#633 erstellt am 14.11.2025 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

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

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

Rechercherichtung

Beginnen Sie damit, die Logik von Python Fire zum Parsen von Befehlszeilenargumenten und die Behandlung von TypeError-Ausnahmen für fehlende erforderliche Positionsargumente zu lokalisieren. Reproduzieren Sie das greet-Beispiel und ermitteln Sie anschließend, wie der Name des fehlenden Arguments und die Nutzungsinformationen verfügbar sind; als erledigt gilt die Aufgabe, wenn der Befehl einen verständlichen Fehler für ein fehlendes Argument mit einem Nutzungshinweis anstelle des generischen Tracebacks ausgibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Description

When a required function argument is not provided via the command line, Python Fire raises a generic TypeError that doesn't clearly indicate which argument is missing or how to provide it.

Current Behavior

$ python my_script.py greet
TypeError: greet() missing 1 required positional argument: 'name'

Expected Behavior

A more user-friendly error message that would guide the user:

$ python my_script.py greet
Error: Missing required argument 'name'
Usage: my_script.py greet <name>

Motivation

This would significantly improve the user experience, especially for new users who are unfamiliar with Python tracebacks. Clear error messages are crucial for CLI tools.

Environment

Python Fire version: 0.7.1
Python version: 3.11
OS: macOS

Possible Solution

Catch TypeError exceptions in the argument parsing logic and check if they're related to missing arguments, then provide a more descriptive message with usage hints.

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