xdoctest
  • Package layout
    • Subpackages
      • xdoctest.docstr package
        • Submodules
          • xdoctest.docstr.docscrape_google module
            • DocBlock
              • DocBlock._asdict()
              • DocBlock._field_defaults
              • DocBlock._fields
              • DocBlock._make()
              • DocBlock._replace()
              • DocBlock.offset
              • DocBlock.text
            • split_google_docblocks()
            • parse_google_args()
            • parse_google_returns()
            • parse_google_retblock()
            • parse_google_argblock()
          • xdoctest.docstr.docscrape_numpy module
        • Module contents
          • parse_google_argblock()
          • parse_google_args()
          • parse_google_retblock()
          • parse_google_returns()
          • split_google_docblocks()
      • xdoctest.utils package
        • Submodules
          • xdoctest.utils.util_deprecation module
            • schedule_deprecation()
          • xdoctest.utils.util_import module
            • is_modname_importable()
            • _importlib_import_modpath()
            • _pkgutil_modname_to_modpath()
            • PythonPathContext
            • _custom_import_modpath()
            • import_module_from_path()
            • import_module_from_name()
            • _parse_static_node_value()
            • _extension_module_tags()
            • _static_parse()
            • _platform_pylib_exts()
            • _syspath_modname_to_modpath()
            • modname_to_modpath()
            • normalize_modpath()
            • modpath_to_modname()
            • split_modpath()
          • xdoctest.utils.util_misc module
            • TempDoctest
            • TempModule
              • TempModule.print_contents()
            • _run_case()
          • xdoctest.utils.util_mixins module
            • NiceRepr
          • xdoctest.utils.util_notebook module
            • _find_notebook()
            • CellDeleter
              • CellDeleter.visit()
            • NotebookLoader
              • NotebookLoader.default_options
              • NotebookLoader.load_module()
            • import_notebook_from_path()
            • execute_notebook()
            • _make_test_notebook_fpath()
          • xdoctest.utils.util_path module
            • TempDir
              • TempDir.ensure()
              • TempDir.cleanup()
            • ensuredir()
          • xdoctest.utils.util_str module
            • strip_ansi()
            • color_text()
            • ensure_unicode()
            • indent()
            • highlight_code()
            • add_line_numbers()
            • codeblock()
          • xdoctest.utils.util_stream module
            • TeeStringIO
              • TeeStringIO.isatty()
              • TeeStringIO.fileno()
              • TeeStringIO.encoding
              • TeeStringIO.write()
              • TeeStringIO.flush()
            • CaptureStream
            • CaptureStdout
              • CaptureStdout.log_part()
              • CaptureStdout.start()
              • CaptureStdout.stop()
              • CaptureStdout.close()
        • Module contents
          • CaptureStdout
            • CaptureStdout.close()
            • CaptureStdout.log_part()
            • CaptureStdout.start()
            • CaptureStdout.stop()
          • CaptureStream
          • NiceRepr
          • PythonPathContext
          • TeeStringIO
            • TeeStringIO.encoding
            • TeeStringIO.fileno()
            • TeeStringIO.flush()
            • TeeStringIO.isatty()
            • TeeStringIO.write()
          • TempDir
            • TempDir.cleanup()
            • TempDir.ensure()
          • TempDoctest
          • add_line_numbers()
          • codeblock()
          • color_text()
          • ensure_unicode()
          • ensuredir()
          • highlight_code()
          • import_module_from_name()
          • import_module_from_path()
          • indent()
          • is_modname_importable()
          • modname_to_modpath()
          • modpath_to_modname()
          • normalize_modpath()
          • split_modpath()
          • strip_ansi()
    • Submodules
      • xdoctest.__main__ module
        • main()
      • xdoctest._tokenize module
        • ISTERMINAL()
        • ISNONTERMINAL()
        • ISEOF()
        • tokenize()
        • generate_tokens()
        • detect_encoding()
        • untokenize()
        • TokenInfo
          • TokenInfo.exact_type
      • xdoctest.checker module
        • check_got_vs_want()
        • _strip_exception_details()
        • extract_exc_want()
        • check_exception()
        • check_output()
        • _check_match()
        • _ellipsis_match()
        • normalize()
        • ExtractGotReprException
        • GotWantException
          • GotWantException._do_a_fancy_diff()
          • GotWantException.output_difference()
          • GotWantException.output_repr_difference()
        • remove_blankline_marker()
      • xdoctest.constants module
        • _NOT_EVAL_TYPE
      • xdoctest.core module
        • parse_freeform_docstr_examples()
        • parse_google_docstr_examples()
        • parse_auto_docstr_examples()
        • parse_docstr_examples()
        • _rectify_to_modpath()
        • package_calldefs()
        • parse_calldefs()
        • parse_doctestables()
      • xdoctest.demo module
        • myfunc()
        • MyClass
          • MyClass.demo()
          • MyClass.always_fails()
      • xdoctest.directive module
        • Basic Directives
        • Advanced Directives
        • named()
        • Effect
          • Effect._asdict()
          • Effect._field_defaults
          • Effect._fields
          • Effect._make()
          • Effect._replace()
          • Effect.action
          • Effect.key
          • Effect.value
        • RuntimeState
          • RuntimeState.to_dict()
          • RuntimeState.set_report_style()
          • RuntimeState.update()
        • Directive
          • Directive.extract()
          • Directive._unpack_args()
          • Directive.effect()
          • Directive.effects()
        • _split_opstr()
        • _is_requires_satisfied()
        • _module_exists()
        • parse_directive_optstr()
      • xdoctest.doctest_example module
        • DoctestConfig
          • DoctestConfig._populate_from_cli()
          • DoctestConfig._update_argparse_cli()
          • DoctestConfig.getvalue()
        • DocTest
          • DocTest.UNKNOWN_MODNAME
          • DocTest.UNKNOWN_MODPATH
          • DocTest.UNKNOWN_CALLNAME
          • DocTest.UNKNOWN_FPATH
          • DocTest.is_disabled()
          • DocTest.unique_callname
          • DocTest.node
          • DocTest.valid_testnames
          • DocTest.wants()
          • DocTest.format_parts()
          • DocTest.format_src()
          • DocTest._parse()
          • DocTest._import_module()
          • DocTest._extract_future_flags()
          • DocTest._test_globals()
          • DocTest.anything_ran()
          • DocTest.run()
          • DocTest.globs
          • DocTest.cmdline
          • DocTest._block_prefix
          • DocTest._pre_run()
          • DocTest.failed_line_offset()
          • DocTest.failed_lineno()
          • DocTest.repr_failure()
          • DocTest._print_captured()
          • DocTest._color()
          • DocTest._post_run()
        • _traverse_traceback()
      • xdoctest.doctest_part module
        • DoctestPart
          • DoctestPart.n_lines
          • DoctestPart.n_exec_lines
          • DoctestPart.n_want_lines
          • DoctestPart.source
          • DoctestPart.compilable_source()
          • DoctestPart.has_any_code()
          • DoctestPart.directives
          • DoctestPart.want
          • DoctestPart.check()
          • DoctestPart.format_part()
      • xdoctest.dynamic_analysis module
        • parse_dynamic_calldefs()
        • get_stack_frame()
        • get_parent_frame()
        • iter_module_doctestables()
        • is_defined_by_module()
      • xdoctest.exceptions module
        • MalformedDocstr
        • ExistingEventLoopError
        • DoctestParseError
        • ExitTestException
        • IncompleteParseError
        • _pytest
          • _pytest.outcomes
            • _pytest.outcomes.Skipped
      • xdoctest.global_state module
        • _boolean_environ()
      • xdoctest.parser module
        • The XDoctest Parser
        • DoctestParser
          • DoctestParser.parse()
          • DoctestParser._package_groups()
          • DoctestParser._package_chunk()
          • DoctestParser._group_labeled_lines()
          • DoctestParser._locate_ps1_linenos()
          • DoctestParser._label_docsrc_lines()
        • _min_indentation()
        • _complete_source()
        • _iterthree()
        • _hasprefix()
      • xdoctest.plugin module
      • xdoctest.runner module
        • The Native XDoctest Runner
        • Using the XDoctest Runner via the Terminal
        • Using the XDoctest Runner Programmatically
        • log()
        • doctest_callable()
        • gather_doctests()
        • doctest_module()
        • _auto_disable_failing_tests_hook()
        • _convert_to_test_module()
        • undefined_names()
        • _print_summary_report()
        • _gather_zero_arg_examples()
        • _run_examples()
        • _parse_commandline()
        • _update_argparse_cli()
      • xdoctest.static_analysis module
        • CallDefNode
        • TopLevelVisitor
          • TopLevelVisitor.parse()
          • TopLevelVisitor.syntax_tree()
          • TopLevelVisitor.process_finished()
          • TopLevelVisitor.visit()
          • TopLevelVisitor.visit_FunctionDef()
          • TopLevelVisitor.visit_ClassDef()
          • TopLevelVisitor.visit_Module()
          • TopLevelVisitor.visit_Assign()
          • TopLevelVisitor.visit_If()
          • TopLevelVisitor._docnode_line_workaround()
          • TopLevelVisitor._find_docstr_endpos_workaround()
          • TopLevelVisitor._find_docstr_startpos_workaround()
          • TopLevelVisitor._get_docstring()
          • TopLevelVisitor._workaround_func_lineno()
        • parse_static_calldefs()
        • parse_calldefs()
        • _parse_static_node_value()
        • parse_static_value()
        • package_modpaths()
        • is_balanced_statement()
        • extract_comments()
        • _strip_hashtag_comments_and_newlines()
        • six_axt_parse()
    • Module contents
      • Xdoctest - Execute Doctests
        • Getting Started 0: Installation
        • Getting Started 1: Your first doctest
        • Getting Started 2: Running your doctests
          • Using the pytest interface
          • Using the native interface.
      • DoctestParseError
      • ExitTestException
      • MalformedDocstr
      • ExistingEventLoopError
      • doctest_module()
      • doctest_callable()
  • Running Doctests in Jupyter Notebooks
    • Method 1 - Inside the notebook
    • Method 2 - Outside the notebook
    • Caveats
  • Doctests with async code
    • Caveats
xdoctest
  • Python Module Index

Python Module Index

x
 
x
- xdoctest
    xdoctest.__init__
    xdoctest.__main__
    xdoctest._tokenize
    xdoctest.checker
    xdoctest.constants
    xdoctest.core
    xdoctest.demo
    xdoctest.directive
    xdoctest.docstr
    xdoctest.docstr.docscrape_google
    xdoctest.docstr.docscrape_numpy
    xdoctest.doctest_example
    xdoctest.doctest_part
    xdoctest.dynamic_analysis
    xdoctest.exceptions
    xdoctest.global_state
    xdoctest.parser
    xdoctest.runner
    xdoctest.static_analysis
    xdoctest.utils
    xdoctest.utils.util_deprecation
    xdoctest.utils.util_import
    xdoctest.utils.util_misc
    xdoctest.utils.util_mixins
    xdoctest.utils.util_notebook
    xdoctest.utils.util_path
    xdoctest.utils.util_str
    xdoctest.utils.util_stream

© Copyright 2025, Jon Crall.

Built with Sphinx using a theme provided by Read the Docs.