📝 PEP8规范

  • 代码格式:每行不超过79个字符,使用4空格缩进(禁止使用Tab)
  • 空格:运算符两侧需空格(如 x = 5),逗号后空格(如 args, kwargs
  • 文档字符串:使用三引号(""")编写,首行简要描述,第二行空行,后续详细说明
    PEP8

🧾 命名约定

类型 命名方式 示例
变量 snake_case user_name
函数 snake_case calculate_sum()
CamelCase DataProcessor
常量 UPPER_SNAKE_CASE MAX_RETRIES

📦 代码结构

  • 模块顶部应有文档字符串(如适用)
  • 导入语句集中放置,按标准库、第三方库、本地库顺序
  • 函数/类之间空两行分隔
    变量命名

🛠️ 最佳实践

  • 使用isinstance()而非type()检查类型(type(obj) is int可能引发问题)
  • 避免使用__magic__方法(如__init__需谨慎使用)
  • 为循环添加明确的注释(# iterate over list
    代码结构

📚 扩展阅读

了解更多Python最佳实践
查看Python官方风格指南