§’ f c @ sū d Z d Z d d d d d d d d d
d d d
d d d d d d d d d d d d d d d d d d d d! g Z d" d# l Z d" d# l Z d" d# l Z d" d# l Z d" d# l Z d" d# l Z d" d# l Z d" d# l
Z
d" d# l Z d" d# l Z d" d$ l
m Z d" d% l m Z e d& d' Z i Z d( d Z e d Z e d Z e d Z e d Z e d Z e d Z e e Be Be Be Be BZ e d
Z e d Z e d Z e d
Z e e Be Be BZ d) Z d* Z! d+ d, Z" d- d. d/ Z# d0 d1 Z$ d2 d3 d4 Z% d5 d6 Z& Gd7 d8 d8 e Z' d9 d: Z( d; d< Z) d= d> Z* Gd? d@ d@ e j+ Z, dA dB Z- GdC d d Z. GdD d d Z/ GdE d d Z0 GdF d d Z1 GdG d d Z2 GdH d d Z3 GdI d d e4 Z5 GdJ d d e4 Z6 GdK d d e2 Z7 e8 a9 e8 e8 e8 e8 e: d" e8 e; e; dL d Z< e: e8 e8 e8 e8 e: d" e8 e; e0 e8 dM d Z= e; dN e8 d" dO d Z> d" a? dP d Z@ GdQ dR dR e jA ZB GdS dT dT eB ZC e8 e8 e8 e8 dU d ZD GdV dW dW eB ZE e: e8 e8 e0 e8 dX dY ZF dZ d ZG d[ d ZH d\ d ZI e; e8 d] d ZJ e; e8 d^ d_ ZK e; d` d! ZL Gda db db ZM i eM db 6dc dd 6de df 6dg dh 6di dj 6dk dl 6ZN dm dn ZO eP do k r÷e
jQ eO n d# S(p uÅ Module doctest -- a framework for running examples in docstrings.
In simplest use, end each module M to be tested with:
def _test():
import doctest
doctest.testmod()
if __name__ == "__main__":
_test()
Then running the module as a script will cause the examples in the
docstrings to get executed and verified:
python M.py
This won't display anything unless an example fails, in which case the
failing example(s) and the cause(s) of the failure(s) are printed to stdout
(why not stderr? because stderr is a lame hack <0.2 wink>), and the final
line of output is "Test failed.".
Run it with the -v switch instead:
python M.py -v
and a detailed report of all examples tried is printed to stdout, along
with assorted summaries at the end.
You can force verbose mode by passing "verbose=True" to testmod, or prohibit
it by passing "verbose=False". In either of those cases, sys.argv is not
examined by testmod.
There are a variety of other ways to run doctests, including integration
with the unittest framework, and support for running non-Python text
files containing doctests. There are also many ways to override parts
of doctest's default behaviors. See the Library Reference Manual for
details.
u reStructuredText enu register_optionflagu DONT_ACCEPT_TRUE_FOR_1u DONT_ACCEPT_BLANKLINEu NORMALIZE_WHITESPACEu ELLIPSISu SKIPu IGNORE_EXCEPTION_DETAILu COMPARISON_FLAGSu REPORT_UDIFFu REPORT_CDIFFu REPORT_NDIFFu REPORT_ONLY_FIRST_FAILUREu REPORTING_FLAGSu Exampleu DocTestu
DocTestParseru
DocTestFinderu
DocTestRunneru
OutputCheckeru DocTestFailureu UnexpectedExceptionu DebugRunneru testmodu testfileu run_docstring_examplesu DocTestSuiteu DocFileSuiteu set_unittest_reportflagsu script_from_examplesu
testsourceu debug_srcu debugi N( u StringIO( u
namedtupleu TestResultsu failed attemptedc C s t j | d t t > S( Ni ( u OPTIONFLAGS_BY_NAMEu
setdefaultu len( u name( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu register_optionflag s u u ...c C sU d } xH t j D]= } | j | d } | t t | k r | | j O} q q W| S( u
Return the compiler-flags associated with the future features that
have been imported into the given namespace (globs).
i N( u
__future__u all_feature_namesu getu Noneu getattru
compiler_flag( u globsu flagsu fnameu feature( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu _extract_future_flags“ s u _extract_future_flagsi c C su t j | r | St | t r> t | t t d g S| d k re t j t j
| j d St d d S( u
Return the module specified by `module`. In particular:
- If `module` is a module, then return module.
- If `module` is a string, then import and return the
module with that name.
- If `module` is None, then return the calling module.
The calling module is assumed to be the module of
the stack frame at the given depth in the call stack.
u *u __name__u" Expected a module, string, or NoneN(
u inspectu ismoduleu
isinstanceu stru
__import__u globalsu localsu Noneu sysu modulesu _getframeu f_globalsu TypeError( u moduleu depth( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu _normalize_moduleĄ s
u _normalize_modulec C s“ | r
t | d } t | | } t | d r
t | j d r | j j | } | j | } | j t j d | f Sq
n t | d | } | j
| f SWd QXd S( Ni u
__loader__u get_datau
u encoding( u _normalize_moduleu _module_relative_pathu hasattru
__loader__u get_datau decodeu replaceu osu linesepu openu read( u filenameu packageu module_relativeu encodingu
file_contentsu f( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu _load_testfileÓ s u _load_testfilei c C s t j d | d | S( u~
Add the given number of space characters to the beginning of
every non-blank line in `s`, and return the result.
u
(?m)^(?!$)u ( u reu sub( u su indent( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu _indentį s u _indentc C s; t } | \ } } } t j | | | d | | j S( uz
Return a string containing a traceback message for the given
exc_info tuple (as returned by sys.exc_info()).
u file( u StringIOu tracebacku print_exceptionu getvalue( u exc_infou excoutu exc_typeu exc_valu exc_tb( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu _exception_tracebacké s u _exception_tracebackc B s/ | Ee Z d Z d d Z d d d Z d S( u _SpoofOutc C s6 t j | } | r2 | j d r2 | d 7} n | S( Nu
( u StringIOu getvalueu endswith( u selfu result( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu getvalueö s
u _SpoofOut.getvaluec C s | j | t j | d S( N( u seeku StringIOu truncate( u selfu size( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu truncate’ s
u _SpoofOut.truncateN( u __name__u
__module__u __qualname__u getvalueu Noneu truncate( u
__locals__( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu _SpoofOutõ s u _SpoofOutc C s t | k r | | k S| j t } d t | } } | d } | rt | j | rm t | } | d =qt d Sn | d } | r“ | j | r | t | 8} | d =q“ d Sn | | k rÄ d SxC | D]; } | j | | | } | d k rö d S| t | 7} qĖ Wd S( u_
Essentially the only subtle case:
>>> _ellipsis_match('aa...aa', 'aaa')
False
i i Fi’’’’i’’’’T( u ELLIPSIS_MARKERu splitu lenu
startswithu Falseu endswithu findu True( u wantu gotu wsu startposu endposu w( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu _ellipsis_match s0
u _ellipsis_matchc C s" | j } | r d | Sd Sd S( u) Return a commented form of the given lineu # u #N( u rstrip( u line( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu
_comment_line5 s u
_comment_linec C s d t | } } | j d } | d k r7 | } n | j d d | } | d k ra | } n | j d d | } | d k r | d } n | | |
S( Ni u
u :u .i ( u lenu findu rfind( u msgu startu endu i( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu _strip_exception_details= s
u _strip_exception_detailsc B sM | Ee Z d Z d Z d d Z d
d d Z d d Z d d Z d
S( u _OutputRedirectingPdbuĄ
A specialized version of the python debugger that redirects stdout
to a given stream when interacting with the user. Stdout is *not*
redirected when traced code is executed.
c C s; | | _ d | _ t j j | d | d d d | _ d S( Nu stdoutu nosiginti FT( u _OutputRedirectingPdb__outu Falseu$ _OutputRedirectingPdb__debugger_usedu pdbu Pdbu __init__u Trueu use_rawinput( u selfu out( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __init__] s u _OutputRedirectingPdb.__init__c C s> d | _ | d k r' t j j } n t j j | | d S( NT( u Trueu$ _OutputRedirectingPdb__debugger_usedu Noneu sysu _getframeu f_backu pdbu Pdbu set_trace( u selfu frame( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu set_tracee s u _OutputRedirectingPdb.set_tracec C s | j r t j j | n d S( N( u$ _OutputRedirectingPdb__debugger_usedu pdbu Pdbu set_continue( u self( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu set_continuek s u" _OutputRedirectingPdb.set_continuec G s= t j } | j t _ z t j j | | SWd | t _ Xd S( N( u sysu stdoutu _OutputRedirectingPdb__outu pdbu Pdbu trace_dispatch( u selfu argsu save_stdout( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu trace_dispatchq s
u$ _OutputRedirectingPdb.trace_dispatchN( u __name__u
__module__u __qualname__u __doc__u __init__u Noneu set_traceu set_continueu trace_dispatch( u
__locals__( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu _OutputRedirectingPdbW s
u _OutputRedirectingPdbc C sž t j | s" t d | n | j d r@ t d n t | d rk t j j | j d } nw | j
d k rĪ t t j
d k rĀ t j
d d k rĀ t j j t j
d d } qā t j } n t d | d t j j | | j d S(
Nu Expected a module: %ru /u1 Module-relative files may not have absolute pathsu __file__i u __main__u u+ Can't resolve paths relative to the module u (it has no __file__)( u inspectu ismoduleu TypeErroru
startswithu
ValueErroru hasattru osu pathu splitu __file__u __name__u lenu sysu argvu curdiru join( u moduleu pathu basedir( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu _module_relative_path| s ( u _module_relative_pathc B sV | Ee Z d Z d Z d d d d d d Z d d Z d d Z d d
Z d S( u Exampleun
A single doctest example, consisting of source code and expected
output. `Example` defines the following attributes:
- source: A single Python statement, always ending with a newline.
The constructor adds a newline if needed.
- want: The expected output from running the source code (either
from stdout, or a traceback in case of exception). `want` ends
with a newline unless it's empty, in which case it's an empty
string. The constructor adds a newline if needed.
- exc_msg: The exception message generated by the example, if
the example is expected to generate an exception; or `None` if
it is not expected to generate an exception. This exception
message is compared against the return value of
`traceback.format_exception_only()`. `exc_msg` ends with a
newline unless it's `None`. The constructor adds a newline
if needed.
- lineno: The line number within the DocTest string containing
this Example where the Example begins. This line number is
zero-based, with respect to the beginning of the DocTest.
- indent: The example's indentation in the DocTest string.
I.e., the number of space characters that precede the
example's first prompt.
- options: A dictionary mapping from option flags to True or
False, which is used to override default options for this
example. Any option flags not contained in this dictionary
are left at their default value (as specified by the
DocTestRunner's optionflags). By default, no options are set.
i c C s· | j d s | d 7} n | r? | j d r? | d 7} n | d k rh | j d rh | d 7} n | | _ | | _ | | _ | | _ | d k r” i } n | | _ | | _ d S( Nu
( u endswithu Noneu sourceu wantu linenou indentu optionsu exc_msg( u selfu sourceu wantu exc_msgu linenou indentu options( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __init__Ć s
u Example.__init__c C s t | t | k r t S| j | j k o
| j | j k o
| j | j k o
| j | j k o
| j | j k o
| j | j k S( N( u typeu NotImplementedu sourceu wantu linenou indentu optionsu exc_msg( u selfu other( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __eq__Õ s u Example.__eq__c C s | | k S( N( ( u selfu other( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __ne__ą s u Example.__ne__c C s( t | j | j | j | j | j f S( N( u hashu sourceu wantu linenou indentu exc_msg( u self( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __hash__ć s u Example.__hash__N( u __name__u
__module__u __qualname__u __doc__u Noneu __init__u __eq__u __ne__u __hash__( u
__locals__( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu Example s " c B sb | Ee Z d Z d Z d d Z d d Z d d Z d d Z d
d Z d d
Z d S( u DocTestue
A collection of doctest examples that should be run in a single
namespace. Each `DocTest` defines the following attributes:
- examples: the list of examples.
- globs: The namespace (aka globals) that the examples should
be run in.
- name: A name identifying the DocTest (typically, the name of
the object whose docstring this DocTest was extracted from).
- filename: The name of the file that this DocTest was extracted
from, or `None` if the filename is unknown.
- lineno: The line number within filename where this DocTest
begins, or `None` if the line number is unavailable. This
line number is zero-based, with respect to the beginning of
the file.
- docstring: The string that the examples were extracted from,
or `None` if the string is unavailable.
c C s@ | | _ | | _ | j | _ | | _ | | _ | | _ d S( u
Create a new DocTest containing the given examples. The
DocTest's globals are initialized with a copy of `globs`.
N( u examplesu docstringu copyu globsu nameu filenameu lineno( u selfu examplesu globsu nameu filenameu linenou docstring( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __init__’ s u DocTest.__init__c C sl t | j d k r d } n1 t | j d k r< d } n d t | j } d | j | j | j | f S( Ni u no examplesi u 1 exampleu %d examplesu ( u lenu examplesu nameu filenameu lineno( u selfu examples( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __repr__
s u DocTest.__repr__c C s t | t | k r t S| j | j k o
| j | j k o
| j | j k o
| j | j k o
| j | j k o
| j | j k S( N( u typeu NotImplementedu examplesu docstringu globsu nameu filenameu lineno( u selfu other( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __eq__ s u DocTest.__eq__c C s | | k S( N( ( u selfu other( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __ne__" s u DocTest.__ne__c C s" t | j | j | j | j f S( N( u hashu docstringu nameu filenameu lineno( u self( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __hash__% s u DocTest.__hash__c C sS t | t s t S| j | j | j t | f | j | j | j t | f k S( N( u
isinstanceu DocTestu NotImplementedu nameu filenameu linenou id( u selfu other( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __lt__) s u DocTest.__lt__N(
u __name__u
__module__u __qualname__u __doc__u __init__u __repr__u __eq__u __ne__u __hash__u __lt__( u
__locals__( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu DocTestē s
c B sū | Ee Z d Z d Z e j d e j e j B Z e j d e j e j Be j B Z
e j d j Z d d d Z
d d Z d d
d Z d d
Z e j d e j Z d d Z e j d e j Z d d Z d d Z d d Z d S( u
DocTestParseruD
A class used to parse strings containing doctest examples.
uś
# Source consists of a PS1 line followed by zero or more PS2 lines.
(?P
(?:^(?P [ ]*) >>> .*) # PS1 line
(?:\n [ ]* \.\.\. .*)*) # PS2 lines
\n?
# Want consists of any non-blank lines that do not start with PS1.
(?P (?:(?![ ]*$) # Not a blank line
(?![ ]*>>>) # Not a line starting with PS1
.+$\n? # But any other line
)*)
uß
# Grab the traceback header. Different versions of Python have
# said different things on the first traceback line.
^(?P Traceback\ \(
(?: most\ recent\ call\ last
| innermost\ last
) \) :
)
\s* $ # toss trailing whitespace on the header.
(?P .*?) # don't blink: absorb stuff until...
^ (?P \w+ .*) # a line *starts* with alphanum.
u ^[ ]*(#.*)?$u c
s} | j } | j | d k rU d j f d d | j d D } n g } d \ } } xų | j j | D]ä } | j | | | j
| | j d | | j 7} | j | | | \ } } } }
| j
| s-| j t | | |
d | d t | j
d d | n | | j d | j | j 7} | j } qz W| j | | d
| S(
u=
Divide the given string into examples and intervening text,
and return them as a list of alternating Examples and strings.
Line numbers for the Examples are 0-based. The optional
argument `name` is a name identifying this string, and is only
used for error messages.
i u
c s g | ] } | d
q S( N( ( u .0u l( u
min_indent( u, /opt/alt/python33/lib64/python3.3/doctest.pyu
p s u' DocTestParser.parse..u linenou indentu optionsN( i i ( u
expandtabsu _min_indentu joinu splitu _EXAMPLE_REu finditeru appendu startu countu _parse_exampleu _IS_BLANK_OR_COMMENTu Exampleu lenu groupu end( u selfu stringu nameu outputu charnou linenou mu sourceu optionsu wantu exc_msg( ( u
min_indentu, /opt/alt/python33/lib64/python3.3/doctest.pyu parsed s& . !
%u DocTestParser.parsec C s% t | j | | | | | | | S( u"
Extract all doctest examples from the given string, and
collect them into a `DocTest` object.
`globs`, `name`, `filename`, and `lineno` are attributes for
the new `DocTest` object. See the documentation for `DocTest`
for more information.
( u DocTestu get_examples( u selfu stringu globsu nameu filenameu lineno( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu get_doctest s u DocTestParser.get_doctestc C s d d | j | | D S( uŃ
Extract all doctest examples from the given string, and return
them as a list of `Example` objects. Line numbers are
0-based, because it's most common in doctests that nothing
interesting appears on the same line as opening triple-quote,
and so the first interesting line is called "line 1" then.
The optional argument `name` is a name identifying this
string, and is only used for error messages.
c S s% g | ] } t | t r | q S( ( u
isinstanceu Example( u .0u x( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu
¢ s u. DocTestParser.get_examples..( u parse( u selfu stringu name( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu get_examples s u DocTestParser.get_examplesc
sx t | j d | j d j d } | j | | | | j | d d
d d | | d j f d d | D } | j d
} | j d } t | d k rŻ t j d | d rŻ | d =n | j | d | | t | d j f d d | D } | j j | } | rM| j d
} n d } | j
| | | } | | | | f S( u¼
Given a regular expression match from `_EXAMPLE_RE` (`m`),
return a pair `(source, want)`, where `source` is the matched
example's source code (with prompts and indentation stripped);
and `want` is the example's expected output (with indentation
stripped).
`name` is the string's name, and `lineno` is the line number
where the example starts; both are used for error messages.
u indentu sourceu
i Nu u .c s$ g | ] } | d d
q S( i N( ( u .0u sl( u indent( u, /opt/alt/python33/lib64/python3.3/doctest.pyu
ø s u0 DocTestParser._parse_example..u wantu *$c s g | ] } | d
q S( N( ( u .0u wl( u indent( u, /opt/alt/python33/lib64/python3.3/doctest.pyu
Ć s u msgi’’’’i’’’’( u lenu groupu splitu _check_prompt_blanku
_check_prefixu joinu reu matchu
_EXCEPTION_REu Noneu
_find_options(
u selfu mu nameu linenou source_linesu sourceu wantu
want_linesu exc_msgu options( ( u indentu, /opt/alt/python33/lib64/python3.3/doctest.pyu _parse_example„ s$ ("(
"u DocTestParser._parse_exampleu #\s*doctest:\s*([^\n\'"]*)$c C sų i } xŗ | j j | D]¦ } | j d j d d j } x| | D]t } | d d k ss | d d
t k r t d | d | | f n t | d d
} | d d k | | ū s u- DocTestParser._min_indent..i N( u
_INDENT_REu findallu lenu min( u selfu su indents( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu _min_indentł s
u DocTestParser._min_indentc
C s xy t | D]k \ } } t | | d k r
| | d d k r
t d | | d | | | | d
| f q
q
Wd S( u
Given the lines of a source string (including prompts and
leading indentation), check to make sure that every prompt is
followed by a space character. If any line is not followed by
a space character, then raise ValueError.
i i u u8 line %r of the docstring for %s lacks blank after %s: %ri N( u enumerateu lenu
ValueError( u selfu linesu indentu nameu linenou iu line( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu _check_prompt_blank s
*u! DocTestParser._check_prompt_blankc C s[ xT t | D]F \ } } | r
| j | r
t d | | d | | f q
q
Wd S( u
Check that every line in the given list starts with the given
prefix; if any line does not, then raise a ValueError.
uG line %r of the docstring for %s has inconsistent leading whitespace: %ri N( u enumerateu
startswithu
ValueError( u selfu linesu prefixu nameu linenou iu line( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu
_check_prefix s u DocTestParser._check_prefixN( u __name__u
__module__u __qualname__u __doc__u reu compileu MULTILINEu VERBOSEu _EXAMPLE_REu DOTALLu
_EXCEPTION_REu matchu _IS_BLANK_OR_COMMENTu parseu get_doctestu get_examplesu _parse_exampleu _OPTION_DIRECTIVE_REu
_find_optionsu
_INDENT_REu _min_indentu _check_prompt_blanku
_check_prefix( u
__locals__( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu
DocTestParser4 s" ' 3 c B s} | Ee Z d Z d Z d e d d d d Z d d d d d d Z d d Z
d d Z d
d Z d d
Z
d S( u
DocTestFinderu<
A class used to extract the DocTests that are relevant to a given
object, from its docstring and the docstrings of its contained
objects. Doctests can currently be extracted from the following
object types: modules, functions, classes, methods, staticmethods,
classmethods, and properties.
c C s( | | _ | | _ | | _ | | _ d S( ut
Create a new doctest finder.
The optional argument `parser` specifies a class or
function that should be used to create new DocTest objects (or
objects that implement the same interface as DocTest). The
signature for this factory function should match the signature
of the DocTest constructor.
If the optional argument `recurse` is false, then `find` will
only examine the given object, and not any contained objects.
If the optional argument `exclude_empty` is false, then `find`
will include tests for objects with empty docstrings.
N( u _parseru _verboseu _recurseu _exclude_empty( u selfu verboseu parseru recurseu
exclude_empty( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __init__( s u DocTestFinder.__init__c C sē | d k rI t | d d } | d k rI t d t | f qI n | d k r^ d } n | d k r| t j | } n y t j | } Wn t k
r© d } Yn X| sé t j | } | d | d d
d k sé d } qé n | d k rž d } nB | d k r"t
j | | j } n t
j | } | s@d } n | d k rs| d k rai } q| j j
} n | j
} | d k r| j | n d | k r“d | d u __main__Fiž’’’( u Noneu getattru
ValueErroru typeu Falseu inspectu getmoduleu
getsourcefileu TypeErroru getfileu linecacheu getlinesu __dict__u copyu updateu _findu sort( u selfu obju nameu moduleu globsu
extraglobsu fileu source_linesu tests( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu find> sJ $
u DocTestFinder.findc C sø | d k r d St j | d k r8 | t j | k St j | rW | j | j k St j | rv | j | j k St
| d r | j | j k St | t rØ d St
d d S( uY
Return true if the given object is defined in the given
module.
u
__module__u" object must be a class or functionNT( u Noneu Trueu inspectu getmoduleu
isfunctionu __dict__u __globals__u isclassu __name__u
__module__u hasattru
isinstanceu propertyu
ValueError( u selfu moduleu object( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu _from_module¤ s u DocTestFinder._from_modulec C s | j r t d | n t | | k r0 d Sd | t | <| j | | | | | } | d k rw | j | n t j | r| j rx | j j
D]n \ } }
d | | f } t j |
sŁ t j |
r | j
| |
r | j | |
| | | | | q q Wn t j | r| j rxź t | d i j
D]Ķ \ } }
t | t s|t d t | f n t j |
pÄt j |
pÄt j |
pÄt j |
pÄt |
t sćt d t |
f n d | | f } | j | |
| | | | | qEWn t j | r
| j r
xÖ | j j
D]Ā \ } }
t |
t rnt | | }
n t |
t rt | | j }
n t j |
sæt j |
sæt |
t rA| j
| |
rAd | | f } | j | |
| | | | | qAqAWn d S( um
Find tests for the given object and any contained objects, and
add them to `tests`.
u Finding tests in %sNi u %s.%su __test__u5 DocTestFinder.find: __test__ keys must be strings: %ru` DocTestFinder.find: __test__ values must be strings, functions, methods, classes, or modules: %ru %s.__test__.%s( u _verboseu printu idu _get_testu Noneu appendu inspectu ismoduleu _recurseu __dict__u itemsu
isfunctionu isclassu _from_moduleu _findu getattru
isinstanceu stru
ValueErroru typeu ismethodu staticmethodu classmethodu __func__u property( u selfu testsu obju nameu moduleu source_linesu globsu seenu testu valnameu val( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu _findø sP % u DocTestFinder._findc C s t | t r | } nd yC | j d k r3 d } n' | j } t | t sZ t | } n Wn t t f k
r{ d } Yn X| j | | } | j r¢ | r¢ d S| d k r· d } n> t | d | j } | d d
d k rõ | d d
} n | j
j | | | | | S( us
Return a DocTest for the given object, if it defines a docstring;
otherwise, return None.
u u __file__i Nu .pycu .pyoi iü’’’( u .pycu .pyoi’’’’( u
isinstanceu stru __doc__u Noneu TypeErroru AttributeErroru _find_linenou _exclude_emptyu getattru __name__u _parseru get_doctest( u selfu obju nameu moduleu globsu source_linesu docstringu linenou filename( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu _get_test÷ s( u DocTestFinder._get_testc C s d } t j | r d } n t j | r | d k r= d St j d t | d d } x6 t | D]% \ } } | j | ri | } Pqi qi Wn t j | r° | j
} n t j | rĖ | j } n t j
| rę | j } n t j | r| j } n t j | r)t | d d d } n | d k r| d k rI| d St j d } x7 t | t | D] } | j | | rn| SqnWn d S( u
Return a line number of the given object's docstring. Note:
this method assumes that the object has a docstring.
i u ^\s*class\s*%s\bu __name__u -u co_firstlinenoi u (^|.*:)\s*\w*("|')N( u Noneu inspectu ismoduleu isclassu reu compileu getattru enumerateu matchu ismethodu __func__u
isfunctionu __code__u istracebacku tb_frameu isframeu f_codeu iscodeu rangeu len( u selfu obju source_linesu linenou patu iu line( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu _find_lineno s< u DocTestFinder._find_linenoNFT( u __name__u
__module__u __qualname__u __doc__u Falseu
DocTestParseru Trueu __init__u Noneu findu _from_moduleu _findu _get_testu _find_lineno( u
__locals__( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu
DocTestFinder s f ? %c B sŪ | Ee Z d Z d Z d d Z d d d d d Z d d Z d d
Z d d Z d
d Z
d d Z d d Z d d Z
e j d Z d d d Z d d d d d Z d d d Z d d Z d S( u
DocTestRunneru3
A class used to run DocTest test cases, and accumulate statistics.
The `run` method is used to process a single DocTest case. It
returns a tuple `(f, t)`, where `t` is the number of test cases
tried, and `f` is the number of test cases that failed.
>>> tests = DocTestFinder().find(_TestClass)
>>> runner = DocTestRunner(verbose=False)
>>> tests.sort(key = lambda test: test.name)
>>> for test in tests:
... print(test.name, '->', runner.run(test))
_TestClass -> TestResults(failed=0, attempted=2)
_TestClass.__init__ -> TestResults(failed=0, attempted=2)
_TestClass.get -> TestResults(failed=0, attempted=2)
_TestClass.square -> TestResults(failed=0, attempted=1)
The `summarize` method prints a summary of all the test cases that
have been run by the runner, and returns an aggregated `(f, t)`
tuple:
>>> runner.summarize(verbose=1)
4 items passed all tests:
2 tests in _TestClass
2 tests in _TestClass.__init__
2 tests in _TestClass.get
1 tests in _TestClass.square
7 tests in 4 items.
7 passed and 0 failed.
Test passed.
TestResults(failed=0, attempted=7)
The aggregated number of tried examples and failed examples is
also available via the `tries` and `failures` attributes:
>>> runner.tries
7
>>> runner.failures
0
The comparison between expected outputs and actual outputs is done
by an `OutputChecker`. This comparison may be customized with a
number of option flags; see the documentation for `testmod` for
more information. If the option flags are insufficient, then the
comparison may also be customized by passing a subclass of
`OutputChecker` to the constructor.
The test runner's display output can be controlled in two ways.
First, an output function (`out) can be passed to
`TestRunner.run`; this function will be called with strings that
should be displayed. It defaults to `sys.stdout.write`. If
capturing the output is not sufficient, then the display output
can be also customized by subclassing DocTestRunner, and
overriding the methods `report_start`, `report_success`,
`report_unexpected_exception`, and `report_failure`.
u *iF i c C sv | p t | _ | d k r0 d t j k } n | | _ | | _ | | _ d | _ d | _ i | _
t | _ d S( uc
Create a new test runner.
Optional keyword arg `checker` is the `OutputChecker` that
should be used to compare the expected outputs and actual
outputs of doctest examples.
Optional keyword arg 'verbose' prints lots of stuff if true,
only failures if false; by default, it's true iff '-v' is in
sys.argv.
Optional argument `optionflags` can be used to control how the
test runner compares expected output to actual output, and how
it displays failures. See the documentation for `testmod` for
more information.
u -vi N(
u
OutputCheckeru _checkeru Noneu sysu argvu _verboseu optionflagsu original_optionflagsu triesu failuresu _name2ftu _SpoofOutu _fakeout( u selfu checkeru verboseu optionflags( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __init__ s u DocTestRunner.__init__c C s_ | j r[ | j r= | d t | j d t | j q[ | d t | j d n d S( u
Report that the test runner is about to process the given
example. (Only displays a message if verbose=True)
u Trying:
u Expecting:
u Expecting nothing
N( u _verboseu wantu _indentu source( u selfu outu testu example( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu report_start° s (u DocTestRunner.report_startc C s | j r | d n d S( ut
Report that the given example ran successfully. (Only
displays a message if verbose=True)
u ok
N( u _verbose( u selfu outu testu exampleu got( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu report_success½ s u DocTestRunner.report_successc C s3 | | j | | | j j | | | j d S( u7
Report that the given example failed.
N( u _failure_headeru _checkeru output_differenceu optionflags( u selfu outu testu exampleu got( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu report_failureÅ s u DocTestRunner.report_failurec C s. | | j | | d t t | d S( uO
Report that the given example raised an unexpected exception.
u Exception raised:
N( u _failure_headeru _indentu _exception_traceback( u selfu outu testu exampleu exc_info( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu report_unexpected_exceptionĢ s u) DocTestRunner.report_unexpected_exceptionc C sŹ | j g } | j rs | j d k rJ | j d k rJ | j | j d } n d } | j d | j | | j f n! | j d | j d | j f | j d | j } | j t | d j | S( Ni u ?u File "%s", line %s, in %su Line %s, in %su Failed example:u
( u DIVIDERu filenameu linenou Noneu appendu nameu sourceu _indentu join( u selfu testu exampleu outu linenou source( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu _failure_headerÓ s !
u DocTestRunner._failure_headerc C sR d } } | j } t d \ } } } | j j }
xņt | j D]į\ } } | j t @of | d k }
| | _ | j rĘ xH | j j D]4 \ } } | rÆ | j | O_ q | j | M_ q Wn | j t @rŁ qD n | d 7} |
s’ | j
| | | n d | j | f } y< t t
| j | d | d | j | j j d } Wn5 t k
re Yn! t j } | j j Yn X| j j } | j j d | } | d k rŪ|
| j | | j r| } qn¬ t j | d d
d } |
s| t | 7} n | j d k r)| } n^ |
| j | | j rJ| } n= | j t @r|
t | j t | | j r| } qn | | k rµ|
s%| j | | | | q%qD | | k rķ|
są| j! | | | | n | d 7} qD | | k rD |
s| j" | | | | n | d 7} qD qD W| | _ | j# | | | t$ | | S( uŅ
Run the examples in `test`. Write the outcome of each example
with one of the `DocTestRunner.report_*` methods, using the
writer function `out`. `compileflags` is the set of compiler
flags that should be used to execute examples. Return a tuple
`(f, t)`, where `t` is the number of examples tried, and `f`
is the number of examples that failed. The examples are run
in the namespace `test.globs`.
i i i u u singleNi i’’’’(% u optionflagsu rangeu _checkeru check_outputu enumerateu examplesu REPORT_ONLY_FIRST_FAILUREu optionsu itemsu SKIPu report_startu nameu execu compileu sourceu globsu debuggeru set_continueu Noneu KeyboardInterruptu sysu exc_infou _fakeoutu getvalueu truncateu wantu tracebacku format_exception_onlyu _exception_tracebacku exc_msgu IGNORE_EXCEPTION_DETAILu _strip_exception_detailsu report_successu report_failureu report_unexpected_exceptionu _DocTestRunner__record_outcomeu TestResults( u selfu testu compileflagsu outu failuresu triesu original_optionflagsu SUCCESSu FAILUREu BOOMu checku
examplenumu exampleu quietu
optionflagu valu filenameu exceptionu gotu outcomeu exc_msg( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __runē s~
u DocTestRunner.__runc C s^ | j j | j d \ } } | | | | f | j | j <| j | 7_ | j | 7_ d S( u{
Record the fact that the given DocTest (`test`) generated `f`
failures out of `t` tried examples.
i N( i i ( u _name2ftu getu nameu failuresu tries( u selfu testu fu tu f2u t2( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __record_outcomea s u DocTestRunner.__record_outcomeu. .+)\[(?P\d+)\]>$c C sy | j j | } | re | j d | j j k re | j j t | j d } | j j d d S| j
| | Sd S( Nu nameu
examplenumu keependsT( u% _DocTestRunner__LINECACHE_FILENAME_REu matchu groupu testu nameu examplesu intu sourceu
splitlinesu Trueu save_linecache_getlines( u selfu filenameu module_globalsu mu example( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __patched_linecache_getlinesn s
! u* DocTestRunner.__patched_linecache_getlinesc s~ | | _ | d k r' t | j } n t j | d k r j d k sc j d k ro j } q f d d } n | j t _ t j
} t j } t
| _ | j j | j j t _ t j | _ | j t _ t j } t j t _ z | j | | | SWd t _ | t _ t j | | j t _ | t _ | ry| j j d d l } d | _ n Xd S( uJ
Run the examples in `test`, and display the results using the
writer function `out`.
The examples are run in the namespace `test.globs`. If
`clear_globs` is true (the default), then this namespace will
be cleared after the test runs, to help with garbage
collection. If you would like to examine the namespace after
the test completes, then use `clear_globs=False`.
`compileflags` gives the set of flags that should be used by
the Python compiler when running the examples. If not
specified, then it will default to the set of future-import
flags that apply to `globs`.
The output of each example is checked using
`DocTestRunner.check_output`, and the results are formatted by
the `DocTestRunner.report_*` methods.
u utf-8c s, t | j d } j | d S( Nu backslashreplace( u stru encodeu write( u s( u encodingu save_stdout( u, /opt/alt/python33/lib64/python3.3/doctest.pyu out s u DocTestRunner.run..outNi ( u testu Noneu _extract_future_flagsu globsu sysu stdoutu encodingu loweru writeu _fakeoutu gettraceu pdbu set_traceu _OutputRedirectingPdbu debuggeru resetu linecacheu getlinesu save_linecache_getlinesu* _DocTestRunner__patched_linecache_getlinesu displayhooku __displayhook__u _DocTestRunner__runu settraceu clearu builtinsu _( u selfu testu compileflagsu outu clear_globsu
save_traceu save_set_traceu save_displayhooku builtins( ( u encodingu save_stdoutu, /opt/alt/python33/lib64/python3.3/doctest.pyu runv s<
u DocTestRunner.runc
C s9 | d k r | j } n g } g } g } d } } x | j j D]w } | \ } \ } }
| |
7} | | 7} |
d k r | j | qD | d k r® | j | |
f qD | j | qD W| r]| r t t | d | j x | D] } t d | qļ Wn | r]t t | d | j x+ | D] \ } } t d | | f q3Wq]n | rÄt | j t t | d | j x4 | D]) \ } \ } }
t d | |
| f qWn | r t | d t | j d t | | d
| d n | rt d | d
n | r,t d n t | | S( u¦
Print a summary of all the test cases that have been run by
this DocTestRunner, and return a tuple `(f, t)`, where `f` is
the total number of failed examples, and `t` is the total
number of tried examples.
The optional `verbose` argument controls how detailed the
summary is. If the verbosity is not specified, then the
DocTestRunner's verbosity is used.
i u items had no tests:u u items passed all tests:u %3d tests in %su items had failures:u %3d of %3d in %su tests inu items.u
passed andu failed.u ***Test Failed***u failures.u Test passed.N(
u Noneu _verboseu _name2ftu itemsu appendu printu lenu sortu DIVIDERu TestResults(
u selfu verboseu notestsu passedu failedu totaltu totalfu xu nameu fu tu thingu count( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu summarizeæ sP
u DocTestRunner.summarizec C sv | j } xf | j j D]U \ } \ } } | | k r^ | | \ } } | | } | | } n | | f | | s u3 OutputChecker.output_difference..u Differences (%s):
u u Expected:
%sGot:
%su Expected:
%sGot nothing
u Expected nothing
Got:
%su Expected nothing
Got nothing
T( u wantu DONT_ACCEPT_BLANKLINEu reu subu BLANKLINE_MARKERu _do_a_fancy_diffu
splitlinesu Trueu REPORT_UDIFFu difflibu unified_diffu listu REPORT_CDIFFu context_diffu REPORT_NDIFFu Differu IS_CHARACTER_JUNKu compareu _indentu join(
u selfu exampleu gotu optionflagsu wantu
want_linesu got_linesu diffu kindu engine( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu output_differencei s6
u OutputChecker.output_differenceN( u __name__u
__module__u __qualname__u __doc__u _toAsciiu check_outputu _do_a_fancy_diffu output_difference( u
__locals__( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu
OutputChecker s
? c B s2 | Ee Z d Z d Z d d Z d d Z d S( u DocTestFailureuÖ A DocTest example has failed in debugging mode.
The exception instance has variables:
- test: the DocTest object being run
- example: the Example object that failed
- got: the actual output
c C s | | _ | | _ | | _ d S( N( u testu exampleu got( u selfu testu exampleu got( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __init__¤ s u DocTestFailure.__init__c C s
t | j S( N( u stru test( u self( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __str__© s u DocTestFailure.__str__N( u __name__u
__module__u __qualname__u __doc__u __init__u __str__( u
__locals__( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu DocTestFailure s
c B s2 | Ee Z d Z d Z d d Z d d Z d S( u UnexpectedExceptionuę A DocTest example has encountered an unexpected exception
The exception instance has variables:
- test: the DocTest object being run
- example: the Example object that failed
- exc_info: the exception info
c C s | | _ | | _ | | _ d S( N( u testu exampleu exc_info( u selfu testu exampleu exc_info( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __init__· s u UnexpectedException.__init__c C s
t | j S( N( u stru test( u self( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __str__¼ s u UnexpectedException.__str__N( u __name__u
__module__u __qualname__u __doc__u __init__u __str__( u
__locals__( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu UnexpectedException¬ s
c B sG | Ee Z d Z d Z d d d d d Z d d Z d d Z d S(
u DebugRunneru Run doc tests but raise an exception as soon as there is a failure.
If an unexpected exception occurs, an UnexpectedException is raised.
It contains the test, the example, and the original exception:
>>> runner = DebugRunner(verbose=False)
>>> test = DocTestParser().get_doctest('>>> raise KeyError\n42',
... {}, 'foo', 'foo.py', 0)
>>> try:
... runner.run(test)
... except UnexpectedException as f:
... failure = f
>>> failure.test is test
True
>>> failure.example.want
'42\n'
>>> exc_info = failure.exc_info
>>> raise exc_info[1] # Already has the traceback
Traceback (most recent call last):
...
KeyError
We wrap the original exception to give the calling application
access to the test and example information.
If the output doesn't match, then a DocTestFailure is raised:
>>> test = DocTestParser().get_doctest('''
... >>> x = 1
... >>> x
... 2
... ''', {}, 'foo', 'foo.py', 0)
>>> try:
... runner.run(test)
... except DocTestFailure as f:
... failure = f
DocTestFailure objects provide access to the test:
>>> failure.test is test
True
As well as to the example:
>>> failure.example.want
'2\n'
and the actual output:
>>> failure.got
'1\n'
If a failure or error occurs, the globals are left intact:
>>> del test.globs['__builtins__']
>>> test.globs
{'x': 1}
>>> test = DocTestParser().get_doctest('''
... >>> x = 2
... >>> raise KeyError
... ''', {}, 'foo', 'foo.py', 0)
>>> runner.run(test)
Traceback (most recent call last):
...
doctest.UnexpectedException:
>>> del test.globs['__builtins__']
>>> test.globs
{'x': 2}
But the globals are cleared if there is no error:
>>> test = DocTestParser().get_doctest('''
... >>> x = 2
... ''', {}, 'foo', 'foo.py', 0)
>>> runner.run(test)
TestResults(failed=0, attempted=1)
>>> test.globs
{}
c C s5 t j | | | | d } | r1 | j j n | S( NF( u
DocTestRunneru runu Falseu globsu clear( u selfu testu compileflagsu outu clear_globsu r( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu run s u DebugRunner.runc C s t | | | d S( N( u UnexpectedException( u selfu outu testu exampleu exc_info( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu report_unexpected_exception s u' DebugRunner.report_unexpected_exceptionc C s t | | | d S( N( u DocTestFailure( u selfu outu testu exampleu got( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu report_failure# s u DebugRunner.report_failureNT( u __name__u
__module__u __qualname__u __doc__u Noneu Trueu runu report_unexpected_exceptionu report_failure( u
__locals__( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu DebugRunneræ s Y c C s | d k r! t j j d } n t j | sF t d | f n | d k r^ | j } n t d | } | r t d | d | }
n t
d | d | }
x3 | j | | d | d | D] } |
j | qæ W| ré |
j
n t d k rž |
a n
t j |
t |
j |
j S( u*
m=None, name=None, globs=None, verbose=None, report=True,
optionflags=0, extraglobs=None, raise_on_error=False,
exclude_empty=False
Test examples in docstrings in functions and classes reachable
from module m (or the current module if m is not supplied), starting
with m.__doc__.
Also test examples reachable from dict m.__test__ if it exists and is
not None. m.__test__ maps names to functions, classes and strings;
function and class docstrings are tested even if the name is private;
strings are tested directly, as if they were docstrings.
Return (#failures, #tests).
See help(doctest) for an overview.
Optional keyword arg "name" gives the name of the module; by default
use m.__name__.
Optional keyword arg "globs" gives a dict to be used as the globals
when executing examples; by default, use m.__dict__. A copy of this
dict is actually used for each docstring, so that each docstring's
examples start with a clean slate.
Optional keyword arg "extraglobs" gives a dictionary that should be
merged into the globals that are used to execute examples. By
default, no extra globals are used. This is new in 2.4.
Optional keyword arg "verbose" prints lots of stuff if true, prints
only failures if false; by default, it's true iff "-v" is in sys.argv.
Optional keyword arg "report" prints a summary at the end when true,
else prints nothing at the end. In verbose mode, the summary is
detailed, else very brief (in fact, empty if all tests passed).
Optional keyword arg "optionflags" or's together module constants,
and defaults to 0. This is new in 2.3. Possible values (see the
docs for details):
DONT_ACCEPT_TRUE_FOR_1
DONT_ACCEPT_BLANKLINE
NORMALIZE_WHITESPACE
ELLIPSIS
SKIP
IGNORE_EXCEPTION_DETAIL
REPORT_UDIFF
REPORT_CDIFF
REPORT_NDIFF
REPORT_ONLY_FIRST_FAILURE
Optional keyword arg "raise_on_error" raises an exception on the
first unexpected exception or failure. This allows failures to be
post-mortem debugged.
Advanced tomfoolery: testmod runs methods of a local instance of
class doctest.Tester, then merges the results into (or creates)
global Tester instance doctest.master. Methods of doctest.master
can be called directly too, if you want to do something unusual.
Passing report=0 to testmod is especially useful then, to delay
displaying a summary. Invoke doctest.master.summarize(verbose)
when you're done fiddling.
u __main__u testmod: module required; %ru
exclude_emptyu verboseu optionflagsu globsu
extraglobsN( u Noneu sysu modulesu getu inspectu ismoduleu TypeErroru __name__u
DocTestFinderu DebugRunneru
DocTestRunneru findu runu summarizeu masteru mergeu TestResultsu failuresu tries( u mu nameu globsu verboseu reportu optionflagsu
extraglobsu raise_on_erroru
exclude_emptyu finderu runneru test( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu testmod/ s$ E %
c C sW | r | r t d n t | | | | p1 d \ } } | d k r^ t j j | } n | d k rs i } n | j } | d k r | j | n d | k r“ d | d >> import doctest
>>> old = doctest._unittest_reportflags
>>> doctest.set_unittest_reportflags(REPORT_NDIFF |
... REPORT_ONLY_FIRST_FAILURE) == old
True
>>> doctest._unittest_reportflags == (REPORT_NDIFF |
... REPORT_ONLY_FIRST_FAILURE)
True
Only reporting flags can be set:
>>> doctest.set_unittest_reportflags(ELLIPSIS)
Traceback (most recent call last):
...
ValueError: ('Only reporting flags allowed', 8)
>>> doctest.set_unittest_reportflags(old) == (REPORT_NDIFF |
... REPORT_ONLY_FIRST_FAILURE)
True
u Only reporting flags allowed( u REPORTING_FLAGSu
ValueErroru _unittest_reportflags( u flagsu old( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu set_unittest_reportflags/ s
c B s¶ | Ee Z d Z d d d d d d Z d d Z d d Z d d Z d
d Z d d
Z d d Z
d d Z d d Z d d Z
d d Z e Z d d Z d S( u DocTestCasei c C sA t j j | | | _ | | _ | | _ | | _ | | _ d S( N( u unittestu TestCaseu __init__u _dt_optionflagsu _dt_checkeru _dt_testu _dt_setUpu _dt_tearDown( u selfu testu optionflagsu setUpu tearDownu checker( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __init__U s u DocTestCase.__init__c C s, | j } | j d k r( | j | n d S( N( u _dt_testu _dt_setUpu None( u selfu test( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu setUp_ s u DocTestCase.setUpc C s9 | j } | j d k r( | j | n | j j d S( N( u _dt_testu _dt_tearDownu Noneu globsu clear( u selfu test( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu tearDowne s u DocTestCase.tearDownc C sĘ | j } t j } t } | j } | t @s; | t O} n t d | d | j d d } z5 d d | _
| j | d | j d d \ } } Wd | t _ X| rĀ | j
| j | j n d S( Nu optionflagsu checkeru verboseu -iF u outu clear_globsF( u _dt_testu sysu stdoutu StringIOu _dt_optionflagsu REPORTING_FLAGSu _unittest_reportflagsu
DocTestRunneru _dt_checkeru Falseu DIVIDERu runu writeu failureExceptionu format_failureu getvalue( u selfu testu oldu newu optionflagsu runneru failuresu tries( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu runTestm s
"
u DocTestCase.runTestc C sp | j } | j d k r! d } n
d | j } d j | j j d d d
} d | j | j | | | f S( Nu unknown line numberu %su .i u: Failed doctest test for %s
File "%s", line %s, in %s
%si’’’’( u _dt_testu linenou Noneu joinu nameu splitu filename( u selfu erru testu linenou lname( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu format_failure
s
%u DocTestCase.format_failurec C sO | j t d | j d | j d d } | j | j d d | j d S( uŅ Run the test case without results and without catching exceptions
The unit test framework includes a debug method on test cases
and test suites to support post-mortem debugging. The test code
is run in such a way that errors are not caught. This way a
caller can catch the errors and initiate post-mortem debugging.
The DocTestCase provides a debug method that raises
UnexpectedException errors if there is an unexpected
exception:
>>> test = DocTestParser().get_doctest('>>> raise KeyError\n42',
... {}, 'foo', 'foo.py', 0)
>>> case = DocTestCase(test)
>>> try:
... case.debug()
... except UnexpectedException as f:
... failure = f
The UnexpectedException contains the test, the example, and
the original exception:
>>> failure.test is test
True
>>> failure.example.want
'42\n'
>>> exc_info = failure.exc_info
>>> raise exc_info[1] # Already has the traceback
Traceback (most recent call last):
...
KeyError
If the output doesn't match, then a DocTestFailure is raised:
>>> test = DocTestParser().get_doctest('''
... >>> x = 1
... >>> x
... 2
... ''', {}, 'foo', 'foo.py', 0)
>>> case = DocTestCase(test)
>>> try:
... case.debug()
... except DocTestFailure as f:
... failure = f
DocTestFailure objects provide access to the test:
>>> failure.test is test
True
As well as to the example:
>>> failure.example.want
'2\n'
and the actual output:
>>> failure.got
'1\n'
u optionflagsu checkeru verboseu clear_globsNF( u setUpu DebugRunneru _dt_optionflagsu _dt_checkeru Falseu runu _dt_testu tearDown( u selfu runner( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu debug s
B
u DocTestCase.debugc C s
| j j S( N( u _dt_testu name( u self( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu idŁ s u DocTestCase.idc C st t | t | k r t S| j | j k os | j | j k os | j | j k os | j | j k os | j | j k S( N( u typeu NotImplementedu _dt_testu _dt_optionflagsu _dt_setUpu _dt_tearDownu _dt_checker( u selfu other( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __eq__Ü s u DocTestCase.__eq__c C s | | k S( N( ( u selfu other( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __ne__ę s u DocTestCase.__ne__c C s" t | j | j | j | j f S( N( u hashu _dt_optionflagsu _dt_setUpu _dt_tearDownu _dt_checker( u self( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __hash__é s u DocTestCase.__hash__c C s: | j j j d } d | d d j | d d
f S( Nu .u %s (%s)i i’’’’i’’’’( u _dt_testu nameu splitu join( u selfu name( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __repr__ķ s u DocTestCase.__repr__c C s d | j j S( Nu Doctest: ( u _dt_testu name( u self( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu shortDescriptionó s u DocTestCase.shortDescriptionN( u __name__u
__module__u __qualname__u Noneu __init__u setUpu tearDownu runTestu format_failureu debugu idu __eq__u __ne__u __hash__u __repr__u __str__u shortDescription( u
__locals__( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu DocTestCaseS s H
u DocTestCasec B sJ | Ee Z d Z d d Z d d Z d d Z d d Z e Z d S(
u SkipDocTestCasec C s | | _ t j | d d S( N( u moduleu DocTestCaseu __init__u None( u selfu module( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __init__÷ s u SkipDocTestCase.__init__c C s | j d d S( Nu- DocTestSuite will not work with -O2 and above( u skipTest( u self( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu setUpū s u SkipDocTestCase.setUpc C s d S( N( ( u self( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu test_skipž s u SkipDocTestCase.test_skipc C s d | j j S( Nu Skipping tests from %s( u moduleu __name__( u self( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu shortDescription s u SkipDocTestCase.shortDescriptionN( u __name__u
__module__u __qualname__u __init__u setUpu test_skipu shortDescriptionu __str__( u
__locals__( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu SkipDocTestCaseö s
u SkipDocTestCasec K s6 | d k r t } n t | } | j | d | d | } | r{ t j j d k r{ t j } | j t
| | S| s t | d n | j t j } x | D]~ } t
| j d k rŃ q° n | j s| j } | d d
d k r | d d
} n | | _ n | j t | | q° W| S( u
Convert doctest tests for a module to a unittest test suite.
This converts each documentation string in a module that
contains doctest tests to a unittest test case. If any of the
tests in a doc string fail, then the test case fails. An exception
is raised showing the name of the file containing the test and a
(sometimes approximate) line number.
The `module` argument provides the module to be tested. The argument
can be either a module or a module name.
If no argument is given, the calling module is used.
A number of options may be provided as keyword arguments:
setUp
A set-up function. This is called before running the
tests in each file. The setUp function will be passed a DocTest
object. The setUp function can access the test globals as the
globs attribute of the test passed.
tearDown
A tear-down function. This is called after running the
tests in each file. The tearDown function will be passed a DocTest
object. The tearDown function can access the test globals as the
globs attribute of the test passed.
globs
A dictionary containing initial global variables for the tests.
optionflags
A set of doctest option flags expressed as an integer.
u globsu
extraglobsi u has no docstringsi i Nu .pycu .pyoi iü’’’( u .pycu .pyoi’’’’( u Noneu
DocTestFinderu _normalize_moduleu findu sysu flagsu optimizeu unittestu TestSuiteu addTestu SkipDocTestCaseu
ValueErroru sortu lenu examplesu filenameu __file__u DocTestCase( u moduleu globsu
extraglobsu test_finderu optionsu testsu suiteu testu filename( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu DocTestSuite s, %
c B s> | Ee Z d Z d d Z d d Z e Z d d Z d S( u DocFileCasec C s d j | j j j d S( Nu _u .( u joinu _dt_testu nameu split( u self( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu idR s u DocFileCase.idc C s
| j j S( N( u _dt_testu filename( u self( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __repr__U s u DocFileCase.__repr__c C s d | j j | j j | f S( Nu2 Failed doctest test for %s
File "%s", line 0
%s( u _dt_testu nameu filename( u selfu err( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu format_failureY s u DocFileCase.format_failureN( u __name__u
__module__u __qualname__u idu __repr__u __str__u format_failure( u
__locals__( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu DocFileCaseP s u DocFileCasec
K s± | d k r i } n | j } | r= | r= t d n t | | | | pR d \ } } d | k rw | | d >> text = '''
... Here are examples of simple math.
...
... Python has super accurate integer addition
...
... >>> 2 + 2
... 5
...
... And very friendly error messages:
...
... >>> 1/0
... To Infinity
... And
... Beyond
...
... You can use logic if you want:
...
... >>> if 0:
... ... blah
... ... blah
... ...
...
... Ho hum
... '''
>>> print(script_from_examples(text))
# Here are examples of simple math.
#
# Python has super accurate integer addition
#
2 + 2
# Expected:
## 5
#
# And very friendly error messages:
#
1/0
# Expected:
## To Infinity
## And
## Beyond
#
# You can use logic if you want:
#
if 0:
blah
blah
#
# Ho hum
Ni u # Expected:c S s g | ] } d | q S( u ## ( ( u .0u l( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu
s u( script_from_examples..u
c S s g | ] } t | q S( ( u
_comment_line( u .0u l( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu
s u #i i’’’’i’’’’i’’’’i’’’’(
u
DocTestParseru parseu
isinstanceu Exampleu appendu sourceu wantu splitu popu join( u su outputu pieceu want( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu script_from_examplesĮ s :
0 "c sl t | } t j | } f d d | D } | sO t d n | d } t | j } | S( u Extract the test sources from a doctest docstring as a script.
Provide the module (or dotted name of the module) containing the
test to be debugged and the name (within the module) of the object
with the doc string with tests to be debugged.
c s% g | ] } | j k r | q S( ( u name( u .0u t( u name( u, /opt/alt/python33/lib64/python3.3/doctest.pyu
s u testsource..u not found in testsi ( u _normalize_moduleu
DocTestFinderu findu
ValueErroru script_from_examplesu docstring( u moduleu nameu testsu testu testsrc( ( u nameu, /opt/alt/python33/lib64/python3.3/doctest.pyu
testsource
s
c C s t | } t | | | d S( u4 Debug a single doctest docstring, in argument `src`'N( u script_from_examplesu debug_script( u srcu pmu globsu testsrc( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu debug_src#
s c
C sĄ d d l } | r! | j } n i } | r y t | | | Wq¼ t t j d | j d d } | j | j d t j d Yq¼ Xn# | j d d j d | | | d S( u7 Debug a test script. `src` is the script, as a string.i Ni u nosiginti u exec(%r)T( u pdbu copyu execu printu sysu exc_infou Pdbu Trueu resetu interactionu Noneu run( u srcu pmu globsu pdbu p( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu debug_script(
s
"u debug_scriptc C s2 t | } t | | } t | | | j d S( uå Debug a single doctest docstring.
Provide the module (or dotted name of the module) containing the
test to be debugged and the name (within the module) of the object
with the docstring with tests to be debugged.
N( u _normalize_moduleu
testsourceu debug_scriptu __dict__( u moduleu nameu pmu testsrc( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu debug<
s c B s> | Ee Z d Z d Z d d Z d d Z d d Z d S( u
_TestClassuå
A pointless class, for sanity-checking of docstring testing.
Methods:
square()
get()
>>> _TestClass(13).get() + _TestClass(-12).get()
1
>>> hex(_TestClass(13).square().get())
'0xa9'
c C s
| | _ d S( u val -> _TestClass object with associated value val.
>>> t = _TestClass(123)
>>> print(t.get())
123
N( u val( u selfu val( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu __init__X
s u _TestClass.__init__c C s | j d | _ | S( uo square() -> square TestClass's associated value
>>> _TestClass(13).square().get()
169
i ( u val( u self( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu squareb
s u _TestClass.squarec C s | j S( u~ get() -> return TestClass's associated value.
>>> x = _TestClass(-42)
>>> print(x.get())
-42
( u val( u self( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu getl
s u _TestClass.getN( u __name__u
__module__u __qualname__u __doc__u __init__u squareu get( u
__locals__( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu
_TestClassJ
s
u
_TestClassuÄ
Example of a string object, searched as-is.
>>> x = 1; y = 2
>>> x + y, x * y
(3, 2)
u stringuÜ
In 2.2, boolean expressions displayed
0 or 1. By default, we still accept
them. This can be disabled by passing
DONT_ACCEPT_TRUE_FOR_1 to the new
optionflags argument.
>>> 4 == 4
1
>>> 4 == 4
True
>>> 4 > 4
0
>>> 4 > 4
False
u bool-int equivalenceuē
Blank lines can be marked with :
>>> print('foo\n\nbar\n')
foo
bar
u blank linesuś
If the ellipsis flag is used, then '...' can be used to
elide substrings in the desired output:
>>> print(list(range(1000))) #doctest: +ELLIPSIS
[0, 1, 2, ..., 999]
u ellipsisu
If the whitespace normalization flag is used, then
differences in whitespace are ignored.
>>> print(list(range(30))) #doctest: +NORMALIZE_WHITESPACE
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26,
27, 28, 29]
u whitespace normalizationc C s& d d t j d d
D } | s t j j t j d } d t k ri t j j | \ } } n t d j | d Sx | D] } | j d rü t j j
| \ } } t j j d | t | d d
} t j d =t
| \ } } n t | d
d \ } } | r d Sq Wd S(
Nc S s, g | ]" } | r | d d k r | q S( i u -( ( u .0u arg( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu
Ŗ
s u _test..i i u
__loader__u usage: {0} [-v] file ...i u .pyi u module_relativeiż’’’F( u sysu argvu osu pathu basenameu globalsu splitextu printu formatu endswithu splitu insertu
__import__u testmodu testfileu False( u testfilesu nameu _u filenameu dirnameu mu failures( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu _test©
s$
u _testu __main__(R u __doc__u
__docformat__u __all__u
__future__u difflibu inspectu linecacheu osu pdbu reu sysu tracebacku unittestu iou StringIOu collectionsu
namedtupleu TestResultsu OPTIONFLAGS_BY_NAMEu register_optionflagu DONT_ACCEPT_TRUE_FOR_1u DONT_ACCEPT_BLANKLINEu NORMALIZE_WHITESPACEu ELLIPSISu SKIPu IGNORE_EXCEPTION_DETAILu COMPARISON_FLAGSu REPORT_UDIFFu REPORT_CDIFFu REPORT_NDIFFu REPORT_ONLY_FIRST_FAILUREu REPORTING_FLAGSu BLANKLINE_MARKERu ELLIPSIS_MARKERu _extract_future_flagsu _normalize_moduleu _load_testfileu _indentu _exception_tracebacku _SpoofOutu _ellipsis_matchu
_comment_lineu _strip_exception_detailsu Pdbu _OutputRedirectingPdbu _module_relative_pathu Exampleu DocTestu
DocTestParseru
DocTestFinderu
DocTestRunneru
OutputCheckeru Exceptionu DocTestFailureu UnexpectedExceptionu DebugRunneru Noneu masteru Trueu Falseu testmodu testfileu run_docstring_examplesu _unittest_reportflagsu set_unittest_reportflagsu TestCaseu DocTestCaseu SkipDocTestCaseu DocTestSuiteu DocFileCaseu DocFileTestu DocFileSuiteu script_from_examplesu
testsourceu debug_srcu debug_scriptu debugu
_TestClassu __test__u _testu __name__u exit( ( ( u, /opt/alt/python33/lib64/python3.3/doctest.pyu . sņ 1 % $GMė’ 2’ ¶n f x $£I I R ,