B \y@sdZddlZddlZddlZddlZddlZddlZddlZddl m Z ddl m Z ddl mZddlmZddlmZmZmZmZmZmZmZmZmZddlmZmZdd lmZmZee Z!d d Z"Gd d d e#Z$Gdddej%Z%Gdddej&Z'Gdddej(Z(Gdddej)Z*Gdddej)Z+Gdddej,Z-e.dZ/Gdddeje#Z0Gdddej1Z1Gdd d ej2Z3Gd!d"d"e3Z4dS)#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) import_module)StringIO) modified_env) getmodule) REPORTING_FLAGSREPORT_ONLY_FIRST_FAILURE_unittest_reportflags DocTestRunner_extract_future_flagspdb_OutputRedirectingPdb_exception_traceback linecache)doctestsPlugin)anyptolistcCstj|ddkS)zReturn whether the given filename is an extension module. This simply checks that the extension is either .so or .pyd. )z.soz.pyd)ospathsplitextlower)filenamer?lib/python3.7/site-packages/IPython/testing/plugin/ipdoctest.pyis_extension_module<src@s$eZdZdZdZddZddZdS) DocTestSkipz*Object wrapper for doctests to be skipped.z/Doctest to skip. >>> 1 #doctest: +SKIP cCs ||_dS)N)obj)selfrrrr__init__KszDocTestSkip.__init__cCs$|dkrtjStt|d|SdS)N__doc__r)rds_skipgetattrobject__getattribute__)rkeyrrrr$NszDocTestSkip.__getattribute__N)__name__ __module__ __qualname__r r!rr$rrrrrDsrc@seZdZddZddZdS) DocTestFindercCs|dkr dSt|r"|j|jkSt|r8|j|jkSt|rN|j|jkSt|rh|j|j j jkSt |dk r|t |kSt |dr|j|jkSt |trdSt|rdStd|dS)zY Return true if the given object is defined in the given module. NTr'Fz*object must be a class or function, got %r)inspect isfunction__dict__ __globals__Z isbuiltinr&r'isclassismethod__self__ __class__rhasattr isinstancepropertyZismethoddescriptor ValueError)rmoduler#rrr _from_moduleXs&           zDocTestFinder._from_modulec Cshtd|||t|dr t|}tj||||||||ddlm}m} t |r|j rxT|j D]F\} } d|| f} || s| | rf| || rf||| | ||||qfWt|rd|j rdx|j D]\} } t| trt|| } t| trt|| j} t| s2t| s2t| s2t| tr| || rd|| f} ||| | ||||qWdS)zm Find tests for the given object and any contained objects, and add them to `tests`. z _find for:Z skip_doctestr) isroutiner.z%s.%sN)printr2rdoctestr)_findr*r8r.ZismoduleZ_recurser,itemsr7r3 staticmethodr" classmethod__func__r+r/r4) rtestsrnamer6 source_linesglobsseenr8r.ZvalnamevalZvalname1rrrr;xs4             zDocTestFinder._findN)r&r'r(r7r;rrrrr)Vs r)c@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)rwantZgot optionflagsZretrrrrHs  z#IPDoctestOutputChecker.check_outputN)r&r'r(r recompilerIrHrrrrrFs rFcs>eZdZdZd ddZddZfd d Zfd d ZZS) DocTestCaseaNProxy for DocTestCase: provides an address() method that returns the correct address for the doctest case. Otherwise acts as a proxy to the test case. To provide hints for address(), an obj may also be passed -- this will be used as the test object for purposes of determining the test address, if it is provided. rN_c Csl||_tjj||||||d||_||_||_|j|_||_ ||_ t ||dd}||_ t j|j|_dS)N)rLsetUptearDowncheckerF)rLrSverbose) _result_varrrOr_dt_optionflagsZ _dt_checker_dt_testrC_dt_test_globs_oriZ _dt_setUpZ _dt_tearDownIPDocTestRunner _dt_runnerrrdirnamer_ori_dir) rtestrLrQrRrSrZ result_varrunnerrrrrs  zDocTestCase.__init__c Cs|j}|j}tj}t}|j}|t@s.|tO}z4t }t |j d|_ |j ||jdd\}}Wd|t_t |X|r|||dS)NzF----------------------------------------------------------------------F)out clear_globs)rWrZsysstdoutrrVrrrgetcwdchdirr\ZDIVIDERrunwriteZfailureExceptionZformat_failuregetvalue) rr]r^oldnewrLcurdirZfailuresZtriesrrrrunTests"   zDocTestCase.runTestcsjt|jjdtrXi|_|jtjtj|jjtj ddt tjd<tj|j_t t | dS)z5Modified test setup that syncs with ipython namespacerrPN __builtins__)r3rWexamples IPExample user_ns_origupdate_ipuser_nsrCpop builtin_modsuperrOrQ)r)r1rrrQs  zDocTestCase.setUpc st|jjdtr4|j|j_tjtj |j yt t | Wn4tk rz}z|jd|jkrjWdd}~XYnXdS)Nr)r3rWrmrnrXrCrqrrclearrprorurOrRAttributeErrorargsrU)rexc)r1rrrR s  zDocTestCase.tearDown)rNNNNrP) r&r'r(r rrkrQrR __classcell__rr)r1rrOs   rOc@s eZdZdS)rnN)r&r'r(rrrrrnAsrnc@seZdZdZdddZdS)IPExternalExamplez2Doctest examples to be run in an external process.Nrc Cs*tj||||||||jd7_dS)N )r:Examplersource)rr~rKexc_msglinenoindentoptionsrrrrGszIPExternalExample.__init__)NrrN)r&r'r(r rrrrrr{Dsr{c@seZdZdZdZdZdZdZdZe eeeeefe j e j BZ e eeeeefe j e j BZe dZe dZd d 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+z#\s*ipdoctest:\s*EXTERNALcCs.tj|}t|dkr&t|S|SdS)z/Convert input IPython source into valid Python.rN)rqZinput_transformer_managerZtransform_celllen splitlinesZ prefilter)rr~blockrrrip2pys  zIPDocTestParser.ip2pyc s|}||dkr8dfdd|dD}g}d\}}|j|rVd}nd}d}t|j|}|rzt j } n*t|j |}|j |rt } nt} d }x|D]} |||| ||d|| 7}|| |||\} } } }| |7} | t krd | t j<| d7} || sJ|| | | ||t| d | d ||d| | 7}| }qW|||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. rr|csg|]}|dqS)Nr).0l) min_indentrr sz)IPDocTestParser.parse..)rrz # randomFTr)rrrN) expandtabsZ _min_indentjoinsplit _RANDOM_TESTrJlist_EXAMPLE_RE_PYfinditerr:r}_EXAMPLE_RE_IP _EXTERNAL_IPr{rnappendstartcount_parse_exampleNORMALIZE_WHITESPACEZ_IS_BLANK_OR_COMMENTrgroupend)rstringrAoutputZcharnorZ random_markerrZtermsr}mr~rrKrr)rrparsesF           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. rr~r|ps1ps2rN cs g|]}|ddqS)rNr)rZsl)rps1_lenrrrsz2IPDocTestParser._parse_example..rKz *$zOut\[\d+\]: \s*?\n?rrcsg|]}|dqS)Nr)rZwl)rrrrsmsg) rrr_check_prompt_blankZ _check_prefixrrrMmatchsubZ _EXCEPTION_REZ _find_options) rrrArrrBrrr~rKZ want_linesrrr)rrrrs2        zIPDocTestParser._parse_examplec Csf||}|d}xPt|D]D\}} t| |kr| |dkrtd||d|| ||| fqWdS)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. rrz8line %r of the docstring for %s lacks blank after %s: %rN) enumeraterr5) rlinesrrArrZ space_idxZmin_lenilinerrrr s  z#IPDocTestParser._check_prompt_blankN)r)F)r&r'r(r Z_PS1_PYZ_PS2_PYZ_PS1_IPZ_PS2_IPZ_RE_TPLrMrN MULTILINEVERBOSErrrrrrrrrrrrrPs    W ArSKIPcs"eZdZdZdfdd ZZS)rYzKTest runner that synchronizes the IPython namespace with test globals. NTc s>|jtjtdddtt|||||SQRXdS)NZ80Z24)ZCOLUMNSZLINES)rCrprqrrrrurYre)rr]Z compileflagsr_r`)r1rrre;s  zIPDocTestRunner.run)NNT)r&r'r(r rerzrr)r1rrY7srYc@seZdZdZddZdS) DocFileCasez"Overrides to provide filename cCs|jjddfS)N)rWr)rrrraddressQszDocFileCase.addressN)r&r'r(r rrrrrrNsrc@sFeZdZdZdZdZejfddZddZ dd Z d d Z d d Z dS)ExtensionDoctestz=Nose Plugin that supports doctests in extension modules. Z extdoctestTcCsbt||||jddd|dddd|jdd d d d |d }|dk r^|jt|ddS)Nz--doctest-tests store_true doctest_testsZNOSE_DOCTEST_TESTSTzAlso look for doctests in test modules. Note that classes, methods and functions should have either doctests or non-doctest tests, not both. [NOSE_DOCTEST_TESTS])actiondestdefaulthelpz--doctest-extensionrdoctestExtensionzLAlso look for doctests in files with this extension [NOSE_DOCTEST_EXTENSION])rrrZNOSE_DOCTEST_EXTENSION)r)rr add_optionget set_defaultsr)rparserenv env_settingrrrr[s  zExtensionDoctest.optionscCsbt|||dd|jjD|j_|j|_t|j|_t|_ t |_ t |_ d|_d|_dS)NcSsg|]}|jdkr|qS)r:)rA)rprrrrssz.ExtensionDoctest.configure..)r configurepluginsrrr extensionr: DocTestParserrr)finderrFrSrC extraglobs)rrconfigrrrrps  zExtensionDoctest.configurecCsXtj|\}}tj|d}z&tj|t|}t||}Wdtj X|S)Nr) rrrrrarrrloadTestsFromModulers)rrZbpathmodmodnamer6r@rrrloadTestsFromExtensionModules  z-ExtensionDoctest.loadTestsFromExtensionModuleccs||jstd|dS|jj||j|jd}|s:dStj tj B}| |j }|dddkrp|dd}x2|D]*}|j sqv|js||_t|||jdVqvWdS)NzDoctest doesn't want module %s)rCr)z.pycz.pyor)rLrS)Zmatchesr&logdebugrfindrCrr:rELLIPSISsort__file__rmrrOrS)rr6r@rLZ module_filer]rrrrs(       z$ExtensionDoctest.loadTestsFromModulec cst|r$x||D] }|VqWnn|jrt|j|jrtj|}t|}| }WdQRX|j j |d|i||dd}|j rt |VndVdS)Nrr)rCrArrF)rrrrendswithrrbasenameopenreadrZ get_doctestrmr)rrtrAZdhdocr]rrrloadTestsFromFiles      z"ExtensionDoctest.loadTestsFromFileN) r&r'r(r rAenabledrenvironrrrrrrrrrrUsrc@s6eZdZdZdZdZddZejfddZ dd Z d S) IPythonDoctestz=Nose Plugin that supports doctests in extension modules. Z ipdoctestTccsZtjtjB}|jj|t|d}|rVx0|D](}t|jdkr>q*t||||j dVq*WdS)zbLook for doctests in the given object, which will be a function, method or class. )r6r)rrLrSN) r:rrrrrrrmrOrS)rrparentrLrr]rrrmakeTests  zIPythonDoctest.makeTestcCsbt||||jddd|dddd|jdd d d d |d }|dk r^|jt|ddS)Nz--ipdoctest-testsripdoctest_testsZNOSE_IPDOCTEST_TESTSTzAlso look for doctests in test modules. Note that classes, methods and functions should have either doctests or non-doctest tests, not both. [NOSE_IPDOCTEST_TESTS])rrrrz--ipdoctest-extensionripdoctest_extensionzNAlso look for doctests in files with this extension [NOSE_IPDOCTEST_EXTENSION])rrrZNOSE_IPDOCTEST_EXTENSION)r)rrrrrr)rrrrrrrrs  zIPythonDoctest.optionscCsft|||dd|jjD|j_|j|_t|j|_t|_ t |j d|_ t |_ d|_d|_dS)NcSsg|]}|jdkr|qS)r:)rA)rrrrrrsz,IPythonDoctest.configure..)r)rrrrrrrrrrr)rrFrSrCr)rrrrrrrs zIPythonDoctest.configureN) r&r'r(r rArrrrrrrrrrrs r)5r builtinsrtr:r*ZloggingrrMra importlibriorZtestpathrrrrrr r r r r rZ nose.pluginsrrZ nose.utilrrZ getLoggerr&rrr#rr)rGrFrOr}rnr{rrZregister_optionflagrrYrZDoctestrrrrrrs:    , T} e j