o rhf@s&UdZddlmZddlZddlmZddlZddlZddlZddl m Z ddl Z ddl Z ddl Z ddlZddlmZddlmZddlmZdd lmZdd lmZdd lmZdd lmZddlZdd lmZddlmZddlmZddlmZddlmZddl m!Z!ddl"m#Z#ddl$m%Z%ddl&m'Z'ddl&m(Z(ddl)m*Z*ddl)m+Z+ddl,m-Z-ddl,m.Z.ddl/m0Z0ddl1m2Z2ddl3m4Z4ddl5m6Z6erddl7Z7ddl8m9Z9d Z:d!Z;d"Ze:e;efZ?da@daAd%eBd&<dd+d,ZCdd-d.ZDdd4d5ZEdd8d9ZFddd?ZHGd@dAdAeZIGdBdCdCeJZKddEdFZL    GdddPdQZMGdRdSdSe+ZNddUdVZOddWdXZPddYdZZQGd[d\d\e2ZRdd_d`ZSddcddZTeddfdgZUGdhdidie2ZVddkdlZWddndoZXddpdqZYddrdsZZddtduZ[ddxdyZ\e'dzd{dd}d~Z]dS)z4Discover and run doctests in modules and test files.) annotationsN)contextmanager)Path)Any)Callable) Generator)Iterable)Pattern)Sequence) TYPE_CHECKING)outcomes) ExceptionInfo)ReprFileLocation) TerminalRepr)TerminalWriter safe_getattr)Config)Parser)fixture) TopRequest) Collector)Item)OutcomeException)skip fnmatch_ex)Module)approx) PytestWarning)Selfnonecdiffndiffudiffonly_first_failurez"type[doctest.OutputChecker] | None CHECKER_CLASSparserrreturnNonecCs|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)r.collectz--doctest-modules store_trueFzRun doctests in all .py modulesdoctestmodules)actionr.helpdestz--doctest-reportr$z9Choose another output format for diffs on doctest failure doctestreport)r-r.r4choicesr5z--doctest-globappendpatz2Doctests file matching pattern, default: test*.txt doctestglob)r3r.metavarr4r5z--doctest-ignore-import-errorsz Ignore doctest collection errorsdoctest_ignore_import_errorsz--doctest-continue-on-failurezsz_is_doctest..)rQsession isinitpath getoptionrS)rPrOrLglobsrErNrFrXsrXcCs |jdkS)Nz __main__.py)r\rNrErErFrUs rUc@s eZdZd ddZd d d Zd S)ReprFailDoctestreprlocation_lines0Sequence[tuple[ReprFileLocation, Sequence[str]]]r(r)cCs ||_dSrH)rg)selfrgrErErF__init__s zReprFailDoctest.__init__twrcCs2|jD]\}}|D]}||q ||qdSrH)rgline toterminal)rirk reprlocationlinesrlrErErFrms   zReprFailDoctest.toterminalN)rgrhr(r))rkrr(r))__name__ __module__ __qualname__rjrmrErErErFrfs rfcseZdZdfdd ZZS)MultipleDoctestFailuresfailures Sequence[doctest.DocTestFailure]r(r)cst||_dSrH)superrjrtrirt __class__rErFrjs  z MultipleDoctestFailures.__init__)rtrur(r))rprqrrrj __classcell__rErErxrFrssrstype[doctest.DocTestRunner]cs"ddlGfdddj}|S)NrcsHeZdZdZ    ddfdd Zdfdd Zd fdd ZZS)!z/_init_runner_class..PytestDoctestRunnerzRunner to collect failures. Note that the out variable in this case is a list instead of a stdout-like object. NrTcheckerdoctest.OutputChecker | Noneverbose bool | None optionflagsintcontinue_on_failurer[r(r)cstj|||d||_dS)N)r|r~r)rvrjr)rir|r~rrrxrErFrjs z8_init_runner_class..PytestDoctestRunner.__init__testdoctest.DocTestexampledoctest.ExamplegotrAcs&|||}|jr||dS|rH)DocTestFailurerr8)rioutrrrfailuredoctestrErFreport_failuresz>_init_runner_class..PytestDoctestRunner.report_failureexc_info>tuple[type[BaseException], BaseException, types.TracebackType]csVt|dtr |dt|dtjrtd|||}|jr)||dS|)NzQuitting debugger) isinstancerbdbBdbQuitr exitUnexpectedExceptionrr8)rirrrrrrrErFreport_unexpected_exceptions zK_init_runner_class..PytestDoctestRunner.report_unexpected_exceptionNNrT) r|r}r~rrrrr[r(r))rrrrrrAr(r))rrrrrrr(r))rprqrr__doc__rjrrrzrErrxrFPytestDoctestRunners  r)r DebugRunner)rrErrF_init_runner_classs/rTr|r}r~rrrrdoctest.DocTestRunnercCstdurtat||||dS)Nr|r~rr)rIrrrErErF _get_runnersrcspeZdZd fd d Zed!fdd Zd"ddZd"ddZd"ddZd"ddZ d#fdd Z d$ddZ Z S)% DoctestItemr\rArLDoctestTextfile | DoctestModulerunnerrdtestrr(r)csRt||||_||_d|_|jj}|j|ddd}||_|j |_ | dS)N)nodefunccls) rvrjrrobjrb_fixturemanagergetfixtureinfo _fixtureinfo names_closure fixturenames _initrequest)rir\rLrrfm fixtureinforxrErFrjs zDoctestItem.__init__r cstj||||dS)zThe public named constructor.)r\rLrr)rvrW)rrLr\rrrxrErFrWs zDoctestItem.from_parentcCsi|_t|dd|_dS)NT) _ispytest)funcargsr_requestrirErErFrszDoctestItem._initrequestcCsL|jt|jjd}|jdD]\}}|||<q|jj|dS)N) getfixturedoctest_namespace)r _fillfixturesdictgetfixturevalueitemsrreupdate)rirer\valuerErErFsetup s  zDoctestItem.setupcCs8t|j|g}|jj|j|d|rt|dS)N)r)_check_all_skippedr$_disable_output_capturing_for_darwinrrunrsrwrErErFruntest's zDoctestItem.runtestcCsZtdkrdS|jjd}|r+|jdd|\}}tj |tj |dSdS)zFDisable output capturing. Otherwise, stdout is lost to doctest (#985).DarwinNcapturemanagerT)in_) platformsystemrP pluginmanager getpluginsuspend_global_captureread_global_capturesysstdoutwritestderr)ricapmanrerrrErErFr1s    z0DoctestItem._disable_output_capturing_for_darwinexcinfoExceptionInfo[BaseException]str | TerminalReprcsddl}d}t|j|j|jfr|jg}n t|jtr|jj}|dur)t|Sg}|D]}|j }|j j }j dur@d}nj |j d}t |j} t||| } t} t|jd} |dur|j jdusjJ|j jd} j dusxJfddt| D} | t|j dd|j d} ndg} d }|jD]}| d |d |d }qt||jr| | ||j| d 7} nt|j}| d|jg7} | ddt j!|jD7} || | fq-t"|S)Nrrr6Fcs&g|]\}}d|jd|fqS)z%03d %sr)lineno)r_ixrrErF csz,DoctestItem.repr_failure.. z?EXAMPLE LOCATION UNKNOWN, not showing all tests of that examplez>>>z???  z... zUNEXPECTED EXCEPTION: cSsg|]}|dqS)r)stripr_rrErErFrws )#rrrrrrsrtrv repr_failurerrfilenamerr-rpr _get_checker_get_report_choicerPrd docstring splitlines enumeratemaxsourcer8output_differencersplitr from_exc_infor tracebackformat_exceptionrf)rirrrtrgrrrrmessagernr| report_choiceroindentrl inner_excinforxrrFr=sd           zDoctestItem.repr_failure.tuple[os.PathLike[str] | str, int | None, str]cCs|j|jjd|jfS)Nz [doctest] )rOrrr\rrErErF reportinfo}szDoctestItem.reportinfo) r\rArLrrrrrr(r)) rLrr\rArrrrr(r r(r))rrr(r)r(r) rprqrrrj classmethodrWrrrrrrrzrErErxrFrs    @rdict[str, int]c Cs4ddl}t|j|j|j|j|j|jtt t d S)Nr) DONT_ACCEPT_TRUE_FOR_1DONT_ACCEPT_BLANKLINENORMALIZE_WHITESPACEr,IGNORE_EXCEPTION_DETAILCOMPARISON_FLAGS ALLOW_UNICODE ALLOW_BYTESNUMBER) rrrrrr,rr_get_allow_unicode_flag_get_allow_bytes_flag_get_number_flagrrErErF_get_flag_lookupsrcCs.|d}t}d}|D]}|||O}q |S)Nr*r)getinir)rPoptionflags_strflag_lookup_tableflag_accflagrErErFget_optionflagss rcCs |d}|r|drd}|S)Nr=usepdbF)getvalue)rPrrErErF_get_continue_on_failures  rc@seZdZdZdddZdS)rYNr(Iterable[DoctestItem]c csddl}|jd}|j|}t|j}|jj}ddi}t|j}td|t t |jd}| } | ||||d} | j rLtj|| j|| dVdSdS)Nrr/rp__main__Fr~rr|rr\rr)rrPrrO read_textrAr\rrrr DocTestParser get_doctestexamplesrrW) rirencodingtextrr\rerrr'rrErErFr0s*      zDoctestTextfile.collectr(r)rprqrrrr0rErErErFrYsrYrrcs4ddltfdd|jD}|rtddSdS)zVRaise pytest.skip() if all examples in the given DocTest have the SKIP option set.rNc3s |] }|jjdVqdS)FN)optionsgetSKIPrrrErFrasz%_check_all_skipped..z!all tests skipped by +SKIP option)rallrr)r all_skippedrErrFrs  rrobjectcCst|ddduS)zmReturn if an object is possibly a mock object by checking the existence of a highly improbable attribute.1pytest_mock_example_attribute_that_shouldnt_existNrrrErErF _is_mockeds rGenerator[None]c#s>tjddd fd d }|t_z dVWt_dSt_w) zContext manager which replaces ``inspect.unwrap`` with a version that's aware of mock objects and doesn't recurse into them.NstoprCallable[..., Any]rCallable[[Any], Any] | Noner(rc spz|dus |turtdWS|fdddWSty7}ztd|ddtd}~ww)Nrcst|pSrH)rr_stoprrErFszF_patch_unwrap_mock_aware.._mock_aware_unwrap..zGot z when unwrapping z. This is usually caused by a violation of Python's object protocol; see e.g. https://github.com/pytest-dev/pytest/issues/5080)r Exceptionwarningswarnr)rre real_unwrapr!rF_mock_aware_unwrapsz4_patch_unwrap_mock_aware.._mock_aware_unwrap)rrrr r(r)inspectunwrap)r*rEr(rF_patch_unwrap_mock_awaresr-c@seZdZdddZdS)rVr(rccsddl}Gddd|j}z|j}Wntjy-|jdr*td|jnYnw|j j ||}t |j}t d|tt|jd}|||jD]}|jr`tj||j||dVqPdS) NrcseZdZejddZedkp"edkoejjdkp"edko"ejjdkZer+fddZejd kr7dfd d Z ejdkrFfddZ Z SZ S)z5DoctestModule.collect..MockAwareDocTestFinderN) r)r/ r/cs8t|tr t|d|}t|drt|}t||S)a%On older Pythons, doctest code does not take into account `@property`. https://github.com/python/cpython/issues/61648 Moreover, wrapped Doctests need to be unwrapped so the correct line number is returned. #8796 fget __wrapped__)rpropertygetattrhasattrr+r,rv _find_lineno)rir source_linesrxrErFr7s    zBDoctestModule.collect..MockAwareDocTestFinder._find_lineno)r/ r(r)c sPt|rdStt|||||||WddS1s!wYdS)zOverride _find to work around issue in stdlib. https://github.com/pytest-dev/pytest/issues/3456 https://github.com/python/cpython/issues/69718 N)rr-rv_find)ritestsrr\moduler8reseenrxrErFr:s"z;DoctestModule.collect..MockAwareDocTestFinder._find)r/ cs t|tjr |j}t||S)a>`cached_property` objects are never considered a part of the 'current module'. As such they are skipped by doctest. Here we override `_from_module` to check the underlying function instead. https://github.com/python/cpython/issues/107995 )r functoolscached_propertyrrv _from_module)rir<rrxrErFrA)s zBDoctestModule.collect..MockAwareDocTestFinder._from_moduler) rprqrrr version_infopy_ver_info_minormicrois_find_lineno_brokenr7r:rArzrErErxrFMockAwareDocTestFinders   rFr<zunable to import module Fr r )r DocTestFinderrr CollectErrorrPrrrOrbrparsefactoriesrrrrfindrprrrWr\)rirrFr<finderrrrrErErFr0s6=    zDoctestModule.collectNr)rprqrrr0rErErErFrVsrVtype[doctest.OutputChecker]cs*ddl}ddlGfddd|j}|S)NrcsTeZdZdjZdjZdjZdfd d Z dd dZ Z S)z2_init_checker_class..LiteralsOutputCheckerz(\W|^)[uU]([rR]?[\'\"])z(\W|^)[bB]([rR]?[\'\"])a (?P (?P (?P [+-]?\d*)\.(?P\d+) | (?P [+-]?\d+)\. ) (?: [Ee] (?P [+-]?\d+) )? | (?P [+-]?\d+) (?: [Ee] (?P [+-]?\d+) ) ) wantrArrrr(r[cst|||r dS|t@}|t@}|t@}|s!|s!|s!dSd fdd }|r6||j|}||j|}|rD||j|}||j|}|rL|||}t|||S) NTFregex Pattern[str]txtrAr(cs|d|S)Nz\1\2)sub)rNrPrerErFremove_prefixesszX_init_checker_class..LiteralsOutputChecker.check_output..remove_prefixes)rNrOrPrAr(rA)rv check_outputrrr_unicode_literal_re_bytes_literal_re_remove_unwanted_precision)rirMrr allow_unicode allow_bytes allow_numberrT)ryrSrErFrUts"         z?_init_checker_class..LiteralsOutputChecker.check_outputc Sst|j|}t|j|}t|t|kr|Sd}t||D]h\}}|d}|d} | dur8|d} |dur>dnt|} | durL| t| 8} t|tt|d| dkr|d| |||| |d}|| | | | 7}q!|S)Nrfraction exponent1 exponent2r9)abs) list _number_refinditerlenziprDrfloatrstartend) rirMrwantsgotsoffsetwgr\exponent precisionrErErFrXs&    &.$zM_init_checker_class..LiteralsOutputChecker._remove_unwanted_precision)rMrArrArrr(r[)rMrArrAr(rA) rprqrrcompileUNICODErVrWVERBOSErarUrXrzrErRrxrFLiteralsOutputCheckerVsrr)rrS OutputChecker)rrrrErRrF_init_checker_classRsQrtdoctest.OutputCheckercCstdurtatS)aReturn a doctest.OutputChecker subclass that supports some additional options: * ALLOW_UNICODE and ALLOW_BYTES options to ignore u'' and b'' prefixes (respectively) in string literals. Useful when the same doctest should run in Python 2 and Python 3. * NUMBER to ignore floating-point differences smaller than the precision of the literal number in the doctest. An inner class is used to avoid importing "doctest" at the module level. N)r&rtrErErErFrsrcCddl}|dS)z+Register and return the ALLOW_UNICODE flag.rNrrregister_optionflagrrErErFr rcCrv)z)Register and return the ALLOW_BYTES flag.rNrrwrrErErFrryrcCrv)z$Register and return the NUMBER flag.rNrrwrrErErFrryrkeyrAc Cs,ddl}t|jt|jt|jt|jt di|S)zReturn 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) rDOCTEST_REPORT_CHOICE_UDIFF REPORT_UDIFFDOCTEST_REPORT_CHOICE_CDIFF REPORT_CDIFFDOCTEST_REPORT_CHOICE_NDIFF REPORT_NDIFF(DOCTEST_REPORT_CHOICE_ONLY_FIRST_FAILUREREPORT_ONLY_FIRST_FAILUREDOCTEST_REPORT_CHOICE_NONE)rzrrErErFrsrrb)scopedict[str, Any]cCstS)aFixture that returns a :py:class:`dict` that will be injected into the namespace of doctests. Usually this fixture is used in conjunction with another ``autouse`` fixture: .. code-block:: python @pytest.fixture(autouse=True) def add_np(doctest_namespace): doctest_namespace["np"] = numpy For more details: :ref:`doctest_namespace`. )rrErErErFrsr)r'rr(r)r)rKrrLrr(rM)rOrr(r[)rPrrOrrLrr(r[)r(r{r) r|r}r~rrrrr[r(r)r(r)rPrr(r)rPrr(r[)rrr(r))rrr(r[)r(r)r(rL)r(ru)r(r)rzrAr(r)r(r)^r __future__rr contextlibrr?r+ospathlibrrrrtypestypingrrrrr r r r%_pytestr _pytest._code.coder rr _pytest._ior_pytest.compatr_pytest.configr_pytest.config.argparsingr_pytest.fixturesrr _pytest.nodesrr_pytest.outcomesrr_pytest.pathlibr_pytest.pythonr_pytest.python_apir_pytest.warning_typesrrtyping_extensionsr rr}rr{rrCrIr&__annotations__rGrJrZrTrXrUrfr$rsrrrrrrrYrrr-rVrtrrrrrrrErErErFs                                2     6        ^ X