Skip to main content

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

Project description

https://img.shields.io/github/actions/workflow/status/adamchainz/flake8-no-pep420/main.yml.svg?branch=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.


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


Requirements

Python 3.9 to 3.14 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.

Rationale

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

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

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.9.0.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flake8_no_pep420-2.9.0-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

Details for the file flake8_no_pep420-2.9.0.tar.gz.

File metadata

  • Download URL: flake8_no_pep420-2.9.0.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for flake8_no_pep420-2.9.0.tar.gz
Algorithm Hash digest
SHA256 5dcd9e23bdd545cb957dd23987d9d227e733d1610717b0e13591262df1a33413
MD5 fabd516d1fc0be4dfb75ec4b6d927b55
BLAKE2b-256 ace35373b9c21537efc9954c5daa924e9b59ff09ead43b5068f2b4b8ea8cde23

See more details on using hashes here.

Provenance

The following attestation bundles were made for flake8_no_pep420-2.9.0.tar.gz:

Publisher: main.yml on adamchainz/flake8-no-pep420

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file flake8_no_pep420-2.9.0-py3-none-any.whl.

File metadata

File hashes

Hashes for flake8_no_pep420-2.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 981d5d720dd545662f85625373badd4ca33a4e6484cc5ad976ca17d00dc994de
MD5 c903c16433a71addf3d9e1708d613329
BLAKE2b-256 92561f625d8399c3441e2976c8dfde6dd2af2319e216323c07e623e8086e9b65

See more details on using hashes here.

Provenance

The following attestation bundles were made for flake8_no_pep420-2.9.0-py3-none-any.whl:

Publisher: main.yml on adamchainz/flake8-no-pep420

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page