Improve error message when required argument is missing

未关闭

#633 创建于 2025年11月14日 1 条评论 0 个 reaction 已指派 0 人在 GitHub 查看

还没有人认领这个 Issue。

评估

难度: 4/5
预计耗时: 3-5 天
新手友好度: 45/100

Issue 类型: 功能
描述清晰度: 基本清楚
活跃度: 停滞
技术栈: python
领域: cli

调研方向

首先定位 Python Fire 的命令行参数解析逻辑，以及对缺少必需位置参数时 TypeError 异常的处理。重现 greet 示例，然后确定如何获取缺少的参数名称和用法信息；完成的标准是：命令报告一条友好的缺少参数错误，并附带用法提示，而不是通用的 traceback。

由索引模型根据 Issue 内容生成。

描述

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.

主要语言: Python
星标: 28.2k
派生: 1.5k
PR 合并指标: 30 天内没有已合并 PR

贡献指南

打开贡献指南

从这里开始

先读完整个 Issue，再读项目的贡献指南。
在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
Fork 仓库，在一个分支上完成修改。
提交 Pull Request，并在描述里引用这个 Issue 编号。

google/python-fire 的其他 Issue

Test suite fails on Windows: unescaped path regex in testArgPassing, NamedTemporaryFile reopen in testFileNameFire 未关闭

难度 2/5 1-3 小时新手友好度 85/100

google/python-fire#693 · 2026年8月16日创建
Release 0.7.2? 未关闭

难度 3/5 1-2 天新手友好度 38/100

google/python-fire#698 · 2026年8月30日创建
Uncaught exception when a component has a property whose getter raises (intended?) 未关闭

难度 3/5 1-2 天新手友好度 58/100

google/python-fire#672 · 5 条评论 · 2026年6月6日创建
python-fire: (1) PAGER+shell=True RCE in console_io.More (2) bash $(...) runs when sourcing --completion from maliciously named .py file. PoC verified. 未关闭

难度 4/5 3-5 天新手友好度 45/100

google/python-fire#665 · 2 条评论 · 2026年5月5日创建
**kwargs unexpectedly parses flags for later chained method 未关闭

难度 4/5 3-5 天新手友好度 55/100

google/python-fire#659 · 1 条评论 · 2026年4月3日创建

查看 google/python-fire 的全部 Issue

相似的 Issue

create_predictable_zip member order differs on Windows for directory input 未关闭

bug

难度 2/5 1-3 小时新手友好度 90/100

learningequality/ricecooker#747 · 2026年9月23日创建
[Anon] Mechanicum: skitarii as mechanicum allies rule 未关闭

难度 2/5 1-3 小时新手友好度 68/100

BSData/horus-heresy-3rd-edition#3171 · 2026年9月23日创建
CHANGELOG.md entries are too long to maintain, and their length is what makes every PR conflict expensive 未关闭

enhancement

难度 2/5 1-3 小时新手友好度 72/100

lanl/PyBNF#809 · 2026年9月23日创建
[Bug]: PrevNextNodePostprocessor loses retrieved scores when neighbor windows overlap 未关闭

难度 2/5 1-3 小时新手友好度 76/100

run-llama/llama_index#23199 · 2026年9月23日创建
Cannot export point cloud without radius attribute 未关闭

难度 2/5 1-3 小时新手友好度 84/100

KhronosGroup/glTF-Blender-IO#2769 · 2026年9月23日创建

更多 Python Issue

精选适合新手参与的 GitHub issue 摘要。