Pycharm 如何自动调整 Python 代码符合 pep8 编码规范

Posted 2022-11-26 上海-悠悠

前言

学生时代，写的一手漂亮的好字，能给人留下好的印象。作为 IT 人，写的一手漂亮的代码也会给人留下美好的印象。
代码就是自己的脸面，不管写质量怎样，首先要写的漂亮。Python 有一套 pep8 编码规范标准。

什么是 pep8 编码规范标准

PEP是Python Enhancement Proposal的缩写，通常翻译为“Python增强提案”。
每个PEP都是一份为Python社区提供的指导Python往更好的方向发展的技术文档，其中的第8号增强提案（PEP 8）是针对Python语言编订的代码风格指南。

​尽管我们可以在保证语法没有问题的前提下随意书写Python代码，但是在实际开发中，采用一致的风格书写出可读性强的代码是每个专业的程序员应该做到的事情，
也是每个公司的编程规范中会提出的要求，这些在多人协作开发一个项目（团队开发）的时候显得尤为重要。

我们可以从Python官方网站的PEP 8链接中找到该文档https://peps.python.org/pep-0008/

这套编码规范要求有很多，没个1-2年的代码功底，你根本记不住。

举个例子

先看一个不好的示范

# Wrong:
from time import time,strftime

def long_function_name(
        var_one,var_two,var_three,var_four):
    print(var_one)
    print(var_two)
    print(time())
    return "hello"

# 调用函数
foo = long_function_name(var_one="a",var_two="b",var_three="c",var_four="d")
print(foo)

上面的代码虽然运行没有问题，但是在编辑器里面阅读会让人分分钟想骂娘

写的代码不用桨，全靠浪~~~

快捷键实现

可以用快捷键ctr+alt+L快速格式化代码，pycharm会按pep8标准给你美化
还有一种方法，安装autopep8插件，继续往下看

Pycharm 安装autopep8

如果我们想写出没有浪的代码，我们也不需要用桨，用 pycharm 的插件 autopep8 即可实现一键实现。

先pip安装autopep8

pip install autopep8

安装成功后开始在pycharm配置autopep8
依次点击file–>settings–>tools–>external tools–>点击绿色的加号添加工具弹出以下界面：
name和description可以自己随便写

找到安装的autopep8所在位置，在Script目录下
如果用的虚拟环境，那么在venv/Script目录下

Tool setting三个参数
Progarm: D:\\...\\venv\\Scripts\\autopep8.exe填写autopep8.exe的绝对地址
Arguments: --in-place --aggressive $FilePath$
Working directory: $ProjectFileDir$

自动调整pep8格式

上面的步骤安装完成后，回到 pycharm 的代码区域
右键-External Tools- autopep8

也可以在顶部Tools 中找到

点击后代码会自动调整为pep8规范

当然这个也不是100%的给你全部调整，它会调整一些基本的格式，比如缩进四个空格，函数前面空2行，变量左右两边给空格等一些基础的。
其它的不能调整的需要自己手工再调整下。

让代码更完美

pep8 让你的代码符合编码规范， 如果想写到完美，还需要进一步调整

完美看到右侧会有一些不同颜色的横线，这其实就是一些警告，需要自己再进一步调整，去掉多余代码，减少重复代码

当我们看到右侧没有各种颜色的横线，并且右上角有个绿色的√，那么恭喜你，你的代码是漂亮干净并且完美的！