2025年python - 代码规范 - PEP8文档翻译整理

科技前沿 • 2025-03-15 12:15 • 阅读 50

大家好，我是讯享网，很高兴认识大家。

说明1：vscode可以下载安装插件，实现自动pep8格式化，有需要的可以去试试；

说明2：用gitlab作为代码管理工具的时候，可以在本地仓库中设置一些参数，每次commit之前，会检查自己的代码，通过了才commit成功，教程可以参考 安装使用 pre-commit
；

说明4：这篇整理文档，尽量直译并选了一些要点。

0. 每行最大列
1. 缩进-Indentation
- 1.1 函数相关
- 1.2 if 条件换行
- 1.3 换行时结束括号的位置
2. 换行
- 2.1 二元操作符换行位置——放到每行开头
3. 空白行-Blank Lines
4. 导入-import
- 4.1 一行import一个，除了from...import...
- 4.2 所有import的包分成三组
- 4.3 推荐用绝对路径导入
- 4.4 避免使用 from import *
5. 空格
- 5.1 和各种括号相邻——不加空格
- 5.2 逗号和结束括号之间——其实是5.1的特例
- 5.3 数组的切片操作
- 5.4 多个操作符
- 5.5 函数参数中等号两边不加空格
- 5.6 不鼓励同一行有多个语句
6. 注释-comment
7. docstrings
8. 命名约定-Naming Conventions
- 8.1 Overriding Principle
- 8.2 命名风格-描述性的（Descriptive: Naming Styles）
- 8.3 命名规范-规定的（Prescriptive: Naming Conventions）
- - 8.3.1 避免使用的命名
  - 8.3.2 包名或者模块名-Package and Module Names
  - 8.3.3 类名称-Class Names
  - 8.3.4 函数名和变量名
  - 8.3.5 常数
9. 编程建议-Programming Recommendations