代码收藏家 Python 项目命名规范！ 掌握它， 隔壁小美直夸你代码写的漂亮！！！！
1. Python 项目通用目录结构
为了确保 Python 项目的可维护性、可扩展性和协作性，合理的目录结构至关重要。以下将介绍一些通用的目录结构推荐、文件夹命名规则和文件名命名规则，帮助您在开发过程中提高效率。
1.1 目录结构推荐
一个清晰且标准化的目录结构不仅能帮助开发者更好地理解项目结构，还能减少项目维护过程中的混乱。以下是推荐的 Python 项目目录结构：
project_name/
├── config/ # 配置文件目录
│ └── settings.py # 项目配置
├── src/ # 源代码目录
│ ├── module1/ # 模块1
│ └── module2/ # 模块2
├── tests/ # 测试目录
│ ├── test_module1.py # 模块1的测试
│ └── test_module2.py # 模块2的测试
├── scripts/ # 脚本目录
│ └── setup.py # 项目初始化脚本
├── docs/ # 文档目录
│ └── README.md # 项目说明文档
├── requirements.txt # 项目依赖
└── README.md # 项目说明文件
此目录结构涵盖了 Python 项目中最常见的目录与文件，确保了代码和配置、测试、文档等文件的分离，从而提升了项目的可管理性。
1.2 文件夹命名规则推荐
在 Python 项目中，文件夹命名需要遵循一些规范，确保项目结构清晰、易于理解。以下是一些文件夹命名的建议：
config/ 而不是 Config/。tests/ 用于存放测试代码，docs/ 用于存放项目文档。source_code/ 可以简化为 src/。1.3 文件名命名规则推荐
文件名的命名同样影响项目的可维护性。良好的文件命名规则能够使项目更易于理解和使用。以下是一些文件名命名的建议：
my_script.py 而不是 MyScript.py。test_model.py 用于测试模型相关功能，settings.py 用于配置文件。class.py 或 os.py）作为文件名，防止与系统库冲突。通过遵循这些命名规则，能够提高项目的可读性与可维护性，降低开发过程中的混乱。
2. 变量命名规范
变量命名是代码可读性的重要组成部分，合理的命名不仅能提升代码的理解度，还能减少后期维护中的错误。以下是一些常见的变量命名规范建议：
user_age、total_amount。username 比 name 更具体，total_price 比 price 更明确。count 而不是 c。list、sum 等。示例：
user_name = "John"
total_price = 100
3. 函数命名规范
函数是执行特定任务的代码块，合理的函数命名能帮助其他开发者快速理解函数的功能。以下是函数命名的规范建议：
calculate_total()、get_user_data()。process_data()，而不是 processData()。fetch_data() 而不是 fetch_data_from_database()，除非功能非常复杂。示例：
def calculate_total(price, tax):
return price + tax
4. 其他规范
除了变量和函数命名外，还有一些其他的重要代码规范，有助于提高代码质量和一致性。
4.1 注释规范
示例：
def calculate_total(price, tax):
"""
计算总价，包括价格和税费
:param price: 商品价格
:param tax: 税费
:return: 总价
"""
return price + tax
4.2 空格和缩进
示例：
def get_user_data():
# 获取用户数据
pass
def process_user_data(user_data):
# 处理用户数据
pass
4.3 常量命名规范
常量应该使用全部大写字母，并且用下划线分隔单词。例如，MAX_SIZE、PI。
示例：
MAX_SIZE = 100
PI = 3.14159
作者：小南AI学院
