讲师中心 微信公众号

工具推荐

视频效率加速
立刻MV
立刻MV

低成本歌曲 MV、视频生成

剧云
剧云

中文短剧剧本制作平台

updream

一键生成高质量推广成片

Laper
Laper

剧本策划到成片协作

Python 编写可维护命令行程序的实践

大静大大_1010

大静大大_1010

发布时间:2026-02-19 15:57:10

|

265人浏览过

|

来源于php中文网

原创

用 argparse 是 Python 命令行程序可维护的底线;应规范使用 add_argument()、subparsers、type/action 校验,业务逻辑须解耦至独立函数,用 logging 替代 print,并正确配置 entry_points。

python 编写可维护命令行程序的实践

用 argparse 而不是 sys.argv 手撕参数

手写 sys.argv 解析很快会失控,尤其当参数变多、要支持 --help、类型校验、子命令时,逻辑迅速变成面条。用 argparse 是 Python 命令行程序可维护的底线。

实操建议:

立即学习“Python免费学习笔记(深入)”;

  • 把每个参数定义为独立的 add_argument() 调用,别堆在一行里;命名用 dest 显式指定变量名,避免靠位置猜含义
  • 对必填参数加 required=True,别靠运行时报错提醒用户;对布尔开关用 action='store_true',而不是手动转字符串
  • 子命令(如 mytool init / mytool run)必须用 add_subparsers() + set_defaults(func=...),否则分支逻辑会散落在 if 判断里,难以测试和复用
  • 别在 parse_args() 后再做参数合法性检查(比如“--port 必须大于 1024”),应该用 type= 或自定义 action 提前拦截——错误信息才准确,用户才不会看到 AttributeError

把业务逻辑从 main() 函数里彻底移出去

常见错误是把所有代码塞进 if __name__ == '__main__': 下面:打开文件、调 API、格式化输出全混在一起。这种写法导致无法单元测试、无法复用、无法调试单个环节。

实操建议:

立即学习“Python免费学习笔记(深入)”;

  • main() 函数只做三件事:解析参数 → 调用一个顶层函数(如 run_cli(args))→ 捕获并打印顶层异常
  • 每个核心能力单独成函数,接收明确输入、返回明确值,不读环境变量、不直接 print;例如 fetch_user(user_id: str) -> dict,而不是 do_the_thing()
  • 如果涉及 I/O,把路径、URL、超时等作为参数传入,而不是硬编码或从全局配置读;这样本地测试时才能 mock 或替换为临时文件
  • 避免在函数里调 exit() 或 print() —— 错误由 main() 统一处理,成功结果由调用方决定怎么展示

用 logging 替代 print() 控制输出粒度

上线后需要看日志定位问题,但满屏 print('step 2 done') 既没法关、又分不清优先级,还会污染 JSON 输出流。用 logging 是唯一合理选择。

Python Hardener
Python Hardener

通过完整的安全审查、代码整洁重构、健壮的错误处理、正确的日志记录以及完整的文档字符串覆盖,强化 Python 脚本。

下载

实操建议:

立即学习“Python免费学习笔记(深入)”;

  • 初始化只调一次 logging.basicConfig(),在 main() 开头,格式带时间、级别、模块名;别在每个文件里重复配置
  • DEBUG 级别只放开发期诊断信息(如“收到 raw payload: {...}”),INFO 放用户关心的进度(如“已同步 127 条记录”),WARNING 和 ERROR 严格对应异常分支,别滥用
  • CLI 工具默认日志级别设为 INFO,通过 --verbose 参数动态设为 DEBUG,别让用户改代码
  • 别用 logging.info('user %s, id %d' % (name, uid)) 拼接字符串——用 logging.info('user %s, id %d', name, uid),避免格式错误时日志直接崩掉

打包前先确认 entry_points 和 console_scripts 是否生效

很多工具本地能跑,pip install 后却提示 command not found,根本原因是没正确注册入口点,或者安装时跳过了 setup.py / pyproject.toml 中的声明。

实操建议:

立即学习“Python免费学习笔记(深入)”;

  • 在 pyproject.toml 中写清楚:[project.entry-points."console_scripts"] 下映射命令名到模块函数,例如 mytool = "mytool.cli:main"
  • 安装必须用 pip install -e .(开发模式)或 pip install .,不能只运行 python mytool/cli.py 就以为完事
  • 装完立刻验证:which mytool 应该返回路径,mytool --help 应该正常输出——别等到 CI 报错才回头查
  • Windows 用户注意:某些终端(如 Git Bash)可能缓存旧的命令路径,改完 entry_points 后要关掉终端重开,否则始终找不到新命令

最常被忽略的是子命令的函数绑定——set_defaults(func=...) 里的函数必须可被 import,路径写错、模块没 __init__.py、或者函数在 if 块里定义,都会让命令静默失败,只显示空 help。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

码上飞
码上飞 Hot

一款基于自然语言的AI应用开发平台,可根据用户描述自动生成应用程序,帮助个人和团队快速完成应用原型与开发。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2335

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

3822

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

1276

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

4439

2025.09.10

pip安装使用方法
pip安装使用方法

安装步骤:1、确保Python已经正确安装在您的计算机上;2、下载“get-pip.py”脚本;3、按下Win + R键,然后输入cmd并按下Enter键来打开命令行窗口;4、在命令行窗口中,使用cd命令切换到“get-pip.py”所在的目录;5、执行安装命令;6、验证安装结果即可。大家可以访问本专题下的文章,了解pip安装使用方法的更多内容。

3590

2023.10.09

更新pip版本
更新pip版本

更新pip版本方法有使用pip自身更新、使用操作系统自带的包管理工具、使用python包管理工具、手动安装最新版本。想了解更多相关的内容,请阅读专题下面的文章。

8123

2024.12.20

pip设置清华源
pip设置清华源

设置方法:1、打开终端或命令提示符窗口;2、运行“touch ~/.pip/pip.conf”命令创建一个名为pip的配置文件;3、打开pip.conf文件,然后添加“[global];index-url = https://pypi.tuna.tsinghua.edu.cn/simple”内容,这将把pip的镜像源设置为清华大学的镜像源;4、保存并关闭文件即可。

9842

2024.12.23

python升级pip
python升级pip

本专题整合了python升级pip相关教程,阅读下面的文章了解更多详细内容。

5187

2025.07.23

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

0

2026.11.12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn