跳转到主要内容

Flake8 __author__ 检查器

项目描述

PyPI Version Python Versions

flake8-author 是一个 Flake8 扩展,用于检查Python模块中模块级别的 __author__ 属性。

关于 __author__ 的使用没有官方标准。它主要根据惯例使用。Guido 在 2001 年说过这样的话

另一个令人不舒服的地方是,这种元数据变量没有任何标准。我们有 __version__,我相信我们曾经同意这个标准(大约在 1994 年左右 :-)。但是 __author__? __credits__?接下来是什么 – __cute_signoff__?

因此,此扩展可以配置为显式要求或禁止 __author__ 属性。默认情况下,__author__ 被视为可选的。

如果允许 __author__ 属性,其值也可以使用可配置的正则表达式模式进行验证。

__author__ 属性通常分配给字符串,但可以使用字符串的列表(或元组或集合)列出多个作者。

安装

使用 pip 从 PyPI 安装

$ pip install flake8-author

该插件将由 flake8 自动激活。您可以通过检查 flake8 --version 字符串来验证它是否已加载。

$ flake8 --version
6.1.0 (author: 2.1.0, ...) CPython 3.11.5 on Darwin

错误代码

此插件添加了三个新的 错误代码(使用 A40 前缀)

  • A400:模块级别需要 __author__ 属性

  • A401:不允许 __author__ 属性

  • A402__author__ 属性值不符合 模式

配置

配置值指定在您的 配置文件[flake8] 部分,或作为命令行参数(例如 --author-attribute=required)。

  • author-attribute: “可选的”,“必需的”,“禁止的”(默认:可选的)

  • author-pattern__author__ 验证 正则表达式 模式(默认: ''

版权(c)2016 Jon Parise

特此授予任何获得此软件及其相关文档副本(“软件”)的人,无限制地处理软件的权利,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本,并允许向软件提供者提供软件的人这么做,前提是遵守以下条件

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

软件按“原样”提供,不提供任何形式的保证,无论是明示的还是暗示的,包括但不限于适销性、适用于特定目的和不侵犯知识产权的保证。在任何情况下,作者或版权所有者均不对任何索赔、损害或其他责任承担责任,无论这些责任是因合同、侵权或其他方式引起的,与软件或软件的使用或其他交易有关。

变更

2.1.0 (2023-09-17)

  • 取消对 Python 3.7 的支持,并添加 3.11。

  • 可以通过将 __author__ 属性设置为字符串列表(或元组或集合)来列出多个作者。每个条目都将与配置的模式进行验证。

2.0.0 (2021-12-30)

  • 取消对 Python 2.7 和 3.6 的支持,并添加 3.10。

  • 取消对 flake8 2.x 版本的支持。

1.2.0 (2020-10-12)

  • 取消对 Python 3.5 的支持,并添加版本 3.8 和 3.9。

  • 小的文档改进。

1.1.4 (2017-07-29)

  • 小的代码和打包清理。

1.1.3 (2017-07-28)

  • 取消对 flake8 的 setup_requires 依赖。

1.1.2 (2017-01-12)

  • 仅当实际配置了模式时才应用作者正则表达式模式检查。

1.1.1 (2016-11-06)

  • 修复了 flake8 3.0+ 的配置文件解析。

1.1.0 (2016-08-15)

  • 支持 flake8 3.0.0(开发所需)

1.0.2 (2016-06-02)

  • 支持 flake8 版本 2.6.0

  • 取消对 pytest 的测试依赖(仅开发)

1.0.1 (2016-05-11)

  • 修复了基于配置选项的解析器验证。

1.0.0 (2016-04-30)

  • 初始发布

项目详情


下载文件

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

源代码分发

flake8-author-2.1.0.tar.gz (6.3 kB 查看哈希值)

上传时间 源代码

构建分发

flake8_author-2.1.0-py3-none-any.whl (6.1 kB 查看哈希值)

上传时间 Python 3

由以下机构支持