CLI工具需用argparse暴露输入输出等参数,避免硬编码路径;清洗函数应返回新DataFrame而非inplace修改;setup.py中通过entry_points注册全局命令;支持自定义编码和分隔符并优雅处理错误。

用 argparse 定义参数时,别把数据路径硬编码进脚本
CLI 工具的核心是「可复用」,一旦把 input.csv 写死在代码里,别人就只能改源码才能跑。必须把输入、输出、清洗规则开关都暴露为命令行参数。
常见错误:用 sys.argv[1] 手动取参,结果没校验类型、缺参数就报 IndexError;或者把所有逻辑塞进 if __name__ == '__main__': 里,导致无法单元测试。
实操建议:
- 用
argparse.ArgumentParser显式声明--input、--output、--drop-empty-cols等布尔开关 - 对路径参数加
type=Path(配合from pathlib import Path),并在parse_args()后立刻检查文件是否存在、是否可读 - 把清洗主逻辑抽成独立函数,例如
clean_data(df: pd.DataFrame, drop_empty: bool = False) -> pd.DataFrame,CLI 只负责加载→调用→保存
清洗逻辑封装成函数时,避免直接修改原始 DataFrame
很多人写 df.dropna(inplace=True) 或 df['col'] = df['col'].str.strip(),看似简洁,但会导致函数副作用——同一份数据被反复清洗时行为不可控,也难做中间状态调试。
实操建议:
- 所有清洗函数默认返回新
DataFrame,不带inplace=True - 对缺失值处理、重复行、异常值等常见操作,用
pd.DataFrame.copy()开头,确保隔离性 - 如果用户传了
--debug参数,可在函数内加print(f"Before cleaning: {len(df)} rows"),但别混在业务逻辑里,用日志模块更稳妥
打包成可执行 CLI 时,setup.py 中 entry_points 是关键
只写 python my_cleaner.py --input data.csv 不算真正 CLI;用户期望的是 dataclean --input data.csv 这种全局命令。靠 entry_points 绑定函数入口,不是靠 shell alias 或软链接。
创建 Flask + Vue.js 全栈项目,采用单端口架构、uv 依赖管理、结构化日志和生产级前端设计。当用户要求以下操作时触发:创建新的 Flask+Vue 项目、搭建 Web 应用、构建全栈 Python+Vue 应用、初始化 Flask Web 项目、设置单端口 Flask 前后端项目。触发词:新建项目、创建项目、搭建项目、Flask项目、Vue项目。
常见错误:在 setup.py 里漏写 console_scripts,或把函数路径写错成 my_cleaner:main 却忘了 main() 是顶层函数而非类方法。
实操建议:
-
setup.py中必须包含:entry_points={ 'console_scripts': ['dataclean = my_cleaner.cli:main'] } -
cli.py文件里定义的main()函数不能带参数,它由argparse自动注入sys.argv - 安装时用
pip install -e .(开发模式),避免每次改完都要重装
处理 CSV 编码和分隔符时,别假设用户用 UTF-8 和逗号
真实数据常来自 Excel 导出、旧系统导出或不同地区 Excel,默认编码可能是 gbk、latin-1,分隔符可能是 \t 或 ;。硬写 pd.read_csv('x.csv') 必然在某次运行时报 UnicodeDecodeError 或列数错乱。
实操建议:
- CLI 参数中加入
--encoding(默认utf-8)和--sep(默认,),并透传给pd.read_csv() - 对编码错误,加
try/except UnicodeDecodeError,提示用户换编码重试,而不是直接崩掉 - 如果用户传了
--sep auto,可用csv.Sniffer().sniff()探测分隔符,但仅限小文件(大文件会卡住)
实际部署时最容易被忽略的是错误传播:CLI 崩溃时,pd 报的 KeyError 或 ValueError 信息太底层,用户根本看不出是列名写错了还是路径不存在。得在最外层 try/except 里统一捕获、重写提示,比如把 FileNotFoundError 转成 “找不到输入文件,请检查 --input 路径”。
Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!










