Make D403 weaker to avoid false positives

Author: Nurdok

src/pep257.py

@@ -14,6 +14,7 @@
 from __future__ import with_statement
 
 import os
+import string
 import sys
 import ast
 import copy
@@ -152,6 +153,10 @@ class Module(Definition):
     module = property(lambda self: self)
     all = property(lambda self: self._all)
 
+    def __init__(self, *args, **kwargs):
+        super(Module, self).__init__(*args, **kwargs)
+        self.name = self.name.lower()
+
     def __str__(self):
         return 'at module level'
 
@@ -1618,6 +1623,11 @@ def check_capitalized(self, function, docstring):
         """
         if docstring:
             first_word = ast.literal_eval(docstring).split()[0]
+            if first_word == first_word.upper():
+                return
+            for char in first_word:
+                if char not in string.ascii_letters and char != "'":
+                    return
             if first_word != first_word.capitalize():
                 return D403(first_word.capitalize(), first_word)
 

src/tests/test_cases/capitalization.py

@@ -18,7 +18,43 @@ def empty_docstring():
     """"""
 
 
-@expect("D403: First word of the first line should be properly capitalized "
-        "('Get', not 'GET')")
 def all_caps():
     """GET the request."""
+
+
+def non_letter_characters():
+    """Create/Edit the doodli-do."""
+
+
+def more_non_letter_characters():
+    """(Un)register the user."""
+
+
+def even_more_non_letter():
+    """'laser' the planet."""
+
+
+def dash():
+    """git-push it."""
+
+
+def digit_in_word():
+    """sha1 the string."""
+
+
+@expect("D403: First word of the first line should be properly capitalized "
+        "(\"Don't\", not \"Don'T\")")
+def partial_caps():
+    """Don'T do that."""
+
+
+@expect("D403: First word of the first line should be properly capitalized "
+        "('Return', not 'ReTurn')")
+def more_partial_caps():
+    """ReTurn the field."""
+
+
+@expect("D403: First word of the first line should be properly capitalized "
+        "('A', not 'a')")
+def just_one_more_example():
+    """a function."""

src/tests/test_cases/test.py

@@ -303,5 +303,5 @@ def inner_function():
         """Do inner something."""
         return 0
 
-expect(__file__ if __file__[-1] != 'c' else __file__[:-1],
+expect(__file__.lower() if __file__[-1] != 'c' else __file__[:-1].lower(),
        'D100: Missing docstring in public module')