Python 代码写得丑怎么办,试试这几款神器

本文推荐了几款工具,如Jupyternotebook的Codeprettify插件、PyCharm的autopep8和pylint、Sublime Text的autopep8插件,帮助程序员轻松遵循PEP8规范,自动美化Python代码,提升代码可读性和规范性。

作者 | 黄海广

来源 | https://zhuanlan.zhihu.com/p/59763076

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

01 Jupyter notebook

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

安装插件

  • 执行以下命令安装插件 Nbextensions


1pip install jupyter_contrib_nbextensions

无报错再执行:

1jupyter contrib nbextension install --user

  • 选取 Code prettify 模块

备注:需要安装 yapf 模块

1pip install yapf

640?wx_fmt=jpeg
img
640?wx_fmt=jpeg
img

原始不规范代码:

640?wx_fmt=jpeg
img

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

640?wx_fmt=jpeg
img

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

640?wx_fmt=png

02 Pycharm

PyCharm 集成 pylint

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

  • Pylint 安装

1pip install pylint


  • PyCharm 设置

文件(file)-设置(settings)-外部工具(external-tools)-添加,其中:

program:

是 python 安装路径下的 Scripts 路径,我的是(建议搜索 pylint.exe 找到路径)

C:\ProgramData\Anaconda3\Scripts\pylint.exe

Arguments:(最后必须以$FilePath$结尾)

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

working directory:(必须是这个)

1$FileDir$

output filters:

1$FILE_PATH$:$LINE$:

具体配置如图:

640?wx_fmt=png

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

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

autopep8

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

  • autopep8 安装

1pip install autopep8


  • autopep8 配置

文件(file)-设置(settings)-外部工具(external-tools)-添加,其中:

Name:(起名可随意)

autopep8

Program: autopep8

Arguments:

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

Working directory:

1$ProjectFileDir$

Output filters:

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

具体配置如图:

640?wx_fmt=jpeg
img

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

  • 使用效果如下:

原始不规范代码:

640?wx_fmt=png

使用工具后:

640?wx_fmt=jpeg
img

03 sublime text

安装 autopep8 插件后:

快捷键 ctrl+shift+8,即可规范 python 代码。

04 变量命名

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

工具网址:https://unbug.github.io/codelf/

GitHub 链接:https://github.com/unbug/codelf

640?wx_fmt=jpeg
img

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

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

  • 点击「Search」就是基于当前命名搜索其它相关的命名。

  • 点击「Repo」就是链接到使用该命名的代码所在的资源库。

  • 点击「Copy」是复制该命名。

  • 点击「Codes」可以查看使用命名的示例代码。

以上推荐的工具有助于你写出漂亮的代码。



/今日留言主题/

你平常有注意代码规范么,常用什么操作/工具实现?

(留言格式:Dayxx:blahblah)

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值