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 | | k r t S| t @sI | | f d k r0 t S| | f d k rI t Sn | t @s t j d t j t d | } t j d d | } | | k r t Sn | t @r d j | j } d j | j } | | k r t Sn | t @rt | | rt 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*?$Rm s (?m)^\s*?$RV ( s True s 1 ( s False s 0 ( Rx R R RY RZ t escapet BLANKLINE_MARKERR R Rs R R Rv ( Rk Ry Rz R ( ( s /usr/lib64/python2.7/doctest.pyR& s, c C sL | t t Bt B@s t S| t @r$ t S| j d d k oK | j d d k S( Ns i ( R R R Rv Rx R ( Rk Ry Rz R ( ( s /usr/lib64/python2.7/doctest.pyt _do_a_fancy_diff% s c C s | j } | t @s+ t j d t | } n | j | | | rd| j t } | j t } | t @r t j | | d d } t | d } d } n | t @r t j | | d d } t | d } d } nR | t @rt j d t j } t | j | | } d } n d s&t d g | D] } | j d ^ q-} d | t d j | S| r| rd t | t | f S| rd t | S| rd 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 +actuali s Bad diff options s Differences (%s): Rm s Expected: %sGot: %ss Expected: %sGot nothing s Expected nothing Got: %ss Expected nothing Got nothing N( Ry R RY RZ RX RY R? Rx R t difflibt unified_difft listR t context_diffR t Differt IS_CHARACTER_JUNKt compareRt R R] R ( Rk R Rz R Ry R t got_linest difft kindt engineR ( ( s /usr/lib64/python2.7/doctest.pyR < s8 # ( R4 Rq R R& RY R ( ( ( s /usr/lib64/python2.7/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 Rz ( Rk R R Rz ( ( s /usr/lib64/python2.7/doctest.pyR w s c C s t | j S( N( R8 R ( Rk ( ( s /usr/lib64/python2.7/doctest.pyt __str__| s ( R4 Rq R R Rg ( ( ( s /usr/lib64/python2.7/doctest.pyR l 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 Rb ( Rk R R Rb ( ( s /usr/lib64/python2.7/doctest.pyR s c C s t | j S( N( R8 R ( Rk ( ( s /usr/lib64/python2.7/doctest.pyRg s ( R4 Rq R R Rg ( ( ( s /usr/lib64/python2.7/doctest.pyR 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 s5 t j | | | | t } | r1 | j j n | S( N( R RM Rv R. RI ( Rk R R+ R RJ t r( ( s /usr/lib64/python2.7/doctest.pyRM s c C s t | | | d S( N( R ( Rk R R R Rb ( ( s /usr/lib64/python2.7/doctest.pyR" s c C s t | | | d S( N( R ( Rk R R R Rz ( ( s /usr/lib64/python2.7/doctest.pyR! s N( R4 Rq R R+ Rx RM R" R! ( ( ( s /usr/lib64/python2.7/doctest.pyR s Y i 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( 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 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. R s testmod: module required; %rR R R R. R N( R+ R= R> R* R5 R6 RA R4 R R R Rw RM RT t masterRV R# R R ( R R' R. R t reportR R t raise_on_errorR t findert runnerR ( ( s /usr/lib64/python2.7/doctest.pyR s$ E % c C sl | r | r t d n t | | | \ } } | d k rU t j j | } n | d k rj 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 s Only reporting flags allowed( R R t _unittest_reportflags( R/ t old( ( s /usr/lib64/python2.7/doctest.pyR E s t DocTestCasec B s e Z d d d d d Z d Z d Z 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 j j | | | _ | | _ | | _ | | _ | | _ d S( N( t unittestt TestCaseR t _dt_optionflagst _dt_checkert _dt_testt _dt_setUpt _dt_tearDown( Rk R R t setUpt tearDownR ( ( s /usr/lib64/python2.7/doctest.pyR k s c C s, | j } | j d k r( | j | n d S( N( R R R+ ( Rk R ( ( s /usr/lib64/python2.7/doctest.pyR u s c C s9 | j } | j d k r( | j | n | j j d S( N( R R R+ R. RI ( Rk R ( ( s /usr/lib64/python2.7/doctest.pyR { s c C s | j } t j } t } | j } | t @s; | t O} n t d | d | j d t } z5 d d | _ | j | d | j d t \ } } Wd | t _ X| r | j | j | j n d S( NR R R R iF R RJ ( R R= R R! R R R R R Rv R$ RM RC t failureExceptiont format_failureRa ( Rk R R t newR Rm R R ( ( s /usr/lib64/python2.7/doctest.pyt runTest s " c C sj | j } | j d k r! d } n d | j } d j | j j d d } d | j | j | | | 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' Rs RN ( Rk t errR R t lname( ( s /usr/lib64/python2.7/doctest.pyR s c C sO | j t d | j d | j d t } | j | j d t | j 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 unexpected 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 RJ N( R R R R Rv RM R R ( Rk Rm ( ( s /usr/lib64/python2.7/doctest.pyR s B c C s | j j S( N( R R' ( Rk ( ( s /usr/lib64/python2.7/doctest.pyR s c 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( R R R R R R R ( Rk R ( ( s /usr/lib64/python2.7/doctest.pyR s c C s | | k S( N( ( Rk R ( ( s /usr/lib64/python2.7/doctest.pyR s c C s" t | j | j | j | j f S( N( R R R R R ( Rk ( ( s /usr/lib64/python2.7/doctest.pyR s c C s4 | j j j d } d | d d j | d f S( NR s %s (%s)i( R R' Rs R ( Rk R' ( ( s /usr/lib64/python2.7/doctest.pyR s c C s d | j j S( Ns Doctest: ( R R' ( Rk ( ( s /usr/lib64/python2.7/doctest.pyt shortDescription s N( R4 Rq R+ R R R R R R R R R R R Rg R ( ( ( s /usr/lib64/python2.7/doctest.pyR i s H t SkipDocTestCasec B s2 e Z d Z d Z d Z d Z e Z RS( c C s | | _ t j | d d S( N( RB R R R+ ( Rk RB ( ( s /usr/lib64/python2.7/doctest.pyR s c C s | j d d S( Ns- DocTestSuite will not work with -O2 and above( t skipTest( Rk ( ( s /usr/lib64/python2.7/doctest.pyR s c C s d S( N( ( Rk ( ( s /usr/lib64/python2.7/doctest.pyt test_skip s c C s d | j j S( Ns Skipping tests from %s( RB R4 ( Rk ( ( s /usr/lib64/python2.7/doctest.pyR s ( R4 Rq R R R R Rg ( ( ( s /usr/lib64/python2.7/doctest.pyR s c K s* | 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 } xz | D]r } t | j d k r q n | j s | j } | d d k r | d } n | | _ n | j t | | q 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 i s has no docstringsi is .pycs .pyoiN( s .pycs .pyo( R+ R RD Rw R= R/ t optimizeR t TestSuitet addTestR R R R& R RN R R ( RB R. R t test_finderR R t suiteR RN ( ( s /usr/lib64/python2.7/doctest.pyR s, % t DocFileCasec B s) e Z d Z d Z e Z d Z RS( c C s d j | j j j d S( Nt _R ( R R R' Rs ( Rk ( ( s /usr/lib64/python2.7/doctest.pyR h s c C s | j j S( N( R RN ( Rk ( ( s /usr/lib64/python2.7/doctest.pyR k s c C s d | j j | j j | f S( Ns2 Failed doctest test for %s File "%s", line 0 %s( R R' RN ( Rk R ( ( s /usr/lib64/python2.7/doctest.pyR o s ( R4 Rq R R Rg R ( ( ( s /usr/lib64/python2.7/doctest.pyR f s c K s | d k r i } n | j } | r= | r= t d n t | | | \ } } d | k rn | | 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 Ry Rs R t popR ( R[ R t pieceRy R ( ( s /usr/lib64/python2.7/doctest.pyR s : 4.c C s{ t | } t j | } g | D] } | j | k r% | ^ q% } | s^ t | d n | d } t | j } | 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 Rw R' R R R ( RB R' R R8 R t testsrc( ( s /usr/lib64/python2.7/doctest.pyR , s ( 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/lib64/python2.7/doctest.pyR < s c C s d d l } t j d d } t | d } | j | | j z | r\ | j } n i } | r y t | | | Wq t j d GH| j t j d q Xn | j d | | | Wd t j | 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 RC t closeR t execfileR= Rb t post_mortemRM RJ t remove( R R R. R t srcfilenameRR ( ( s /usr/lib64/python2.7/doctest.pyR A s" c C s2 t | } t | | } t | | | j 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/lib64/python2.7/doctest.pyR a 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 ( Rk R ( ( s /usr/lib64/python2.7/doctest.pyR } s c C s | j d | _ | S( so square() -> square TestClass's associated value >>> _TestClass(13).square().get() 169 i ( R ( Rk ( ( s /usr/lib64/python2.7/doctest.pyt square s c C s | j S( s} get() -> return TestClass's associated value. >>> x = _TestClass(-42) >>> print x.get() -42 ( R ( Rk ( ( s /usr/lib64/python2.7/doctest.pyR* s ( R4 Rq R R R R* ( ( ( s /usr/lib64/python2.7/doctest.pyR o 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 s1 g t j d D]" } | r | d d k r | ^ q } | s t j j t j d } d t k r t j j | \ } } n d j | GHd Sx | D] } | j d rt j j | \ } } t j j d | t | d } t j d =t | \ } } n t | d t \ } } | r d Sq Wd S( Ni i R RE s usage: {0} [-v] file ...i s .pyiRP ( R= R RJ R Rn R; t splitextt formatRj Rs t insertR: R R Rv ( t argt testfilesR' R RN t dirnameR R ( ( s /usr/lib64/python2.7/doctest.pyt _test s$ 6 R (V R t __docformat__t __all__R( R= R_ R5 R RJ RY R R\ R R Rs R! t collectionsR" R# R$ R R R R R R R R R R R R R RX Rr R2 RD RS R, t __stdout__R+ RX R] Rg Rh R R R R RG R R R R R R t ExceptionR R R Ri Rx Rv R 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/lib64/python2.7/doctest.pyt . s H0 1 $ $HL ) n f z ? $I I R ,