跳转到主要内容

检查PEP-8命名约定,flake8插件

项目描述

请将您的代码与 PEP 8 命名约定进行比对。

本模块为 Python 代码检查器 flake8 提供了一个插件。

(它替换了用于 flint 检查器的插件 flint-naming。)

安装

您可以使用以下命令安装、升级或卸载 pep8-naming

$ pip install pep8-naming
$ pip install --upgrade pep8-naming
$ pip uninstall pep8-naming

Flake8 插件

当同时安装了 flake8pep8-naming 时,插件将在 flake8 中可用

$ flake8 --version
4.0.1 (mccabe: 0.6.1, naming: 0.13.0, pycodestyle: 2.8.0, pyflakes: 2.4.0) CPython 3.8.10 on Linux

默认情况下,插件是启用的。

错误代码

以下错误代码会被发出

代码

示例信息

N801

类名应使用 CapWords 约定(类名

N802

函数名应小写(函数名

N803

参数名应小写(函数参数

N804

类方法的第一个参数应命名为‘cls’(函数参数

N805

方法的第一个参数应命名为‘self’(函数参数

N806

函数中的变量应小写

N807

函数名不应以‘__’开头和结尾

N811

作为非常量导入的常量(常量

N812

作为非小写导入的小写

N813

作为小写导入的驼峰式

N814

作为常量导入的驼峰式(与 N817 的选择性执行不同)

N815

类作用域中的混合大小写变量(常量方法名

N816

全局作用域中的混合大小写变量(常量

N817

作为缩写导入的驼峰式(与 N814 的选择性执行不同)

N818

异常名中的错误后缀(异常

选项

添加以下 flake8 选项

--ignore-names

忽略特定名称或 glob 模式错误。

目前,此选项只能用于 N802、N803、N804、N805、N806、N815 和 N816 错误。

默认值:setUp,tearDown,setUpClass,tearDownClass,setUpModule,tearDownModule,asyncSetUp,asyncTearDown,setUpTestData,failureException,longMessage,maxDiff

--classmethod-decorators

pep8-naming 插件应考虑为类方法的装饰器列表。

用于防止假 N804 错误。

默认值:classmethod

--staticmethod-decorators

pep8-naming 插件应考虑为静态方法的装饰器列表。

用于防止假 N805 错误。

默认值:staticmethod

常见问题解答

如何配置 classmethod_decorators 以识别 SQLAlchemy 类方法?

classmethod_decorators =
    classmethod
    declared_attr
    expression
    comparator

项目详细信息


下载文件

下载您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分发

pep8-naming-0.14.1.tar.gz (16.5 kB 查看哈希值)

上传时间

构建分发

pep8_naming-0.14.1-py3-none-any.whl (8.9 kB 查看哈希值)

上传时间 Python 3

由以下支持