Merge pull request #1168 from PyCQA/improve-coverage

improve coverage

Author: asottile

.coveragerc

@@ -73,9 +73,9 @@
 DEFAULT_EXCLUDE = '.svn,CVS,.bzr,.hg,.git,__pycache__,.tox'
 DEFAULT_IGNORE = 'E121,E123,E126,E226,E24,E704,W503,W504'
 try:
-    if sys.platform == 'win32':
+    if sys.platform == 'win32':  # pragma: win32 cover
         USER_CONFIG = os.path.expanduser(r'~\.pycodestyle')
-    else:
+    else:  # pragma: win32 no cover
         USER_CONFIG = os.path.join(
             os.getenv('XDG_CONFIG_HOME') or os.path.expanduser('~/.config'),
             'pycodestyle'
@@ -150,11 +150,11 @@
 DUNDER_REGEX = re.compile(r"^__([^\s]+)__(?::\s*[a-zA-Z.0-9_\[\]\"]+)? = ")
 BLANK_EXCEPT_REGEX = re.compile(r"except\s*:")
 
-if sys.version_info >= (3, 12):
+if sys.version_info >= (3, 12):  # pragma: >=3.12 cover
     FSTRING_START = tokenize.FSTRING_START
     FSTRING_MIDDLE = tokenize.FSTRING_MIDDLE
     FSTRING_END = tokenize.FSTRING_END
-else:
+else:  # pragma: <3.12 cover
     FSTRING_START = FSTRING_MIDDLE = FSTRING_END = -1
 
 _checks = {'physical_line': {}, 'logical_line': {}, 'tree': {}}
@@ -863,14 +863,14 @@ def missing_whitespace(logical_line, tokens):
     for token_type, text, start, end, line in tokens:
         if token_type == tokenize.OP and text in {'[', '(', '{'}:
             brace_stack.append(text)
-        elif token_type == FSTRING_START:
+        elif token_type == FSTRING_START:  # pragma: >=3.12 cover
             brace_stack.append('f')
         elif token_type == tokenize.NAME and text == 'lambda':
             brace_stack.append('l')
         elif brace_stack:
             if token_type == tokenize.OP and text in {']', ')', '}'}:
                 brace_stack.pop()
-            elif token_type == FSTRING_END:
+            elif token_type == FSTRING_END:  # pragma: >=3.12 cover
                 brace_stack.pop()
             elif (
                     brace_stack[-1] == 'l' and
@@ -889,7 +889,7 @@ def missing_whitespace(logical_line, tokens):
                 if text == ':' and brace_stack[-1:] == ['[']:
                     pass
                 # 3.12+ fstring format specifier
-                elif text == ':' and brace_stack[-2:] == ['f', '{']:
+                elif text == ':' and brace_stack[-2:] == ['f', '{']:  # pragma: >=3.12 cover  # noqa: E501
                     pass
                 # tuple (and list for some reason?)
                 elif text == ',' and next_char in ')]':
@@ -1960,7 +1960,7 @@ def build_tokens_line(self):
                 continue
             if token_type == tokenize.STRING:
                 text = mute_string(text)
-            elif token_type == FSTRING_MIDDLE:
+            elif token_type == FSTRING_MIDDLE:  # pragma: >=3.12 cover
                 text = 'x' * len(text)
             if prev_row:
                 (start_row, start_col) = start

pycodestyle.py

@@ -9,3 +9,18 @@ select =
 ignore = E226,E24,W504
 max_line_length = 79
 max_doc_length = 72
+
+[coverage:run]
+plugins = covdefaults
+omit =
+    # TODO: separate the tests from the test data
+    testsuite/E*.py
+    testsuite/W*.py
+    testsuite/latin-1.py
+    testsuite/noqa.py
+    testsuite/python*.py
+    testsuite/utf-8-bom.py
+parallel = true
+
+[coverage:report]
+fail_under = 93

setup.cfg

@@ -40,46 +40,45 @@ def error(self, line_number, offset, text, check):
             self.counters[code] = 1
         detailed_code = '%s:%s:%s' % (code, line_number, offset + 1)
         # Don't care about expected errors or warnings
-        if code in self.expected or detailed_code in self.expected:
-            return
-        self._deferred_print.append(
-            (line_number, offset, detailed_code, text[5:], check.__doc__))
-        self.file_errors += 1
-        self.total_errors += 1
-        return code
+        if code not in self.expected and detailed_code not in self.expected:  # pragma: no cover  # noqa: E501
+            err = (line_number, offset, detailed_code, text[5:], check.__doc__)
+            self._deferred_print.append(err)
+            self.file_errors += 1
+            self.total_errors += 1
+            return code
 
     def get_file_results(self):
         # Check if the expected errors were found
         label = '%s:%s:1' % (self.filename, self.line_offset)
         for extended_code in self.expected:
             code = extended_code.split(':')[0]
-            if not self.counters.get(code):
+            if not self.counters.get(code):  # pragma: no cover
                 self.file_errors += 1
                 self.total_errors += 1
                 print('%s: error %s not found' % (label, extended_code))
             else:
                 self.counters[code] -= 1
         for code, extra in sorted(self.counters.items()):
             if code not in self._benchmark_keys:
-                if extra and code in self.expected:
+                if extra and code in self.expected:  # pragma: no cover
                     self.file_errors += 1
                     self.total_errors += 1
                     print('%s: error %s found too many times (+%d)' %
                           (label, code, extra))
                 # Reset counters
                 del self.counters[code]
-        if self._verbose and not self.file_errors:
+        if self._verbose and not self.file_errors:  # pragma: no cover
             print('%s: passed (%s)' %
                   (label, ' '.join(self.expected) or 'Okay'))
         self.counters['test cases'] += 1
-        if self.file_errors:
+        if self.file_errors:  # pragma: no cover
             self.counters['failed tests'] += 1
         return super(TestReport, self).get_file_results()
 
     def print_results(self):
         results = ("%(physical lines)d lines tested: %(files)d files, "
                    "%(test cases)d test cases%%s." % self.counters)
-        if self.total_errors:
+        if self.total_errors:  # pragma: no cover
             print(results % ", %s failures" % self.total_errors)
         else:
             print(results % "")
@@ -127,20 +126,20 @@ def selftest(options):
             checker.check_all()
             error = None
             if code == 'Okay':
-                if len(counters) > len(options.benchmark_keys):
+                if len(counters) > len(options.benchmark_keys):  # pragma: no cover  # noqa: E501
                     codes = [key for key in counters
                              if key not in options.benchmark_keys]
                     error = "incorrectly found %s" % ', '.join(codes)
-            elif not counters.get(code):
+            elif not counters.get(code):  # pragma: no cover
                 error = "failed to find %s" % code
             # Keep showing errors for multiple tests
             for key in set(counters) - set(options.benchmark_keys):
                 del counters[key]
             count_all += 1
             if not error:
-                if options.verbose:
+                if options.verbose:  # pragma: no cover
                     print("%s: %s" % (code, source))
-            else:
+            else:  # pragma: no cover
                 count_failed += 1
                 print("pycodestyle.py: %s:" % error)
                 for line in checker.lines:
@@ -176,7 +175,7 @@ def run_tests(filename):
         if ver_match:
             test_against_version = tuple(int(val or 0)
                                          for val in ver_match.groups())
-            if sys.version_info < test_against_version:
+            if sys.version_info < test_against_version:  # pragma: no cover
                 return
         lines = readlines(filename) + ['#:\n']
         line_offset = 0
@@ -220,7 +219,7 @@ def run_tests(style):
             count_passed = done_d + done_s - count_failed
             print("%d passed and %d failed." % (count_passed, count_failed))
             print("Test failed." if count_failed else "Test passed.")
-        if count_failed:
+        if count_failed:  # pragma: no cover
             sys.exit(1)
     if options.testsuite:
         init_tests(style)

testsuite/support.py

@@ -12,7 +12,7 @@ def test_E101(self):
             '\tprint(1)  # tabs\n'
             '        print(2)  # spaces\n'
         )
-        if sys.version_info >= (3, 12):
+        if sys.version_info >= (3, 12):  # pragma: >=3.12 cover
             self.assertEqual(errors, ['W191:2:1', 'E901:3:28'])
-        else:
+        else:  # pragma: <3.12 cover
             self.assertEqual(errors, ['W191:2:1', 'E101:3:1'])

testsuite/test_E101.py

@@ -8,9 +8,9 @@
 class E901Test(unittest.TestCase):
     def test_closing_brace(self):
         errors = errors_from_src('}\n')
-        if sys.version_info < (3, 12):
+        if sys.version_info < (3, 12):  # pragma: <3.12 cover
             self.assertEqual(errors, ['E901:2:1'])
-        else:
+        else:  # pragma: >=3.12 cover
             self.assertEqual(errors, [])
 
     def test_unclosed_brace(self):
@@ -22,8 +22,8 @@ def lasting(self, duration=300):
     progress = self._progress.setdefault('foo', {}
 '''
         errors = errors_from_src(src)
-        if sys.version_info < (3, 12):
+        if sys.version_info < (3, 12):  # pragma: <3.12 cover
             expected = ['E122:4:1', 'E251:5:13', 'E251:5:15']
-        else:
+        else:  # pragma: >=3.12 cover
             expected = ['E122:4:1', 'E251:5:13', 'E251:5:15', 'E901:5:1']  # noqa: E501
         self.assertEqual(errors, expected)

testsuite/test_E901.py

@@ -329,11 +329,11 @@ def test_check_nullbytes(self):
         count_errors = pep8style.input_file('stdin', lines=['\x00\n'])
 
         stdout = sys.stdout.getvalue()
-        if sys.version_info < (3, 11, 4):
+        if sys.version_info < (3, 11, 4):  # pragma: <3.11 cover
             expected = ["stdin:1:1: E901 ValueError: source code string cannot contain null bytes"]  # noqa: E501
-        elif sys.version_info < (3, 12):
+        elif sys.version_info < (3, 12):  # pragma: <3.12 cover  # pragma: >=3.11 cover  # noqa: E501
             expected = ["stdin:1:1: E901 SyntaxError: source code string cannot contain null bytes"]  # noqa: E501
-        else:
+        else:  # pragma: >=3.12 cover
             expected = [
                 "stdin:1:1: E901 SyntaxError: source code string cannot contain null bytes",   # noqa: E501
                 "stdin:1:1: E901 TokenError: source code cannot contain null bytes",   # noqa: E501
@@ -353,17 +353,17 @@ def test_styleguide_unmatched_triple_quotes(self):
         pep8style.input_file('stdin', lines=lines)
         stdout = sys.stdout.getvalue()
 
-        if sys.version_info < (3, 10):
+        if sys.version_info < (3, 10):  # pragma: <3.10 cover
             expected = [
                 'stdin:2:5: E901 TokenError: EOF in multi-line string',
                 'stdin:2:26: E901 SyntaxError: EOF while scanning triple-quoted string literal',  # noqa: E501
             ]
-        elif sys.version_info < (3, 12):
+        elif sys.version_info < (3, 12):  # pragma: >=3.10 cover  # pragma: <3.12 cover  # noqa: E501
             expected = [
                 'stdin:2:5: E901 TokenError: EOF in multi-line string',
                 'stdin:2:6: E901 SyntaxError: unterminated triple-quoted string literal (detected at line 2)',  # noqa: E501
             ]
-        else:
+        else:  # pragma: >=3.12 cover
             expected = [
                 'stdin:2:6: E901 SyntaxError: unterminated triple-quoted string literal (detected at line 2)',  # noqa: E501
                 'stdin:2:6: E901 TokenError: EOF in multi-line string',

testsuite/test_api.py

@@ -8,7 +8,9 @@ envlist = py, pypy3
 skip_missing_interpreters = True
 
 [testenv]
-deps = coverage
+deps =
+    covdefaults
+    coverage
 commands =
     python -m pycodestyle --statistics pycodestyle.py
     coverage run -m pycodestyle --max-doc-length=72 --testsuite testsuite