U 1ei.@sdZddlZddlZddlZddlmZeeZGdddej Z Gdddej Z Gdd d ej Z Gd d d ejZed ZGd ddejeZdS)aNose Plugin that supports IPython doctests. Limitations: - When generating examples for use as doctests, make sure that you have pretty-printing OFF. This can be done either by setting the ``PlainTextFormatter.pprint`` option in your configuration file to False, or by interactively disabling it with %Pprint. This is required so that IPython output matches that of normal Python, which is used by doctest for internal execution. - Do not rely on specific prompt numbers for results (such as using '_34==True', for example). For IPython tests run via an external process the prompt numbers may be different, and IPython tests run as normal python code won't even have these special _NN variables set at all. N) modified_envcseZdZfddZZS) DocTestFindercsHt|||||}tt|ddrD|dk rD|jD]}d|jtj<q2|S)NZ__skip_doctest__FT)super _get_testboolgetattrZexamplesoptionsdoctestSKIP)selfobjnamemoduleZglobs source_linestestZexample __class__D/tmp/pip-unpacked-wheel-3hxk2k58/IPython/testing/plugin/ipdoctest.pyr)s  zDocTestFinder._get_test)__name__ __module__ __qualname__r __classcell__rrrrr(src@s"eZdZdZedZddZdS)IPDoctestOutputCheckerzSecond-chance checker with support for random tests. If the default comparison doesn't pass, this checker looks in the expected output string for flags that tell us to ignore the output. z #\s*random\s+cCs*tj||||}|s&|j|r&dS|S)zCheck output, accepting special markers embedded in the output. If the output didn't pass the default validation but the special string '#random' is included, we accept it.T)r OutputChecker check_output random_research)r wantgotZ optionflagsretrrrr<s  z#IPDoctestOutputChecker.check_outputN)rrr__doc__recompilerrrrrrr3s rc@s eZdZdS) IPExampleN)rrrrrrrr$Osr$c@seZdZdZdZdZdZdZdZe eeeeefe j e j BZ e eeeeefe j e j BZe dZdd Zdd d ZdddZddZdS)IPDocTestParserz A class used to parse strings containing doctest examples. Note: This is a version modified to properly recognize IPython input and convert any IPython examples into valid Python ones. z>>>z\.\.\.z In\ \[\d+\]:z\ \ \ \.\.\.+:a] # Source consists of a PS1 line followed by zero or more PS2 lines. (?P (?:^(?P [ ]*) (?P %s) .*) # PS1 line (?:\n [ ]* (?P %s) .*)*) # PS2 lines \n? # a newline # Want consists of any non-blank lines that do not start with PS1. (?P (?:(?![ ]*$) # Not a blank line (?![ ]*%s) # Not a line starting with PS1 (?![ ]*%s) # Not a line starting with PS2 .*$\n? # But any other line )*) z#\s*all-random\s+cCs.tj|}t|dkr&t|S|SdS)z/Convert input IPython source into valid Python.N)_ipZinput_transformer_managerZtransform_celllen splitlinesZ prefilter)r sourceblockrrrip2pys  zIPDocTestParser.ip2pyc sT|}||dkr8dfdd|dD}g}d\}}|j|rVd}nd}d}t|j|}|rzt j } nt|j |}t } d }|D]} | ||| ||d|| 7}|| |||\} } } }| |7} || s| | | | ||t| d | d ||d| | 7}| }q| ||d |S) a= 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. r csg|]}|dqSNr).0lZ min_indentrr sz)IPDocTestParser.parse..)rrz # randomFTindent)linenor5rN) expandtabsZ _min_indentjoinsplit _RANDOM_TESTrlist_EXAMPLE_RE_PYfinditerr Example_EXAMPLE_RE_IPr$appendstartcount_parse_exampleZ_IS_BLANK_OR_COMMENTr(groupend)r stringr outputZcharnor6Z random_markerr,Ztermsr>mr*rrexc_msgrr2rparses@       zIPDocTestParser.parseFc sTt|d|dd}|d}|d}t||||||rp||ddd|||dfd d |D}|r||}|d } | d} t| dkrtd | d r| d =|| d||t|t dd| d| d<dfdd | D} |j | }|r6|d} nd} | |||} || | | fS)a7 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. Optional: `ip2py`: if true, filter the input via IPython to convert the syntax into valid python. r5r*r.ps1ps2r&N cs g|]}|ddqS)r&Nr)r0slr5ps1_lenrrr3sz2IPDocTestParser._parse_example..rz *$zOut\[\d+\]: \s*?\n?r4rcsg|]}|dqSr/r)r0Zwl)r5rrr3smsg) r(rDr9_check_prompt_blankZ _check_prefixr8r,r"matchsubZ _EXCEPTION_REZ _find_options) r rHr r6r,rrKrLr*rZ want_linesrIrrrOrrCs4         zIPDocTestParser._parse_examplec Csb||}|d}t|D]D\}} t| |kr| |dkrtd||d|| ||| fqdS)a 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. Note: IPython-modified version which takes the input prompt length as a parameter, so that prompts of variable length can be dealt with. r&rMz8line %r of the docstring for %s lacks blank after %s: %rN) enumerater( ValueError) r linesr5r r6rPZ space_idxZmin_lenilinerrrrS s   z#IPDocTestParser._check_prompt_blankN)r-)F)rrrr!Z_PS1_PYZ_PS2_PYZ_PS1_IPZ_PS2_IPZ_RE_TPLr"r# MULTILINEVERBOSEr<r?r:r,rJrCrSrrrrr%Rs"     D Ar%r cs"eZdZdZdfdd ZZS)IPDocTestRunnerzKTest runner that synchronizes the IPython namespace with test globals. NTc s<tddd$tt|||||W5QRSQRXdS)N80Z24)COLUMNSLINES)rrr]run)r rZ compileflagsoutZ clear_globsrrrra's  zIPDocTestRunner.run)NNT)rrrr!rarrrrrr]#sr])r!r loggingr"Ztestpathr getLoggerrlogrrrr>r$Z DocTestParserr%Zregister_optionflagr Z DocTestRunnerobjectr]rrrrs   O