PEP 8是Python社区官方推荐的代码风格指南,是第8号Python增强提案(Python Enhancement Proposal),核心目标是统一Python代码的书写风格,提升代码的可读性与可维护性,是绝大多数Python项目都遵循的默认规范。
核心规范内容
PEP 8对代码编写的细节做了明确约定,核心规则如下:
缩进:必须用4个空格表示缩进,禁止使用制表符(Tab),更不能混用空格和Tab。
行宽:每行代码的字符数不超过79个字符,注释与文档字符串建议不超过72个字符。
空行:函数和类定义前后各留两个空行,同一个类中不同方法之间留一个空行,逻辑无关段落之间可空一行分隔。
命名规则:
变量、函数、模块名:全小写,多单词用下划线连接(如get_user_id)
类名、异常名:每个单词首字母大写(大驼峰,如UserProfile)
常量:全大写,多单词用下划线连接(如MAX_CONNECT_COUNT)
导入规则:import语句放在文件开头,按「标准库→第三方库→本地模块」分组排序,每行仅导入一个模块。
空格规范:二元运算符(如+、=)左右两侧各保留一个空格,逗号后加一个空格。
作用与落地
PEP 8不是强制语法要求,但在团队协作开发中非常重要:统一的风格能减少因代码不一致带来的阅读成本,让他人更容易阅读和修改你的代码。实际开发中不需要手动逐条检查,主流编辑器(如PyCharm、VS Code)都支持自动提示和格式化,还可以用pycodestyle、flake8等工具自动扫描不合规的代码。