# PyCharm中配置PEP8

请根据笔记的写作日期,选择性阅读。

作者: 放羊的大少爷
Home: joynoting.com
写作日期: 2018-08-16
系统: Mac
软件版本:
python@3.6.5
pycharm@2018.2.1
black@18.6b4
参考:
black
autopep8


# 一、什么是PEP8

关于这个问题,不再赘述,请参考官方文档 PEP 8 -- Style Guide for Python Code


# 二、pycharm中配置PEP8

# 2.1 查看自带的PEP8检测规则

PyCharm 自带 PEP8 代码风格检测,点击右下角的“小医生”图标,点击 Configure inspections

pycharm-pep8-1

打开如图所示的窗体:

pycharm-pep8-2

在搜索栏中输入“pep8”,就能看到相关的配置项,可以在选项的右侧勾选表示启用。

pycharm-pep8-3

# 2.2 Python code formatter

这里主要介绍三款自动将代码格式化为 PEP8 风格的工具:

  • black(推荐)
  • yapf(google爸爸出品)
  • autopep8

两款工具在文章的开头都有提供链接,或者自行到pypi上也可以搜索到,简单介绍一下推荐 black 的理由:

  • black 格式化效果略好
  • black 更新快,目前已支持3.7和3.8dev

# 2.2.1 black

下面以 black 为例,开始配置,autopep8 的配置与 black 一致:

  1. 安装black

    pip install black
    
    1
  2. 在pycharm中配置black

    菜单栏点击Pycharm ▸ Preferences ▸ Tools ▸ External Tools,打开如下图的界面,点击左下角的“+”号,打开配置界面

pycharm-tool-1 pycharm-tool-2

具体配置如下:

- Name:black(自己随意取名)
- Tools settings:
    - Programs:black
    - Parameters:\$FilePath$
    - Working directory:\$ProjectFileDir$
1
2
3
4
5

black

# 2.2.2 yapf

具体配置如下:

- Name:yapf(自己随意取名)
- Tools settings:
    - Programs:yapf
    - Parameters:-i \$FilePath$
    - Working directory:\$ProjectFileDir$
1
2
3
4
5

yapf


# 三、使用

使用 PyCharm 打开一个不符合 PEP8 风格的py文件,将鼠标放在该文件的编辑器中,右键 ▸ External Tools ▸ black,等待执行完成,你的代码就被格式化为PEP8的风格了,如下图:

pycharm-tool-3

# 四、PyCharm优化代码

后来才发现,其实 PyCharm 自带代码格式化的工具,Mac 下的快捷键为 Command+Option+L,Win下的快捷键为Ctrl+Alt+L,一键PEP8并且优化代码,需要注意的是它会删除多余的代码。

上次更新时间: 2020/3/13 下午12:44:00