Skip to main content

A flake8 plugin to ban PEP-420 implicit namespace packages.

Project description

https://img.shields.io/github/workflow/status/adamchainz/flake8-no-pep420/CI/main?style=for-the-badge https://img.shields.io/pypi/v/flake8-no-pep420.svg?style=for-the-badge https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge pre-commit

A flake8 plugin to ban PEP-420 implicit namespace packages.

Requirements

Python 3.7 to 3.11 supported.

Installation

First, install with pip:

python -m pip install flake8-no-pep420

Second, if you define Flake8’s select setting, add the INP prefix to it. Otherwise, the plugin should be active by default.


Linting a Django project? Check out my book Boost Your Django DX which covers Flake8 and many other code quality tools.


Rationale

Implicit namespace packages are directories of Python files without an __init__.py. They’re valid and importable, but they break many tools, such as:

In most cases, tools fail silently, which can lead to a false sense of security:

  • Tests may look legitimate but never run

  • Code may be untested but not appear in coverage statistics

  • Types may never be checked

PEP-420’s algorithm is non-trivial which is probably why such tools haven’t (yet) implemented it.

Rules

INP001: File is part of an implicit namespace package. Add __init__.py?

flake8-no-pep420 will trigger this on the first line of any file that sits in a directory without an __init__.py file.

Often projects have a few root files not in packages, for which an __init__.py file should not be added. For example, Django projects normally have a manage.py file in the root of their repository. In these cases you can ignore the INP001 error. It’s possible to use # noqa: INP001 to ignore the error in-line, but this isn’t possible if the first line is a shebang, such as in Django’s manage.py. In such cases it’s preferable to use Flake8’s per-file-ignores option, for example in setup.cfg:

[flake8]
# ...
per-file-ignores =
    manage.py:INP001

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

flake8-no-pep420-2.3.0.tar.gz (5.3 kB view hashes)

Uploaded source

Built Distribution

flake8_no_pep420-2.3.0-py3-none-any.whl (4.7 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page