A flake8 plugin to enforce object calisthenics rule "do not use ELSE"
Project description
flake8-no-else
flake8-no-else
is a plugin for Flake8 that promotes cleaner and more maintainable code by enforcing the Object Calisthenics rule: "Do Not Use ELSE." This plugin discourages the use of else
, elif
, and ternary operators in Python code, encouraging developers to use guard clauses and other techniques to keep code flat and prevent deep nesting.
Installation
You can install flake8-no-else
using pip:
pip install flake8-no-else
Usage
Once installed, flake8-no-else
will automatically integrate with Flake8. Run Flake8 as you normally would:
flake8 your_project_directory
flake8-no-else
will check for the presence of else
, elif
, and ternary expressions and flag them as violations.
Rules Enforced
- NOE100: Use of
else
- NOE101: Use of
elif
- NOE102: Use of ternary operator (
condition ? true_value : false_value
)
Configuration
There are no specific configurations required for flake8-no-else
. It works out-of-the-box once installed. However, you can exclude specific files or directories through your standard .flake8
configuration file.
Example .flake8
configuration:
[flake8]
exclude = tests/*
max-line-length = 120
Motivation
The motivation behind this plugin is to encourage developers to follow the "Do Not Use ELSE" rule of Object Calisthenics. This rule aims to reduce the complexity of code by avoiding multiple conditional branches, which often lead to deeply nested structures and can make code harder to read and maintain.
Contributing
Contributions to flake8-no-else
are welcome! If you have suggestions for improvements or have found a bug, please open an issue or submit a pull request.
License
Distributed under the MIT License. See LICENSE
file for more information.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for flake8_no_else-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | be1b577f05d1129f77bf5cb4828f0e907d9a41cbc4e4aeb494fd8a299a4203b0 |
|
MD5 | 3bd6d2883dea7e5d7d552c727216010b |
|
BLAKE2b-256 | 2582858250a54f5cb05e7c2ff78f9ade1ae4bed94b0640a2f4737833c7047c2f |