https://github.com/bskinn/flake8-absolute-import

flake8 plugin to require absolute imports
https://github.com/bskinn/flake8-absolute-import

absolute-imports flake8-plugin linting relative-imports

Last synced: 9 days ago
JSON representation

flake8 plugin to require absolute imports

• Host: GitHub
• URL: https://github.com/bskinn/flake8-absolute-import
• Owner: bskinn
• License: mit
• Created: 2019-09-06T16:05:06.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-10-09T02:57:59.000Z (about 1 year ago)
• Last Synced: 2024-10-10T16:06:43.709Z (29 days ago)
• Topics: absolute-imports, flake8-plugin, linting, relative-imports
• Language: Python
• Homepage:
• Size: 66.4 KB
• Stars: 12
• Watchers: 3
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt
  • Authors: AUTHORS.md

Awesome Lists containing this project

• awesome-flake8-extensions - flake8-absolute-import - Plugin to require absolute imports. (Imports)

README

        
flake8-absolute-import

======================

*flake8 plugin to require absolute imports*

**Current Development Version:**

.. image:: https://img.shields.io/github/actions/workflow/status/bskinn/flake8-absolute-import/ci_tests.yml?branch=main&logo=github

    :alt: GitHub Workflow Status

    :target: https://github.com/bskinn/flake8-absolute-import/actions

.. image:: https://codecov.io/gh/bskinn/flake8-absolute-import/branch/main/graph/badge.svg

    :target: https://codecov.io/gh/bskinn/flake8-absolute-import

**Most Recent Stable Release:**

.. image:: https://img.shields.io/pypi/v/flake8-absolute-import.svg?logo=pypi

    :target: https://pypi.org/project/flake8-absolute-import

.. image:: https://img.shields.io/pypi/pyversions/flake8-absolute-import.svg?logo=python

**Info:**

.. image:: https://img.shields.io/github/license/mashape/apistatus.svg

    :target: https://github.com/bskinn/flake8-absolute-import/blob/stable/LICENSE.txt

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/psf/black

.. image:: https://pepy.tech/badge/flake8-absolute-import/month

    :target: https://pepy.tech/project/flake8-absolute-import

----

*Don't like relative imports?*

Lint 'em out!

``flake8-absolute-import`` uses a direct check of the AST for each

``from x import y`` statement to flag relative imports.

Specifically, it checks for a nonzero *level* attribute on each

|ImportFrom|_ node.

Relative imports raise the ``ABS101`` error code:

.. code:: python

    from foo import bar   # OK

    from .foo import bar  # ABS101

----

Available on `PyPI `__

(``pip install flake8-absolute-import``).  ``flake8`` should automatically

detect and load the plugin. ``flake8``>=5.0 is required.

Source on `GitHub `__.  Bug reports

and feature requests are welcomed at the

`Issues `__ page there.

Copyright (c) Brian Skinn 2019-2023

The ``flake8-absolute-import`` documentation (including docstrings and README)

is licensed under a

`Creative Commons Attribution 4.0 International License `__

(CC-BY). The ``flake8-absolute-import`` codebase is released under the

`MIT License `__. See

`LICENSE.txt `__ for

full license terms.

.. _ImportFrom: https://greentreesnakes.readthedocs.io/en/latest/nodes.html#ImportFrom

.. |ImportFrom| replace:: ``ImportFrom``