From 9c0ef87a62af0f341f196f50a995743cd9c838d5 Mon Sep 17 00:00:00 2001 From: Florian Bruhin Date: Sat, 10 Oct 2015 12:59:45 +0200 Subject: [PATCH] tox: Update pep257 to 0.7.0. Upstream changelog: New Features - Added the D104 error code - "Missing docstring in public package". This new error is turned on by default. Missing docstring in __init__.py files which previously resulted in D100 errors ("Missing docstring in public module") will now result in D104. - Added the D105 error code - "Missing docstring in magic method'. This new error is turned on by default. Missing docstrings in magic method which previously resulted in D102 error ("Missing docstring in public method") will now result in D105. Note that exceptions to this rule are variadic magic methods - specifically __init__, __call__ and __new__, which will be considered non-magic and missing docstrings in them will result in D102. - Support the option to exclude all error codes. Running pep257 with --select= (or select= in the configuration file) will exclude all errors which could then be added one by one using add-select. Useful for projects new to pep257. - Added check D211: No blank lines allowed before class docstring. This change is a result of a change to the official PEP257 convention. Therefore, D211 will now be checked by default instead of D203, which required a single blank line before a class docstring. - Configuration files are now handled correctly. The closer a configuration file is to a checked file the more it matters. Configuration files no longer support explain, source, debug, verbose or count. Bug Fixes - On Python 2.x, D302 ("Use u""" for Unicode docstrings") is not reported if unicode_literals is imported from __future__. - Fixed a bug where there was no executable for pep257 on Windows. --- tox.ini | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/tox.ini b/tox.ini index b4364d608..37e9a1dc7 100644 --- a/tox.ini +++ b/tox.ini @@ -104,13 +104,17 @@ commands = basepython = python3 skip_install = true passenv = PYTHON LANG -deps = pep257==0.6.0 +deps = pep257==0.7.0 # Disabled checks: # D102: Missing docstring in public method (will be handled by others) # D103: Missing docstring in public function (will be handled by others) +# D104: Missing docstring in public package (will be handled by others) +# D105: Missing docstring in magic method (will be handled by others) # D209: Blank line before closing """ (removed from PEP257) +# D211: Now b lank lines allowed before class docstring +# (PEP257 got changed, but let's stick to the old standard) # D402: First line should not be function's signature (false-positives) -commands = {envpython} -m pep257 scripts tests qutebrowser --ignore=D102,D103,D209,D402 '--match=(?!resources|test_*).*\.py' +commands = {envpython} -m pep257 scripts tests qutebrowser --ignore=D102,D103,D104,D105,D209,D211,D402 '--match=(?!resources|test_*).*\.py' [testenv:pyflakes] basepython = python3