千锋教育-做有情怀、有良心、有品质的职业教育机构

Pylint让Python代码保持一致

来源:千锋教育
发布时间:2023-11-06 00:53:56
分享

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

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

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

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

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

配置Pylint

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

[MESSAGESCONTROL]

disable=all

[MESSAGESCONTROL]

disable=all

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

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

$pylint

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

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

enable=,

...

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

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

[DESIGN]

max-args=7

max-locals=15

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

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

[SIMILARITIES]

min-similarity-lines=3

Pylint使代码评审变得简单

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

以上内容为大家介绍了Pylint让Python代码保持一致,希望对大家有所帮助,如果想要了解更多Python相关知识,请关注IT培训机构:千锋教育。https://www.mobiletrain.org/

声明:本站部分稿件版权来源于网络,如有侵犯版权,请及时联系我们。

相关推荐

  • Python字符串连接 字符串是Python中常用的数据类型,在开发过程中可以对字符创进行截取并与其他字符创进行连接。下面小编整理了5种方法完成Python字符创的连接!加号如果有其他编程语言开发经验的人,肯定知道很多语言里
  • 如何把awk脚本移植到Python 将一个awk脚本移植到Python主要在于代码风格而不是转译。脚本是解决问题的有效方法,而awk是编写脚本的出色语言。它特别擅长于简单的文本处理,它可以带你完成配置文件的某些复杂重写或目录中文件名的重
  • 使用Python删除排序数组中的重复项 问题描述:给定一个排序数组,你需要在原地删除重复出现的元素,使得每个元素只出现一次,返回移除后数组的新长度。不要使用额外的数组空间,你必须在原地修改输入数组并在使用O(1)额外空间的条件下完成。示例示
  • 如何迈出Python学习第一步 出于怀旧的缘故,我想分享我两年前的第一个Python程序。我最初学习Python,只是作为一名航空航天工程专业的学生想要逃避学习Spreadsheets(电子表格制作软件),而我也不知道怎么就选择了P
  • 了解Python语言中的时间处理 Python语言对于时间的处理继承了C语言的传统,时间值是以秒为单位的浮点数,记录的是从1970年1月1日零点到现在的秒数,这个秒数可以转换成我们日常可阅读形式的日期和时间:我们下面首先来看一下pyt
  • Web开发人员推荐的Python框架 您可以在没有框架的情况下创建出色的应用程序。如果您正在寻找一个Python框架,那么请查看以下5个好的选项列表!任何一个有价值的技术人员都会同意,通过允许更快的自定义和更专注于逻辑,框架可以让他们的生