lostm/flake8-no-nesting
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
34 commits 1 branch 0 tags 51 KiB
Find a file
Exact
nocyphr 2bafa53a80 update: version increment
2024-04-18 08:40:30 +03:00
tests update: added golded masters for '... in try' test cases 2024-04-17 08:30:36 +03:00
.gitignore add: base setup 2024-04-16 08:08:39 +03:00
flake8_no_nesting.py update: try visitor and tstcases 2024-04-17 08:23:15 +03:00
README.md docs: proper readme 2024-04-18 08:37:09 +03:00
requirements.txt add: gitignore + requirements 2024-04-16 08:03:54 +03:00
setup.cfg update: version increment 2024-04-18 08:40:30 +03:00
setup.py add: base setup 2024-04-16 08:08:39 +03:00

README.md

flake8-no-nesting

flake8-no-nesting is a plugin for Flake8 designed to enhance code readability and maintainability by enforcing the Object Calisthenics rule: "One Level of Indentation per Method." The plugin aims to detect and flag the use of nested control structures such as try, if, with, while, and for in Python code.

Installation

Install flake8-no-nesting via pip:

pip install flake8-no-nesting

Usage

After installation, flake8-no-nesting integrates seamlessly with Flake8. To run the plugin, execute Flake8 on your project directory:

flake8 your_project_directory

The plugin will analyze your code for any violations related to nested control structures.

Rules Enforced

  • FNN100 nested if found
  • FNN101 nested for loop found
  • FNN102 nested while loop found
  • FNN103 nested with found
  • FNN104 nested try found

Each violation will report the specific type of nesting and its location, helping you to refactor your code accordingly.

Configuration

No specific configuration is required to get started with flake8-no-nesting. However, you can customize the behavior of Flake8 via the .flake8 configuration file to ignore certain files or directories, or to adjust other Flake8 settings.

Example .flake8 configuration:

[flake8]
exclude = tests/*
max-line-length = 120

Motivation

This plugin supports the "One Level of Indentation per Method" rule from Object Calisthenics, which advocates for minimal indentation to improve code readability and reduce complexity. Following this rule helps in writing code that is easier to understand, test, and maintain.

Contributing

We welcome contributions to improve flake8-no-nesting. If you have suggestions or encounter bugs, please feel free to open an issue or submit a pull request.

License

flake8-no-nesting is distributed under the MIT License. See the LICENSE file for more details.