Python 编程规范

全屏查看

1 代码风格与格式规范 #

mindmap
    id1[代码风格与格式规范]
        id1-1[缩进与空格]
        id1-2[使用4个空格缩进]
        id1-3[行尾无多余空格]
        id1-4[运算符周围空格使用规范]
        id1-5[行长度与换行]
        id1-6[最大行长度79字符]
        id1-7[适当位置换行规则]
        id1-8[括号内换行规范]
        id1-9[空行使用]
        id1-10[模块级空行规则]
        id1-11[类内空行规范]
        id1-12[函数内空行要求]
        id1-13[导入规范]
        id1-14[标准库导入顺序]
        id1-15[第三方库导入规则]
        id1-16[本地模块导入规范]
        id1-17[绝对导入与相对导入]
缩进与空格
使用4个空格缩进
行尾无多余空格
运算符周围空格使用规范
行长度与换行
最大行长度79字符
适当位置换行规则
括号内换行规范
空行使用
模块级空行规则
类内空行规范
函数内空行要求
导入规范
标准库导入顺序
第三方库导入规则
本地模块导入规范
绝对导入与相对导入

2 命名规范 #

命名风格
蛇形命名法 snake_case
驼峰命名法 CamelCase
大写加下划线 UPPER_CASE
变量与函数命名
局部变量命名规则
全局变量命名规范
函数命名最佳实践
类与模块命名
类命名规范
模块命名要求
包命名规则
特殊命名约定
私有成员命名
保护成员命名
特殊方法命名
mindmap
    id2[命名规范]
        id2-1[命名风格]
        id2-2[蛇形命名法 snake_case]
        id2-3[驼峰命名法 CamelCase]
        id2-4[大写加下划线 UPPER_CASE]
        id2-5[变量与函数命名]
        id2-6[局部变量命名规则]
        id2-7[全局变量命名规范]
        id2-8[函数命名最佳实践]
        id2-9[类与模块命名]
        id2-10[类命名规范]
        id2-11[模块命名要求]
        id2-12[包命名规则]
        id2-13[特殊命名约定]
        id2-14[私有成员命名]
        id2-15[保护成员命名]
        id2-16[特殊方法命名]

3 注释与文档 #

mindmap
    id3[注释与文档]
        id3-1[行内注释]
        id3-2[行内注释格式]
        id3-3[注释内容规范]
        id3-4[注释位置要求]
        id3-5[块注释]
        id3-6[块注释格式]
        id3-7[多行注释规范]
        id3-8[代码块说明注释]
        id3-9[文档字符串]
        id3-10[模块文档字符串]
        id3-11[函数文档字符串]
        id3-12[类文档字符串]
        id3-13[方法文档字符串]
        id3-14[类型注解]
        id3-15[变量类型注解]
        id3-16[函数参数类型提示]
        id3-17[返回值类型标注]
行内注释
行内注释格式
注释内容规范
注释位置要求
块注释
块注释格式
多行注释规范
代码块说明注释
文档字符串
模块文档字符串
函数文档字符串
类文档字符串
方法文档字符串
类型注解
变量类型注解
函数参数类型提示
返回值类型标注

4 代码结构 #

模块组织
模块导入顺序
模块级别代码组织
__all__变量使用
函数设计
函数长度控制
参数设计规范
返回值处理规则
类设计原则
单一职责原则
类继承规范
接口设计最佳实践
异常处理
异常捕获规范
自定义异常设计
异常链使用
mindmap
    id4[代码结构]
        id4-1[模块组织]
        id4-2[模块导入顺序]
        id4-3[模块级别代码组织]
        id4-4[__all__变量使用]
        id4-5[函数设计]
        id4-6[函数长度控制]
        id4-7[参数设计规范]
        id4-8[返回值处理规则]
        id4-9[类设计原则]
        id4-10[单一职责原则]
        id4-11[类继承规范]
        id4-12[接口设计最佳实践]
        id4-13[异常处理]
        id4-14[异常捕获规范]
        id4-15[自定义异常设计]
        id4-16[异常链使用]

5 编程最佳实践 #

mindmap
    id5[编程最佳实践]
        id5-1[表达式与语句]
        id5-2[条件表达式使用]
        id5-3[循环语句优化]
        id5-4[上下文管理器应用]
        id5-5[数据结构使用]
        id5-6[列表推导式规范]
        id5-7[字典操作最佳实践]
        id5-8[集合运算使用]
        id5-9[函数式编程]
        id5-10[高阶函数应用]
        id5-11[lambda表达式使用规范]
        id5-12[生成器表达式优化]
        id5-13[面向对象编程]
        id5-14[封装原则应用]
        id5-15[多态实现规范]
        id5-16[组合与继承选择]
表达式与语句
条件表达式使用
循环语句优化
上下文管理器应用
数据结构使用
列表推导式规范
字典操作最佳实践
集合运算使用
函数式编程
高阶函数应用
lambda表达式使用规范
生成器表达式优化
面向对象编程
封装原则应用
多态实现规范
组合与继承选择

6 性能与优化 #

代码性能
时间复杂度分析
空间复杂度优化
算法选择原则
内存管理
引用计数理解
垃圾回收机制
内存泄漏预防
并发编程
线程安全规范
异步编程最佳实践
锁机制使用
mindmap
    id6[性能与优化]
        id6-1[代码性能]
        id6-2[时间复杂度分析]
        id6-3[空间复杂度优化]
        id6-4[算法选择原则]
        id6-5[内存管理]
        id6-6[引用计数理解]
        id6-7[垃圾回收机制]
        id6-8[内存泄漏预防]
        id6-9[并发编程]
        id6-10[线程安全规范]
        id6-11[异步编程最佳实践]
        id6-12[锁机制使用]

7 测试与调试 #

mindmap
    id7[测试与调试]
        id7-1[单元测试]
        id7-2[测试用例设计]
        id7-3[测试覆盖率要求]
        id7-4[模拟对象使用]
        id7-5[集成测试]
        id7-6[模块集成测试]
        id7-7[系统测试规范]
        id7-8[性能测试方法]
        id7-9[调试技巧]
        id7-10[日志记录规范]
        id7-11[断言使用最佳实践]
        id7-12[调试工具应用]
单元测试
测试用例设计
测试覆盖率要求
模拟对象使用
集成测试
模块集成测试
系统测试规范
性能测试方法
调试技巧
日志记录规范
断言使用最佳实践
调试工具应用

8 工具与自动化 #

代码检查工具
pylint配置使用
flake8规则配置
black自动格式化
版本控制
Git提交规范
分支管理策略
代码审查流程
持续集成
自动化测试配置
代码质量检查
部署流程规范
mindmap
    id8[工具与自动化]
        id8-1[代码检查工具]
        id8-2[pylint配置使用]
        id8-3[flake8规则配置]
        id8-4[black自动格式化]
        id8-5[版本控制]
        id8-6[Git提交规范]
        id8-7[分支管理策略]
        id8-8[代码审查流程]
        id8-9[持续集成]
        id8-10[自动化测试配置]
        id8-11[代码质量检查]
        id8-12[部署流程规范]

9 安全规范 #

mindmap
    id9[安全规范]
        id9-1[输入验证]
        id9-2[用户输入处理]
        id9-3[数据清洗规范]
        id9-4[SQL注入预防]
        id9-5[认证授权]
        id9-6[密码安全处理]
        id9-7[会话管理规范]
        id9-8[权限控制设计]
        id9-9[数据保护]
        id9-10[敏感信息加密]
        id9-11[数据传输安全]
        id9-12[日志安全规范]
输入验证
用户输入处理
数据清洗规范
SQL注入预防
认证授权
密码安全处理
会话管理规范
权限控制设计
数据保护
敏感信息加密
数据传输安全
日志安全规范

10 项目组织 #

项目结构
标准项目布局
配置文件管理
资源文件组织
依赖管理
依赖声明规范
虚拟环境使用
包发布流程
文档维护
README编写规范
API文档生成
变更日志管理
mindmap
    id10[项目组织]
        id10-1[项目结构]
        id10-2[标准项目布局]
        id10-3[配置文件管理]
        id10-4[资源文件组织]
        id10-5[依赖管理]
        id10-6[依赖声明规范]
        id10-7[虚拟环境使用]
        id10-8[包发布流程]
        id10-9[文档维护]
        id10-10[README编写规范]
        id10-11[API文档生成]
        id10-12[变更日志管理]