2018必威体育精装版Python编程规范.doc

内部文档 严禁外传 Python编程规范 签署： （管理者代表） 日期： 修订记录 日期 版本 作者 批准 生效日期 目 录 TOC \o 1-3 \h \z \u 1. Purpose目的 4 2. Scope适用范围 4 3. Roles and Responsibilities角色和职责 4 4. Procedure程序要求 4 4.1 General Requirements总要求 4 4.2 总则 5 5. Reference Documents参考文档 7 5.1 External Reference外部参考文档 7 5.2 Internal Reference内部参考文档 7 5.3 Record记录模板 8 6. Terms and Definitions缩略语和定义 8 6.1 Definitions定义 8 6.2 Acronym缩略语 8 Purpose目的 本程序文件指导Python代码编写，旨在通过程序文件规范编码，通过编码规范来提高代码质量、代码可读性和可维护性。 Scope适用范围 本程序文件适用于开发部项目开发过程中所有Python代码。 Roles and Responsibilities角色和职责 角色 职责描述 Module负责人 （MO） Module Owner 组织完成软件模块编码规范的评审 软件开发工程师 （SD） Software Developer 按照编程规范完成编码实现 参与编码规范的评审，并按照规范要求完成不符合规范代码的整改 Procedure程序要求 4.1 General Requirements总要求 对于命名的规则，各模块负责人应能给出各自明确的命名规则。 对于错误的处理机制和要求，各模块负责人应能给出明确的要求。 对于各自的日志处理，各位模块负责人最好能把日志消息分为高、中、低或其他形式不同的等级，同时对日志有明确的要求。 项目组内多人开发时，需要统一变量命名规则，保持风格的一致性。 本规范分为强制规范和推荐规范，强制规范以黑色字体表示，推荐规范以蓝色字体表示。 4.2 总则 1、标识符的命名应该使用具有实际含义的英文单词作为标识符的名称。 具体的标识符包括：包名、类名、方法名、属性名、方法参数、局部变量名等； 要求使用具有实际含义的英文单词作为标识符的名称，不应该使用汉语拼音、数字序列等作为标识符的名称，如：Class Yonghu（用户）、int C_1001都不是符合规范的标识符。 标识符应该尽量使用完整的英文单词的组合作为标识符的名称，当需要使用缩写时，只能使用计算机领域或业务领域内公认的缩写，如：url、html等就是符合规范的缩写；缩写的大小写要求同普通英文单词，具体视标识符的类型而定。 2、模块名称应该全部使用小写字母和下划线。 如：core.cache_service就是一个符合规范的模块路径。 3、包的命名尽量短小，使用全部小写的方式，不可以使用下划线。 如：mon.token_service是一个符合规范的包名（其中core和common都表示不同层级的包名） mon_service.token不符合命名规范的包名，其中common_service应该是一个包名，但是包含的下划线 4、类的名称通常使用名词，并且首字母大写，如果类名由多个英文单词组成时，每个英文单词的首字母也要大写。模块内部使用的类采用_CapWord的方式。 不符合规范的类名如： class metadata class Metadatafactory 符合规范的如： class Metadata class MetadataFactory 类名的首字母大写，类名由多个英文单词组成时，每个英文单词的首字母大写。 5、函数命名使用全部小写的方式，可以使用下划线。 6、类的属性（方法和变量）命名使用全部小写的方式，可以使用下划线。 7、类的属性有三种作用域public，non-public和subclass API，non-public属性的成员函数需要加上一个下划线做前缀。 8、类的属性若与关键字名字冲突，使用后缀一个下划线，尽量不要使用更加缩略或其他方式 9、异常命名使用CapWords+Error后缀的方式 10、静态常量要全部使用大写字母；常量由多个单词组成时，单词之间使用_隔开。 符合规范的示例如下： SESSION_MAX_NUMBER = 20; DEFAULT_CLASS_NAME = “BaseBean”; 常量全部使用大写字母，如常量由多个单词组成时，单词之间使用_隔开。 1