Merge branch 'master' into 91-dev-deps

Author: adiroiban

twistedchecker/checkers/__init__.py

@@ -1,3 +1,6 @@
+# -*- test-case-name: twistedchecker.test -*-
+# Copyright (c) Twisted Matrix Laboratories.
+# See LICENSE for details.
 """
 Checkers of Twistedchecker.
-"""
+"""

twistedchecker/checkers/comment.py

@@ -8,7 +8,7 @@ class CommentChecker(BaseChecker):
     """
     A checker for checking comment issues.
 
-    A good comment should begin with one whiespace and
+    A good comment should begin with one whitespace and
     with first letter capitalized.
     """
     msgs = {
@@ -31,8 +31,19 @@ def visit_module(self, node):
             # Failed to open the module
             return
         isFirstLineOfComment = True
+        isDocString = False
         lines = node.file_stream.readlines()
         for linenum, line in enumerate(lines):
+            if line.strip().startswith('"""'):
+                # This is a simple assumption than docstring are delimited
+                # with triple double quotes on a single line.
+                # Should do the job for Twisted code.
+                isDocString = not isDocString
+
+            if isDocString:
+                # We ignore comments in docstrings.
+                continue
+
             matchedComment = COMMENT_RGX.search(STRING_RGX.sub('', line))
             if matchedComment:
                 if isFirstLineOfComment:

twistedchecker/checkers/docstring.py

@@ -10,6 +10,7 @@
 
 from logilab.astng import node_classes
 from logilab.astng import scoped_nodes
+from logilab.astng.exceptions import InferenceError
 
 from pylint.interfaces import IASTNGChecker
 from pylint.checkers.base import DocStringChecker as PylintDocStringChecker
@@ -35,6 +36,40 @@ class or inner function.
 
 
 
+def _getDecoratorsName(node):
+    """
+    Return a list with names of decorators attached to this node.
+
+    @param node: current node of pylint
+    """
+    try:
+        return node.decoratornames()
+    except InferenceError:
+        # For setter properties pylint fails so we use a custom code.
+        decorators = []
+        for decorator in node.decorators.nodes:
+            decorators.append(decorator.as_string())
+        return decorators
+
+
+def _isSetter(node_type, node):
+    """
+    Determine whether the given node is a setter property.
+
+    @param node_type: The type of the node to inspect.
+    @param node: The L{logilab.astng.bases.NodeNG} to inspect.
+
+    @return: a boolean indicating if the given node is a setter.
+    """
+    if node_type not in ['function', 'method']:
+        return False
+
+    for name in _getDecoratorsName(node):
+        if '.setter' in name:
+            return True
+    return False
+
+
 class DocstringChecker(PylintDocStringChecker):
     """
     A checker for checking docstrings.
@@ -114,9 +149,16 @@ def _check_docstring(self, node_type, node):
         docstring = node.doc
         if docstring is None:
             # The node does not have a docstring.
-            # But do not check things inside a function or method.
-            if not _isInner(node):
-                self.add_message('W9208', node=node)
+            if _isInner(node):
+                # Do not check things inside a function or method.
+                return
+
+            if _isSetter(node_type, node):
+                # Setters don't need a docstring as they are documented in
+                # the getter.
+                return
+
+            self.add_message('W9208', node=node)
             return
         elif not docstring.strip():
             # Empty docstring.
@@ -206,15 +248,46 @@ def _checkEpytext(self, node_type, node, linenoDocstring):
         # The first argument usually named 'self'.
         argnames = (node.argnames()[1:] if node_type == 'method'
                     else node.argnames())
+
+        if _isSetter(node_type, node):
+           # For setter methods we remove the `value` argument as it
+            # does not need to be documented.
+            try:
+                argnames.remove('value')
+            except ValueError:
+                # No `value` in arguments.
+                pass
+
         for argname in argnames:
             if not re.search(r"@param\s+%s\s*:" % argname, node.doc):
                 self.add_message('W9202', line=linenoDocstring,
                                  node=node, args=argname)
             if not re.search(r"@type\s+%s\s*:" % argname, node.doc):
                 self.add_message('W9203', line=linenoDocstring,
                                  node=node, args=argname)
+
+        self._checkReturnValueEpytext(node, linenoDocstring)
+
+
+    def _checkReturnValueEpytext(self, node, linenoDocstring):
+        """
+        Check if return value is documented.
+
+        @param node: current node of pylint
+        @param linenoDocstring: linenumber of docstring
+        """
+        # Getter properties don't need to document their return value,
+        # but then need to have a return value.
+        if '__builtin__.property' in _getDecoratorsName(node):
+            if self._hasReturnValue(node):
+                # Getter properties don't need a docstring.
+                return
+
         # Check for return value.
         if self._hasReturnValue(node):
+            if node.name.startswith('test_'):
+                # Ignore return documentation for test methods.
+                return
             if not re.search(r"@return[s]{0,1}\s*:", node.doc):
                 self.add_message('W9204', line=linenoDocstring, node=node)
             if not re.search(r"@rtype\s*:", node.doc):

twistedchecker/checkers/header.py

@@ -66,5 +66,9 @@ def _checkTestReference(self, text, node):
         @param text: codes of the module
         @param node: node of the module
         """
+        if '.test.' in node.name or '.test_' in node.name:
+            # Test packages or test modules don't need references to tests.
+            return
+
         if not re.search(self.patternTestReference, text):
             self.add_message('W9002', node=node)

twistedchecker/checkers/patch_pylint_format.py

@@ -0,0 +1,29 @@
+"""
+Extension of pylint format checkers.
+"""
+from pylint.checkers.format import FormatChecker
+
+
+def check_lines(self, lines, i):
+    """
+    check lines have less than a maximum number of characters.
+
+    It ignored lines with long URLs.
+    """
+    maxChars = self.config.max_line_length
+    for line in lines.splitlines():
+        if len(line) > maxChars:
+            if 'http://' in line or 'https://' in line:
+                continue
+            self.add_message('C0301', line=i, args=(len(line), maxChars))
+        i += 1
+
+
+
+def patch():
+    """
+    pylint thinks that its default checkers are so special that anybody
+    wants them so there is no clean way to prevent them from being loaded
+    or to unregister them.
+    """
+    FormatChecker.check_lines = check_lines

twistedchecker/checkers/pep8format.py

@@ -278,6 +278,16 @@ def isClassDefDecorator(thing):
             # There should only be 1 line or less between docstrings and
             # the next function
             if previous_is_comment:
+                # Previous is a comment so it has one extra indentation.
+                at_same_indent = previous_indent_level - 4 == indent_level
+                if (
+                    at_same_indent and
+                    logical_line.startswith('def ') and
+                    blank_before == 2
+                        ):
+                    # This look like a previous method with a docstring
+                    # and empty body.
+                    return
                 if blank_before > 1:
                     yield 0, (
                         "E305 too many blank lines after docstring "

twistedchecker/configuration/pylintrc

@@ -63,7 +63,7 @@ function-rgx=((([a-z])|([a-z]+_[a-z]))[a-zA-Z0-9]+)$|(__[a-z]+__)$|(\_.+)$|(test
 # Attribute names should be in mixed case, with the first letter lower case,
 # each word separated by having its first letter capitalized just like method names.
 # And all private names should begin with an underscore.
-attr-rgx=((([a-z_])|([a-z]+_[a-z]))[a-zA-Z0-9]+)$
+attr-rgx=(((([a-z_])|([a-z]+_[a-z]))[a-zA-Z0-9]+)|(([A-Z_][A-Z0-9_]*)))$
 
 # Classes are to be named in mixed case, with the first letter capitalized,
 # each word separated by having its first letter capitalized.

twistedchecker/core/runner.py

@@ -14,6 +14,8 @@
 import twistedchecker
 from twistedchecker.reporters.limited import LimitedReporter
 from twistedchecker.core.exceptionfinder import findAllExceptions
+from twistedchecker.checkers import patch_pylint_format
+
 
 class Runner():
     """
@@ -125,6 +127,9 @@ def registerCheckers(self):
 
         @return: a list of allowed messages
         """
+        # We patch the default pylint format checker.
+        patch_pylint_format.patch()
+
         # add checkers for python 3
         cfgfile = self.linter.cfgfile_parser
         if (cfgfile.has_option("TWISTEDCHECKER", "check-python3") and
@@ -316,6 +321,8 @@ def run(self, args):
             exitCode = 1 if diffCount else 0
             sys.exit(exitCode)
 
+        sys.exit(self.linter.msg_status)
+
 
     def prepareDiff(self):
         """

twistedchecker/functionaltests/attributename_fail.py

@@ -15,5 +15,4 @@ def __init__(self):
         """
         self.foo_bar_zar = None
         self.FooBarZar = None
-        self.FOOBARZAR = None
         self.a = None

twistedchecker/functionaltests/attributename_fail.result

@@ -1,4 +1,3 @@
-19:C0103
 18:C0103
 16:C0103
 17:C0103