。

上一篇总结的pylint、pyproject-flake8、…本篇将总结实际项目开发中Python代码规范检查、自动编排的一些工具特点使用方法以及如何在Pycharm中集成这些工具如autoflake、yapf、black、isort、autopep8代码规范和自动编排工具。

上一篇总结的pylint、pyproject-flake8、pyflakes、flake8、mypy代码规范扫描工具参考

https://blog.csdn.net/zhouruifu2015/article/details/129876922https://blog.csdn.net/zhouruifu2015/article/details/129876922

autoflake

代码中删除未使用的导入和变量以及无用的pass语句以此精简你的代码。

默认情况下autoflake仅删除标准库中未使用的模块的导入其他模块可能有副作用所以禁止了自动删除可以使用--imports

autoflake

--importsdjango,requests,urllib3

文件名

指定要删除未引用导入的模块--expand-star-imports

使用未定义名称扩展星号通配符导入仅在只有一颗星导入时触发文件如果文件中有

__all__

删除所有未使用的导入不仅仅是那些来自标准库--ignore-init-module-imports

__init__.py--remove-duplicate-keys

删除对象中的所有重复键--remove-unused-variables

noqa

由Google开发维护的格式化工具目的是让代码更漂亮它支持很多的自定义选项适合对自己的代码有特殊格式需求的场景

yapf并不支持对import进行排序所以需要使用isort工具。

安装配置

yapf有默认的查找格式化配置文件的策略可以使用参数--no-local-style禁用搜索查找策略的细节可以查看官方README。

pep8,

--style-help查看或者查看官方文档https://github.com/google/yapf#id11。

yapf

yapf命令行参数及格式化选项yapf命令行工具的参数并不是很多主要常用的有下面几个

-d,

其中--style最为常用用于指定格式化的标准和自定义选项。

可以是一些预设的选项包括

Python

Guideyapf用于Google开源项目的代码风格facebook格式化代码

yapf支持递归处理及其子目录使用-e

格式化代码之后再使用isort进行imports的排序当然也可以先排序imports

isort

检查代码是否符合规范可以将yapf的-i参数替换为-d如果存在不符合规范的内容则打印出来并且返回非0比如

yapf

如此便可以在自动化检查的时候通过判断返回值是否为0确定代码是否符合规范从而可以在自动化构建的pipeline中提前结束提示开发者重新格式化代码。

参考文档

https://github.com/google/yapf#usage

black

类似但限制较多没有太多的自定义选项。

这样的好处是不需要去决定使用怎么样的代码风格让Black来做决定就好。

可以在这里查阅

Black

Black配置选项很少避免因为配置选项太多反而导致格式规范不一致。

安装配置

https://en.wikipedia.org/wiki/Lint_(software)GitHub

psf/black:

这个库能将项目中导入的库按字母顺序排序并将其正确划分为不同部分例如标准库、第三方库、自建的库等。

这样提高了代码的可读性并且可以在导入的库较多的时候轻松找到各个库。

.isort.cfg

--force-sort-within-sections严格按照包名进行排序而不管是直接使用import还是使用from

...

执行后的效果可以看出isort并没有把引入但未使用的os做移除

Pycharm中执行转换

Optionshttps://pycqa.github.io/isort/docs/configuration/options.htmlProfileshttps://pycqa.github.io/isort/docs/configuration/profiles.htmlhttps://github.com/PyCQA/isorthttps://github.com/PyCQA/isort/wiki/isort-Pluginsautopep8

tool

是一个开源的命令行工具它能够将Python代码自动格式化为PEP8风格如重新缩进行、修复缩进、删除多余的空格并重构常见的比较错误例如布尔值和

None

Autopep8使用pycodestyle工具来决定代码中的哪部分需要被格式化这能够修复大部分pycodestyle工具中报告的排版问题。

安装配置

D:\env36_tornado\Scripts\autopep8.exe

Arguments

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

如果Arguments仅仅配置成

则发现有不符合规范的文件仅仅输出结果。

Arguments配置成

--in-place

--in-place类似于sed命令的-i选项如果不包含–in-place选项则会将autopep8格式化以后的代码直接输出到控制台。

可以使用这种方式检查autopep8的修改使用–in-place则会直接将结果保存到源文件中将不会有任何输出autopep8会直接修改源文件。

autopep8还存在--aggressive选项这会执行更多实质性地更改可以多次使用--aggressive以达到更佳的效果。

命令行中针对单个指定文件

Pycharm中执行格式化Pycharm编辑区域右击中选择autopep8

格式化后的效果库的排列顺序还是没有做排序以及引用但未使用的os库也没有去掉可以考虑使用isort再次进行整改。

autopep8对来对多个文件进行扫描和格式化。

可以使用以下命令格式

bash

directory_path_or_file_path指定目录路径或单个文件路径。

上述命令进入项目。

可以尝试在命令前加上sudo作为管理员身份运行命令或者将文件或目录权限更改为可读写权限。

参考文档

guide.https://github.com/hhatto/autopep8