https://github.com/ghazi-git/flake8-max-function-length

A configurable flake8 rule to enforce a maximum function/method length.
https://github.com/ghazi-git/flake8-max-function-length

flake8 flake8-plugin max-function-length

Last synced: 3 months ago
JSON representation

A configurable flake8 rule to enforce a maximum function/method length.

• Host: GitHub
• URL: https://github.com/ghazi-git/flake8-max-function-length
• Owner: ghazi-git
• License: mit
• Created: 2023-02-18T17:03:53.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2025-12-06T09:37:12.000Z (5 months ago)
• Last Synced: 2025-12-10T02:46:14.517Z (5 months ago)
• Topics: flake8, flake8-plugin, max-function-length
• Language: Python
• Homepage:
• Size: 57.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# flake8-max-function-length

A configurable [flake8](https://github.com/pycqa/flake8) plugin to enforce a maximum function/method length.

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ghazi-git/flake8-max-function-length/tests.yml?branch=main&label=Tests&logo=GitHub)](https://github.com/ghazi-git/flake8-max-function-length/actions/workflows/tests.yml)

[![PyPI](https://img.shields.io/pypi/v/flake8-max-function-length)](https://pypi.org/project/flake8-max-function-length/)

[![PyPI](https://img.shields.io/pypi/pyversions/flake8-max-function-length?logo=python&logoColor=white)](https://pypi.org/project/flake8-max-function-length/)

[![PyPI - License](https://img.shields.io/pypi/l/flake8-max-function-length)](https://github.com/ghazi-git/flake8-max-function-length/blob/main/LICENSE)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

## Installation

Install with `pip`

```shell

pip install flake8-max-function-length

```

## Configuration Options

The package has only one rule `MFL000` to check that function length is equal or lower to a maximum value.

By default, the function length should be lower than 50 lines and is calculated based on its content ignoring

its docstring, comments and empty lines. Still, you have the ability to customize that based on the following

options:

- `--max-function-length=n`: Maximum allowed function length. (Default: 50)

- `--mfl-include-function-definition`: Include the function definition line(s) when calculating the function length.

(Default: disabled)

- `--mfl-include-docstring`: Include the length of the docstring when calculating the function length.

(Default: disabled)

- `--mfl-include-empty-lines`: Include empty lines inside the function when calculating the function length.

(Default: disabled)

- `--mfl-include-comment-lines`: Include comment lines when calculating the function length. (Default: disabled)

## Usage with pre-commit

```yaml

repos:

  - repo: https://github.com/pycqa/flake8

    rev: '6.0.0'

    hooks:

      - id: flake8

        #args: [ --max-function-length, '100', --mfl-include-docstring, --mfl-include-comment-lines ]

        additional_dependencies: [ "flake8-max-function-length==0.10.0" ]

```

## Similar tools

- flake8-functions has a similar rule for maximum function length, however, it [doesn't allow excluding empty lines

and comments](https://github.com/best-doctor/flake8-functions/issues/9).

- Pylint has the [too-many-statements](https://pylint.readthedocs.io/en/latest/user_guide/checkers/features.html#design-checker-messages)

rule, which is also similar to this one. Still, I find it easier to reason about number of lines as opposed to

number of statements.

## License

This project is [MIT licensed](LICENSE).