软件过程管理-python代码规范

Python代码规范

1.1 命名规范

类别 规范要求

变量 使用小写字母，单词间用下划线连接，如user_name

常量 使用全大写字母，单词间用下划线连接，如MAX_CONNECTIONS

函数 使用小写字母，单词间用下划线连接，如calculate_total()

类名 使用驼峰命名法，首字母大写，如ClassName

模块/包 使用简短、全小写名称，避免下划线，如mymodule

1.2 格式规范

项目 规范要求

缩进 使用4个空格，不使用Tab

行长度 不超过79字符(代码)，72字符(文档/注释)

空行 顶级定义间空2行，方法间空1行

导入 分组导入(标准库、第三方、本地)，每组间空1行

引号 统一使用单引号，字符串内有单引号时使用双引号

1.3 编码风格

项目     规范要求

异常处理 避免裸露的except，指定具体异常类型

类型注解 为公共接口添加类型注解

文档字符串 为所有公共模块、函数、类和方法编写docstring

比较操作 使用is和is not比较单例(如None)，不要用==