https://github.com/queensferryme/flake8-too-many

A flake8 plugin that prevents you from writing "too many" bad codes.
https://github.com/queensferryme/flake8-too-many

flake8 flake8-plugin linter python static-analysis

Last synced: about 2 months ago
JSON representation

A flake8 plugin that prevents you from writing "too many" bad codes.

• Host: GitHub
• URL: https://github.com/queensferryme/flake8-too-many
• Owner: queensferryme
• License: mit
• Created: 2021-08-10T14:22:52.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-05-06T19:14:07.000Z (about 2 months ago)
• Last Synced: 2024-05-06T20:28:51.466Z (about 2 months ago)
• Topics: flake8, flake8-plugin, linter, python, static-analysis
• Language: Python
• Homepage:
• Size: 128 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-flake8-extensions - flake8-too-many - Plugin that prevents you from writing "too many" bad codes. (Clean code)

README

        
# flake8-too-many

[![python: 3.7+](https://img.shields.io/badge/python->=3.7-blue.svg)](https://www.python.org/downloads/)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/queensferryme/flake8-too-many/master.svg)](https://results.pre-commit.ci/latest/github/queensferryme/flake8-too-many/master)

[![github ci status](https://img.shields.io/github/workflow/status/queensferryme/flake8-too-many/Test?label=test&logo=github&message=passed)](https://github.com/RSSerpent/RSSerpent/actions/workflows/test.yaml)

[![codecov](https://codecov.io/gh/queensferryme/flake8-too-many/branch/master/graph/badge.svg?token=56VCCB1JUB)](https://codecov.io/gh/queensferryme/flake8-too-many)

A flake8 plugin that prevents you from writing "too many" bad codes.

## Installation

with `pip`

```shell

pip install flake8-too-many

```

with [`poetry`](https://python-poetry.org/)

```shell

poetry add -D flake8-too-many

```

with [`pre-commit`](https://pre-commit.com/) ([doc](https://flake8.pycqa.org/en/latest/user/using-hooks.html))

```yaml

repos:

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

    rev: '' # pick a git hash/tag

    hooks:

      - id: flake8

        additional_dependencies:

          # ...

          - flake8-too-many

```

## Error Codes

| code   | description                              | example                                                      |

| ------ | ---------------------------------------- | ------------------------------------------------------------ |

| TMN001 | function has too many arguments.         | [link](https://github.com/queensferryme/flake8-too-many/blob/master/tests/files/function_arguments.py) |

| TMN002 | function returns too many values.        | [link](https://github.com/queensferryme/flake8-too-many/blob/master/tests/files/function_return_values.py) |

| TMN003 | function has too many return statements. | [link](https://github.com/queensferryme/flake8-too-many/blob/master/tests/files/function_return_stmts.py) |

| TMN004 | unpacking has too many targets.          | [link](https://github.com/queensferryme/flake8-too-many/blob/master/tests/files/unpacking_targets.py) |

## Options

These options could be either passed in as command line flags, or specified in a `.flake8` configuration file.

* `--max-function-arguments`, int, default to 6;

  * `--ignore-defaulted-arguments`, bool, default to false;

* `--max-function-return-values`, int, default to 3;

* `--max-function-return-stmts`, int, default to 3;

* `--max-unpacking-targets`, int, default to 3.

Run `flake8 -h` for detailed description of each option.