Pylint:让你的Python代码保持一致

开发 后端
Pylint 是更高层级的 Python 样式强制程序。而 flake8 和 black 检查的是“本地”样式:换行位置、注释的格式、发现注释掉的代码或日志格式中的错误做法之类的问题。

[[280333]]

当你想要争论代码复杂性时,Pylint 是你的朋友。

Pylint 是更高层级的 Python 样式强制程序。而 flake8 和 black 检查的是“本地”样式:换行位置、注释的格式、发现注释掉的代码或日志格式中的错误做法之类的问题。

默认情况下,Pylint 非常激进。它将对每样东西都提供严厉的意见,从检查是否实际实现声明的接口到重构重复代码的可能性,这对新用户来说可能会很多。一种温和地将其引入项目或团队的方法是先关闭所有检查器,然后逐个启用检查器。如果你已经在使用 flake8、black 和 mypy,这尤其有用:Pylint 有相当多的检查器和它们在功能上重叠。

但是,Pylint 独有之处之一是能够强制执行更高级别的问题:例如,函数的行数或者类中方法的数量。

这些数字可能因项目而异,并且可能取决于开发团队的偏好。但是,一旦团队就参数达成一致,使用自动工具强制化这些参数非常有用。这是 Pylint 闪耀的地方。

配置 Pylint

要以空配置开始,请将 .pylintrc 设置为

  1. [MESSAGES CONTROL]
  2.  
  3. disable=all

这将禁用所有 Pylint 消息。由于其中许多是冗余的,这是有道理的。在 Pylint 中,message 是一种特定的警告。

你可以通过运行 pylint 来确认所有消息都已关闭:

  1. $ pylint <my package>

通常,向 pylint 命令行添加参数并不是一个好主意:配置 pylint 的位置是 .pylintrc。为了使它做一些有用的事,我们需要启用一些消息。

要启用消息,在 .pylintrc 中的 [MESSAGES CONTROL] 下添加

  1. enable=<message>,
  2. ...

对于看起来有用的“消息”(Pylint 称之为不同类型的警告)。我最喜欢的包括 too-many-linestoo-many-argumentstoo-many-branches。所有这些会限制模块或函数的复杂性,并且无需进行人工操作即可客观地进行代码复杂度测量。

检查器消息的来源:每条消息只属于一个检查器。许多最有用的消息都在设计检查器下。默认数字通常都不错,但要调整最大值也很简单:我们可以在 .pylintrc 中添加一个名为 DESIGN 的段。

  1. [DESIGN]
  2. max-args=7
  3. max-locals=15

另一个有用的消息来源是“重构”检查器。我已启用一些最喜欢的消息有 consider-using-dict-comprehensionstop-iteration-return(它会查找正确的停止迭代的方式是 return 而使用了 raise StopIteration 的迭代器)和 chained-comparison,它将建议使用如 1 <= x < 5,而不是不太明显的 1 <= x && 5 > 5 的语法。

最后是一个在性能方面消耗很大的检查器,但它非常有用,就是 similarities。它会查找不同部分代码之间的复制粘贴来强制执行“不要重复自己”(DRY 原则)。它只启用一条消息:duplicate-code。默认的 “最小相似行数” 设置为 4。可以使用 .pylintrc 将其设置为不同的值。

  1. [SIMILARITIES]
  2. min-similarity-lines=3

Pylint 使代码评审变得简单

如果你厌倦了需要指出一个类太复杂,或者两个不同的函数基本相同的代码评审,请将 Pylint 添加到你的持续集成配置中,并且只需要对项目复杂性准则的争论一次就行。 

责任编辑:庞桂玉 来源: Linux中国
相关推荐

2021-02-04 15:05:36

人工智能机器学习技术

2024-02-20 08:35:08

数据库缓存代码

2021-11-12 15:40:37

Windows 11操作系统微软

2022-09-22 07:27:49

IT/OT治理网络安全物联网安全

2022-06-30 05:26:41

网络安全业务

2021-03-29 12:45:24

微软Edge浏览器

2024-03-12 13:26:46

2020-09-11 08:59:02

网络安全业务连续性计勒索软件

2009-08-28 08:56:48

2022-07-11 09:18:24

SwiftLintSwift

2024-01-18 16:52:02

CISO企业• 网络安全

2022-12-14 08:23:30

2023-07-27 08:29:09

2021-01-25 07:54:25

Windows10操作系统Windows10X

2017-06-27 09:40:28

MYSQL数据备份

2021-02-04 06:30:26

Python编程语言

2024-01-17 08:18:18

2023-10-13 09:17:11

代码Java

2022-02-17 21:04:27

数据库MysqlRedis

2011-08-08 18:19:00

Windows7图标
点赞
收藏

51CTO技术栈公众号