flake8-tidy-imports

4.12.0 · active · verified Wed Apr 15

A flake8 plugin that helps you write tidier imports by enforcing rules on import aliases, banned modules, and relative imports. It is currently at version 4.12.0, actively maintained, and supports Python versions 3.10 and newer. Releases typically occur a few times a year, with major versions introducing significant changes.

Warnings

breaking Rule codes were renumbered in version 4.0.0. All rule codes were increased by 50 (e.g., I200 became I250).
Fix: If you explicitly selected or ignored `flake8-tidy-imports` rules in your `flake8` configuration (e.g., `select = I20`), you must update them to the new `I25` prefix (e.g., `select = I25`).
breaking Python 2 support was dropped in version 2.0.0.
Fix: Ensure your project runs on Python 3.4+ (for older `flake8-tidy-imports` versions) or Python 3.10+ (for current 4.x versions).
gotcha If `flake8`'s `select` option is defined, `flake8-tidy-imports` rules (I25x) must be explicitly added for the plugin to be active.
Fix: Add `I25` (to enable all `flake8-tidy-imports` rules) or specific rules like `I250`, `I251`, `I252` to your `select` configuration in your `flake8` config file (e.g., `select = E,W,F,I25`).
gotcha The `banned-modules` configuration can use wildcards (`*`) to match zero or more path components. It also allows banning imported objects, not just modules.
Fix: Use patterns like `example.yellow.*` to match `example.yellow`, `example.yellow.truck`, etc. You can ban `decimal.Decimal` as well as `decimal`.
gotcha A special `{python2to3}` directive can be used within `banned-modules` to automatically ban a preselected list of Python 2-era modules and recommend their Python 3/six replacements.
Fix: Add `{python2to3}` to your `banned-modules` list in `flake8` configuration, e.g., `banned-modules = mock = use unittest.mock.\n{python2to3}`.

Install

pip install flake8-tidy-imports Install stable version

Quickstart

After installation, `flake8-tidy-imports` automatically registers itself with `flake8`. You typically configure it via a `setup.cfg`, `pyproject.toml`, or `.flake8` file. The primary options are `banned-modules` to specify disallowed imports with custom messages and `ban-relative-imports` to control relative import restrictions. If you use `flake8`'s `select` option, ensure you include `I25` to activate the plugin's checks.

import os

# Example file: my_module.py
# import json as json # I250: Unnecessary import alias
# from datetime import timedelta as timedelta # I250: Unnecessary import alias
# from ..utils import helper # I252: Relative import from parent module (if configured)
# import mock # I251: Banned import 'mock' used - use unittest.mock instead. (if configured)

# Configure flake8 in setup.cfg or pyproject.toml
# [flake8]
# banned-modules = 
#   mock = use unittest.mock instead.
#   django.utils.six = no more six!
#   {python2to3}
# ban-relative-imports = parents
# select = I25

# To run flake8:
# flake8 my_module.py

# For demonstration purposes, this code is not meant to be run directly
# but shows common violations flake8-tidy-imports would catch.
# The actual plugin operates via the flake8 command-line tool.

print("Run 'flake8 <your_file.py>' after configuring flake8-tidy-imports.")

view raw JSON →