Code audit tool for python. Pylama wraps these tools:
- PEP8 © 2012-2013, Florent Xicluna;
- PEP257 © 2012, GreenSteam, <http://greensteam.dk/>
- PyFlakes © 2005-2013, Kevin Watters;
- Pylint © 2013, Logilab;
- Mccabe © Ned Batchelder;
Pylint doesnt supported in python3.
Docs are available at https://pylama.readthedocs.org/. Pull requests with documentation enhancements and/or fixes are awesome and most welcome.
Contents
- Python (2.6, 2.7, 3.2, 3.3)
Pylama should be installed using pip: ::
$ pip install pylama
Pylama is easy to use and realy fun for checking code quality. Just run pylama and get common output from all pylama plugins (PEP8, PyFlakes and etc)
Recursive check the current directory.
$ pylama
Recursive check a path.
$ pylama <path_to_directory_or_file>
Ignore some errors
$ pylama -i W,E501
Customize linters
$ pylama -l "pep8,mccabe"
$ pylama --help
usage: main.py [-h] [--verbose] [--format {pep8,pylint}] [--select SELECT]
[--linters LINTERS] [--ignore IGNORE] [--skip SKIP]
[--complexity COMPLEXITY] [--report REPORT] [--hook]
[--options OPTIONS]
[path]
Code audit tool for python.
positional arguments:
path Path on file or directory.
optional arguments:
-h, --help show this help message and exit
--verbose, -v Verbose mode.
--version show program's version number and exit
--format {pep8,pylint}, -f {pep8,pylint}
Error format.
--select SELECT, -s SELECT
Select errors and warnings. (comma-separated)
--linters LINTERS, -l LINTERS
Select linters. (comma-separated). Choices are
pep8,pep257,mccabe,pyflakes,pylint.
--ignore IGNORE, -i IGNORE
Ignore errors and warnings. (comma-separated)
--skip SKIP Skip files by masks (comma-separated, Ex.
*/messages.py*)
--complexity COMPLEXITY, -c COMPLEXITY
Set mccabe complexity.
--report REPORT, -r REPORT
Filename for report.
--hook Install Git (Mercurial) hook.
--options OPTIONS, -o OPTIONS
Select configuration file. By default is
'<CURDIR>/pylama.ini'
You can set :ref:`options` for Pylama inside a source files.
.. Somethere in code # lint_ignore=W:lint_select=W301
Disable code checking for current file:
.. Somethere in code # lint=0
Just add # noqa in end of line for ignore.
.. Somethere in code x=d+34 # noqa
When starting Pylama try loading configuration file. By default: <CURDIR>/pylama.ini, but you set it with "-o" option.
Section main contains a global options (see :ref:`options`), like linters and skip.
Other sections could set :ref:`modeline` for a custom files by filepath mask.
Example: pylama.ini
[main] format = pylint skip = */.tox/*,*/.env/* linters = pylint,mccabe [*/pylama/main.py] lint_ignore = C901,R0914,W0212 lint_select = R [*/tests.py] lint_ignore = C0110 [*/setup.py] lint = 0
If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/pylama/issues
Development of adrest happens at github: https://github.com/klen/pylama
- klen (Kirill Klenov)
Licensed under a BSD license.