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/master?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.6 to 3.9 supported.

Installation

First, install with pip:

python -m pip install flake8-no-pep420

Second, check that flake8 lists the plugin in its version line:

$ flake8 --version
3.8.4 (flake8-no-pep420: 1.0.0, mccabe: 0.6.1, pycodestyle: 2.5.0, pyflakes: 2.1.1) CPython 3.8.0 on Darwin

Third, add the INP prefix to your select list. For example, if you have your configuration in setup.cfg:

[flake8]
select = E,F,W,INP

Linting a Django project? Check out my book Speed Up Your Django Tests which covers loads of best practices so you can write faster, more accurate tests.


Rationale

Implicit namespace packages are folders of Python files without an __init__.py. They’re valid and importable, but unfortunately they’re not discovered by many code quality tools:

Such silent failure leads to a false sense of security. 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.

flake8-no-pep420 will trigger this on the first line of any file that sits in a folder without a __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 on a Django project there’s the manage.py file. In these cases you should add # noqa: INP001 on the first line of the file.

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-1.0.0.tar.gz (11.0 kB view hashes)

Uploaded Source

Built Distribution

flake8_no_pep420-1.0.0-py3-none-any.whl (4.2 kB view hashes)

Uploaded Python 3

Supported by

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