Replace codes E111/2/3 with E114/5/6 for indentation of comments; issue #274

Author: florentx

CHANGES.txt

@@ -9,6 +9,9 @@ Changelog
 
 * Report E704 for one-liner def instead of E701. (Issue #277)
 
+* Replace codes E111, E112 and E113 with codes E114, E115 and E116
+  for wrong indentation of comments. (Issue #274)
+
 
 1.5.7 (2014-05-29)
 ------------------

docs/intro.rst

@@ -194,6 +194,12 @@ This is the current list of error and warning codes:
 +----------+----------------------------------------------------------------------+
 | E113     | unexpected indentation                                               |
 +----------+----------------------------------------------------------------------+
+| E114     | indentation is not a multiple of four (comment)                      |
++----------+----------------------------------------------------------------------+
+| E115     | expected an indented block (comment)                                 |
++----------+----------------------------------------------------------------------+
+| E116     | unexpected indentation (comment)                                     |
++----------+----------------------------------------------------------------------+
 +----------+----------------------------------------------------------------------+
 | E121 (^) | continuation line under-indented for hanging indent                  |
 +----------+----------------------------------------------------------------------+

pep8.py

@@ -353,20 +353,25 @@ def indentation(logical_line, previous_logical, indent_char,
     Okay: a = 1
     Okay: if a == 0:\n    a = 1
     E111:   a = 1
+    E114:   # a = 1
 
     Okay: for item in items:\n    pass
     E112: for item in items:\npass
+    E115: for item in items:\n# Hi\n    pass
 
     Okay: a = 1\nb = 2
     E113: a = 1\n    b = 2
+    E116: a = 1\n    # b = 2
     """
-    if indent_char == ' ' and indent_level % 4:
-        yield 0, "E111 indentation is not a multiple of four"
+    c = 0 if logical_line else 3
+    tmpl = "E11%d %s" if logical_line else "E11%d %s (comment)"
+    if indent_level % 4:
+        yield 0, tmpl % (1 + c, "indentation is not a multiple of four")
     indent_expect = previous_logical.endswith(':')
     if indent_expect and indent_level <= previous_indent_level:
-        yield 0, "E112 expected an indented block"
-    if indent_level > previous_indent_level and not indent_expect:
-        yield 0, "E113 unexpected indentation"
+        yield 0, tmpl % (2 + c, "expected an indented block")
+    elif not indent_expect and indent_level > previous_indent_level:
+        yield 0, tmpl % (3 + c, "unexpected indentation")
 
 
 def continued_indentation(logical_line, tokens, indent_level, hang_closing,

testsuite/E11.py

@@ -10,7 +10,27 @@
 #: E113
 print
     print
-#: E111 E113
+#: E114 E116
 mimetype = 'application/x-directory'
      # 'httpd/unix-directory'
 create_date = False
+#: E116 E116 E116
+def start(self):
+    if True:
+        self.master.start()
+        # try:
+            # self.master.start()
+        # except MasterExit:
+            # self.shutdown()
+        # finally:
+            # sys.exit()
+#: E115 E115 E115 E115 E115 E115
+def start(self):
+    if True:
+#       try:
+#           self.master.start()
+#       except MasterExit:
+#           self.shutdown()
+#       finally:
+#           sys.exit()
+        self.master.start()

testsuite/test_api.py

@@ -124,15 +124,15 @@ def test_styleguide(self):
         report = pep8.StyleGuide().check_files([E11])
         stdout = sys.stdout.getvalue().splitlines()
         self.assertEqual(len(stdout), report.total_errors)
-        self.assertEqual(report.total_errors, 6)
+        self.assertEqual(report.total_errors, 17)
         self.assertFalse(sys.stderr)
         self.reset()
 
         # Passing the paths in the constructor gives same result
         report = pep8.StyleGuide(paths=[E11]).check_files()
         stdout = sys.stdout.getvalue().splitlines()
         self.assertEqual(len(stdout), report.total_errors)
-        self.assertEqual(report.total_errors, 6)
+        self.assertEqual(report.total_errors, 17)
         self.assertFalse(sys.stderr)
         self.reset()
 

testsuite/test_shell.py

@@ -75,7 +75,7 @@ def test_check_simple(self):
         stdout = stdout.splitlines()
         self.assertEqual(errcode, 1)
         self.assertFalse(stderr)
-        self.assertEqual(len(stdout), 6)
+        self.assertEqual(len(stdout), 17)
         for line, num, col in zip(stdout, (3, 6, 9, 12), (3, 6, 1, 5)):
             path, x, y, msg = line.split(':')
             self.assertTrue(path.endswith(E11))