Method run

tools/sampcd_processor.py:474–511

Run the xdoctest with a docstring.

(self, api_name: str, docstring: str)

        return bad_results

    def run(self, api_name: str, docstring: str) -> list[TestResult]:
        """Run the xdoctest with a docstring."""
        # check bad statements
        bad_results = self._check_bad_statements(docstring)
        if bad_results:
            for bad_statement in bad_results:
                logger.warning("%s >>> %s", api_name, bad_statement.msg)

            return [
                TestResult(
                    name=api_name,
                    badstatement=True,
                )
            ]

        # parse global directive
        docstring, directives = self._parse_directive(docstring)

        # extract xdoctest examples
        examples_to_test, examples_nocode = self._extract_examples(
            api_name, docstring, **directives
        )

        # run xdoctest
        try:
            result = self._execute_xdoctest(
                examples_to_test, examples_nocode, **directives
            )
        except queue.Empty:
            result = [
                TestResult(
                    name=api_name,
                    timeout=True,
                    time=directives.get('timeout', TEST_TIMEOUT),
                )
            ]

        return result

    def _extract_examples(self, api_name, docstring, **directives):
        """Extract code block examples from docstring."""