o hf@s"UdZddlmZddlZddlmZddlmZddlmZddlmZddl m Z ddl Z ddl Z ddl Z dd lmZddlZddlZddlZddlZddlZdd lmZdd lmZddlZdd lmZdd lmZddlmZddlmZddlm 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-m/Z/ddl0m1Z1ddl2m3Z3ddl4m5Z5ddl6m7Z7erddl8Z8ddl9m:Z:dZ;d Zd#Z?e;ee?fZ@daAdaBd$eCd%<d~d*d+ZDdd,d-ZEdd3d4ZFdd7d8ZGdd;d<ZHdd=d>ZIGd?d@d@eZJGdAdBdBeKZLddDdEZM    FdddOdPZNGdQdRdRe,ZOddTdUZPddVdWZQddXdYZRGdZd[d[e3ZSdd^d_ZTddbdcZUe ddedfZVGdgdhdhe3ZWddjdkZXddmdnZYddodpZZddqdrZ[ddsdtZ\ddwdxZ]e(dydzdd|d}Z^dS)z4Discover and run doctests in modules and test files.) annotationsN)Callable) Generator)Iterable)Sequence)contextmanager)Path)Any) 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-r3choicesr4z--doctest-globappendpatz2Doctests file matching pattern, default: test*.txt doctestglob)r2r-metavarr3r4z--doctest-ignore-import-errorsz Ignore doctest collection errorsdoctest_ignore_import_errorsz--doctest-continue-on-failurezsz_is_doctest..)rPsession isinitpath getoptionrR)rOrNrKglobsrDrMrErWsrWcCs |jdkS)Nz __main__.py)r[rMrDrDrErTs rTc@s eZdZd ddZd d d Zd S)ReprFailDoctestreprlocation_lines0Sequence[tuple[ReprFileLocation, Sequence[str]]]r'r(cCs ||_dSrG)rf)selfrfrDrDrE__init__s zReprFailDoctest.__init__twrcCs2|jD]\}}|D]}||q ||qdSrG)rfline toterminal)rhrj reprlocationlinesrkrDrDrErls   zReprFailDoctest.toterminalN)rfrgr'r()rjrr'r()__name__ __module__ __qualname__rirlrDrDrDrEres recseZdZdfdd ZZS)MultipleDoctestFailuresfailures Sequence[doctest.DocTestFailure]r'r(cst||_dSrG)superrirsrhrs __class__rDrEris  z MultipleDoctestFailures.__init__)rsrtr'r()rorprqri __classcell__rDrDrwrErrsrrtype[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_failurerZr'r(cstj|||d||_dS)N)r{r}r)rurir)rhr{r}rrrwrDrEris z8_init_runner_class..PytestDoctestRunner.__init__testdoctest.DocTestexampledoctest.Examplegotr@cs&|||}|jr||dS|rG)DocTestFailurerr7)rhoutrrrfailuredoctestrDrEreport_failuresz>_init_runner_class..PytestDoctestRunner.report_failureexc_info>tuple[type[BaseException], BaseException, types.TracebackType]csVt|dtr |dt|dtjrtd|||}|jr)||dS|)NzQuitting debugger) isinstancerbdbBdbQuitr exitUnexpectedExceptionrr7)rhrrrrrrrDrEreport_unexpected_exceptions zK_init_runner_class..PytestDoctestRunner.report_unexpected_exceptionNNrT) r{r|r}r~rrrrZr'r()rrrrrr@r'r()rrrrrrr'r()rorprq__doc__rirrryrDrrwrEPytestDoctestRunners  r)r DebugRunner)rrDrrE_init_runner_classs/rTr{r|r}r~rrrdoctest.DocTestRunnercCstdurtat||||dS)Nr{r}rr)rHrrrDrDrE _get_runnersrcspeZdZd fd d Zed!fdd Zd"ddZd"ddZd"ddZd"ddZ d#fdd Z d$ddZ Z S)% DoctestItemr[r@rKDoctestTextfile | DoctestModulerunnerrdtestrr'r(csRt||||_||_d|_|jj}|j|ddd}||_|j |_ | dS)N)nodefunccls) rurirrobjra_fixturemanagergetfixtureinfo _fixtureinfo names_closure fixturenames _initrequest)rhr[rKrrfm fixtureinforwrDrEris zDoctestItem.__init__rcstj||||dS)zThe public named constructor.)r[rKrr)rurV)rrKr[rrrwrDrErVs zDoctestItem.from_parentcCsi|_t|dd|_dS)NT) _ispytest)funcargsr_requestrhrDrDrErszDoctestItem._initrequestcCsL|jt|jjd}|jdD]\}}|||<q|jj|dS)N) getfixturedoctest_namespace)r _fillfixturesdictgetfixturevalueitemsrrdupdate)rhrdr[valuerDrDrEsetup s  zDoctestItem.setupcCs8t|j|g}|jj|j|d|rt|dS)N)r)_check_all_skippedr$_disable_output_capturing_for_darwinrrunrrrvrDrDrEruntest's zDoctestItem.runtestcCsZtdkrdS|jjd}|r+|jdd|\}}tj |tj |dSdS)zFDisable output capturing. Otherwise, stdout is lost to doctest (#985).DarwinNcapturemanagerT)in_) platformsystemrO pluginmanager getpluginsuspend_global_captureread_global_capturesysstdoutwritestderr)rhcapmanrerrrDrDrEr1s    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)Nrrr5Fcs*g|]\}}|jddd|qS)r03d )lineno)r^ixrrDrE csz,DoctestItem.repr_failure.. z?EXAMPLE LOCATION UNKNOWN, not showing all tests of that examplez>>>z??? rz... zUNEXPECTED EXCEPTION: cSsg|]}|dqS)r)stripr^rrDrDrErws )#rrrrrrrrsru repr_failurerrfilenamerr,ror _get_checker_get_report_choicerOrc docstring splitlines enumeratemaxsourcer7output_differencersplitr from_exc_infor tracebackformat_exceptionre)rhrrrsrfrrrrmessagermr{ report_choicernindentrk inner_excinforwrrEr=sd           zDoctestItem.repr_failure.tuple[os.PathLike[str] | str, int | None, str]cCs|j|jjd|jfS)Nz [doctest] )rNrrr[rrDrDrE reportinfo}szDoctestItem.reportinfo) r[r@rKrrrrrr'r() rKrr[r@rrrrr'rr'r()rrr'r)r'r) rorprqri classmethodrVrrrrrrryrDrDrwrErs    @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_flagrrDrDrE_get_flag_lookupsrcCs.|d}t}d}|D]}|||O}q |S)Nr)r)getinir)rOoptionflags_strflag_lookup_tableflag_accflagrDrDrEget_optionflagss rcCs |d}|r|drd}|S)Nr<usepdbF)getvalue)rOrrDrDrE_get_continue_on_failures  rc@seZdZdZdddZdS)rXNr'Iterable[DoctestItem]c csddl}|jd}|j|}t|j}|jj}ddi}t|j}td|t t |jd}| } | ||||d} | j rLtj|| j|| dVdSdS)Nrr.ro__main__Fr}rr{rr[rr)rrOrrN read_textr@r[rrrr DocTestParser get_doctestexamplesrrV) rhrencodingtextrr[rdrrr&rrDrDrEr/s*      zDoctestTextfile.collectr'r)rorprqrr/rDrDrDrErXsrXrrcs4ddltfdd|jD}|rtddSdS)zVRaise pytest.skip() if all examples in the given DocTest have the SKIP option set.rNc3s |] }|jjdVqdS)FN)optionsgetSKIPrrrDrEr`sz%_check_all_skipped..z!all tests skipped by +SKIP option)rallrr)r all_skippedrDrrErs  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_existNrrrDrDrE _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'r c spz|dus |turtdWS|fdddWSty7}ztd|ddtd}~ww)Nrcst|pSrG)rr_stoprrDrEszF_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!rE_mock_aware_unwrapsz4_patch_unwrap_mock_aware.._mock_aware_unwrap)rrrr r'r )inspectunwrap)r*rDr(rE_patch_unwrap_mock_awaresr-c@seZdZdddZdS)rUr'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,ru _find_lineno)rhr source_linesrwrDrEr7s    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-ru_find)rhtestsrr[moduler8rdseenrwrDrEr: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_propertyrru _from_module)rhr<rrwrDrErA)s zBDoctestModule.collect..MockAwareDocTestFinder._from_moduler) rorprqr version_infopy_ver_info_minormicrois_find_lineno_brokenr7r:rAryrDrDrwrEMockAwareDocTestFinders   rFr;zunable to import module Fr r )r DocTestFinderrr CollectErrorrOrrrNrarparsefactoriesrrrrfindrorrrVr[)rhrrFr<finderrrrrDrDrEr/s6=    zDoctestModule.collectNr)rorprqr/rDrDrDrErUsrUtype[doctest.OutputChecker]cCsddl}Gddd|j}|S)NrcsReZdZedejZedejZedejZ dfd 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+) ) ) wantr@rrrr'rZcst|||r dS|t@}|t@}|t@}|s!|s!|s!dSd dd }|r4||j|}||j|}|rB||j|}||j|}|rJ|||}t|||S) NTFregexre.Pattern[str]txtr@r'cSst|d|S)Nz\1\2)resub)rNrPrDrDrEremove_prefixes~szX_init_checker_class..LiteralsOutputChecker.check_output..remove_prefixes)rNrOrPr@r'r@)ru check_outputrrr_unicode_literal_re_bytes_literal_re_remove_unwanted_precision)rhrMrr allow_unicode allow_bytes allow_numberrSrwrDrErTss"          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_refinditerlenziprCrfloatrstartend) rhrMrwantsgotsoffsetwgr[exponent precisionrDrDrErWs&    &.$zM_init_checker_class..LiteralsOutputChecker._remove_unwanted_precision)rMr@rr@rrr'rZ)rMr@rr@r'r@) rorprqrQcompileUNICODErUrVVERBOSEr`rTrWryrDrDrwrELiteralsOutputCheckerUsrq)r OutputChecker)rrqrDrDrE_init_checker_classRsQrsdoctest.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%rsrDrDrDrErsrcCddl}|dS)z+Register and return the ALLOW_UNICODE flag.rNrrregister_optionflagrrDrDrEr rcCru)z)Register and return the ALLOW_BYTES flag.rNrrvrrDrDrErrxrcCru)z$Register and return the NUMBER flag.rNrrvrrDrDrErrxrkeyr@c 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)ryrrDrDrErsrra)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`. )rrDrDrDrErsr)r&rr'r(r)rJrrKrr'rL)rNrr'rZ)rOrrNrrKrr'rZ)r'rzr) r{r|r}r~rrrrZr'r)r'r)rOrr'r)rOrr'rZ)rrr'r()rrr'rZ)r'r)r'rL)r'rt)r'r)ryr@r'r)r'r)_r __future__rrcollections.abcrrrr contextlibrr?r+ospathlibrrrQrrtypestypingr r r%_pytestr _pytest._code.coder r r _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_extensionsrrr|r~rzrrBrHr%__annotations__rFrIrYrSrWrTrer$rrrrrrrrrXrrr-rUrsrrrrrrrDrDrDrEs                               2     6        ^ W