Skip to main content

flake8-functions

Build Status PyPI version PyPI - Python Version

An extension for flake8 to report on issues with functions.

We believe code readability is very important for a team that consists of more than one person. One of the issues we've encountered is functions that are more that two screens long.

The validator checks for:

  • CFQ001 - function length (default max length is 100)
  • CFQ002 - function arguments number (default max arguments amount is 6)
  • CFQ003 - function is not pure.
  • CFQ004 - function returns number (default max returns amount is 3)

Installation

pip install flake8-functions

Example

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

Usage:

$ 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

Error codes

Error code Description
CFQ001 Function "some_function" has length %function_length% that exceeds max allowed length %max_length%
CFQ002 Function "some_function" has %args_amount% arguments that exceeds max allowed %max_args_amount%
CFQ003 Function "some_function" is not pure.
CFQ004 Function "some_function" has %returns_amount% returns that exceeds max allowed %max_returns_amount%

Code prerequisites

  1. Python 3.10+ (tested up to 3.14).

Contributing

We would love you to contribute to our project. It's simple:

  1. Create an issue with bug you found or proposal you have. Wait for approve from maintainer.
  2. Create a pull request. Make sure all checks are green.
  3. Fix review comments if any.
  4. Be awesome.

Here are useful tips:

  • The project uses uv. Run make install once, then make check to run all checks and tests before CI does.
  • Optionally enable the git hooks with uv run pre-commit install.
  • We use BestDoctor python styleguide.
  • We respect Django CoC. Make soft, not bullshit.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flake8_functions-0.1.0.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flake8_functions-0.1.0-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

Details for the file flake8_functions-0.1.0.tar.gz.

File metadata

  • Download URL: flake8_functions-0.1.0.tar.gz
  • Upload date:
  • Size: 9.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for flake8_functions-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d4047bdf06c091b1156680505012d5c1139c9e52b2fefab7d5b18eea21e05f86
MD5 cac51719c61425ddda4e0a058cfc9ddf
BLAKE2b-256 45dd7dce9a49c73a3292b18b4da2ddc8578379d653d26895c50bb84575858d33

See more details on using hashes here.

File details

Details for the file flake8_functions-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for flake8_functions-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1e13213bbe923244d4a4640c2780d788e1c37ff1fbe41bacd02c6576c3afcc3d
MD5 6349fd1dfc47f199b2943170eb48f64f
BLAKE2b-256 52900ee64a1f4586695975380ecdb140078be51e03f6ee9eea9ca83c7251476a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page