参考链接

在之前《使代码整洁的几种规范》文章中，介绍了比较常用的变量、函数等定义方法，本文专门针对 python 的代码风格进行介绍，主要用到两个超牛的工具 pylink 和 black，可以对代码风格进行规范检测和自动优化。

python 界被广泛认同的代码风格是 PEP8，这种规则对行长度、缩进、多行表达式、变量命名等内容进行了统一约定，但要注意的是，PEP8 中有一些规范是为了方便阅读，而有一些规范实实在在地影响着代码的性能、容错率或重构难度，因此要合理利用，不要盲目使用。具体的规范可参考《python常见的PEP8规范》，这里不做详细介绍，着重讲代码自动化检测和优化工具。

1 自动检测工具Pylint

Pylint 是一个检查违反 PEP8 规范和常见错误的库，它会自动查找不符合代码风格标准和有潜在问题的代码，并在控制台输出代码中违反规范和出现问题的相关信息。

1.安装与使用

与python的其他库一样，直接 pip install pylint 即可完成安装，另外 anaconda 自带pylint，所以如果安装过 anaconda 不必再单独安装此库。pylint的使用也非常简单，最基本的用法直接在控制台输入 pylint 路径/模块名即可对相关模块的代码风格规范进行检查，检查结果会在控制台输出。建议结合 pylint --help 的提示进行学习和检索。介绍完 pylint 的基本情况，我们来结合一个实例进行详细说明。

2).实例演示说明

这里我找了自己刚学 python 时写的一段代码 test.py 进行测试:

import pandas as pddata = []
char_replace_dict = {':':'\t', '（':'(', '）':')', '，':','}with open('xmq_survey.txt', 'r', encoding = 'utf-8') as file:for line in file.readlines():for key, value in char_replace_dict.items():line = line.replace(key, value)#原来这个是深度引用#这条代码比自己写的简介的多，也更pythondata.append(line)with open('survey.txt', 'w', encoding = 'utf-8') as file:for line in data:file.write(line)raw_data = pd.read_table('survey.txt', delimiter = '\t', header = None) #查看read_table函数的用法
raw_data.columns = ['Name', 'Raw Info']
raw_data.count()
print('successful')

乍一看好像没什么大问题，但是经过 pylint 检查后（pylint test.py）却给出了一堆问题提示(下图)，我们来看检查结果，每行以大写字母+冒号开头的信息都是一处反馈提示。

其中开头的大写字母表示错误类型(主要有C\R\W\E\F几类);以逗号间隔的两个数字表示发现问题的位置(行和列);其后是对问题的具体描述，括号里的内容称为message id，可以简单理解为错误类型的详细分类，通过 pylint --help-msg=<msg-id> 指令可以查看这个问题的的详细信息。

C——违反代码风格标准;
R——代码结构较差;
W——关于细节的警告;
E——代码中存在错误;
F——导致Pylint无法继续运行的错误。

根据输出信息进行对应的修改，但还是要强调一下，PEP8 不是百分百需要遵守的，当遵循 PEP8使自己代码的可读性变差、与自己代码风格不一致的时候，还是要遵循自己的判断。这种情况下，pylint 也提供了一种操作，可以手动屏蔽某些问题提示，以刚才的代码为例，剩下的几个问题主要是因为使用了 Tab 键、变量命名不规范、缺少文档说明造成的，我们可以使用 pylint --disable=mixex-indentation,invalid-name,missing-docstring 模块名称命令对相关规范进行屏蔽重新检测，发现问题提示全部消除，评分也提升到了10分。

一段20行的代码就检测到如此之多的问题提示，虽然手动修改代码有助于对 PEP 8规范的学习，但当项目文件比较多、脚本代码很长的时候，实在是一个不小的工作量，因此就出现了能够自动优化代码风格的工具。

2 自动优化工具black

在众多代码格式化工具中，Black 算是比较新的一个，它最大的特点是可配置项比较少，个人认为这对于新手来说是件好事，因为我们不必过多考虑如何设置 Black，让 Black 自己做决定就好。

源码路径：https://github.com/psf/black

1).安装与使用

与pylint类似，直接 pip install black 即可完成该模块的安装，不过black依赖于Python 3.6+，但它仍然可以格式化Python2的代码。在使用方面black默认读取指定python文件并对其进行代码规范格式化，然后输出到原文件。

2).实例演示说明

这里我们仍然使用 pylint 部分的代码进行演示。通过上面的操作我们知道，对这段代码直接使用pylint 进行测试会输出很多问题提示，并给出一个评分 0.67。现在我们首先使用 black 对其进行格式化，得到以下代码：

import pandas as pddata = []
char_replace_dict = {":": "\t", "（": "(", "）": ")", "，": ","}with open("xmq_survey.txt", "r", encoding="utf-8") as file:for line in file.readlines():for key, value in char_replace_dict.items():line = line.replace(key, value)  # 原来这个是深度引用# 这条代码比自己写的简介的多，也更pythondata.append(line)with open("survey.txt", "w", encoding="utf-8") as file:for line in data:file.write(line)raw_data = pd.read_table("survey.txt", delimiter="\t", header=None)  # 查看read_table函数的用法
raw_data.columns = ["Name", "Raw Info"]
raw_data.count()
print("successful")

可能看起来修改前后的代码差异并不十分明显，实质上black已经对代码中参数赋值 = 两端的空格、注释的格式、制表符等进行了替换和修改，我们使用pylint来进行验证，执行 pylint 模块名称命令，得到如下结果:

可以看到，相对于最初的文件，评分从 0.67 分提高到 7.3 分，输出的问题提示少了很多，剩余的问题主要是缺少说明文档、变量命名不规范，black 对于提高我们代码规范性价比也是非常高的。

如果不想 black 直接对原文件进行修改，而是想看看它对代码中的哪些地方进行了改动的话，可以使用--diff参数，执行 black --diff 文件名称，black会将相关信息输出到控制台（下图，其中-表示源代码，+表示建议修改后的代码），而不会对原文件进行修改。

总之，black真的是一个非常好用的库，尤其对于新手来说，可以很方便地规范自己的代码风格。

可以使用 help 指令查看使用方法

Usage: black [OPTIONS] [SRC]...

The uncompromising code formatter.

Options:
-c, --code TEXT Format the code passed in as a string.
-l, --line-length INTEGER How many characters per line to allow.
[default: 88]

-t, --target-version [py27|py33|py34|py35|py36|py37|py38]
Python versions that should be supported by
Black's output. [default: per-file auto-
detection]

--pyi Format all input files like typing stubs
regardless of file extension (useful when
piping source on standard input).

-S, --skip-string-normalization
Don't normalize string quotes or prefixes.
--check Don't write the files back, just return the
status. Return code 0 means nothing would
change. Return code 1 means some files
would be reformatted. Return code 123 means
there was an internal error.

--diff Don't write the files back, just output a
diff for each file on stdout.

--color / --no-color Show colored diff. Only applies when
`--diff` is given.

--fast / --safe If --fast given, skip temporary sanity
checks. [default: --safe]

--include TEXT A regular expression that matches files and
directories that should be included on
recursive searches. An empty value means
all files are included regardless of the
name. Use forward slashes for directories
on all platforms (Windows, too). Exclusions
are calculated first, inclusions later.
[default: \.pyi?$]

--exclude TEXT A regular expression that matches files and
directories that should be excluded on
recursive searches. An empty value means no
paths are excluded. Use forward slashes for
directories on all platforms (Windows, too).
Exclusions are calculated first, inclusions
later. [default: /(\.direnv|\.eggs|\.git|\.
hg|\.mypy_cache|\.nox|\.tox|\.venv|\.svn|_bu
ild|buck-out|build|dist)/]

--force-exclude TEXT Like --exclude, but files and directories
matching this regex will be excluded even
when they are passed explicitly as arguments

-q, --quiet Don't emit non-error messages to stderr.
Errors are still emitted; silence those with
2>/dev/null.

-v, --verbose Also emit messages to stderr about files
that were not changed or were ignored due to
--exclude=.

--version Show the version and exit.
--config FILE Read configuration from FILE path.
-h, --help Show this message and exit.

Python之代码规范管理工具(pylint、black)相关推荐

python开发软件的实例-由Python编写的MySQL管理工具代码实例
本文实例为大家分享了由Python编写的MySQL管理工具的具体代码,供大家参考,具体内容如下 import pymysql import pandas as pd from tkinter impo ...
代码片段管理工具_VS代码片段：提高编码效率的最强大工具
代码片段管理工具 by Sam Williams 通过山姆·威廉姆斯 VS代码片段:提高编码效率的最强大工具 (VS Code snippets: the most powerful tool to ...
Python简单主机批量管理工具
Python简单主机批量管理工具一.程序介绍需求: 简单主机批量管理工具需求:1.主机分组2.主机信息使用配置文件3.可批量执行命令.发送文件,结果实时返回4.主机用户名密码.端口可以不同5.执行 ...
Python：代码规范和命名规范
Python:代码规范和命名规范所有命名规范都要准守这三条: 1.命名只能以字母或者_下划线开头: 2.名字不能包含空格: 3.名字不能与关键字重合.不能将字符l(小写字母l),'O''o'(大小写 ...
python卸载_Python包管理工具pip - amanlikethis
一.pip概述包 python包,可以使我们利用网络上现成的代码库资源,解决程序中某一方面的问题,类似于C语言的各种库. PyPi(Python Package Index ,包索引) 是 Py ...
swift/dart代码规范检查工具介绍
swift/dart代码规范检查工具介绍简介: 本篇主要介绍swift和dart代码规范检查工具,以及他们的工作原理,操作过程,代码规范规则. 1 swift代码检查工具-swiftlint 1.1 ...
pip Python 包安装和管理工具
pip 是一个 Python 包安装与管理工具. 从PyPI安装软件包: $ pip install SomePackage [...] Successfully installed SomePack ...
百度工程师手把手教你实现代码规范检测工具
01 引言代码规范是软件开发领域经久不衰的话题.在前端领域中,说到代码规范,我们会很容易想到检查代码缩进.尾逗号以及分号等等,除此之外,代码规范还包括了针对特殊场景定制化的检查.JavaScript ...
代码规范检查工具+代码规范生成工具
代码规范检查工具: 1. arc lint arc diff时会自动执行arc lint,arc lint会根据配置文件(.arclint)进行代码规范检查,并且只检查最新的提交:需要在每个git仓库 ...

Python之代码规范管理工具(pylint、black)

1 自动检测工具Pylint

2 自动优化工具black

1).安装与使用

2).实例演示说明

Python之代码规范管理工具(pylint、black)相关推荐

最新文章

热门文章