Merge pull request #1173 from PyCQA/doctests

convert --doctest to pytest tests

Author: asottile

.gitignore

@@ -1,7 +1,7 @@
 *.egg
 *.egg-info
 *.pyc
-/.coverage
+/.coverage*
 /.tox
 /build/
 /dist

docs/developer.rst

@@ -89,16 +89,16 @@ Several docstrings contain examples directly from the `PEP 8`_ document.
   Okay: spam(ham[1], {eggs: 2})
   E201: spam( ham[1], {eggs: 2})
 
-These examples are verified automatically when ``pycodestyle.py`` is run with
-the ``--doctest`` option.  You can add examples for your own check functions.
+These examples are verified automatically by ``test_self_doctest.py``.
+You can add examples for your own check functions.
 The format is simple: ``"Okay"`` or error/warning code followed by colon and
 space, the rest of the line is example source code.  If you put ``'r'`` before
 the docstring, you can use ``\n`` for newline and ``\t`` for tab.
 
 Then be sure to pass the tests::
 
   $ python pycodestyle.py --testsuite testsuite
-  $ python pycodestyle.py --doctest
+  $ pytest testsuite/test_self_doctest.py
   $ python pycodestyle.py --verbose pycodestyle.py
 
 When contributing to pycodestyle, please observe our `Code of Conduct`_.

pycodestyle.py

@@ -1136,10 +1136,6 @@ def module_imports_on_top_of_file(
     Okay: # this is a comment\nimport os
     Okay: '''this is a module docstring'''\nimport os
     Okay: r'''this is a module docstring'''\nimport os
-    Okay:
-    try:\n\timport x\nexcept ImportError:\n\tpass\nelse:\n\tpass\nimport y
-    Okay:
-    try:\n\timport x\nexcept ImportError:\n\tpass\nfinally:\n\tpass\nimport y
     E402: a=1\nimport os
     E402: 'One string'\n"Two string"\nimport os
     E402: a=1\nfrom sys import x
@@ -1730,15 +1726,6 @@ def expand_indent(line):
     r"""Return the amount of indentation.
 
     Tabs are expanded to the next multiple of 8.
-
-    >>> expand_indent('    ')
-    4
-    >>> expand_indent('\t')
-    8
-    >>> expand_indent('       \t')
-    8
-    >>> expand_indent('        \t')
-    16
     """
     line = line.rstrip('\n\r')
     if '\t' not in line:
@@ -1755,15 +1742,7 @@ def expand_indent(line):
 
 
 def mute_string(text):
-    """Replace contents with 'xxx' to prevent syntax matching.
-
-    >>> mute_string('"abc"')
-    '"xxx"'
-    >>> mute_string("'''abc'''")
-    "'''xxx'''"
-    >>> mute_string("r'abc'")
-    "r'xxx'"
-    """
+    """Replace contents with 'xxx' to prevent syntax matching."""
     # String modifiers (e.g. u or r)
     start = text.index(text[-1]) + 1
     end = len(text) - 1
@@ -2323,7 +2302,7 @@ def __init__(self, *args, **kwargs):
 
         options.select = tuple(options.select or ())
         if not (options.select or options.ignore or
-                options.testsuite or options.doctest) and DEFAULT_IGNORE:
+                options.testsuite) and DEFAULT_IGNORE:
             # The default choice: ignore controversial checks
             options.ignore = tuple(DEFAULT_IGNORE.split(','))
         else:
@@ -2496,8 +2475,6 @@ def get_parser(prog='pycodestyle', version=__version__):
     if os.path.exists(TESTSUITE_PATH):
         group.add_option('--testsuite', metavar='dir',
                          help="run regression tests from dir")
-        group.add_option('--doctest', action='store_true',
-                         help="run doctest on myself")
     group.add_option('--benchmark', action='store_true',
                      help="measure processing speed")
     return parser
@@ -2574,7 +2551,7 @@ def read_config(options, args, arglist, parser):
 
         # Third, overwrite with the command-line options
         (options, __) = parser.parse_args(arglist, values=new_options)
-    options.doctest = options.testsuite = False
+    options.testsuite = False
     return options
 
 
@@ -2609,7 +2586,7 @@ def process_options(arglist=None, parse_argv=False, config_file=None,
 
     if options.ensure_value('testsuite', False):
         args.append(options.testsuite)
-    elif not options.ensure_value('doctest', False):
+    else:
         if parse_argv and not args:
             if options.diff or any(os.path.exists(name)
                                    for name in PROJECT_CONFIG):
@@ -2662,7 +2639,7 @@ def _main():
     style_guide = StyleGuide(parse_argv=True)
     options = style_guide.options
 
-    if options.doctest or options.testsuite:
+    if options.testsuite:
         from testsuite.support import run_tests
         report = run_tests(style_guide)
     else:

testing/__init__.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+from pycodestyle import BaseReport
+from pycodestyle import StyleGuide
+
+
+class InMemoryReport(BaseReport):
+    """
+    Collect the results in memory, without printing anything.
+    """
+
+    def __init__(self, options):
+        super().__init__(options)
+        self.in_memory_errors = []
+
+    def error(self, line_number, offset, text, check):
+        """
+        Report an error, according to options.
+        """
+        code = text[:4]
+        self.in_memory_errors.append(f'{code}:{line_number}:{offset + 1}')
+        return super().error(line_number, offset, text, check)
+
+
+def errors_from_src(src: str) -> list[str]:
+    guide = StyleGuide(select=('E', 'W'))
+    reporter = guide.init_report(InMemoryReport)
+    guide.input_file(
+        filename='in-memory-test-file.py',
+        lines=src.splitlines(True),
+    )
+    return reporter.in_memory_errors

testing/support.py

@@ -4,11 +4,8 @@
 import re
 import sys
 
-from pycodestyle import BaseReport
-from pycodestyle import Checker
 from pycodestyle import readlines
 from pycodestyle import StandardReport
-from pycodestyle import StyleGuide
 
 SELFTEST_REGEX = re.compile(r'\b(Okay|[EW]\d{3}):\s(.*)')
 ROOT_DIR = os.path.dirname(os.path.dirname(__file__))
@@ -87,68 +84,6 @@ def print_results(self):
         print("Test failed." if self.total_errors else "Test passed.")
 
 
-class InMemoryReport(BaseReport):
-    """
-    Collect the results in memory, without printing anything.
-    """
-
-    def __init__(self, options):
-        super().__init__(options)
-        self.in_memory_errors = []
-
-    def error(self, line_number, offset, text, check):
-        """
-        Report an error, according to options.
-        """
-        code = text[:4]
-        self.in_memory_errors.append('{}:{}:{}'.format(
-            code, line_number, offset + 1))
-        return super().error(
-            line_number, offset, text, check)
-
-
-def selftest(options):
-    """
-    Test all check functions with test cases in docstrings.
-    """
-    count_failed = count_all = 0
-    report = BaseReport(options)
-    counters = report.counters
-    checks = options.physical_checks + options.logical_checks
-    for name, check, argument_names in checks:
-        for line in check.__doc__.splitlines():
-            line = line.lstrip()
-            match = SELFTEST_REGEX.match(line)
-            if match is None:
-                continue
-            code, source = match.groups()
-            lines = [part.replace(r'\t', '\t') + '\n'
-                     for part in source.split(r'\n')]
-            checker = Checker(lines=lines, options=options, report=report)
-            checker.check_all()
-            error = None
-            if code == 'Okay':
-                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):  # 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:  # pragma: no cover
-                    print(f"{code}: {source}")
-            else:  # pragma: no cover
-                count_failed += 1
-                print("pycodestyle.py: %s:" % error)
-                for line in checker.lines:
-                    print(line.rstrip())
-    return count_failed, count_all
-
-
 def init_tests(pep8style):
     """
     Initialize testing framework.
@@ -211,28 +146,6 @@ def run_tests(filename):
 
 
 def run_tests(style):
-    options = style.options
-    if options.doctest:
-        import doctest
-        fail_d, done_d = doctest.testmod(report=False, verbose=options.verbose)
-        fail_s, done_s = selftest(options)
-        count_failed = fail_s + fail_d
-        if not options.quiet:
-            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:  # pragma: no cover
-            sys.exit(1)
-    if options.testsuite:
+    if style.options.testsuite:
         init_tests(style)
     return style.check_files()
-
-
-def errors_from_src(src: str) -> list[str]:
-    guide = StyleGuide()
-    reporter = guide.init_report(InMemoryReport)
-    guide.input_file(
-        filename='in-memory-test-file.py',
-        lines=src.splitlines(True),
-    )
-    return reporter.in_memory_errors

testsuite/support.py

@@ -2,7 +2,7 @@
 import sys
 import unittest
 
-from testsuite.support import errors_from_src
+from testing.support import errors_from_src
 
 
 class E101Test(unittest.TestCase):

testsuite/test_E101.py

@@ -2,7 +2,7 @@
 import sys
 import unittest
 
-from testsuite.support import errors_from_src
+from testing.support import errors_from_src
 
 
 class E901Test(unittest.TestCase):

testsuite/test_E901.py

@@ -4,7 +4,6 @@
 import pycodestyle
 from testsuite.support import init_tests
 from testsuite.support import ROOT_DIR
-from testsuite.support import selftest
 
 
 class PycodestyleTestCase(unittest.TestCase):
@@ -15,19 +14,6 @@ def setUp(self):
             paths=[os.path.join(ROOT_DIR, 'testsuite')],
             select='E,W', quiet=True)
 
-    def test_doctest(self):
-        import doctest
-        fail_d, done_d = doctest.testmod(
-            pycodestyle, verbose=False, report=False
-        )
-        self.assertTrue(done_d, msg='tests not found')
-        self.assertFalse(fail_d, msg='%s failure(s)' % fail_d)
-
-    def test_selftest(self):
-        fail_s, done_s = selftest(self._style.options)
-        self.assertTrue(done_s, msg='tests not found')
-        self.assertFalse(fail_s, msg='%s failure(s)' % fail_s)
-
     def test_checkers_testsuite(self):
         init_tests(self._style)
         report = self._style.check_files()

testsuite/test_all.py

@@ -148,7 +148,7 @@ def test_styleguide_options(self):
 
         # Check unset options
         for o in ('benchmark', 'config', 'count', 'diff',
-                  'doctest', 'quiet', 'show_pep8', 'show_source',
+                  'quiet', 'show_pep8', 'show_source',
                   'statistics', 'testsuite', 'verbose'):
             oval = getattr(pep8style.options, o)
             self.assertTrue(oval in (None, False), msg=f'{o} = {oval!r}')
@@ -183,10 +183,6 @@ def parse_argv(argstring):
             ('E121', 'E123', 'E126', 'E226', 'E24', 'E704', 'W503', 'W504')
         )
 
-        options = parse_argv('--doctest').options
-        self.assertEqual(options.select, ())
-        self.assertEqual(options.ignore, ())
-
         options = parse_argv('--ignore E,W').options
         self.assertEqual(options.select, ())
         self.assertEqual(options.ignore, ('E', 'W'))