{"author":null,"author_email":"Adam Johnson ","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Framework :: Flake8","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Natural Language :: English","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.9","Typing :: Typed"],"description":"===================\nflake8-tidy-imports\n===================\n\n.. image:: https://img.shields.io/github/actions/workflow/status/adamchainz/flake8-tidy-imports/main.yml.svg?branch=main&style=for-the-badge\n :target: https://github.com/adamchainz/flake8-tidy-imports/actions?workflow=CI\n\n.. image:: https://img.shields.io/pypi/v/flake8-tidy-imports.svg?style=for-the-badge\n :target: https://pypi.org/project/flake8-tidy-imports/\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge\n :target: https://github.com/psf/black\n\n.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=for-the-badge\n :target: https://github.com/pre-commit/pre-commit\n :alt: pre-commit\n\nA `flake8 `_ plugin that helps you write tidier imports.\n\n----\n\n**Linting a Django project?**\nCheck out my book `Boost Your Django DX `__ which covers Flake8 and many other code quality tools.\n\n----\n\nRequirements\n============\n\nPython 3.9 to 3.13 supported.\n\nInstallation\n============\n\nFirst, install with ``pip``:\n\n.. code-block:: sh\n\n python -m pip install flake8-tidy-imports\n\nSecond, if you define Flake8’s ``select`` setting, add the ``I25`` prefix to it.\nOtherwise, the plugin should be active by default.\n\nOptions\n=======\n\n``banned-modules``\n------------------\n\nConfig for rule I251 (below).\nShould contain a map where each line is a banned import string, followed by '=', then the message to use when encountering that import.\n\nThere is also a special directive to ban a preselected list of removed/moved modules between Python 2 and Python 3, recommending replacements from `six\n`_ where possible.\nIt can be turned on by adding ``{python2to3}`` to the list of ``banned-modules``.\n\nFor example in ``setup.cfg``:\n\n.. code-block:: ini\n\n [flake8]\n banned-modules =\n mock = Use unittest.mock.\n {python2to3}\n\nNote that despite the name, you can ban imported objects too, since the syntax is the same.\nFor example:\n\n.. code-block:: ini\n\n [flake8]\n banned-modules =\n decimal.Decimal = Use ints and floats only.\n\nEntries containing ``*`` are treated as wildcards matching zero or more path components.\nFor example:\n\n* ``example.yellow.*`` matches ``example.yellow``, ``example.yellow.truck``, ``example.yellow.truck.driving`` etc.\n* ``example.*.truck`` matches ``example.truck``, ``example.yellow.truck``, ``example.red.truck``, ``example.big.red.truck``, etc.\n\n``ban-relative-imports``\n------------------------\n\nControls rule I252 (below). Accepts two values:\n\n* ``parents`` - bans imports from parent modules (and grandparents, etc.), i.e. with more than one ``.``.\n* ``true`` - bans all relative imports.\n\nFor example:\n\n.. code-block:: ini\n\n [flake8]\n ban-relative-imports = parents\n\n(If you want to ban absolute imports, you can put your project's modules in ``banned-modules``.)\n\nRules\n=====\n\n**Note:** Before version 4.0.0, the rule codes were numbered 50 lower, e.g. I250 was I200.\nThey were changed in `Issue #106 `__ due to conflict with ``flake8-import-order``.\n\nI250: Unnecessary import alias\n------------------------------\n\nComplains about unnecessary import aliasing of three forms:\n\n* ``import foo as foo`` -> ``import foo``\n* ``import foo.bar as bar`` -> ``from foo import bar``\n* ``from foo import bar as bar`` -> ``from foo import bar``\n\nThe message includes the suggested rewrite (which may not *always* be correct), for example:\n\n.. code-block:: sh\n\n $ flake8 file.py\n file.py:1:1: I250 Unnecessary import alias - rewrite as 'from foo import bar'.\n\nSuch aliases can be automatically fixed by ``isort`` if you activate its `remove_redundant_aliases option `__.\n\nI251: Banned import ```` used.\n--------------------------------------\n\nComplains about use of banned imports.\nBy default there are no imports banned - you should configure them with ``banned-modules`` as described above in 'Options'.\n\nThe message includes a user-defined part that comes from the configuration.\nFor example:\n\n.. code-block:: sh\n\n $ flake8 file.py\n file.py:1:1: I251 Banned import 'mock' used - use unittest.mock instead.\n\nI252: Relative imports are banned.\n--------------------------------------------------------\n\nComplains about use of relative imports:\n\n* ``from . import foo`` (sibling import)\n* ``from .bar import foo`` (sibling import)\n* ``from .. import foo`` (parent import)\n\nControlled by the ``ban-relative-imports`` configuration option.\n\nAbsolute imports, or relative imports from siblings, are recommended by `PEP8 `__:\n\n Absolute imports are recommended, as they are usually more readable and tend to be better behaved...\n\n .. code-block:: python\n\n import mypkg.sibling\n from mypkg import sibling\n from mypkg.sibling import example\n\n However, explicit relative imports are an acceptable alternative to absolute imports...\n\n .. code-block:: python\n\n from . import sibling\n from .sibling import example\n\nSee also\n--------\n\nFor more advanced control of imports in your project, try `import-linter `__.\n","description_content_type":"text/x-rst","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":null,"keywords":"flake8_tidy_imports","license":null,"license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"flake8-tidy-imports","package_url":"https://pypi.org/project/flake8-tidy-imports/","platform":null,"project_url":"https://pypi.org/project/flake8-tidy-imports/","project_urls":{"Changelog":"https://github.com/adamchainz/flake8-tidy-imports/blob/main/CHANGELOG.rst","Funding":"https://adamj.eu/books/","Repository":"https://github.com/adamchainz/flake8-tidy-imports"},"provides_extra":null,"release_url":"https://pypi.org/project/flake8-tidy-imports/4.11.0/","requires_dist":["flake8>=3.8"],"requires_python":">=3.9","summary":"A flake8 plugin that helps you write tidier imports.","version":"4.11.0","yanked":false,"yanked_reason":null}

Package search

flake8-tidy-imports

project_urls

Dependencies

All package metadata

Releases