脚本之家,脚本语言编程技术及教程分享平台!
分类导航

Python|VBS|Ruby|Lua|perl|VBA|Golang|PowerShell|Erlang|autoit|Dos|bat|

服务器之家 - 脚本之家 - Python - PyLint 的优点、缺点和危险

PyLint 的优点、缺点和危险

2022-10-18 18:22Linux中国Moshe Zadka] Python

PyLint 可以让你远离非常难找到的和复杂的缺陷。最差的情况下,它只可以节省测试运行的时间。最好的情况下,它可以帮你避免生产环境中复杂的错误。

PyLint 的优点、缺点和危险

充分利用 PyLint。

敲黑板:PyLint 实际上很好!

“PyLint 可以拯救你的生命”,这是一句夸张的描述,但没有你想象的那么夸张。PyLint 可以让你远离非常难找到的和复杂的缺陷。最差的情况下,它只可以节省测试运行的时间。最好的情况下,它可以帮你避免生产环境中复杂的错误。

优点

我不好意思说这种情况是多么普遍。测试的命名总是那么奇怪:没有人关心这个名称,而且通常也找不到一个自然的名称。例如以下代码:

def test_add_small():    # Math, am I right?    assert 1 + 1 == 3    def test_add_large():    assert 5 + 6 == 11    def test_add_small():    assert 1 + 10 == 11

测试生效:

collected 2 items                                                                         test.py .. 2 passed

但问题是:如果你覆盖了一个测试的名称,测试框架将愉快地跳过这个测试!

实际上,这些文件可能有数百行,而添加新测试的人可能并不知道所有的名称。除非有人仔细查看测试输出,否则一切看起来都很好。

最糟糕的是,被覆盖测试的添加被覆盖测试造成的破坏,以及连锁反应的问题可能要几天、几月甚至几年才能发现。

PyLint 会找到它

就像一个好朋友一样,PyLint 可以帮助你。

test.py:8:0: E0102: function already defined line 1     (function-redefined)

缺点

就像 90 年代的情景喜剧一样,你对 PyLint 了解的越多,问题就越多。以下是一个库存建模程序的常规代码:

"""Inventory abstractions"""import attrs@attrs.defineclass Laptop:    """A laptop"""    ident: str    cpu: str

但 PyLint 似乎有自己的观点(可能形成于 90 年代),并且不怕把它们作为事实陈述出来:

$ pylint laptop.py | sed -n '/^laptop/s/[^ ]*: //p'R0903: Too few public methods (0/2) (too-few-public-methods)

危险

有没有想过在一个数百万人使用的工具中加入自己未证实的观点?PyLint 每月有 1200 万次下载。

“如果太挑剔,人们会取消检查” — 这是 PyLint GitHub 的 6987 号议题,于 2022 年 7 月 3 号提出

对于添加一个可能有许多误报的测试,它的态度是 ... “”。

让它为你工作

PyLint 很好,但你需要小心地与它配合。为了让 PyLint 为你工作,以下是我推荐的三件事:

1、固定版本

固定你使用的 PyLint 版本,避免任何惊喜!

在你的 .toml 文件中定义:

[project.optional-dependencies]pylint = ["pylint"]

在代码中定义:

from unittest import mock

这与以下代码对应:

# noxfile.py...@nox.session(python=VERSIONS[-1])def refresh_deps(session):    """Refresh the requirements-*.txt files"""    session.install("pip-tools")    for deps in [..., "pylint"]:        session.run(            "pip-compile",            "--extra",            deps,            "pyproject.toml",            "--output-file",            f"requirements-{deps}.txt",        )

2、默认禁止

禁用所有检查,然后启用那些你认为误报比率高的。(不仅仅是漏报/误报的比率!)

# noxfile.py...@nox.session(python="3.10")def lint(session):    files = ["src/", "noxfile.py"]    session.install("-r", "requirements-pylint.txt")    session.install("-e", ".")    session.run(        "pylint",        "--disable=all",        *(f"--enable={checker}" for checker in checkers)        "src",    )

3、检查器

以下是我喜欢的检查器。加强项目的一致性,避免一些明显的错误。

checkers = [    "missing-class-docstring",    "missing-function-docstring",    "missing-module-docstring",    "function-redefined",]

使用 PyLint

你可以只使用 PyLint 好的部分。在 CI 中运行它以保持一致性,并使用常用检查器。

放弃不好的部分:默认禁止检查器。

避免危险的部分:固定版本以避免意外。

原文地址:https://linux.cn/article-15144-1.html

延伸 · 阅读

精彩推荐
  • PythonPython3.4解释器用法简单示例

    Python3.4解释器用法简单示例

    这篇文章主要介绍了Python3.4解释器用法,结合简单实例形式分析了Windows与Linux系统环境中Python3.4解释器的简单使用方法,需要的朋友可以参考下...

    流年醉影4122021-06-08
  • PythonPython 专题二 条件语句和循环语句的基础知识

    Python 专题二 条件语句和循环语句的基础知识

    本文主要介绍了Python条件语句和循环语句的基础知识。主要内容包括: 1.条件语句:包括单分支、双分支和多分支语句,if-elif-else;2.循环语句:while的使用及简...

    Eastmount5532020-09-24
  • PythonPython+pandas计算数据相关系数的实例

    Python+pandas计算数据相关系数的实例

    今天小编就为大家分享一篇Python+pandas计算数据相关系数的实例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...

    Python_小屋13982021-03-12
  • PythonPython 字符串换行的多种方式

    Python 字符串换行的多种方式

    本文通过四种方法给大家介绍了Python 字符串换行的方式,在文中最下面通过代码给大家介绍了python代码过长的换行方法,需要的朋友可以参考下...

    寒爵6012021-04-01
  • Python使用url_helper简化Python中Django框架的url配置教程

    使用url_helper简化Python中Django框架的url配置教程

    这篇文章主要介绍了使用url_helper简化Python中Django框架的url配置教程,需要的朋友可以参考下 ...

    Python教程网5632020-07-10
  • PythonPython 经典面试题 21 道【不可错过】

    Python 经典面试题 21 道【不可错过】

    这篇文章主要介绍了Python 经典面试题 21 道,在python面试过程中这21道是经常被问到了,感兴趣的朋友跟随小编一起看看吧...

    Python教程网4762021-04-04
  • PythonPython文件操作之二进制文件详解

    Python文件操作之二进制文件详解

    下面小编就为大家带来一篇使用Python文件操作之二进制文件。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧...

    Tester_Cheng5052022-01-12
  • Python利用Python如何批量更新服务器文件

    利用Python如何批量更新服务器文件

    这篇文章主要给大家介绍了关于利用Python如何批量更新服务器文件的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用python具有一定的参...

    YxYYxY4332021-03-23