Flake8 Return Plugin

1.2.0 · active · verified Mon Apr 13

flake8-return is a Flake8 plugin that provides a set of checks related to return values and unnecessary control flow. It aims to improve code readability and eliminate redundant statements. The current version is 1.2.0, with active development and regular releases addressing bug fixes and new checks.

Warnings

breaking Version 1.2.0 introduced new checks (R505, R506, R507, R508) ported from Pylint (no-else-break, no-else-continue, no-else-raise, no-else-return). These will likely flag new warnings in existing codebases that previously passed linting.
Fix: Review newly reported R505-R508 warnings and refactor code to eliminate unnecessary `else` statements or explicitly ignore these specific error codes in your Flake8 configuration if desired.
gotcha The R504 check ('Unnecessary assignment') has undergone multiple fixes and refinements across versions (e.g., v1.1.2, v1.2.0). This means its behavior, including false positives or negatives, might have changed, leading to different linting results for the same code across versions.
Fix: Ensure you are on the latest version of `flake8-return` for the most accurate R504 detection. If you encounter issues, review the code or consider temporarily ignoring R504 if the warning is deemed incorrect for your specific use case.
gotcha The R503 check ('Unnecessary else statement') can be opinionated. While often promoting cleaner code, some developers prefer explicit `else` blocks for certain control flow patterns, leading to desired code being flagged.
Fix: If the R503 warning clashes with your team's coding style or is considered a false positive for a specific case, you can disable this check in your Flake8 configuration (e.g., `ignore = R503` in `pyproject.toml`).

Install

pip install flake8-return Install

Imports

Checker
```
from flake8_return.checker import Checker
```
Flake8 plugins are typically loaded automatically via entry points. Direct import of the Checker class is generally not needed for regular use, but shown here for completeness of the package structure.

Quickstart

After installing flake8-return, simply run `flake8` in your project. The plugin will automatically integrate and apply its checks (R5xx codes) to your codebase. You can configure or ignore specific checks using your `pyproject.toml`, `setup.cfg`, or `.flake8` file.

# 1. Install Flake8 (if not already installed)
pip install flake8

# 2. Install flake8-return
pip install flake8-return

# 3. Run Flake8 in your project directory
# flake8 will automatically discover and load flake8-return
flake8 .

view raw JSON →