Python 代码规范神器及变量命名

以下内容摘自于知乎黄海广博士，链接如下：Python代码写得丑怎么办？推荐几个神器拯救你，侵删！

涉及编辑器：Jupyter notebook、Pycharm、sublime text
亲测可用！

Python编程语言需要遵循PEP8规范，但是初学者往往记不住这个规范，代码写得比较丑。本文推荐几个神器来拯救奇丑无边的python代码。

一、Jupyter notebook 篇

Jupyter notebook的代码要想写得规范，推荐用Code prettify插件。

1、安装插件

首先插件Nbextensions
执行以下命令

pip install jupyter_contrib_nbextensions

无报错再执行：

jupyter contrib nbextension install --user

2、选取Code prettify模块
备注：需要安装 yapf模块

pip install yapf

3、使用如下：

原始不规范代码：

使用工具栏最右侧的按钮：

使用后代码立刻变规范了：

二、Pycharm篇

1、 PyCharm集成pylint

pylint是代码检查工具，不能自动修改代码

1.1 Pylint 安装

pip install pylint

1.2 PyCharm 设置
File—Settings—Tools—External Tools—+，其中：

program：

是python安装路径下的Scripts路径，我的是（建议搜索pylint.exe找到路径）
D:\software\Anaconda3\Scripts\pylint.exe

Arguments:

--reports=n --disable=C0103 $FilePath$

working directory：

$FileDir$

output filters：

$FILE_PATH$:$LINE$:

具体配置如图：

1.3 使用如下：

配置完毕，选择一个Python程序，右键点击，快捷菜单中会有“Extensions Tools -> Pylint”，点击运行即可。输出结果在执行程序结果的窗口（IDE下半部分）。

如果看到返回值为0，说明程序没问题了。

2、 autopep8

autopep8是一款将python代码自动排版为PEP8风格的工具

2.1 autopep8安装

pip install autopep8

2.2 autopep8配置

File—Settings—Tools—External Tools—+，其中：

Name:

Autopep8

Program:

 autopep8

Arguments:

--in-place --aggressive --aggressive $FilePath$

Working directory:

$ProjectFileDir$

Output filters:

$FILE_PATH$\:$LINE$\:$COLUMN$\:.*

具体配置如图：

2.3 使用如下

将鼠标放在该文件的编辑器中→右键→External Tools→点击Autopep8。这样你的代码就符合pep8的风格了。

使用效果如下：
原始不规范代码：

使用工具后：

三、sublime text篇

1、安装 autopep8

略

2、autopep8规范代码

很简单，用快捷键 ctrl+shift+8，即可规范python代码。

四、变量命名篇

在平时工作中，好多程序员都在为变量的命名纠结不已，随便命名怕以后看不懂，想好好命名可是自己的英文水平又不好，在这个命名上可能需要花费大量的时间，会耽误到开发的效率，今天推荐一个神器，这个神器可以摆脱变量命名纠结！

工具网址
网站地址：https://unbug.github.io/codelf/
GitHub 链接：https://github/unbug/codelf

输入要起名的变量，可以是中文或者英文。

点击搜索后，网站会给出变量名的翻译，下方给出变量的起名建议，大家可以copy下变量名，也可以看下用了这个变量的源代码，而且可以选择开发语言种类。

点击「Search」就是基于当前命名搜索其它相关的命名。
点击「Repo」就是链接到使用该命名的代码所在的资源库。
点击「Copy」是复制该命名。
点击「Codes」可以查看使用命名的示例代码。