python flake8 Python PEP8 编码规范 _Python编码格式化之PEP8编码规范

[]]

在项目开发阶段，代码的易读性与统一性对项目的持续维护及团队间的合作极为关键。为此，PEP8（ 8）这一官方推荐的编码规范指南，向开发者提供了一套规范的编码标准。本文将详细介绍PEP8的核心原则、流行的格式检查与格式化工具，以及如何将这些工具融入开发流程中。

PEP8编码风格

PEP8 是被社区普遍认可的编码规范手册，其核心目的是增强代码的统一性和易读性。它涵盖了以下主要方面：

py文本组织规范 命名规范 编码风格

当然，上述内容仅仅是PEP8编码准则中的一部分，而在实际的软件开发中，仅凭个人记忆来遵循并调整这些规范是不现实的。因此，许多基于PEP8编码准则的检测和格式化工具便应运而生。在此，我首先对检查工具和格式化工具之间的差异进行简要说明：

审查工具是指依托于配置文件或遵循PEP8编码标准的规范，对脚本进行检测的软件，一旦发现脚本中存在不规范的表达，便会通过文件报警的方式指出，并提示开发者对脚本进行修正；而格式化工具则是在检查工具的基础上，不仅能够检测脚本的规范性，还能根据预设的规范配置文件，直接辅助开发者对代码进行格式化处理。

以下将列举一些当前开发领域广泛使用的检查工具与格式化工具，不仅对其强大的检查功能进行阐述，同时也会简要说明如何在集成开发环境（IDE）中进行相应的配置，为有需求的同学提供一份配置上的参考。

PEP8编码检查工具

该工具功能全面，不仅能够执行PEP8编码规范的审查，还具备识别潜在错误和评估代码复杂度的能力。

安装方式： pip

基本使用方法： .py

支持根据配置文件对格式化检查的规则进行个性化设定，该配置文件的名称为：.，用户可在其中指定希望忽略的警告信息，以及设定一系列规范参数，如最大行宽等。若需在持续集成/持续部署（CI/CD）流程中执行此检查，可编写命令为：--=/path/to/，后跟文件路径及通配符*.py，以指定检查的文件类型。需要注意的是：

配置文件可存放在代码仓库内一同提交，并确保路径设置恰当；在处理某些规模较大的项目时，若以*.py格式进行检查，效率可能不高，此时可利用patch技术提取出新增的py文件，进而仅对这部分文件进行审查。

相较于其他选项，它重量更轻，拥有更高的检查速度和简便的配置过程，并且能够通过插件实现灵活的扩展功能；然而，它并不支持静态类型的检查。

安装方式： pip

基本使用方法： .py

支持用户自行设定配置文件，通常这类文件被命名为setup.cfg或类似的名称。在配置文件中，用户可以自定义一系列参数，同时也可以参考官方网站获取详细信息。

在持续集成/持续部署流程中，执行代码检查的指令可以表述为：请指定路径至项目根目录下的隐藏文件，并对所有以.py结尾的文件进行操作，即：--=/path/to/. *.py

中配置检查工具

这款IDE是开发领域的主要工具之一，其中提供了将检查命令封装成tool命令或快捷键的功能，使得在提交代码前，用户能够轻松地对py脚本进行格式检查。

以项目为例，起初需构建一个模拟的开发环境，接着进行环境的部署，并生成一个设置文档，最后编写一段示范性的程序代码，具体如下：

示例代码：

# 这是一个示例 Python 脚本。
# 按 Shift+F10 执行或将其替换为您的代码。
在所有区域进行搜索时，请通过双击Shift键来激活搜索功能，以便查找类、文件、工具窗口、操作以及相关设置。
import os
def print_hi(name):
    # 在下面的代码行中使用断点来调试脚本。
    print(f'Hi, {name}')  # 按 Ctrl+F8 切换断点。
# 按装订区域中的绿色按钮以运行脚本。
if __name__ == '__main__':
    print_hi('PyCharm')
    print(此线条的长度过于冗长冗长冗长冗长冗长冗长冗长冗长冗长冗长冗长冗长冗长冗长。)

示例配置文件：

[flake8]
# 最大行长度
max-line-length = 88
# 忽略的错误码（根据团队风格定制）
ignore = E203, E266, W503
# 检查的最大复杂度（McCabe 指标）
max-complexity = 10
# 排除检查的目录或文件
exclude =
    .git,
    __pycache__,
    env,
    venv,
    migrations,
    *.pyc
# 显示错误信息的格式（可选）
格式如下：路径为%(path)s，行号为%(row)d，错误代码为%(code)s，错误信息为%(text)s。

中的配置方法如下：

进入设置菜单，选择工具选项，再点击外部工具，随后点击新建工具按钮，并输入所需内容。

PEP8编码格式化工具

代码规范化工具不仅能够识别并指出不规范代码，还能实现自动修正，以下两种工具尤为推荐：black以及点号。

black

Black是一款无需配置的代码整理工具，它具有较为严格的格式规范，并强制实行了项目编码风格的统一。

安装方式： pip black

基本使用方法： black .py

依据PEP8标准对代码格式进行自动修正，该工具能够通过命令行参数来调节格式化操作的具体行为。

安装方式： pip

基本操作步骤为：在文件名后加上“--in-place”参数，随后紧跟“-- .py”，程序将依照PEP8标准对文件进行直接编辑处理。

如果只是想检查而不直接修改，可以： --diff .py

配置格式化工具

以该示例为参照，依旧采用上述示例代码，将安装的配置设定为一种外部工具。

运行效果：

本地git配置hook

在采用git进行项目管理的环境中，我们能够通过设置pre-钩子功能，确保每次代码提交时脚本都能自动进行格式化处理。具体的配置步骤是：

安装方式： pip pre-

在项目的基础文件夹中建立一个名为“.pre--.yaml”的文件，同时留意将“entry”字段的路径更改为您个人电脑上的实际路径。

repos:
  - repo: local
    hooks:
      - id: autopep8
        name: autopep8
        entry:请将项目路径中的python目录下的py_demo文件夹内的venv子目录中的Scripts文件夹中的autopep8.exe程序执行。
        language: system
        args: [--aggressive, --in-place]
        types: [python]

总结

在项目开发过程中，通常会在CI/CD流程中设置检查工具，特别是在团队协作的情境下，于代码合并到Patch之前增设一道关卡，这样能确保代码库风格的一致性；同时，在本地集成开发环境中配置格式化工具，完成自测并在提交Patch之前执行格式化操作，这能极大地便利开发者统一编码风格；此外，还可以在Git Hook的pre-阶段设置钩子，使得在提交代码前自动完成格式化，从而省去额外步骤，提升开发效率。