pep8-naming

0.15.1 · active · verified Fri Apr 10

pep8-naming is a plugin for flake8 that checks Python code against PEP 8 naming conventions. It is currently at version 0.15.1 and has a regular release cadence, with multiple releases per year addressing Python version compatibility and new checks.

Warnings

breaking Python version compatibility has changed across major releases. For example, version 0.15.0 dropped support for Python 3.8 and added support for Python 3.13. The current version (0.15.1) requires Python >=3.9.
Fix: Ensure your Python environment meets the 'requires_python' specification for the installed pep8-naming version. Upgrade Python if necessary.
breaking The minimum required version of flake8 has increased. As of pep8-naming 0.13.3, flake8 5.0.0 or later is formally required. Using an older flake8 version may lead to installation issues or unexpected behavior.
Fix: Upgrade your flake8 installation to version 5.0.0 or later: `pip install --upgrade flake8`.
gotcha The behavior of the N808 check for type variable names was updated in 0.15.0 to require `CapWords` convention and optional suffixes (`_co` or `_contra`). Version 0.15.1 further refined this to allow type variable names to start with an underscore. This might cause new N808 errors in existing code.
Fix: Review and update type variable names to adhere to the `CapWords` convention, with optional `_co` or `_contra` suffixes. If using a leading underscore, ensure you are on version 0.15.1 or newer.
gotcha The `--ignore-names` option only applies to a specific subset of naming errors (N802, N803, N804, N805, N806, N815, and N816). Other naming conventions, such as N801 for class names, cannot be ignored using this option.
Fix: Be aware of which error codes `--ignore-names` impacts. For other naming violations, consider using `# noqa` comments on specific lines or adjusting your code to conform to PEP 8.

Install

pip install pep8-naming Install pep8-naming

Imports

pep8-naming (plugin)
```
pep8-naming is a flake8 plugin and is not typically imported directly into user code.
```
The functionality is integrated when flake8 is run, provided pep8-naming is installed in the same environment.

Quickstart

To quickly use pep8-naming, install it alongside flake8. Once installed, flake8 will automatically detect and use the pep8-naming plugin when run against your Python code.

# 1. Install flake8 and pep8-naming
pip install flake8 pep8-naming

# 2. Create a Python file (e.g., my_module.py) with a naming violation
# For example, a class name that doesn't use CapWords
# class myClass:
#    pass

# 3. Run flake8 from your terminal in the directory containing the file
# flake8 my_module.py

# Example output for 'class myClass:' might include N801:
# my_module.py:1:7: N801 class names should use CapWords convention

view raw JSON →