京创开发Python规范
latest
京创Python开发规范
京创开发Python规范
»
Contents
Edit on GitHub
Note
This project is under active development.
Contents
京创Python开发规范
1 背景
2.1 Lint
2.1.1Definition(以下都译为定义)
2.1.2 Pros
2.1.3 Cons
2.1.4 Decision(以下都译为建议)
2.2 Imports
2.2.1 定义
2.2.2 Pros
2.2.3 Cons
2.2.4 建议
2.3 包
2.3.1 Pros
2.3.2 Cons
2.4 异常
2.4.1 定义
2.4.2 Pros
2.4.3 Cons
2.4.4 建议
2.5 全局变量
2.5.1 定义
2.5.2 Pros
2.5.3 Cons
2.5.4 建议
2.6 内嵌/局部/内部 类和函数
2.6.1 定义
2.6.2 Pros
2.6.3 Cons
2.6.4 建议
2.7 列表推导和生成器表达式
2.7.1 定义
2.7.2 Pros
2.7.3 Cons
2.7.4 建议
2.8 默认迭代器和运算符
2.8.1 定义
Pros
Cons
建议
2.9 生成器
2.9.1 定义
2.9.2 Pros
2.9.3 Cons
2.9.4 建议
2.10 Lambda表达式
2.10.1 定义
2.10.2 Pros
2.10.3 Cons
2.10.4 建议
2.11 条件表达式
2.11.1 定义
2.11.2 Pros
2.11.3 Cons
2.11.4 建议
2.12 默认参数值
2.12.1 定义
2.12.2 Pros
2.12.3 Cons
2.12.4 建议
2.13 属性
2.13.1 定义
2.13.2 Pros
2.13.3 Cons
2.13.4 建议
2.14 True/False表达式
2.14.1 定义
2.14.2 Pros
2.14.3 Cons
建议
2.15 弃用的语言特性
2.15.1 定义
2.15.2 建议
2.16 词法作用域
2.16.1 定义
2.16.2 Pros
2.16.3 Cons
2.16.4 建议
2.17 函数和方法装饰器
2.17.1 定义
2.17.2 Pros
2.17.3 Cons
2.17.4 建议
2.18 线程
2.19 过于强大的特性
2.19.1 定义
2.19.2 Pros
2.19.3 Cons
2.19.4 定义
2.20 新版本Python: Python3 和从
__future__
import
2.20.1 定义
2.20.2 Pros
2.20.3 Cons
2.20.4 建议
2.21 带有类型注释的代码
2.21.1 定义
2.21.2 Pros
2.21.3 Cons
2.21.4 建议
3 Python代码风格规范
3.1 分号
3.2 行长度
3.3 括号
3.4 缩进
3.4.1 关于尾后逗号
3.5 空行
3.6 空格
3.7 Shebang
3.8 注释和文档字符串
3.8.1 文档字符串
3.8.2 模块
3.8.3 函数和方法
3.8.4 类
3.8.5 块注释和行注释
3.8.6 标点,拼写和语法
3.9 类
3.10 字符串
3.11 文件和socket
3.12 TODO注释
3.13 import格式
3.14 语句
3.15 访问
3.16 命名
3.16.1 要避免的名字：
3.16.4 命名约定
3.16.3 文件名
3.16.4 Guido的指导建议
3.17 Main
3.18 函数长度
3.19 类型注释
3.19.1 基本规则
3.19.2 分行
3.19.3 前置声明
3.19.4 默认值
3.19.5 NoneType
3.19.6 类型别名
3.19.7 忽略类型检查
3.19.8 对变量注释类型
3.19.9 元组和列表
3.19.10 TypeVars
3.19.11 字符串类型
3.19.12 typing的import
3.19.13 条件import
3.19.14 循环依赖
3.19.15 泛型
4 最后的话