B ܇\RI@sdZddlmZddlmZddlmZddlZddlZddlZddlZddl m Z ddl Z ddl m Z ddl mZdd l mZdd lmZdd lmZd Zd ZdZdZdZeeeeefZdaddZddZddZddZGdddeZGddde Z!ddZ"dDd d!Z#Gd"d#d#e j$Z%d$d%Z&d&d'Z'd(d)Z(Gd*d+d+e j)Z*d,d-Z+d.d/Z,e d0d1Z-Gd2d3d3e j)Z.d4d5Z/d6d7Z0d8d9Z1d:d;Z2dd?Z4e j5d@dAdBdCZ6dS)Ez5 discover and run doctests in modules and test files.)absolute_import)division)print_functionN)contextmanager) ExceptionInfo)ReprFileLocation) TerminalRepr) safe_getattr)FixtureRequestZnoneZcdiffZndiffudiffZonly_first_failurecCs|jddddgd|jdddd |d }|jd d d ddd|jdtjddtdd|jddgdddd|jdd d ddd|jdd d d d!ddS)"Ndoctest_optionflagszoption flags for doctestsargsELLIPSIS)typedefaultdoctest_encodingzencoding used for doctest fileszutf-8)rcollectz--doctest-modules store_trueFzrun doctests in all .py modulesdoctestmodules)actionrhelpdestz--doctest-reportr z9choose another output format for diffs on doctest failure doctestreport)rrrchoicesrz--doctest-globappendZpatz2doctests file matching pattern, default: test*.txt doctestglob)rrmetavarrrz--doctest-ignore-import-errorszignore doctest ImportErrorsdoctest_ignore_import_errorsz--doctest-continue-on-failurezr?r@r9 __classcell__r$r$)rDr%rA}srAcs"ddlGfdddj}|S)Nrcs6eZdZdZd fdd ZfddZfd d ZdS) z/_init_runner_class..PytestDoctestRunnerz Runner to collect failures. Note that the out variable in this case is a list instead of a stdout-like object NrTcsjj||||d||_dS)N)checkerverbose optionflags) DebugRunnerr9continue_on_failure)r8rFrGrHrJ)doctestr$r%r9sz8_init_runner_class..PytestDoctestRunner.__init__cs(|||}|jr ||n|dS)N)DocTestFailurerJr)r8outtestexamplegotfailure)rKr$r%report_failures z>_init_runner_class..PytestDoctestRunner.report_failurecs(|||}|jr ||n|dS)N)UnexpectedExceptionrJr)r8rMrNrOexc_inforQ)rKr$r%report_unexpected_exceptions zK_init_runner_class..PytestDoctestRunner.report_unexpected_exception)NNrT)r>r?r@__doc__r9rRrUr$)rKr$r%PytestDoctestRunners rW)rKrI)rWr$)rKr%_init_runner_classsrXTcCstdkrtat||||dS)N)rFrGrHrJ) RUNNER_CLASSrX)rFrGrHrJr$r$r% _get_runnersrZcsJeZdZdfdd ZddZddZdd Zfd d Zd d ZZ S) DoctestItemNcs.tt|||||_||_d|_d|_dS)N)rBr[r9runnerdtestobjfixture_request)r8namer.r\r])rDr$r%r9s zDoctestItem.__init__cCsZ|jdk rVt||_t|jjd}x$|jdD]\}}|||<q4W|jj|dS)N)Z getfixturedoctest_namespace)r]_setup_fixturesr_dictZgetfixturevalueitemsr5update)r8r5r`valuer$r$r%setups   zDoctestItem.setupcCs8t|j|g}|jj|j|d|r4t|dS)N)rM)_check_all_skippedr]$_disable_output_capturing_for_darwinr\runrA)r8rCr$r$r%runtests  zDoctestItem.runtestcCsVtdkrdS|jjd}|rR|jdd|\}}tj |tj |dS)zW Disable output capturing. Otherwise, stdout is lost to doctest (#985) ZDarwinNZcapturemanagerT)Zin_) platformsystemr' pluginmanagerZ getpluginZsuspend_global_captureZread_global_capturesysstdoutwritestderr)r8ZcapmanrMerrr$r$r%ris    z0DoctestItem._disable_output_capturing_for_darwincsddl}d}||j|jfr(|jg}n|tr:|jj}|dk rg}xV|D]L}|j}|jj }j dkrxd}nj |j d}t |j } t ||| } t} t|jd} |dk r|jjd} fddt| D} | t|j dd|j d} n6dg} d }x*|jD]}| d ||fd }qWt||jrb| | ||j| d 7} n.t|j}| d t|jg7} | tj |j7} || | fqPWt!|St"t#|$|SdS)NrrFcs&g|]\}}d|jd|fqS)z%03d %srt)lineno).0ix)rNr$r% sz,DoctestItem.repr_failure.. z?EXAMPLE LOCATION UNKNOWN, not showing all tests of that examplez>>>z ??? %s %sz... zUNEXPECTED EXCEPTION: %s)%rKZ errisinstancerLrSrfrArCrOrNfilenamerurr>r _get_checker_get_report_choicer'r4Z docstring splitlines enumeratemaxsourcer isinstanceZoutput_differencerPsplitrrTrepr tracebackformat_exceptionr6rBr[ repr_failure)r8excinforKrCr7rQrOr|rumessager<rFZ report_choicer=indentr:Z inner_excinfo)rD)rNr%rsP              zDoctestItem.repr_failurecCs|j|jjd|jfS)Nz [doctest] %s)fspathr]rur`)r8r$r$r% reportinfoszDoctestItem.reportinfo)NN) r>r?r@r9rgrkrirrrEr$r$)rDr%r[s   7r[c Cs0ddl}t|j|j|j|j|j|jtt dS)Nr)DONT_ACCEPT_TRUE_FOR_1DONT_ACCEPT_BLANKLINENORMALIZE_WHITESPACErIGNORE_EXCEPTION_DETAILCOMPARISON_FLAGS ALLOW_UNICODE ALLOW_BYTES) rKrcrrrrrr_get_allow_unicode_flag_get_allow_bytes_flag)rKr$r$r%_get_flag_lookupsrcCs4|jd}t}d}x|D]}|||O}qW|S)Nr r)r'getinir)r.Zoptionflags_strZflag_lookup_tableZflag_accflagr$r$r%get_optionflags#s   rcCs |d}|r|drd}|S)NrZusepdbF)getvalue)r'rJr$r$r%_get_continue_on_failure,s   rc@seZdZdZddZdS)r,Nc csddl}|jd}|j|}t|j}|jj}ddi}t|}td|t t |jd}t ||| } | ||||d} | jrt| j||| VdS)Nrrr>__main__)rGrHrFrJ)rKr'rrZ read_textrr0rrZr}r_fix_spoof_python2Z DocTestParserZ get_doctestexamplesr[r`) r8rKencodingtextr|r`r5rHr\r"rNr$r$r%r9s"    zDoctestTextfile.collect)r>r?r@r^rr$r$r$r%r,6sr,cs2ddltfdd|jD}|r.tddS)z\raises pytest.skip() if all examples in the given DocTest have the SKIP option set. rNc3s|]}|jjdVqdS)FN)ZoptionsgetZSKIP)rvrx)rKr$r% Zsz%_check_all_skipped..z!all tests skipped by +SKIP option)rKallrpytestskip)rNZ all_skippedr$)rKr%rhTsrhcCst|dddk S)zr returns if a object is possibly a mock object by checking the existence of a highly improbable attribute Z1pytest_mock_example_attribute_that_shouldnt_existN)r )r^r$r$r% _is_mocked_s rc#sHttdddkrdVn(dfdd }|t_z dVWdt_XdS)z contextmanager which replaces ``inspect.unwrap`` with a version that's aware of mock objects and doesn't recurse on them unwrapNcs,dkr|tdS|fdddSdS)N)stopcst|p|S)N)r)r^)rr$r%xszF_patch_unwrap_mock_aware.._mock_aware_unwrap..)r)r^r) real_unwrap)rr%_mock_aware_unwrapts z4_patch_unwrap_mock_aware.._mock_aware_unwrap)N)getattrinspectr)rr$)rr%_patch_unwrap_mock_awareis  rc@seZdZddZdS)r*c#sddlGfdddj}|jjdkr<|jj|j}nDy|j}Wn4tk r~|j drxt d|jnYnX|}t |}t d|tt|jd}x.|||jD]}|jrt|j|||VqWdS)NrcseZdZdZfddZdS)z5DoctestModule.collect..MockAwareDocTestFinderz a hackish doctest finder that overrides stdlib internals to fix a stdlib bug https://github.com/pytest-dev/pytest/issues/3456 https://bugs.python.org/issue25532 c s<t|r dSt j||||||||WdQRXdS)N)rr DocTestFinder_find)r8Ztestsr^r`moduleZ source_linesr5seen)rKr$r%rs z;DoctestModule.collect..MockAwareDocTestFinder._findN)r>r?r@rVrr$)rKr$r%MockAwareDocTestFindersrz conftest.pyrzunable to import module %r)rGrHrFrJ)rKrrr0r'rnZ_importconftestZpyimport ImportErrorrrrrrZr}rfindr>rr[r`)r8rrfinderrHr\rNr$)rKr%rs(  zDoctestModule.collectN)r>r?r@rr$r$r$r%r*sr*cCs>dd}i|_|jj}|j||ddd|_t|}||S)zO Used by DoctestTextfile and DoctestItem to setup fixture information. cSsdS)Nr$r$r$r$r%funcsz_setup_fixtures..funcNF)Znoderclsfuncargs)rr3Z_fixturemanagerZgetfixtureinfoZ _fixtureinfor Z _fillfixtures)Z doctest_itemrZfmr_r$r$r%rbsrbcsHttdrtSddlddlGfdddj}|t_tS)aJ Returns a doctest.OutputChecker subclass that takes in account the ALLOW_UNICODE option to ignore u'' prefixes in strings and ALLOW_BYTES to strip b'' prefixes. Useful when the same doctest should run in Python 2 and Python 3. An inner class is used to avoid importing "doctest" at the module level. LiteralsOutputCheckerrNcs:eZdZdZdjZdjZfddZdS)z+_get_checker..LiteralsOutputCheckerz Copied from doctest_nose_plugin.py from the nltk project: https://github.com/nltk/nltk Further extended to also support byte literals. z(\W|^)[uU]([rR]?[\'\"])z(\W|^)[bB]([rR]?[\'\"])csj||||}|rdS|t@}|t@}|s:|s:dSfdd}|rb||j|}||j|}|r~||j|}||j|}j||||}|SdS)NTFcs|d|S)Nz\1\2)sub)ZregexZtxt)rer$r%remove_prefixesszQ_get_checker..LiteralsOutputChecker.check_output..remove_prefixes) OutputChecker check_outputrr_unicode_literal_re_bytes_literal_re)r8ZwantrPrHZresZ allow_unicodeZ allow_bytesr)rKrr$r%rs        z8_get_checker..LiteralsOutputChecker.check_outputN) r>r?r@rVcompileUNICODErrrr$)rKrr$r%rs)hasattrr}rrKrr)rr$)rKrr%r}s #r}cCsddl}|dS)z7 Registers and returns the ALLOW_UNICODE flag. rNr)rKregister_optionflag)rKr$r$r%rsrcCsddl}|dS)z5 Registers and returns the ALLOW_BYTES flag. rNr)rKr)rKr$r$r%rsrc Cs,ddl}t|jt|jt|jt|jt di|S)z This function returns the actual `doctest` module flag value, we want to do it as late as possible to avoid importing `doctest` and all its dependencies when parsing options, as it adds overhead and breaks tests. rN) rKDOCTEST_REPORT_CHOICE_UDIFFZ REPORT_UDIFFDOCTEST_REPORT_CHOICE_CDIFFZ REPORT_CDIFFDOCTEST_REPORT_CHOICE_NDIFFZ REPORT_NDIFF(DOCTEST_REPORT_CHOICE_ONLY_FIRST_FAILUREZREPORT_ONLY_FIRST_FAILUREDOCTEST_REPORT_CHOICE_NONE)keyrKr$r$r%r~ sr~csBddlm}|sdSddlmGfddd}||_dS)a Installs a "SpoofOut" into the given DebugRunner so it properly deals with unicode output. This should patch only doctests for text files because they don't have a way to declare their encoding. Doctests in docstrings from Python modules don't have the same problem given that Python already decoded the strings. This fixes the problem related in issue #2434. r)_PY2N) _SpoofOutcseZdZfddZdS)z(_fix_spoof_python2..UnicodeSpoofcs&|}r"t|tr"|}|S)N)rrbytesdecode)r8result)rrr$r%r+s  z1_fix_spoof_python2..UnicodeSpoof.getvalueN)r>r?r@rr$)rrr$r% UnicodeSpoof*sr)_pytest.compatrrKrZ_fakeout)r\rrrr$)rrr%rs  rr3)ZscopecCstS)zg Fixture that returns a :py:class:`dict` that will be injected into the namespace of doctests. )rcr$r$r$r%ra4sra)NNrT)7rVZ __future__rrrrrlror contextlibrrZ_pytest._code.coderrrrr Z_pytest.fixturesr rrrrrr!rYr&r/r)r+r6 ExceptionrArXrZZItemr[rrrZModuler,rhrrr*rbr}rrr~rZfixturerar$r$r$r%sb         2   " b    .7