Linter(flake8、pylint、自定义CLI)用于查找已弃用函数的使用。
项目描述
flake8-warnings
Python linter,它会警告您使用已弃用的模块、类和函数。它提供命令行界面以及flake8和pylint插件。
用法
安装
python3 -m pip install flake8-warnings
现在,您可以使用以下方式之一使用它
- 直接从CLI:
python3 -m flake8_warnings ./my_project/
- 作为flake8插件。只需运行
flake8 ./my_project/
,它将自动检测插件。 - 作为pylint插件。对于pylint,必须显式指定插件:
pylint --load-plugins=flake8_warnings ./my_project/
。
它是如何工作的
它分析所有导入的模块、类和函数,并检测以下内容
- warnings.warn 函数调用。
- 如deprecated或deprecation之类的弃用装饰器。
- 文档字符串中的弃用消息。
- 由PEP 594弃用的stdlib模块。
错误代码
该工具为每个警告类别提供不同的错误代码。
- 01: 警告
- 02: UserWarning
- 03: DeprecationWarning
- 04: SyntaxWarning
- 05: RuntimeWarning
- 06: FutureWarning
- 07: PendingDeprecationWarning
- 08: ImportWarning
- 09: UnicodeWarning
- 10: BytesWarning
- 11: ResourceWarning
它们在不同代码检查器中的使用方法如下。
- 在flake8中,代码前缀为
WS0
,因此DeprecationWarning
将被报告为WS003
。 - 在pylint中,前缀为
W99
,因此DeprecationWarning
将被报告为W9903
。"消息符号"是警告类别。所以,如果你想忽略关于DeprecationWarning
的错误,请在此行添加# pylint: disable=DeprecationWarning
。 - 如果你使用命令行界面,警告类别将直接显示,没有任何晦涩的代码。
在所有情况下,错误信息是检测到的警告消息。
许可证
- flake8-wranings遵循MIT许可证。在实践中,我不在乎你将如何使用它。我做这个项目是因为它很有趣,而不是因为我想要出名或类似的事情。
- astroid是flake8-warnings的直接运行时依赖,它遵循LGPL-2.1许可证。它允许商业和私人使用、分发等,不要与GPL混淆。但是,如果你的法律部门仍然感到不安,只需不要将flake8-warnings作为生产依赖项(你为什么要这样做?),仅在开发和测试环境中使用它。
项目详情
下载文件
下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。
源代码分布
flake8_warnings-0.4.1.tar.gz (11.9 kB 查看散列)
构建分布
flake8_warnings-0.4.1-py3-none-any.whl (11.0 kB 查看散列)