Class Xdoctester

tools/sampcd_processor.py:347–655

A Xdoctest doctester.

class Xdoctester(DocTester):
    """A Xdoctest doctester."""

    directives: dict[str, tuple[type[Directive], ...]] = {
        'timeout': (TimeoutDirective, TEST_TIMEOUT),
        'solo': (SingleProcessDirective,),
    }

    bad_statements: dict[str, tuple[type[BadStatement], ...]] = {
        'fluid': (Fluid,),
        'skip': (SkipNoReason,),
        'require': (DeprecatedRequired,),
    }

    def __init__(
        self,
        debug=False,
        style='freeform',
        target='codeblock',
        mode='native',
        verbose=2,
        patch_global_state=True,
        patch_tensor_place=True,
        patch_float_precision=5,
        use_multiprocessing=True,
        **config,
    ):
        self.debug = debug

        self.style = style
        self.target = target
        self.mode = mode
        self.verbose = verbose
        self.config = XDOCTEST_CONFIG | (config or {})
        self._test_capacity = set()

        self._patch_global_state = patch_global_state
        self._patch_tensor_place = patch_tensor_place
        self._patch_float_precision = patch_float_precision
        self._use_multiprocessing = use_multiprocessing

        # patch xdoctest before `xdoctest.core.parse_docstr_examples`
        self._patch_xdoctest()

        self.docstring_parser = functools.partial(
            xdoctest.core.parse_docstr_examples, style=self.style
        )

        self.directive_pattern = re.compile(
            r"""
            (?<=(\#\s))     # positive lookbehind, directive begins
            (doctest)       # directive prefix, which should be replaced
            (?=(:\s*.*\n))  # positive lookahead, directive content
            """,
            re.VERBOSE,
        )

        self.directive_prefix = 'xdoctest'