摘要:在 Python 项目中,遵循一致且清晰的命名规范可以提高代码的可读性和可维护性。
在 Python 项目中,遵循一致且清晰的命名规范可以提高代码的可读性和可维护性。
小写字母:文件名应全部使用小写字母(避免大小写混淆,尤其在跨平台时)。
短横线分隔:单词之间用下划线 _ 分隔(例如 data_processor.py),而不是驼峰式或空格。
✅ 推荐:utils.py, data_loader.py
❌ 避免:DataLoader.py, data-loader.py, dataLoader.py
模块文件(普通功能模块):使用描述性名称,如 string_utils.py、file_io.py。
脚本文件(可执行脚本):若为直接运行的脚本,可以用动词开头,如 run_server.py、process_data.py。
测试文件:以 test_ 开头或结尾,如 test_models.py 或 models_test.py(与测试框架如 pytest 兼容)。
配置文件:如 config.py、settings.py,或按环境区分(dev_config.py, prod_config.py)。
主程序入口:
常用 main.py、app.py 或项目名称(如 my_project_cli.py)。
__init__.py:
包初始化文件(Python 包必需),通常为空或包含包级别代码。
__main__.py:
当包通过 python -m package_name 运行时作为入口。
隐藏文件:以 . 开头的文件(如 .env)通常用于配置或环境变量,避免用作代码文件。
Python 内置模块名:如 sys.py, json.py(会覆盖标准库)。
模糊名称:如 utils.py 或 functions.py 应尽量细化(例如 date_utils.py)。
特殊字符:避免空格、连字符(-)、中文等(可能引发导入错误)。
一致性:保持团队或项目的命名风格统一。
描述性:文件名应清晰反映内容(例如 image_processing.py 比 imgproc.py 更明确)。
短而清晰:平衡简洁性和描述性(如 db.py 可能过于简单,适合小项目)。
示例目录结构:
来源:架构笔记一点号