flake8-functions

flake8的扩展，用于报告与函数相关的问题。

我们认为，对于由多个人组成的团队来说，代码的可读性非常重要。我们遇到的一个问题是，函数长度超过两个屏幕。

验证器会检查

• CFQ001 - 函数长度（默认最大长度为100）
• CFQ002 - 函数参数数量（默认最大参数数量为6）
• CFQ003 - 函数不是纯净的。
• CFQ004 - 函数返回值数量（默认最大返回值数量为3）

安装

pip install flake8-functions

示例

def some_long_function(
    first_parameter: int,
    second_parameter: int,
    third_parameter: int,
):
    first_parameter = (
        first_parameter +
        second_parameter +
        third_parameter
    )

    first_parameter = (
        first_parameter +
        second_parameter +
        third_parameter
    )

    first_parameter = (
        first_parameter +
        second_parameter +
        third_parameter
    )

    first_parameter = (
        first_parameter +
        second_parameter +
        third_parameter
    )

    return first_parameter

用法

$ flake8 --max-function-length=20 test.py
test.py:1:0: CFQ001 "some_long_function" function has length 25
that exceeds max allowed length 20

错误代码

代码先决条件

1. Python 3.7+;

贡献

我们非常欢迎您为我们的项目做出贡献。这很简单

1. 创建一个问题，说明您发现的错误或您有的建议。等待维护者的批准。
2. 创建一个拉取请求。确保所有检查都是绿色的。
3. 如果有任何审查评论，请修复。
4. 做得好。

以下是一些有用的提示

• 您可以使用 make check 运行所有检查和测试。请在 TravisCI 前这样做。
• 我们使用 BestDoctor python styleguide。
• 我们尊重 Django CoC。温和，不做无意义的事情。