U 42if@sUdZddlmZddlZddlmZddlZddlZddlZddl 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&<d'd(d)d*d+ZCd(d,d-d.ZDd/d0d1d2d3d4ZEd/d5d6d7d8ZFd9d/d0d5d:d;d<ZGd/d5d6d=d>ZHGd?d@d@eZIGdAdBdBeJZKdCd,dDdEZLd|dGdHdId5dJdKdLdMZMGdNdOdOe+ZNdPd,dQdRZOd9dIdSdTdUZPd9d5dSdVdWZQGdXdYdYe2ZRdZd(d[d\d]ZSd^d5d_d`daZTedbd,dcddZUGdedfdfe2ZVdgd,dhdiZWdjd,dkdlZXdId,dmdnZYdId,dodpZZdId,dqdrZ[dsdIdtdudvZ\e'dwdxdyd,dzd{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)SelfnoneZcdiffZndiffudiffZonly_first_failurez"type[doctest.OutputChecker] | None CHECKER_CLASSrNone)parserreturncCs|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+r1choicesr2z--doctest-globappendpatz2Doctests file matching pattern, default: test*.txt doctestglob)r0r+metavarr1r2z--doctest-ignore-import-errorsz Ignore doctest collection errorsdoctest_ignore_import_errorsz--doctest-continue-on-failurezsz_is_doctest..)rKsessionZ isinitpath getoptionrM)rJrIrGglobsr?rHr@rRsrRcCs |jdkS)Nz __main__.py)rVrHr?r?r@rOsrOc@s,eZdZdddddZddddd Zd S) ReprFailDoctestz0Sequence[tuple[ReprFileLocation, Sequence[str]]]r$)reprlocation_linesr&cCs ||_dSrC)r`)selfr`r?r?r@__init__szReprFailDoctest.__init__r)twr&cCs2|jD]&\}}|D]}||q||qdSrC)r`line toterminal)rarc reprlocationlinesrdr?r?r@res zReprFailDoctest.toterminalN)__name__ __module__ __qualname__rbrer?r?r?r@r_sr_cs$eZdZdddfdd ZZS)MultipleDoctestFailuresz Sequence[doctest.DocTestFailure]r$)failuresr&cst||_dSrC)superrbrlrarl __class__r?r@rbs z MultipleDoctestFailures.__init__)rhrirjrb __classcell__r?r?ror@rksrkztype[doctest.DocTestRunner]cs"ddlGfdddj}|S)Nrcs`eZdZdZdddddd d fd d Zd ddd dfdd Zd ddd dfdd 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. NrTdoctest.OutputChecker | None bool | NoneintrUr$checkerverbose optionflagscontinue_on_failurer&cstj|||d||_dS)N)rvrwrx)rmrbry)rarvrwrxryror?r@rbsz8_init_runner_class..PytestDoctestRunner.__init__doctest.DocTestzdoctest.Exampler;)testexamplegotr&cs(|||}|jr ||n|dSrC)DocTestFailureryr5)raoutr{r|r}failuredoctestr?r@report_failures z>_init_runner_class..PytestDoctestRunner.report_failurez>tuple[type[BaseException], BaseException, types.TracebackType])r{r|exc_infor&csXt|dtr|dt|dtjr0td|||}|jrP||n|dS)NzQuitting debugger) isinstancerbdbZBdbQuitr exitUnexpectedExceptionryr5)rarr{r|rrrr?r@report_unexpected_exceptions  zK_init_runner_class..PytestDoctestRunner.report_unexpected_exception)NNrT)rhrirj__doc__rbrrrqr?rror@PytestDoctestRunners  r)rZ DebugRunner)rr?rr@_init_runner_classs/rTrrrsrtdoctest.DocTestRunnerrucCstdkrtat||||dS)Nrvrwrxry)rDrrr?r?r@ _get_runnersrcseZdZddddddfdd Zeddddd d fd d Zdd ddZdd ddZdd ddZdd ddZ dddfdd Z dd ddZ Z S) DoctestItemr;zDoctestTextfile | DoctestModulerrzr$)rVrGrunnerdtestr&csRt||||_||_d|_|jj}|j|ddd}||_|j |_ | dS)N)nodefunccls) rmrbrrobjr\_fixturemanagerZgetfixtureinfoZ _fixtureinfoZ names_closureZ fixturenames _initrequest)rarVrGrrZfmZ fixtureinforor?r@rbszDoctestItem.__init__r )rGrVrrr&cstj||||dS)zThe public named constructor.)rVrGrr)rmrQ)rrGrVrrror?r@rQs zDoctestItem.from_parentrBcCsi|_t|dd|_dS)NT)Z _ispytest)Zfuncargsr_requestrar?r?r@rszDoctestItem._initrequestcCsL|jt|jjd}|jdD]\}}|||<q(|jj|dS)N)Z getfixturedoctest_namespace)rZ _fillfixturesdictZgetfixturevalueitemsrr^update)rar^rVvaluer?r?r@setup s   zDoctestItem.setupcCs8t|j|g}|jj|j|d|r4t|dS)N)r)_check_all_skippedr$_disable_output_capturing_for_darwinrrunrkrnr?r?r@runtest's  zDoctestItem.runtestcCsVtdkrdS|jjd}|rR|jdd|\}}tj |tj |dS)zFDisable output capturing. Otherwise, stdout is lost to doctest (#985).DarwinNZcapturemanagerT)Zin_) platformsystemrJZ pluginmanagerZ getpluginZsuspend_global_captureZread_global_capturesysstdoutwritestderr)raZcapmanrerrr?r?r@r1s    z0DoctestItem._disable_output_capturing_for_darwinzExceptionInfo[BaseException]zstr | TerminalRepr)excinfor&csddl}d}t|j|j|jfr*|jg}nt|jtr>|jj}|dkrRt|Sg}|D]t}|j }|j j }j dkrd}nj |j d}t |j} t||| } t} t|jd} |dk r*|j jdk st|j jd} j dk stfddt| D} | t|j dd|j d} n6dg} d }|jD] }| d |d |d }q>t||jr| | ||j| d 7} n8t|j }| d|jg7} | ddt!j"|j D7} || | fqZt#|S)Nrrr3Fcs&g|]\}}d|jd|fqS)z%03d %sr)lineno)rYixr{r?r@ csz,DoctestItem.repr_failure.. z?EXAMPLE LOCATION UNKNOWN, not showing all tests of that examplez>>>z???  z... zUNEXPECTED EXCEPTION: cSsg|]}|dqS)r)striprYrr?r?r@rws)$rrrr~rrkrlrm repr_failurer|r{filenamerr*rhr _get_checker_get_report_choicerJr]Z docstringAssertionError splitlines enumeratemaxsourcer5Zoutput_differencer}splitr Z from_exc_infor tracebackformat_exceptionr_)rarrrlr`rr|rrmessagerfrvZ report_choicergindentrdZ inner_excinfororr@r=sj             zDoctestItem.repr_failurez.tuple[os.PathLike[str] | str, int | None, str]cCs|j|jjd|jfS)Nz [doctest] )rIrrrVrr?r?r@ reportinfo}szDoctestItem.reportinfo) rhrirjrb classmethodrQrrrrrrrqr?r?ror@rs   @rzdict[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_flagrr?r?r@_get_flag_lookupsr)rJr&cCs.|d}t}d}|D]}|||O}q|S)Nr'r)getinir)rJZoptionflags_strZflag_lookup_tableZflag_accflagr?r?r@get_optionflagss  rcCs |d}|r|drd}|S)Nr:ZusepdbF)getvalue)rJryr?r?r@_get_continue_on_failures   rc@seZdZdZddddZdS)rSNIterable[DoctestItem]rBc csddl}|jd}|j|}t|j}|jj}ddi}t|j}td|t t |jd}| } | ||||d} | j rtj|| j|| dVdS)Nrr,rh__main__FrwrxrvryrVrr)rrJrrI read_textr;rVrrrrZ DocTestParserZ get_doctestexamplesrrQ) rarencodingtextrrVr^rxrr%r{r?r?r@r-s,    zDoctestTextfile.collect)rhrirjrr-r?r?r?r@rSsrSrz)r{r&cs0ddltfdd|jD}|r,tddS)zVRaise pytest.skip() if all examples in the given DocTest have the SKIP option set.rNc3s|]}|jjdVqdS)FN)optionsgetZSKIPrrr?r@r[sz%_check_all_skipped..z!all tests skipped by +SKIP option)rallrr)r{Z all_skippedr?rr@rsrobject)rr&cCst|dddk S)zmReturn if an object is possibly a mock object by checking the existence of a highly improbable attribute.Z1pytest_mock_example_attribute_that_shouldnt_existNrrr?r?r@ _is_mockeds rzGenerator[None]c#s@tjddddddfdd}|t_z dVW5t_XdS) zContext manager which replaces ``inspect.unwrap`` with a version that's aware of mock objects and doesn't recurse into them.NstopzCallable[..., Any]zCallable[[Any], Any] | Noner)rrr&c s~z:|dks|tkr tdWS|fdddWStk rx}z td|ddtW5d}~XYnXdS)Nrcst|pSrC)rr_stoprr?r@zF_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)rreZ real_unwraprr@_mock_aware_unwrapsz4_patch_unwrap_mock_aware.._mock_aware_unwrap)inspectunwrap)rr?rr@_patch_unwrap_mock_awares rc@seZdZddddZdS)rPrrBccsddl}Gddd|j}z |j}Wn6tjk rZ|jdrTtd|jnYnX|j j ||}t |j}t d|tt|jd}|||jD] }|jrtj||j||dVqdS) NrcseZdZejddZedkpDedkr2ejjdkpDedkoDejjdkZerVfddZejd krrd d fd d Z ejdkrfddZ Z S)z5DoctestModule.collect..MockAwareDocTestFinderN) r)r rcs8t|trt|d|}t|dr*t|}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__)rpropertygetattrhasattrrrrm _find_lineno)rar source_linesror?r@rs    zBDoctestModule.collect..MockAwareDocTestFinder._find_lineno)r r$rBc s:t|r dStt|||||||W5QRXdS)zOverride _find to work around issue in stdlib. https://github.com/pytest-dev/pytest/issues/3456 https://github.com/python/cpython/issues/69718 N)rrrm_find)ratestsrrVmodulerr^seenror?r@rsz;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_propertyrrm _from_module)rarrror?r@r )s zBDoctestModule.collect..MockAwareDocTestFinder._from_module) rhrirjr version_infoZpy_ver_info_minormicroZis_find_lineno_brokenrrr rqr?r?ror@MockAwareDocTestFinders   r r9zunable to import module Frr)rZ DocTestFinderrrZ CollectErrorrJrrrIr\rZparsefactoriesrrrrfindrhrrrQrV)rarr rfinderrxrr{r?r?r@r-s2=   zDoctestModule.collectN)rhrirjr-r?r?r?r@rPsrPztype[doctest.OutputChecker]cs*ddl}ddlGfddd|j}|S)NrcsfeZdZdjZdjZdjZdddddfdd Z dddd d d Z 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+) ) ) r;rtrU)wantr}rxr&cst|||rdS|t@}|t@}|t@}|sB|sB|sBdSddddfdd }|rt||j|}||j|}|r||j|}||j|}|r|||}t|||S)NTFz Pattern[str]r;)regextxtr&cs|d|S)Nz\1\2)sub)rrrer?r@remove_prefixesszX_init_checker_class..LiteralsOutputChecker.check_output..remove_prefixes)rm check_outputrrr_unicode_literal_re_bytes_literal_re_remove_unwanted_precision)rarr}rxZ allow_unicodeZ allow_bytesZ allow_numberr)rprr?r@rts"         z?_init_checker_class..LiteralsOutputChecker.check_output)rr}r&c Sst|j|}t|j|}t|t|kr4|Sd}t||D]\}}|d}|d} | dkrp|d} |dkr|dnt|} | dk r| t| 8} t|tt|d| dkrB|d| |||| |d}|| | | | 7}qB|S)NrfractionZ exponent1Z exponent2r)abs) list _number_refinditerlenzipr>rtfloatrstartend) rarr}ZwantsgotsoffsetwgrexponentZ precisionr?r?r@rs$    &.&zM_init_checker_class..LiteralsOutputChecker._remove_unwanted_precision) rhrirjcompileUNICODErrVERBOSErrrrqr?rror@LiteralsOutputCheckerVsr-)rrZ OutputChecker)rr-r?rr@_init_checker_classRsQr.zdoctest.OutputCheckercCstdkrtatS)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#r.r?r?r?r@rsrcCsddl}|dS)z+Register and return the ALLOW_UNICODE flag.rNrrZregister_optionflagrr?r?r@rsrcCsddl}|dS)z)Register and return the ALLOW_BYTES flag.rNrr/rr?r?r@rsrcCsddl}|dS)z$Register and return the NUMBER flag.rNrr/rr?r?r@rsrr;)keyr&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_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)r0rr?r?r@rsrr\)Zscopezdict[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`. )rr?r?r?r@rsr)NNrT)^r __future__rr contextlibrrrospathlibrrrrtypestypingrrrrr r r rZ_pytestr Z_pytest._code.coder rrZ _pytest._iorZ_pytest.compatrZ_pytest.configrZ_pytest.config.argparsingrZ_pytest.fixturesrrZ _pytest.nodesrrZ_pytest.outcomesrrZ_pytest.pathlibrZ_pytest.pythonrZ_pytest.python_apirZ_pytest.warning_typesrrZtyping_extensionsr r5r2r3r1r4r=rDr#__annotations__rArErTrNrRrOr_rrkrrrrrrrSrrrrPr.rrrrrrr?r?r?r@s                               2 6    ^X