xdoctest.exceptions module

Define errors that may be raised by xdoctest

exception xdoctest.exceptions.MalformedDocstr[source]

Bases: Exception

Exception raised when the docstring itself does not conform to the expected style (e.g. google / numpy).

exception xdoctest.exceptions.DoctestParseError(msg, string=None, info=None, orig_ex=None)[source]

Bases: Exception

Exception raised when doctest code has an error.

Parameters:

  • msg (str) – error message

  • string (str | None) – the string that failed

  • info (Any | None) – extra information

  • orig_ex (Exception | None) – The underlying exceptoin

exception xdoctest.exceptions.ExitTestException[source]

Bases: Exception

exception xdoctest.exceptions.IncompleteParseError[source]

Bases: SyntaxError

Used when something goes wrong in the xdoctest parser