gc ! @ 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! d" g! Z d# d$ k Z d# d$ k Z d# d$ k Z d# d$ k Z d# d$ k Z d# d$ k Z d# d$ k Z d# d$ k
Z
d# d$ k Z d# d$ k Z d# d$ k
Z
d# d$ k Z d# d% k l Z d# d& k l Z e d' d( Z h Z 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, Z# d- d. Z$ d/ Z% e& e i' d0 e( p d1 Z) d2 d3 Z* d4 Z+ d5 e f d6 YZ, d7 Z- d8 Z. d9 e i/ f d: YZ0 d; Z1 d f d< YZ2 d f d= YZ3 d f d> YZ4 d f d? YZ5 d f d@ YZ6 d f dA YZ7 d e8 f dB YZ9 d e8 f dC YZ: d e6 f dD YZ; e( a< e( e( e( e( e= dE e( e> e> dF Z? e= e( e( e( e( e= dE e( e> e4 e( dG Z@ e> dH e( dE dI ZA d f dJ YZB dE aC dK ZD dL e
iE f dM YZF e( e( e( e( dN ZG dO eF f dP YZH e= e( e( e4 e( dQ ZI dR ZJ dS ZK dT ZL e> e( dU ZM e> e( dV ZN e> dW ZO dX f dY YZP h eP dX 6dZ d[ 6d\ d] 6d^ d_ 6d` da 6db dc 6ZQ dd ZR eS de j o e iT eR n d$ S(f s 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.
s reStructuredText ent register_optionflagt DONT_ACCEPT_TRUE_FOR_1t DONT_ACCEPT_BLANKLINEt NORMALIZE_WHITESPACEt ELLIPSISt SKIPt IGNORE_EXCEPTION_DETAILt COMPARISON_FLAGSt REPORT_UDIFFt REPORT_CDIFFt REPORT_NDIFFt REPORT_ONLY_FIRST_FAILUREt REPORTING_FLAGSt Examplet DocTestt
DocTestParsert
DocTestFindert
DocTestRunnert
OutputCheckert DocTestFailuret UnexpectedExceptiont DebugRunnert testmodt testfilet run_docstring_examplest Testert DocTestSuitet DocFileSuitet set_unittest_reportflagst script_from_examplest
testsourcet debug_srct debugiN( t StringIO( t
namedtuplet TestResultss failed attemptedc C s t i | d t t > S( Ni ( t OPTIONFLAGS_BY_NAMEt
setdefaultt len( t name( ( s /usr/lib/python2.6/doctest.pyR s s s ...c C sW d } xJ t i D]? } | i | d } | t t | j o | | i O} q q W| S( s
Return the compiler-flags associated with the future features that
have been imported into the given namespace (globs).
i N( t
__future__t all_feature_namest gett Nonet getattrt
compiler_flag( t globst flagst fnamet feature( ( s /usr/lib/python2.6/doctest.pyt _extract_future_flags s
i c C s t i | o | St | t t f o t | t t d g S| d j o t i
t i | i d St
d d S( s
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.
t *t __name__s" Expected a module, string, or NoneN( t inspectt ismodulet
isinstancet strt unicodet
__import__t globalst localsR+ t syst modulest _getframet f_globalst TypeError( t modulet depth( ( s /usr/lib/python2.6/doctest.pyt _normalize_module s
c C s | ou t | d } t | | } t | d oC t | i d o, | i i | } | i t i d | f Sq| n t | i | f S( Ni t
__loader__t get_datas
(
RD t _module_relative_patht hasattrRE RF t replacet ost linesept opent read( t filenamet packaget module_relativet
file_contents( ( s /usr/lib/python2.6/doctest.pyt _load_testfile s "t encodings utf-8i c C s= t | t o | i t d } n t i d | d | S( s
Add the given number of space characters to the beginning of
every non-blank line in `s`, and return the result.
If the string `s` is Unicode, it is encoded using the stdout
encoding and the `backslashreplace` error handler.
t backslashreplaces
(?m)^(?!$)t ( R7 R9 t encodet _encodingt ret sub( t st indent( ( s /usr/lib/python2.6/doctest.pyt _indent s c C s; t } | \ } } } t i | | | d | | i S( sz
Return a string containing a traceback message for the given
exc_info tuple (as returned by sys.exc_info()).
t file( R! t tracebackt print_exceptiont getvalue( t exc_infot excoutt exc_typet exc_valt exc_tb( ( s /usr/lib/python2.6/doctest.pyt _exception_traceback s t _SpoofOutc B s e Z d Z d d Z RS( c C sS t i | } | o | i d o | d 7} n t | d o
| ` n | S( Ns
t softspace( R! R` t endswithRH Rh ( t selft result( ( s /usr/lib/python2.6/doctest.pyR` s
c C sE t i | | t | d o
| ` n | i p
d | _ n d S( NRh t ( R! t truncateRH Rh t buf( Rj t size( ( s /usr/lib/python2.6/doctest.pyRm s
N( R4 t
__module__R` R+ Rm ( ( ( s /usr/lib/python2.6/doctest.pyRg s
c C s t | j o | | j S| i t } d t | } } | d } | o/ | i | o t | } | d =qz t Sn | d } | o3 | i | o | t | 8} | d =q t Sn | | j o t SxE | D]= } | i | | | } | d j o t S| t | 7} q Wt S( s_
Essentially the only subtle case:
>>> _ellipsis_match('aa...aa', 'aaa')
False
i i( t ELLIPSIS_MARKERt splitR& t
startswitht FalseRi t findt True( t wantt gott wst startpost endpost w( ( s /usr/lib/python2.6/doctest.pyt _ellipsis_match s2
c C s$ | i } | o d | Sd Sd S( s) Return a commented form of the given lines # t #N( t rstrip( t line( ( s /usr/lib/python2.6/doctest.pyt
_comment_line@ s t _OutputRedirectingPdbc B s5 e Z d Z d Z d d Z d Z d Z RS( s
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 s5 | | _ t | _ t i i | d | d | _ d S( Nt stdouti ( t _OutputRedirectingPdb__outRt t$ _OutputRedirectingPdb__debugger_usedt pdbt Pdbt __init__t use_rawinput( Rj t out( ( s /usr/lib/python2.6/doctest.pyR N s c C s@ t | _ | d j o t i i } n t i i | | d S( N( Rv R R+ R= R? t f_backR R t set_trace( Rj t frame( ( s /usr/lib/python2.6/doctest.pyR U s
c C s" | i o t i i | n d S( N( R R R t set_continue( Rj ( ( s /usr/lib/python2.6/doctest.pyR [ s
c G s= t i } | i t _ z t i i | | SWd | t _ Xd S( N( R= R R R R t trace_dispatch( Rj t argst save_stdout( ( s /usr/lib/python2.6/doctest.pyR a s
N( R4 Rp t __doc__R R+ R R R ( ( ( s /usr/lib/python2.6/doctest.pyR H s
c C s t i | p t d | n | i d o
t d n t | d o t i i | i d } n} | i
d j oX t t i
d j o5 t i
d d j o! t i i t i
d d } q t i } n t d | d t i i | | i d S(
Ns Expected a module: %rt /s1 Module-relative files may not have absolute pathst __file__i t __main__Rl s+ Can't resolve paths relative to the module s (it has no __file__)( R5 R6 RA Rs t
ValueErrorRH RJ t pathRr R R4 R& R= t argvt curdirt join( RB R t basedir( ( s /usr/lib/python2.6/doctest.pyRG l s
*!
c B s# e Z d Z d d d d d Z RS( sn
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 preceed 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 | i d p | d 7} n | o | i d o | d 7} n | d j o | i d o | d 7} n | | _ | | _ | | _ | | _ | d j o
h } n | | _ | | _ d S( Ns
( Ri R+ t sourceRw t linenoR[ t optionst exc_msg( Rj R Rw R R R[ R ( ( s /usr/lib/python2.6/doctest.pyR s
N( R4 Rp R R+ R ( ( ( s /usr/lib/python2.6/doctest.pyR
s " c B s) e Z d Z d Z d Z d Z RS( se
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@ | | _ | | _ | i | _ | | _ | | _ | | _ d S( s
Create a new DocTest containing the given examples. The
DocTest's globals are initialized with a copy of `globs`.
N( t examplest docstringt copyR. R' RN R ( Rj R R. R' RN R R ( ( s /usr/lib/python2.6/doctest.pyR s c C sp t | i d j o
d } n4 t | i d j o
d } n d t | i } d | i | i | i | f S( Ni s no examplesi s 1 examples %d exampless ( R& R R' RN R ( Rj R ( ( s /usr/lib/python2.6/doctest.pyt __repr__ s
c C sX t | t p d St | i | i | i t | f | i | i | i t | f S( Ni( R7 R t cmpR' RN R t id( Rj t other( ( s /usr/lib/python2.6/doctest.pyt __cmp__ s !( R4 Rp R R R R ( ( ( s /usr/lib/python2.6/doctest.pyR s c B s e Z d Z e i d e i e i B Z e i d e i e i Be i B Z e i d i
Z d d Z d Z
d d Z d Z e i d e i Z d
Z e i d e i Z d Z d
Z d Z RS( sD
A class used to parse strings containing doctest examples.
s
# 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
)*)
s
# 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.
s ^[ ]*(#.*)?$s c C s | i } | i | } | d j o; d i g } | i d D] } | | | qB ~ } n g } d \ } } x | i i | D] } | i | | | i ! | | i d | | i 7} | i | | | \ }
} } }
| i
|
pB | i t |
| |
d | d | t | i
d d | n | | i d | i | i 7} | i } q W| i | | | S( s=
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 s
R R[ R ( i i ( t
expandtabst _min_indentR Rr t _EXAMPLE_REt finditert appendt startt countt _parse_examplet _IS_BLANK_OR_COMMENTR
R& t groupt end( Rj t stringR' t
min_indentt _[1]t lt outputt charnoR t mR R Rw R ( ( s /usr/lib/python2.6/doctest.pyt parse1 s(
; !%c C s% t | i | | | | | | | S( s"
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.
( R t get_examples( Rj R R. R' RN R ( ( s /usr/lib/python2.6/doctest.pyt get_doctestX s c C s? g } | i | | D]! } t | t o | | q q ~ S( s
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.
( R R7 R
( Rj R R' R t x( ( s /usr/lib/python2.6/doctest.pyR d s c
C s t | i d } | i d i d } | i | | | | | i | d d | d | | d i g } | D] } | | | d qv ~ } | i d } | i d }
t |
d j o" t i d |
d
o |
d
=n | i |
d | | | t | d i g } |
D] } | | | q ~ } | i i | } | o | i d }
n d }
| i
| | | } | | | |
f S(
s
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.
R[ R s
i RU t .i Rw s *$it msgN( R& R Rr t _check_prompt_blankt
_check_prefixR RX t matcht
_EXCEPTION_RER+ t
_find_options( Rj R R' R R[ t source_linesR t slR Rw t
want_linest _[2]t wlR R ( ( s /usr/lib/python2.6/doctest.pyR r s$ "2* .s #\s*doctest:\s*([^\n\'"]*)$c C s h } x | i i | D] } | i d i d d i } xs | D]k } | d d j p | d t j o! t d | d | | f n t | d } | d d j | | $
c C s | d j o t St i | d j o | t i | j St i | o | i | i j St i | o | i | i j St
| d o | i | i j St | t o t St
d d S( sY
Return true if the given object is defined in the given
module.
Rp s" object must be a class or functionN( R+ Rv R5 R t
isfunctionR t func_globalst isclassR4 Rp RH R7 t propertyR ( Rj RB t object( ( s /usr/lib/python2.6/doctest.pyt _from_moduleh s
c
C s- | i o
d | GHn t | | j o d Sd | t | <| i | | | | | } | d j o | i | n t i | o | i o x | i i D]r \ } }
d | | f } t i
|
p t i |
o6 | i | |
o# | i
| |
| | | | | q q Wn t i | o | i o x t | d h i D] \ } }
t | t p t d t | f n t i
|
p= t i |
p- t i |
p t i |
p
t |
t p t d t |
f n d | | f } | i
| |
| | | | | qOWn t i | o | i o x | i i D] \ } }
t |
t o t | | }
n t |
t o t | | i }
n t i
|
p t i |
p t |
t oF | i | |
o3 d | | f } | i
| |
| | | | | qVqVWn d S( sm
Find tests for the given object and any contained objects, and
add them to `tests`.
s Finding tests in %sNi s %s.%st __test__s5 DocTestFinder.find: __test__ keys must be strings: %rs` DocTestFinder.find: __test__ values must be strings, functions, methods, classes, or modules: %rs %s.__test__.%s( R R t _get_testR+ R R5 R6 R R t itemsR R R R R, R7 t
basestringR R t ismethodt staticmethodt classmethodt im_funcR ( Rj R R R' RB R R. t seent testt valnamet val( ( s /usr/lib/python2.6/doctest.pyR | sV
c C s t | t o
| } nj yG | i d j o
d } n* | i } t | t p t | } n Wn t t f j
o
d } n X| i | | } | i o
| o d S| d j o
d } n5 t | d | i
} | d d j o | d } n | i i | | | | | S( ss
Return a DocTest for the given object, if it defines a docstring;
otherwise, return None.
Rl R is .pycs .pyoiN( s .pycs .pyo(
R7 R R R+ R8 RA t AttributeErrort _find_linenoR R, R4 R R ( Rj R R' RB R. R R R RN ( ( s /usr/lib/python2.6/doctest.pyR s(
c C s d } t i | o
d } n t i | om | d j o d St i d t | d d } x9 t | D]' \ } } | i | o | } Pqn qn Wn t i | o
| i
} n t i | o
| i } n t i
| o
| i } n t i | o
| i } n t i | o t | d d d } n | d j ob | d j o | d St i d } x: t | t | D] } | i | | o | SqWn d S( s
Return a line number of the given object's docstring. Note:
this method assumes that the object has a docstring.
i s ^\s*class\s*%s\bR4 t -t co_firstlinenoi s (^|.*:)\s*\w*("|')N( R+ R5 R6 R RX R R, R R R R R t func_codet istracebackt tb_framet isframet f_codet iscodet rangeR& ( Rj R R R t patR R ( ( s /usr/lib/python2.6/doctest.pyR s@
N(
R4 Rp R Rt R Rv R R+ Ru R R R R ( ( ( s /usr/lib/python2.6/doctest.pyR s ] ? %c B s e Z d Z d d Z d d d d Z d Z d Z d Z d Z d Z
d
Z d Z e
i d Z d d
Z d d e d Z d d Z d Z RS( s2
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`.
R3 iF i c C sy | p t | _ | d j o d t i j } n | | _ | | _ | | _ d | _ d | _ h | _
t | _ d S( sc
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.
s -vi N(
R t _checkerR+ R= R R t optionflagst original_optionflagst triest failurest _name2ftRg t _fakeout( Rj t checkerR R ( ( s /usr/lib/python2.6/doctest.pyR P s
c C sc | i oU | i o, | d t | i d t | i q_ | d t | i d n d S( s
Report that the test runner is about to process the given
example. (Only displays a message if verbose=True)
s Trying:
s Expecting:
s Expecting nothing
N( R Rw R\ R ( Rj R R t example( ( s /usr/lib/python2.6/doctest.pyt report_startt s
)c C s | i o | d n d S( st
Report that the given example ran successfully. (Only
displays a message if verbose=True)
s ok
N( R ( Rj R R R Rx ( ( s /usr/lib/python2.6/doctest.pyt report_success s
c C s3 | | i | | | i i | | | i d S( s7
Report that the given example failed.
N( t _failure_headerR t output_differenceR ( Rj R R R Rx ( ( s /usr/lib/python2.6/doctest.pyt report_failure s c C s. | | i | | d t t | d S( sO
Report that the given example raised an unexpected exception.
s Exception raised:
N( R R\ Rf ( Rj R R R Ra ( ( s /usr/lib/python2.6/doctest.pyt report_unexpected_exception s c C s | i g } | i ob | i d j o( | i d j o | i | i d } n d } | i d | i | | i f n" | i d | i d | i f | i d | i } | i t | d i | S( Ni t ?s File "%s", line %s, in %ss Line %s, in %ss Failed example:s
( t DIVIDERRN R R+ R R' R R\ R ( Rj R R R R R ( ( s /usr/lib/python2.6/doctest.pyR s
!
c B s d } } | i } e d \ } } } | i i }
xNe | i D]=\ } } | i e @o
| d j }
| | _ | i oN xK | i i D]6 \ } } | o | i | O_ q | i | M_ q Wn | i e @o qD n | d 7} |
p | i
| | | n d | i | f } y7 e | i
| d | d | i U| i i d } Wn5 e j
o
n! e i } | i i n X| i i } | i i d | } | d j o' |
| i | | i o
| } qn e i } e i | d d } |
p | e | 7} n | i d j o
| } n |
| i | | i o
| } nz | i e @ok e i d | i } e i d | } | o9 | o2 |
| i d | i d | i o
| } qn | | j o% |
p | i! | | | | qqD | | j o/ |
p | i" | | | | n | d 7} qD | | j o/ |
p | i# | | | | n | d 7} qD qD W| | _ | i$ | | | e% | | S(
s
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 s t singlei is [^:]*:N(& R R
R t check_outputR R R R R R R R' R R R. t debuggerR R+ t KeyboardInterruptR= Ra R R` Rm Rw R^ t format_exception_onlyRf R R RX R R R R R t _DocTestRunner__record_outcomeR# ( Rj R t compileflagsR R R R t SUCCESSt FAILUREt BOOMt checkt
examplenumR t quiett
optionflagR RN t exceptionRx t outcomeRa R t m1t m2( ( s /usr/lib/python2.6/doctest.pyt __run s
)
c C s^ | i i | i d \ } } | | | | f | i | i <| i | 7_ | i | 7_ d S( s{
Record the fact that the given DocTest (`test`) generated `f`
failures out of `t` tried examples.
i N( i i ( R R* R' R R ( Rj R t ft tt f2t t2( ( s /usr/lib/python2.6/doctest.pyt __record_outcome' s s3 [\w\.]+)\[(?P\d+)\]>$c C s | i i | } | o^ | i d | i i j oB | i i t | i d } | i i d d } | i t
S| i | | Sd S( NR' R+ t asciiRT ( t% _DocTestRunner__LINECACHE_FILENAME_RER R R R' R t intR RV t
splitlinesRv t save_linecache_getlines( Rj RN t module_globalsR R R ( ( s /usr/lib/python2.6/doctest.pyt __patched_linecache_getlines4 s # c C s | | _ | d j o t | i } n t i } | d j o
| i } n | i t _ t i } t
| | _ | i i | i i t _ t
i | _ | i t
_ t i } t i t _ z | i | | | SWd | t _ | t _ | i t
_ | t _ | o | i i n Xd S( sJ
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.
N( R R+ R2 R. R= R t writeR R R R R" t resetR R R< t* _DocTestRunner__patched_linecache_getlinest displayhookt __displayhook__t _DocTestRunner__runt clear( Rj R R& R t clear_globsR t save_set_tracet save_displayhook( ( s /usr/lib/python2.6/doctest.pyt run= s.
c
C s" | d j o
| i } n g } g } g } d } } x | i i D]{ } | \ } \ } }
| |
7} | | 7} |
d j o | i | qF | d j o | i | |
f qF | i | qF W| o | o7 t | Gd GH| i x | D] } d G| GHq Wn | oC t | Gd GH| i x' | D] \ } } d | | f GHq1WqXn | oT | i GHt | Gd GH| i x0 | D]$ \ } \ } }
d | |
| f GHqWn | o3 | Gd Gt | i Gd GH| | Gd
G| Gd GHn | o d G| Gd
GHn | o d GHn t | | S( s
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 s items had no tests:s s items passed all tests:s %3d tests in %ss items had failures:s %3d of %3d in %ss tests ins items.s
passed ands failed.s ***Test Failed***s failures.s Test passed.N( R+ R R R R R& R R R# (
Rj R t notestst passedt failedt totaltt totalfR R' R3 R4 t thingR ( ( s /usr/lib/python2.6/doctest.pyt summarize{ sX
c C sx | i } xh | i i D]W \ } \ } } | | j o( | | \ } } | | } | | } n | | f | | 9c B s) e Z d Z d Z d Z d Z RS( s_
A class used to check the whether the actual output from a doctest
example matches the expected output. `OutputChecker` defines two
methods: `check_output`, which compares a given pair of outputs,
and returns true if they match; and `output_difference`, which
returns a string describing the differences between two outputs.
c C s | | j o t S| t @p4 | | f d j o t S| | f d
j o t Sn | t @pM t i d t i t d | } t i d d | } | | j o t Sn | t @o@ d i | i } d i | i } | | j o t Sn | t
@o t | | o t Sn t S( s
Return True iff the actual output from an example (`got`)
matches the expected output (`want`). These strings are
always considered to match if they are identical; but
depending on what option flags the test runner is using,
several non-exact match types are also possible. See the
documentation for `TestRunner` for more information about
option flags.
s True
s 1
s False
s 0
s (?m)^%s\s*?$Rl s
(?m)^\s*?$RU ( s True
s 1
( s False
s 0
(
Rv R R RX RY t escapet BLANKLINE_MARKERR R Rr R R} Rt ( Rj Rw Rx R ( ( s /usr/lib/python2.6/doctest.pyR! s,
c C sQ | t t Bt B@p t S| t @o t S| i d d j o | i d d j S( Ns
i ( R R R
Rt Rv R ( Rj Rw Rx R ( ( s /usr/lib/python2.6/doctest.pyt _do_a_fancy_diff s c C s | i } | t @p t i d t | } n | i | | | o!| i t } | i t } | t @o2 t i
| | d d } t | d } d } n | t @o2 t i
| | d d } t | d } d } nC | t @o7 t i d t i } t | i | | } d } n g }
| D] } |
| i d q(~
} d | t d
i | S| o" | o d t | t | f S| o d t | S| o d
t | Sd Sd S( s
Return a string describing the differences between the
expected output for a given example (`example`) and the actual
output (`got`). `optionflags` is the set of option flags used
to compare `want` and `got`.
s (?m)^[ ]*(?=
)t ni s# unified diff with -expected +actuals- context diff with expected followed by actualt charjunks ndiff with -expected +actuals
s Differences (%s):
Rl s Expected:
%sGot:
%ss Expected:
%sGot nothing
s Expected nothing
Got:
%ss Expected nothing
Got nothing
N( Rw R RX RY RT RU R; Rv R t difflibt unified_difft listR t context_diffR
t Differt IS_CHARACTER_JUNKt compareR R\ R ( Rj R Rx R Rw R t got_linest difft kindt engineR R ( ( s /usr/lib/python2.6/doctest.pyR s6
+ ( R4 Rp R R! RU R ( ( ( s /usr/lib/python2.6/doctest.pyR s 6 c B s e Z d Z d Z d Z RS( s 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( R R Rx ( Rj R R Rx ( ( s /usr/lib/python2.6/doctest.pyR Q s c C s
t | i S( N( R8 R ( Rj ( ( s /usr/lib/python2.6/doctest.pyt __str__V s ( R4 Rp R R Rc ( ( ( s /usr/lib/python2.6/doctest.pyR F s
c B s e Z d Z d Z d Z RS( s 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( R R Ra ( Rj R R Ra ( ( s /usr/lib/python2.6/doctest.pyR d s c C s
t | i S( N( R8 R ( Rj ( ( s /usr/lib/python2.6/doctest.pyRc i s ( R4 Rp R R Rc ( ( ( s /usr/lib/python2.6/doctest.pyR Y s
c B s2 e Z d Z d d e d Z d Z d Z RS( s{ 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, failure:
... pass
>>> failure.test is test
True
>>> failure.example.want
'42\n'
>>> exc_info = failure.exc_info
>>> raise exc_info[0], exc_info[1], exc_info[2]
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, failure:
... pass
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):
...
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 s7 t i | | | | t } | o | i i n | S( N( R RI Rt R. RE ( Rj R R& R RF t r( ( s /usr/lib/python2.6/doctest.pyRI s c C s t | | | d S( N( R ( Rj R R R Ra ( ( s /usr/lib/python2.6/doctest.pyR s c C s t | | | d S( N( R ( Rj R R R Rx ( ( s /usr/lib/python2.6/doctest.pyR s N( R4 Rp R R+ Rv RI R R ( ( ( s /usr/lib/python2.6/doctest.pyR l s Y i c C s* | d j o t i i d } n t i | p t d | f n | d j o
| i } n t d | } | o t d | d | }
n t
d | d | }
x3 | i | | d | d | D] } |
i | q W| o |
i
n t d j o
|
a n t i |
t |
i |
i S( s,
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 doctest.__doc__ 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.
R s testmod: module required; %rR R R R. R N( R+ R= R> R* R5 R6 RA R4 R R R Ru RI RP t masterRR R# R R ( R R' R. R t reportR R t raise_on_errorR t findert runnerR ( ( s /usr/lib/python2.6/doctest.pyR s& E
c C s | o | o t d n t | | | \ } } | d j o t i i | } n | d j o
h } n
| i } | d j o | i | n d | j o 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
s Only reporting flags allowed( R R t _unittest_reportflags( R/ t old( ( s /usr/lib/python2.6/doctest.pyR s
t DocTestCasec B sk e Z d d
d
d
d Z d Z d Z d Z d Z d Z d Z d Z
e
Z d Z RS( i c C sA t i i | | | _ | | _ | | _ | | _ | | _ d S( N( t unittestt TestCaseR t _dt_optionflagst _dt_checkert _dt_testt _dt_setUpt _dt_tearDown( Rj R R t setUpt tearDownR ( ( s /usr/lib/python2.6/doctest.pyR E s c C s. | i } | i d j o | i | n d S( N( R R R+ ( Rj R ( ( s /usr/lib/python2.6/doctest.pyR O s c C s; | i } | i d j o | i | n | i i d S( N( R R R+ R. RE ( Rj R ( ( s /usr/lib/python2.6/doctest.pyR U s c C s | i } t i } t } | i } | t @p | t O} n t d | d | i d t } z5 d d | _
| i | d | i d t \ } } Wd | t _ X| o" | i
| i | i n d S( NR R R R iF R RF ( R R= R R! R R R| R R Rt R RI R? t failureExceptiont format_failureR` ( Rj R R} t newR Ri R R ( ( s /usr/lib/python2.6/doctest.pyt runTest] s
"
c C sl | i } | i d j o
d } n d | i } d i | i i d d } d | i | i | | | f S( Ns unknown line numbers %sR is: Failed doctest test for %s
File "%s", line %s, in %s
%s( R R R+ R R' Rr RN ( Rj t errR R t lname( ( s /usr/lib/python2.6/doctest.pyR u s
c C sO | i t d | i d | i d t } | i | i d t | i d S( s 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 unexepcted
exception:
>>> test = DocTestParser().get_doctest('>>> raise KeyError\n42',
... {}, 'foo', 'foo.py', 0)
>>> case = DocTestCase(test)
>>> try:
... case.debug()
... except UnexpectedException, failure:
... pass
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[0], exc_info[1], exc_info[2]
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, failure:
... pass
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'
R R R RF N( R R R R Rt RI R R ( Rj Ri ( ( s /usr/lib/python2.6/doctest.pyR s
B
c C s
| i i S( N( R R' ( Rj ( ( s /usr/lib/python2.6/doctest.pyR s c C s4 | i i i d } d | d d i | d f S( NR s %s (%s)i( R R' Rr R ( Rj R' ( ( s /usr/lib/python2.6/doctest.pyR s c C s d | i i S( Ns Doctest: ( R R' ( Rj ( ( s /usr/lib/python2.6/doctest.pyt shortDescription s N(
R4 Rp R+ R R R R R R R R Rc R ( ( ( s /usr/lib/python2.6/doctest.pyR~ C s H c K s | d j o
t } n t | } | i | d | d | } | p t | d n | i t i } x | D]x } t | i d j o qx n | i
p5 | i } | d d
j o | d } n | | _
n | i t
| | qx W| S( s
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.
R. R s has no testsi is .pycs .pyoiN( s .pycs .pyo( R+ R RD Ru R R R t TestSuiteR& R RN R t addTestR~ ( RB R. R t test_finderR R t suiteR RN ( ( s /usr/lib/python2.6/doctest.pyR s& %
t DocFileCasec B s) e Z d Z d Z e Z d Z RS( c C s d i | i i i d S( Nt _R ( R R R' Rr ( Rj ( ( s /usr/lib/python2.6/doctest.pyR s c C s
| i i S( N( R RN ( Rj ( ( s /usr/lib/python2.6/doctest.pyR s c C s d | i i | i i | f S( Ns2 Failed doctest test for %s
File "%s", line 0
%s( R R' RN ( Rj R ( ( s /usr/lib/python2.6/doctest.pyR s ( R4 Rp R R Rc R ( ( ( s /usr/lib/python2.6/doctest.pyR s c
K s | d j o
h } n
| i } | o | o t d n t | | | \ } } d | j o | | 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
is # Expected:s
s ## R~ i ( R R R7 R
R R Rw Rr R t popR ( RZ R t pieceRw R R R ( ( s /usr/lib/python2.6/doctest.pyR s$ :
>
2 c C s t | } t i | } g } | D]! } | i | j o | | q) q) ~ } | p t | d n | d } t | i } | S( s 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.
s not found in testsi ( RD R Ru R' R R R ( RB R' R R R4 R t testsrc( ( s /usr/lib/python2.6/doctest.pyR s 5
c C s t | } t | | | d S( s4 Debug a single doctest docstring, in argument `src`'N( R t debug_script( t srct pmR. R ( ( s /usr/lib/python2.6/doctest.pyR s c C s d d k } t i d d } t | d } | i | | i z | o | i } n h } | oH y t | | | Wq t i d GH| i
t i d q Xn | i d | | | Wd t i
| Xd S( s7 Debug a test script. `src` is the script, as a string.iNs .pyt doctestdebugR| i i s execfile(%r)( R t tempfilet mktempRL R? t closeR t execfileR= Ra t post_mortemRI RJ t remove( R R R. R t srcfilenameR3 ( ( s /usr/lib/python2.6/doctest.pyR s"
c C s2 t | } t | | } t | | | i d S( s 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( RD R R R ( RB R' R R ( ( s /usr/lib/python2.6/doctest.pyR
s t
_TestClassc B s) e Z d Z d Z d Z d Z RS( s
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( s val -> _TestClass object with associated value val.
>>> t = _TestClass(123)
>>> print t.get()
123
N( R ( Rj R ( ( s /usr/lib/python2.6/doctest.pyR )
s c C s | i d | _ | S( so square() -> square TestClass's associated value
>>> _TestClass(13).square().get()
169
i ( R ( Rj ( ( s /usr/lib/python2.6/doctest.pyt square3
s c C s | i S( s} get() -> return TestClass's associated value.
>>> x = _TestClass(-42)
>>> print x.get()
-42
( R ( Rj ( ( s /usr/lib/python2.6/doctest.pyR* =
s ( R4 Rp R R R R* ( ( ( s /usr/lib/python2.6/doctest.pyR
s
s
Example of a string object, searched as-is.
>>> x = 1; y = 2
>>> x + y, x * y
(3, 2)
R s
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
s bool-int equivalences
Blank lines can be marked with :
>>> print 'foo\n\nbar\n'
foo
bar
s blank liness
If the ellipsis flag is used, then '...' can be used to
elide substrings in the desired output:
>>> print range(1000) #doctest: +ELLIPSIS
[0, 1, 2, ..., 999]
t ellipsiss|
If the whitespace normalization flag is used, then
differences in whitespace are ignored.
>>> print 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]
s whitespace normalizationc C s g } t i d D]) } | o | d d j o | | q q ~ } | o x | D] } | i d o[ t i i | \ } } t i i d | t | d } t i d =t | \ } } n t | d t
\ } } | o d SqR Wn t i } | i
t d S( Ni i R s .pyiRP ( R= R Ri RJ R Rr t insertR: R R Rt R t TextTestRunnerRI R ( R t argt testfilesRN t dirnameR R R Rd ( ( s /usr/lib/python2.6/doctest.pyt _testy
s D
R (U R t
__docformat__t __all__R( R= R^ R5 R RJ RX R RX R R Ro R! t collectionsR" R# R$ R R R R R R R R R R R
R R RT Rq R2 RD RR R, t
__stdout__R+ RW R\ Rf Rg R} R R R RG R
R R R R R t ExceptionR R R Re Rv Rt R R R R R| R R R~ R R R R R R R R R R R R R4 t exit( ( ( s /usr/lib/python2.6/doctest.pyt . s H0
1 $ $5< ) n f z ? $= I R ,