9[gfNUdZddlmZddlZddlmZddlZddlZddlZddl 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/m0Z0ddl1m2Z2ddl3m4Z4ddl5m6Z6er ddl7Z7ddl8m9Z9d Z:d!Z;d"Ze:e;efZ?da@daAd%eBd&<dHd'ZCdId(ZD dJd)ZEdKd*ZFdLd+ZGdKd,ZHGd-d.eZIGd/d0eJZKdMd1ZL dN dOd2ZMGd3d4e+ZNdPd5ZOdQd6ZPdRd7ZQGd8d9e2ZRdSd:ZSdTd;ZTedUd<ZUGd=d>e2ZVdVd?ZWdWd@ZXdXdAZYdXdBZZdXdCZ[dYdDZ\e'dEFdZdGZ]y)[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_CLASSc~|jddddg|jddd |jd }|jd d d dd|jdtjddt d|jddgddd|jdd d dd|jdd d d d!y)"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-failurezz_is_doctest..s8%$z$%%s)rQsession isinitpath getoptionrS)rPrOr[globss ` rErXrXsL {{&&6>>+D+DT+J   ] + < }E 8%8 88rGc |jdk(S)Nz __main__.py)r^rNs rErUrUs 99 %%rGc$eZdZ ddZddZy)ReprFailDoctestc||_yrI)reprlocation_lines)selfrns rE__init__zReprFailDoctest.__init__s #5rGc~|jD].\}}|D]}|j||j|0yrI)rnline toterminal)rotw reprlocationlinesrrs rErszReprFailDoctest.toterminals:#'#:#: L%   # #B '$;rGN)rnz0Sequence[tuple[ReprFileLocation, Sequence[str]]]returnNone)rtrrwrx)__name__ __module__ __qualname__rprsrKrGrErlrls5"R5 5 (rGrlc eZdZdfd ZxZS)MultipleDoctestFailuresc0t|||_yrI)superrpfailures)ror __class__s rErpz MultipleDoctestFailures.__init__s   rG)rz Sequence[doctest.DocTestFailure]rwrx)ryrzr{rp __classcell__rs@rEr}r}s !!rGr}c>ddlGfddj}|S)NrczeZdZdZ d dfd Z dfd Z dfd ZxZS) /_init_runner_class..PytestDoctestRunnerzRunner to collect failures. Note that the out variable in this case is a list instead of a stdout-like object. c8t||||||_y)N)checkerverbose optionflags)rrpcontinue_on_failure)rorrrrrs rErpz8_init_runner_class..PytestDoctestRunner.__init__s! G Wg;  W':D $rGclj|||}|jr|j|y|rI)DocTestFailurerr7)roouttestexamplegotfailuredoctests rEreport_failurez>_init_runner_class..PytestDoctestRunner.report_failures5-g,,T7C@G'' 7# rGct|dtr|dt|dtjrt j dj |||}|jr|j|y|)NzQuitting debugger) isinstancerbdbBdbQuitr exitUnexpectedExceptionrr7)rorrrexc_inforrs rEreport_unexpected_exceptionzK_init_runner_class..PytestDoctestRunner.report_unexpected_exceptionsm(1+'78qk!(1+s{{3 121g11$JG'' 7# rGNNrT) rdoctest.OutputChecker | Noner bool | Nonerintrboolrwrx)rdoctest.DocTestrdoctest.Examplerr@rwrx)rrrrrz>tuple[type[BaseException], BaseException, types.TracebackType]rwrx)ryrzr{__doc__rprrr)rrs@rEPytestDoctestRunnerrs 59#' (,  ;1 ;! ;  ; "&  ;   ; " %      " %   U      rGr)r DebugRunner)rrs @rE_init_runner_classrs!-g11-^ rGc@t tat||||S)Nrrrr)rJrrs rE _get_runnerrs-)+  /  rGceZdZ d fd Ze d fd Zd dZd dZd dZd dZ d fd Z d dZ xZ S) DoctestItemct|||||_||_d|_|j j }|j|dd}||_|j|_ |jy)N)nodefunccls) rrprunnerdtestobjrf_fixturemanagergetfixtureinfo _fixtureinfo names_closure fixturenames _initrequest)ror^r[rrfm fixtureinfors rErpzDoctestItem.__init__ss v&   \\ ) )''T$'G ''55 rGc*t|||||S)zThe public named constructor.)r^r[rr)rrW)rr[r^rrrs rErWzDoctestItem.from_parentsw"VFRW"XXrGc6i|_t|d|_y)NT) _ispytest)funcargsr_requestros rErzDoctestItem._initrequests+- "448 rGc.|jjt|jj}|jjdj D] \}}|||< |j j j|y)N) getfixturedoctest_namespace)r _fillfixturesdictgetfixturevalueitemsrriupdate)rorir^values rEsetupzDoctestItem.setup so ##% = =>==889LMSSUKD%E$KV &rGct|j|jg}|jj |j||r t |y)N)r)_check_all_skippedr$_disable_output_capturing_for_darwinrrunr})rors rEruntestzDoctestItem.runtest'sL4::& 11313  1 )(3 3 rGcJtjdk7ry|jjj d}|rd|j d|j \}}tjj|tjj|yy)zFDisable output capturing. Otherwise, stdout is lost to doctest (#985).DarwinNcapturemanagerT)in_) platformsystemrP pluginmanager getpluginsuspend_global_captureread_global_capturesysstdoutwritestderr)rocapmanrerrs rErz0DoctestItem._disable_output_capturing_for_darwin1s~ ??  ( **445EF   ) )d ) 3113HC JJ  S ! JJ  S ! rGcddl}d}t|j|j|jfr|jg}n0t|jt r|jj }|t|!|Sg}|D]O}|j}|j}|j}|jd} n|j|jzdz} t|j} t|| | } t!} t#|j$j'd} | |jj(J|jj(j+d}|jJt-|Dcgc]\}}d||jzdz|fz}}}|t/|jdz d|jdz}n=dg}d}|j0j+D]}|j3d |d |d }t||jr0|| j5||j6| j9d z }nnt;j<|j>}|d |jgz }|tAjB|j>Dcgc]}|jEd c}z }|j3| |fRtG|Scc}}wcc}w)Nrrr5Fz%03d %s z?EXAMPLE LOCATION UNKNOWN, not showing all tests of that examplez>>>z???  z... zUNEXPECTED EXCEPTION: )$rrrrrr}rr repr_failurerrfilenamelinenor,ryr _get_checker_get_report_choicerPrh docstring splitlines enumeratemaxsourcer7output_differencersplitr from_exc_infor tracebackformat_exceptionstriprl)roexcinforrrnrrrrrmessagerur report_choicervixindentrr inner_excinfors rErzDoctestItem.repr_failure=s     MMG22G4O4OP  H  '> ?}}--H  7'0 0GooG<>A;MNV#NN557DLL4xq!78"F8'7#9#9:22W[[-%+!. ; ;G3->3 >3@FrGrc ddl}t|j|j|j|j |j |jttt 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_flagrs rE_get_flag_lookuprsZ &==%;;$99!! ' ? ? 11-/)+!  rGc^|jd}t}d}|D] }|||z} |S)Nr)r)getinir)rPoptionflags_strflag_lookup_tableflag_accflags rEget_optionflagsrs>mm$9:O(*H%d++ OrGcR|jd}|r|jdrd}|S)Nr<usepdbF)getvalue)rPrs rE_get_continue_on_failurers/ &0M N ??8 $"'  rGceZdZdZddZy)rYNc# Kddl}|jjd}|jj |}t |j}|jj }ddi}t|j}td|tt|j}|j} | j||||d} | jr&tj|| j || yyw)Nrr.ry__main__Frrrrr^rr)rrPrrO read_textr@r^rrrr DocTestParser get_doctestexamplesrrW) rorencodingtextrr^rirrrCrs rEr/zDoctestTextfile.collects;;%%&89yy""8,tyy>yy~~Z(%dkk2 # N 8 E  '&&(!!$tXqA ==))499V4*  sDDrwzIterable[DoctestItem])ryrzr{rr/rKrGrErYrYs CrGrYcfddltfd|jD}|r tdyy)zVRaise pytest.skip() if all examples in the given DocTest have the SKIP option set.rNc3jK|]*}|jjjd,yw)FN)optionsgetSKIP)rcrrs rErez%_check_all_skipped..s%P-QaiimmGLL%8-s03z!all tests skipped by +SKIP option)rallr$r)r all_skippedrs @rErrs-P$--PPK 01rGc t|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_existNr)rs rE _is_mockedr1s SMtT rGc#Ktjdd dfd}|t_ dt_y#t_wxYww)zContext manager which replaces ``inspect.unwrap`` with a version that's aware of mock objects and doesn't recurse into them.Nstopc ||turtS|fdS#t$r'}tjd|ddtd}~wwxYw)Nr3c.t|xsSrI)r1)r_stoprs rEzF_patch_unwrap_mock_aware.._mock_aware_unwrap..sjo6Tt6TrGzGot 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)r1 Exceptionwarningswarnr )rr4er7 real_unwraps` @rE_mock_aware_unwrapz4_patch_unwrap_mock_aware.._mock_aware_unwrapst |tz1"4j99Et*TU U  MMqe,TH5CC    s-- A"AA)rzCallable[..., Any]r4zCallable[[Any], Any] | Nonerwr)inspectunwrap)r>r=s @rE_patch_unwrap_mock_awarerAsU..KJN +F "(GN% $s*A> A A  AceZdZddZy)rVc#rKddl}Gdd|j} |j}|jjj||}t|j }td|tt|j }|j!|j"D]4}|j$st&j)||j*||6y#tj$r9|j j drtd|jnY wxYww) Nrc0eZdZejddZedkxsBedk(xrejj dkxs edk(xrejj dkZerfdZejdkr d fd Z ejd kr fd Z xZ SxZ S) 5DoctestModule.collect..MockAwareDocTestFinderN) r)rG rGct|tr t|d|}t|drt j |}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@r _find_lineno)ror source_linesrs rErPzBDoctestModule.collect..MockAwareDocTestFinder._find_linenosO"#x0%c637sM2%nnS1!7/$rG)rG c t|ryt5t| |||||||dddy#1swYyxYw)zOverride _find to work around issue in stdlib. https://github.com/pytest-dev/pytest/issues/3456 https://github.com/python/cpython/issues/69718 N)r1rAr_find) rotestsrr^modulerQriseenrs rErTz;DoctestModule.collect..MockAwareDocTestFinder._finds<"#13 !3flE4433s 7A)rG cpt|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_propertyrr _from_module)rorVobjectrs rEr\zBDoctestModule.collect..MockAwareDocTestFinder._from_module)s2 "&)*C*CD!'!7/??rGr) ryrzr{r version_infopy_ver_info_minormicrois_find_lineno_brokenrPrTr\rrs@rEMockAwareDocTestFinderrEs # 0 0! 4 !G+Q%0OS5E5E5K5Ka5OQ%0OS5E5E5K5Ka5O " %(') ') @ @*rGrbr;zunable to import module Frr )r DocTestFinderrr CollectErrorrPrrrOrfrparsefactoriesrrrrfindryr$rrWr^)rorrbrVfinderrrrs rEr/zDoctestModule.collects ; @W%:%:; @z XXF $$33D9()%dkk2 # N 8 E  KK8D}}!--tyyt.9)%% {{##$BC/ }=>? s/D7 C(BD7(D7(AD40D73D44D7Nr')ryrzr{r/rKrGrErVrVsZrGrVcFddl}ddlGfdd|j}|S)NrceZdZWjdWjZWjdWjZWjdWjZdfd Z ddZ xZ S)2_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+) ) ) czt||||ry|tz}|tz}|t z}|s|s|syd fd }|r&||j |}||j |}|r&||j |}||j |}|r|j||}t||||S)NTFc*j|d|S)Nz\1\2)sub)regextxtres rEremove_prefixeszX_init_checker_class..LiteralsOutputChecker.check_output..remove_prefixessvveWc22rG)rnz Pattern[str]ror@rwr@)r check_outputr r r_unicode_literal_re_bytes_literal_re_remove_unwanted_precision) rowantrr allow_unicode allow_bytes allow_numberrqrrps rErrz?_init_checker_class..LiteralsOutputChecker.check_outputtsw#D#{;'*A*CCM%(=(??K&)9);;L \ 3&t'?'?F%d&>&>D&t'='=tD%d&<&.LiteralsOutputChecker._remove_unwanted_precisions\11$78E0056D5zSY& FE4(1'(wwz':'(ww{';# ww{3H!)!1As8} 'X.I#veAGGI.>B N'SS 0aggi&01AGGI=AEEGfDTDV@WWaeeg 1QUUWqwwy5HIIF) JrG)rvr@rr@rrrwr)rvr@rr@rwr@) ryrzr{compileUNICODErsrtVERBOSErrrrur)rrps@rELiteralsOutputCheckerrjVsX !jj)CRZZPJJ'A2::NZZ & JJ) . @6 rGr)rrp OutputChecker)rrrps @rE_init_checker_classrRs& O 5 5Ob ! rGc6t tatS)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. )r'rrKrGrErrs+- ?rGc.ddl}|jdS)z+Register and return the ALLOW_UNICODE flag.rNr rregister_optionflagrs rEr r s &7 & & 77rGc.ddl}|jdS)z)Register and return the ALLOW_BYTES flag.rNr rrs rEr r s &7 & &} 55rGc.ddl}|jdS)z$Register and return the NUMBER flag.rNr rrs rErrs &7 & &x 00rGc ddl}t|jt|jt |j t|jtdi|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)keyrs rErrsN  $W%9%9#W%9%9#W%9%90'2S2S"A      rGrf)scopectS)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`. )rrKrGrErrs  6MrG)rCrrwrxr)rZrr[rrwz&DoctestModule | DoctestTextfile | None)rOrrwr)rPrrOrr[rrwr)rwztype[doctest.DocTestRunner]r) rrrrrrrrrwr)rwzdict[str, int])rPrrwr)rPrrwr)rrrwrx)rr]rwr)rwzGenerator[None])rwztype[doctest.OutputChecker])rwzdoctest.OutputChecker)rwr)rr@rwr)rwzdict[str, Any])^r __future__rr contextlibrrZr?ospathlibrrrrtypestypingrrrr r r r r:_pytestr _pytest._code.coderrr _pytest._ior_pytest.compatr_pytest.configr_pytest.config.argparsingr_pytest.fixturesrr _pytest.nodesrr_pytest.outcomesrr_pytest.pathlibr_pytest.pythonr_pytest.python_apir_pytest.warning_typesr rtyping_extensionsr!rrrrrrBrJr'__annotations__rFrLr\rTrXrUrlr9r}rrrrrrrYrr1rArVrrr r rrrrKrGrErs:" %    ,/+&'!,$'#-!&!%/&#%%%+?(,  48 18/d    , A9& (l (!i! 2l-1 $  )    (CF$CFL  f>2%%:[F[|U!p(861 " yrG