PEP-8 Names¶
Plugin for xdress which converts target names to PEP8 compatible versions.
This module is available as an xdress plugin by the name xdress.pep8names
.
It should probably come after xdress.autoall
and after xdress.autodescribe
.
author: | Anthony Scopatz <scopatz@gmail.com> |
---|
PEP-8 Names Plugin API¶
-
class
xdress.pep8names.
XDressPlugin
[source]¶ This class provides PEP-8 naming functionality for xdress.
The __init__() method may take no arguments or keyword arguments.
-
xdress.pep8names.
ensure_pep8name
(name, kind)[source]¶ Ensures that an apiname is valid for its kind: ‘var’, ‘func’, or ‘class’.
-
xdress.pep8names.
pep8class
(name)[source]¶ Converts a name, which may not be PEP-8 compliant for classes to a name that is compliant.
-
xdress.pep8names.
pep8func
(name)[source]¶ Converts a name, which may not be PEP-8 compliant for functions, methods, or variables, to a name that is compliant.
-
xdress.pep8names.
pep8var
(name)¶ Converts a name, which may not be PEP-8 compliant for functions, methods, or variables, to a name that is compliant.