mirror of
https://github.com/thegeeklab/ansible-later.git
synced 2024-11-23 13:20:41 +00:00
116 lines
4.4 KiB
Plaintext
116 lines
4.4 KiB
Plaintext
|
Metadata-Version: 2.1
|
||
|
|
Name: pep8-naming
|
||
|
|
Version: 0.8.2
|
||
|
|
Summary: Check PEP-8 naming conventions, plugin for flake8
|
||
|
|
Home-page: https://github.com/PyCQA/pep8-naming
|
||
|
|
Author: Florent Xicluna
|
||
|
|
Author-email: florent.xicluna@gmail.com
|
||
|
|
License: Expat license
|
||
|
|
Keywords: flake8 pep8 naming
|
||
|
|
Platform: UNKNOWN
|
||
|
|
Classifier: Development Status :: 5 - Production/Stable
|
||
|
|
Classifier: Environment :: Console
|
||
|
|
Classifier: Framework :: Flake8
|
||
|
|
Classifier: Intended Audience :: Developers
|
||
|
|
Classifier: License :: OSI Approved :: MIT License
|
||
|
|
Classifier: Operating System :: OS Independent
|
||
|
|
Classifier: Programming Language :: Python
|
||
|
|
Classifier: Programming Language :: Python :: 2
|
||
|
|
Classifier: Programming Language :: Python :: 2.7
|
||
|
|
Classifier: Programming Language :: Python :: 3
|
||
|
|
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
||
|
|
Classifier: Topic :: Software Development :: Quality Assurance
|
||
|
|
Requires-Dist: flake8-polyfill (<2,>=1.0.2)
|
||
|
|
|
||
|
|
.. image:: https://travis-ci.org/PyCQA/pep8-naming.svg?branch=master
|
||
|
|
:target: https://travis-ci.org/PyCQA/pep8-naming
|
||
|
|
|
||
|
|
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 or 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``.
|
||
|
|
|
||
|
|
|