tools: Added pydocstyle for python files.

This commit is contained in:
Andrew Hamilton 2018-05-31 14:34:10 +10:00
parent bff38fc697
commit 402cdf3994
3 changed files with 10 additions and 4 deletions

View file

@ -26,7 +26,7 @@ then to run:
Extensions | Tools
---------- | -----
.* | [contents](http://pygments.org/) • metadata • [git_blame](https://git-scm.com/docs/git-blame) • [git_log](https://git-scm.com/docs/git-log)
.py | [python_syntax](https://en.wikipedia.org/wiki/Python_syntax_and_semantics) • [python_unittests](https://docs.python.org/3/library/unittest.html) • [pydoc](https://docs.python.org/3/library/pydoc.html) • [mypy](http://www.mypy-lang.org/) • [python_coverage](http://nedbatchelder.com/code/coverage/) • [pycodestyle](https://pypi.python.org/pypi/pycodestyle) • [pyflakes](https://launchpad.net/pyflakes) • [pylint](http://www.pylint.org/) • [python_gut](https://github.com/ahamilton/vigil/blob/master/gut.py) • [python_modulefinder](https://docs.python.org/3/library/modulefinder.html) • [dis](https://docs.python.org/3/library/dis.html) • [python_mccabe](https://github.com/flintwork/mccabe) • [bandit](https://wiki.openstack.org/wiki/Security/Projects/Bandit)
.py | [python_syntax](https://en.wikipedia.org/wiki/Python_syntax_and_semantics) • [python_unittests](https://docs.python.org/3/library/unittest.html) • [pydoc](https://docs.python.org/3/library/pydoc.html) • [mypy](http://www.mypy-lang.org/) • [python_coverage](http://nedbatchelder.com/code/coverage/) • [pycodestyle](https://pypi.python.org/pypi/pycodestyle) • [pydocstyle](package) • [pyflakes](https://launchpad.net/pyflakes) • [pylint](http://www.pylint.org/) • [python_gut](https://github.com/ahamilton/vigil/blob/master/gut.py) • [python_modulefinder](https://docs.python.org/3/library/modulefinder.html) • [dis](https://docs.python.org/3/library/dis.html) • [python_mccabe](https://github.com/flintwork/mccabe) • [bandit](https://wiki.openstack.org/wiki/Security/Projects/Bandit)
.pl .pm .t | [perl_syntax](https://en.wikipedia.org/wiki/Perl) • [perldoc](http://perldoc.perl.org/) • [perltidy](http://perltidy.sourceforge.net/)
.pod .pod6 | [perldoc](http://perldoc.perl.org/)
.java | [uncrustify](https://github.com/uncrustify/uncrustify)

View file

@ -383,6 +383,12 @@ def pycodestyle(path):
return _run_command([_python_version(path), "-m", "pycodestyle", path])
@deps(deps={"python-pydocstyle", "python3-pydocstyle"},
url="python-pydocstyle")
def pydocstyle(path):
return _run_command([_python_version(path), "-m", "pydocstyle", path])
@deps(deps={"python-pyflakes", "python3-pyflakes"}, url="pyflakes")
def pyflakes(path):
return _run_command([_python_version(path), "-m", "pyflakes", path])

View file

@ -1,8 +1,8 @@
tools_for_extensions = [
[["py"], ["python_syntax", "python_unittests", "pydoc", "mypy",
"python_coverage", "pycodestyle", "pyflakes", "pylint",
"python_gut", "python_modulefinder", "dis", "python_mccabe",
"bandit"]],
"python_coverage", "pycodestyle", "pydocstyle", "pyflakes",
"pylint", "python_gut", "python_modulefinder", "dis",
"python_mccabe", "bandit"]],
# [["pyc"], ["pydisasm"]],
[["pl", "pm", "t"], ["perl_syntax", "perldoc", "perltidy"]],
# [["p6", "pm6"], ["perl6_syntax", "perldoc"]],