Skip to content
Naming Convention checker for Python
Branch: master
Clone or download
jparise Merge pull request #113 from jparise/version-0.9.0
The next version will be 0.9.0
Latest commit d5f5fb2 Feb 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src The next version will be 0.9.0 Feb 20, 2019
testsuite
.gitignore
.travis.yml Add py36 and py37 environments to tox.ini Jan 29, 2019
CHANGELOG.rst Fix ignore-names option initialization Feb 4, 2019
LICENSE
MANIFEST.in Move changelog to its own file Dec 30, 2017
README.rst Relax N807 to "start *and* end with '__'" Feb 5, 2019
run_tests.py Check namings in async statements Oct 31, 2018
setup.cfg Add setup.cfg for wheel support; tag 0.2.2 Apr 19, 2014
setup.py
tox.ini Check reStructuredText syntax along with flake8 Feb 1, 2019

README.rst

https://travis-ci.org/PyCQA/pep8-naming.svg?branch=master

PEP-8 Naming Conventions

Check the PEP-8 naming conventions.

This module provides a plugin for flake8, the Python code checker.

(It replaces the plugin flint-naming for the flint checker.)

Installation

You can install, upgrade, uninstall pep8-naming with these commands:

$ pip install pep8-naming
$ pip install --upgrade pep8-naming
$ pip uninstall pep8-naming

Plugin for Flake8

When both flake8 and pep8-naming are installed, the plugin is available in flake8:

$ flake8 --version
2.0 (pep8: 1.4.3, pyflakes: 0.6.1, naming: 0.2)

By default the plugin is enabled.

These error codes are emitted:

code sample message
N801 class names should use CapWords convention
N802 function name should be lowercase
N803 argument name should be lowercase
N804 first argument of a classmethod should be named 'cls'
N805 first argument of a method should be named 'self'
N806 variable in function should be lowercase
N807 function name should not start and end with '__'
   
N811 constant imported as non constant
N812 lowercase imported as non lowercase
N813 camelcase imported as lowercase
N814 camelcase imported as constant
N815 mixedCase variable in class scope
N816 mixedCase variable in global scope

Options

The following flake8 options are added:

--ignore-names

Ignore errors for specific variable names.

Currently, this option can only be used for N802, N806, N815, and N816 errors.

Default: setUp,tearDown,setUpClass,tearDownClass,setUpTestData,failureException,longMessage,maxDiff.

--classmethod-decorators
 

List of method decorators pep8-naming plugin should consider class method.

Used to prevent false N804 errors.

Default: classmethod.

--staticmethod-decorators
 

List of method decorators pep8-naming plugin should consider static method.

Used to prevent false N805 errors.

Default: staticmethod.

You can’t perform that action at this time.