1. 代码风格规范

遵循 PEP 8 是 Python 社区的核心准则,确保代码可读性与一致性。

  • 缩进:使用 4 个空格,避免 Tab
  • 行长度:不超过 79 个字符(可扩展至 99 个字符)
  • 空格:运算符两侧、逗号后留空格,如 x = 1 + 2
  • 命名规范
    • 变量/函数:snake_case
    • 类名:CamelCase
    • 常量:全大写 UPPER_CASE
Python_编码规范

2. 函数与模块设计

  • 单一职责:每个函数只完成一个任务,避免复杂逻辑
  • 参数顺序:优先位置参数,后置可选参数(如 def func(a, b, c=None)
  • 模块组织:按功能划分模块,避免全局变量污染
  • 文档字符串:使用 Google Style 描述函数用途、参数与返回值

3. 异常处理

  • 避免裸露的 except,明确捕获特定异常:
    try:  
        ...  
    except ValueError as e:  
        logger.error("无效输入: %s", e)  
    
  • 使用 finally 确保资源释放(如文件、网络连接)

4. 类型提示

从 Python 3.5 开始,推荐使用类型注解提升可维护性:

def add(a: int, b: int) -> int:  
    return a + b  

了解更多:Python类型提示指南

5. 测试与调试

  • 单元测试:使用 unittestpytest,覆盖边界条件
  • 日志记录:通过 logging 模块替代 print,便于排查问题
  • 调试技巧:优先使用 pdb,避免直接输出调试信息
代码格式化

6. 性能优化

  • 避免不必要的全局变量,使用 lru_cache 缓存递归函数
  • 列表推导式优于 for 循环(如 [x**2 for x in range(10)]
  • 使用 __slots__ 减少类内存占用

7. 安全建议

  • 输入验证:对用户输入进行严格检查,防止注入攻击
  • 密码处理:使用 bcryptargon2 加密敏感信息
  • 依赖管理:通过 pip 安装第三方库,定期更新版本

如需进一步学习 Python 编码规范,可参考 Python 官方风格指南
🎯 推荐工具

PEP8

📌 小贴士:坚持使用 IDE 的自动格式化功能(如 VSCode 的 Prettier 插件),可大幅减少代码风格问题!