Index

A

action (xdoctest.directive.Effect attribute) add_line_numbers() (in module xdoctest.utils) (in module xdoctest.utils.util_str)

always_fails() (xdoctest.demo.MyClass static method) anything_ran() (xdoctest.doctest_example.DocTest method)

C

CallDefNode (class in xdoctest.static_analysis) CaptureStdout (class in xdoctest.utils) (class in xdoctest.utils.util_stream) CaptureStream (class in xdoctest.utils) (class in xdoctest.utils.util_stream) CellDeleter (class in xdoctest.utils.util_notebook) check() (xdoctest.doctest_part.DoctestPart method) check_exception() (in module xdoctest.checker) check_got_vs_want() (in module xdoctest.checker) check_output() (in module xdoctest.checker)

cleanup() (xdoctest.utils.TempDir method) (xdoctest.utils.util_path.TempDir method) close() (xdoctest.utils.CaptureStdout method) (xdoctest.utils.util_stream.CaptureStdout method) cmdline (xdoctest.doctest_example.DocTest property) codeblock() (in module xdoctest.utils) (in module xdoctest.utils.util_str) color_text() (in module xdoctest.utils) (in module xdoctest.utils.util_str) compilable_source() (xdoctest.doctest_part.DoctestPart method)

D

default_options (xdoctest.utils.util_notebook.NotebookLoader attribute) demo() (xdoctest.demo.MyClass class method) Directive (class in xdoctest.directive) directives (xdoctest.doctest_part.DoctestPart property) DocBlock (class in xdoctest.docstr.docscrape_google) DocTest (class in xdoctest.doctest_example) doctest_callable() (in module xdoctest) (in module xdoctest.runner)

doctest_module() (in module xdoctest) (in module xdoctest.runner) DoctestConfig (class in xdoctest.doctest_example) DoctestParseError, [1] DoctestParser (class in xdoctest.parser) DoctestPart (class in xdoctest.doctest_part)

E

Effect (class in xdoctest.directive) effect() (xdoctest.directive.Directive method) effects() (xdoctest.directive.Directive method) encoding (xdoctest.utils.TeeStringIO property) (xdoctest.utils.util_stream.TeeStringIO property) ensure() (xdoctest.utils.TempDir method) (xdoctest.utils.util_path.TempDir method) ensure_unicode() (in module xdoctest.utils) (in module xdoctest.utils.util_str)

ensuredir() (in module xdoctest.utils) (in module xdoctest.utils.util_path) execute_notebook() (in module xdoctest.utils.util_notebook) ExitTestException, [1] extract() (xdoctest.directive.Directive class method) extract_comments() (in module xdoctest.static_analysis) extract_exc_want() (in module xdoctest.checker) ExtractGotReprException

F

failed_line_offset() (xdoctest.doctest_example.DocTest method) failed_lineno() (xdoctest.doctest_example.DocTest method) fileno() (xdoctest.utils.TeeStringIO method) (xdoctest.utils.util_stream.TeeStringIO method)

flush() (xdoctest.utils.TeeStringIO method) (xdoctest.utils.util_stream.TeeStringIO method) format_part() (xdoctest.doctest_part.DoctestPart method) format_parts() (xdoctest.doctest_example.DocTest method) format_src() (xdoctest.doctest_example.DocTest method)

G

gather_doctests() (in module xdoctest.runner) get_parent_frame() (in module xdoctest.dynamic_analysis) get_stack_frame() (in module xdoctest.dynamic_analysis)

getvalue() (xdoctest.doctest_example.DoctestConfig method) globs (xdoctest.doctest_example.DocTest property) GotWantException

H

has_any_code() (xdoctest.doctest_part.DoctestPart method)

highlight_code() (in module xdoctest.utils) (in module xdoctest.utils.util_str)

I

import_module_from_name() (in module xdoctest.utils) (in module xdoctest.utils.util_import) import_module_from_path() (in module xdoctest.utils) (in module xdoctest.utils.util_import) import_notebook_from_path() (in module xdoctest.utils.util_notebook) IncompleteParseError indent() (in module xdoctest.utils) (in module xdoctest.utils.util_str)

is_balanced_statement() (in module xdoctest.static_analysis) is_defined_by_module() (in module xdoctest.dynamic_analysis) is_disabled() (xdoctest.doctest_example.DocTest method) is_modname_importable() (in module xdoctest.utils) (in module xdoctest.utils.util_import) isatty() (xdoctest.utils.TeeStringIO method) (xdoctest.utils.util_stream.TeeStringIO method) iter_module_doctestables() (in module xdoctest.dynamic_analysis)

K

key (xdoctest.directive.Effect attribute)

L

load_module() (xdoctest.utils.util_notebook.NotebookLoader method) log() (in module xdoctest.runner)

log_part() (xdoctest.utils.CaptureStdout method) (xdoctest.utils.util_stream.CaptureStdout method)

M

MalformedDocstr, [1] modname_to_modpath() (in module xdoctest.utils) (in module xdoctest.utils.util_import) modpath_to_modname() (in module xdoctest.utils) (in module xdoctest.utils.util_import) module xdoctest xdoctest.__init__ 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

MyClass (class in xdoctest.demo) myfunc() (in module xdoctest.demo)

N

n_exec_lines (xdoctest.doctest_part.DoctestPart property) n_lines (xdoctest.doctest_part.DoctestPart property) n_want_lines (xdoctest.doctest_part.DoctestPart property) named() (in module xdoctest.directive) NiceRepr (class in xdoctest.utils) (class in xdoctest.utils.util_mixins)

node (xdoctest.doctest_example.DocTest property) normalize() (in module xdoctest.checker) normalize_modpath() (in module xdoctest.utils) (in module xdoctest.utils.util_import) NotebookLoader (class in xdoctest.utils.util_notebook)

O

offset (xdoctest.docstr.docscrape_google.DocBlock attribute)

output_difference() (xdoctest.checker.GotWantException method) output_repr_difference() (xdoctest.checker.GotWantException method)

P

package_calldefs() (in module xdoctest.core) package_modpaths() (in module xdoctest.static_analysis) parse() (xdoctest.parser.DoctestParser method) (xdoctest.static_analysis.TopLevelVisitor class method) parse_auto_docstr_examples() (in module xdoctest.core) parse_calldefs() (in module xdoctest.core) (in module xdoctest.static_analysis) parse_directive_optstr() (in module xdoctest.directive) parse_docstr_examples() (in module xdoctest.core) parse_doctestables() (in module xdoctest.core) parse_dynamic_calldefs() (in module xdoctest.dynamic_analysis) parse_freeform_docstr_examples() (in module xdoctest.core) parse_google_argblock() (in module xdoctest.docstr) (in module xdoctest.docstr.docscrape_google)

parse_google_args() (in module xdoctest.docstr) (in module xdoctest.docstr.docscrape_google) parse_google_docstr_examples() (in module xdoctest.core) parse_google_retblock() (in module xdoctest.docstr) (in module xdoctest.docstr.docscrape_google) parse_google_returns() (in module xdoctest.docstr) (in module xdoctest.docstr.docscrape_google) parse_static_calldefs() (in module xdoctest.static_analysis) parse_static_value() (in module xdoctest.static_analysis) print_contents() (xdoctest.utils.util_misc.TempModule method) process_finished() (xdoctest.static_analysis.TopLevelVisitor method) PythonPathContext (class in xdoctest.utils) (class in xdoctest.utils.util_import)

R

remove_blankline_marker() (in module xdoctest.checker) repr_failure() (xdoctest.doctest_example.DocTest method)

run() (xdoctest.doctest_example.DocTest method) RuntimeState (class in xdoctest.directive)

S

schedule_deprecation() (in module xdoctest.utils.util_deprecation) set_report_style() (xdoctest.directive.RuntimeState method) six_axt_parse() (in module xdoctest.static_analysis) source (xdoctest.doctest_part.DoctestPart property) split_google_docblocks() (in module xdoctest.docstr) (in module xdoctest.docstr.docscrape_google) split_modpath() (in module xdoctest.utils) (in module xdoctest.utils.util_import)

start() (xdoctest.utils.CaptureStdout method) (xdoctest.utils.util_stream.CaptureStdout method) stop() (xdoctest.utils.CaptureStdout method) (xdoctest.utils.util_stream.CaptureStdout method) strip_ansi() (in module xdoctest.utils) (in module xdoctest.utils.util_str) syntax_tree() (xdoctest.static_analysis.TopLevelVisitor method)

T

TeeStringIO (class in xdoctest.utils) (class in xdoctest.utils.util_stream) TempDir (class in xdoctest.utils) (class in xdoctest.utils.util_path) TempDoctest (class in xdoctest.utils) (class in xdoctest.utils.util_misc)

TempModule (class in xdoctest.utils.util_misc) text (xdoctest.docstr.docscrape_google.DocBlock attribute) to_dict() (xdoctest.directive.RuntimeState method) TopLevelVisitor (class in xdoctest.static_analysis)

U

undefined_names() (in module xdoctest.runner) unique_callname (xdoctest.doctest_example.DocTest property) UNKNOWN_CALLNAME (xdoctest.doctest_example.DocTest attribute)

UNKNOWN_FPATH (xdoctest.doctest_example.DocTest attribute) UNKNOWN_MODNAME (xdoctest.doctest_example.DocTest attribute) UNKNOWN_MODPATH (xdoctest.doctest_example.DocTest attribute) update() (xdoctest.directive.RuntimeState method)

V

valid_testnames (xdoctest.doctest_example.DocTest property) value (xdoctest.directive.Effect attribute) visit() (xdoctest.static_analysis.TopLevelVisitor method) (xdoctest.utils.util_notebook.CellDeleter method)

visit_Assign() (xdoctest.static_analysis.TopLevelVisitor method) visit_ClassDef() (xdoctest.static_analysis.TopLevelVisitor method) visit_FunctionDef() (xdoctest.static_analysis.TopLevelVisitor method) visit_If() (xdoctest.static_analysis.TopLevelVisitor method) visit_Module() (xdoctest.static_analysis.TopLevelVisitor method)

W

want (xdoctest.doctest_part.DoctestPart property) wants() (xdoctest.doctest_example.DocTest method)

write() (xdoctest.utils.TeeStringIO method) (xdoctest.utils.util_stream.TeeStringIO method)

X

xdoctest module xdoctest.__init__ module xdoctest.checker module xdoctest.constants module xdoctest.core module xdoctest.demo module xdoctest.directive module xdoctest.docstr module xdoctest.docstr.docscrape_google module xdoctest.docstr.docscrape_numpy module xdoctest.doctest_example module xdoctest.doctest_part module xdoctest.dynamic_analysis module xdoctest.exceptions module

xdoctest.global_state module xdoctest.parser module xdoctest.runner module xdoctest.static_analysis module xdoctest.utils module xdoctest.utils.util_deprecation module xdoctest.utils.util_import module xdoctest.utils.util_misc module xdoctest.utils.util_mixins module xdoctest.utils.util_notebook module xdoctest.utils.util_path module xdoctest.utils.util_str module xdoctest.utils.util_stream module