a !fh@sUdZddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl m Z ddl m Z ddlmZddlmZddlmZddlmZdd lmZdd lmZdd lmZdd lmZdd lmZddlmZddlmZddlmZddlmZddlmZddlmZddlm Z ddlm!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/ddl0m1Z1ddl0m2Z2dd l3m4Z4dd!l3m5Z5dd"l6m7Z7dd#l8m9Z9dd$l:m;Z;erddld'Z?d(Z@d)ZAe=e>e?e@eAfZBdaCdaDeed*eEd+<e)dd,d-d.ZFdd/d0d1ZGe e.eed2d3d4d5ZHe eId6d7d8ZJe'e e.eId9d:d;ZKe eId6dd?d?e!ZMGd@dAdAeNZOedBd/dCdDZPdsed*eeIeQeIdBdFdGdHZRGdIdJdJe/ZSeeTeQfd/dKdLZUdMdNZVdOdPZWGdQdRdRe7ZXdSddTdUdVZYeZeIdWdXdYZ[e edZd/d[d\Z\Gd]d^d^e7Z]eSe,d_d`daZ^ed*d/dbdcZ_d*d/dddeZ`eQd/dfdgZaeQd/dhdiZbeQd/djdkZceTeQdldmdnZde+dodpeeTefd/dqdrZedS)tz4Discover and run doctests in modules and test files.N)contextmanager)Path)Any)Callable)Dict) Generator)Iterable)List)Optional)Pattern)Sequence)Tuple)Type) TYPE_CHECKING)Union)outcomes) ExceptionInfo)ReprFileLocation) TerminalRepr)TerminalWriter safe_getattr)Config)Parser)fixture)FixtureRequest) Collector)Item)OutcomeException)skip fnmatch_ex) import_path)Module)approx) PytestWarningnoneZcdiffZndiffudiffZonly_first_failuredoctest.OutputChecker CHECKER_CLASS)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)r0collectz--doctest-modules store_trueFzRun doctests in all .py modulesdoctestmodules)actionr0helpdestz--doctest-reportr'z9Choose another output format for diffs on doctest failure doctestreport)r/r0r6choicesr7z--doctest-globappendpatz2Doctests file matching pattern, default: test*.txt doctestglob)r5r0metavarr6r7z--doctest-ignore-import-errorszIgnore doctest ImportErrorsdoctest_ignore_import_errorsz--doctest-continue-on-failurezz_is_doctest..)rRsessionZ isinitpath getoptionrT)rQrPrNglobsrDrOrErXsrXcCs |jdkS)Nz __main__.py)r\rOrDrDrErVsrVc@s<eZdZeeeeefddddZeddddZ dS)ReprFailDoctestN)reprlocation_linesr+cCs ||_dSrH)rg)selfrgrDrDrE__init__szReprFailDoctest.__init__)twr+cCs2|jD]&\}}|D]}||q||qdSrH)rgline toterminal)rhrj reprlocationlinesrkrDrDrErls zReprFailDoctest.toterminal) __name__ __module__ __qualname__r r rr@rirrlrDrDrDrErfs rfcs(eZdZedddfdd ZZS)MultipleDoctestFailureszdoctest.DocTestFailureN)failuresr+cst||_dSrH)superrirsrhrs __class__rDrEris z MultipleDoctestFailures.__init__)rorprqr ri __classcell__rDrDrvrErrsrrdoctest.DocTestRunnercs"ddlGfdddj}|S)NrcsxeZdZdZdedeeeeddfdd Zd d edd fd d Z d d e e e e e jfddfdd 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. NrTr(checkerverbose optionflagscontinue_on_failurer+cstj|||d||_dS)N)r{r|r})rtrir~)rhr{r|r}r~rvrDrErisz8_init_runner_class..PytestDoctestRunner.__init__doctest.DocTestzdoctest.Example)testexamplegotr+cs(|||}|jr ||n|dSrH)DocTestFailurer~r:)rhoutrrrfailuredoctestrDrEreport_failures z>_init_runner_class..PytestDoctestRunner.report_failure)rrexc_infor+csXt|dtr|dt|dtjr0td|||}|jrP||n|dS)NzQuitting debugger) isinstancerbdbZBdbQuitrexitUnexpectedExceptionr~r:)rhrrrrrrrDrEreport_unexpected_exceptions  zK_init_runner_class..PytestDoctestRunner.report_unexpected_exception)NNrT)rorprq__doc__r boolintrir@rr r BaseExceptiontypes TracebackTyperrxrDrrvrEPytestDoctestRunners, r)rZ DebugRunner)rrDrrE_init_runner_classs/rTrzcCstdurtat||||dS)Nr{r|r}r~)rIrrrDrDrE _get_runnersrcseZdZdedededddfdd Zededddfd d Zdd d d Zdd ddZ dd ddZ e e e eefdfdd Zee defeeefd ddZZS) DoctestItemNz%Union[DoctestTextfile, DoctestModule]ryr)r\rNrunnerdtestr+cs*t||||_||_d|_d|_dSrH)rtrirrobjfixture_request)rhr\rNrrrvrDrEris zDoctestItem.__init__)rNr\rrcstj||||dS)zThe public named constructor.)r\rNrr)rtrW)clsrNr\rrrvrDrErW s zDoctestItem.from_parentrGcCsV|jdurRt||_t|jjd}|jdD]\}}|||<q2|jj|dS)N)Z getfixturedoctest_namespace)r_setup_fixturesrdictZgetfixturevalueitemsreupdate)rhrer\valuerDrDrEsetups   zDoctestItem.setupcCsT|jdusJ|jdusJt|j|g}|jj|j|d|rPt|dS)N)r)rr_check_all_skipped$_disable_output_capturing_for_darwinrunrrrurDrDrEruntest"s zDoctestItem.runtestcCsVtdkrdS|jjd}|rR|jdd|\}}tj |tj |dS)zFDisable output capturing. Otherwise, stdout is lost to doctest (#985).DarwinNZcapturemanagerT)Zin_) platformsystemrQ pluginmanagerZ getpluginZsuspend_global_captureZread_global_capturesysstdoutwritestderr)rhZcapmanrerrrDrDrEr.s    z0DoctestItem._disable_output_capturing_for_darwin)excinfor+csddl}d}t|j|j|jfr*|jg}nt|jtr>|jj}|durRt|Sg}|D]v}|j }|j j }j durd}nj |j d}t |j} t||| } t} t|jd} |dur*|j jdusJ|j jd} j dusJfddt| D} | t|j dd|j d} n6dg} d }|jD] }| d |d |d }q>t||jr| | ||j| d 7} n:t|j}| dt |jg7} | ddt!j"|jD7} || | fqZt#|S)Nrrr8Fcs&g|]\}}d|jd|fqS)z%03d %sr)lineno)r_ixrrDrE `sz,DoctestItem.repr_failure.. z?EXAMPLE LOCATION UNKNOWN, not showing all tests of that examplez>>>z???  z... zUNEXPECTED EXCEPTION: %scSsg|]}|dqS)r)stripr_rrDrDrErts)$rrrrrrrrsrt repr_failurerrfilenamerr/ror _get_checker_get_report_choicerQrd docstring splitlines enumeratemaxsourcer:Zoutput_differencersplitrZ from_exc_inforrepr tracebackformat_exceptionrf)rhrrrsrgrrrrmessagermr{Z report_choicernindentrkZ inner_excinforvrrEr:sd            zDoctestItem.repr_failurezos.PathLike[str]cCs$|jdusJ|j|jjd|jfS)Nz [doctest] %s)rrPrr\)rhrDrDrE reportinfozszDoctestItem.reportinfo)NN)rorprqr@r ri classmethodrWrrrrrrrrr rrrxrDrDrvrErs,     @rc 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_lookupsrcCs0|jd}t}d}|D]}|||O}q|S)Nr,r)rQgetinir)rNZoptionflags_strZflag_lookup_tableZflag_accflagrDrDrEget_optionflagss  rcCs |d}|r|drd}|S)Nr?ZusepdbF)getvalue)rQr~rDrDrE_get_continue_on_failures   rc@s"eZdZdZeedddZdS)rLNrGc csddl}|jd}|j|}t|j}|jj}ddi}t|}td|t t |jd}| } | ||||d} | j rtj|| j|| dVdS)Nrr1ro__main__Fr|r}r{r~r\rr)rrQrrP read_textr@r\rrrrZ DocTestParserZ get_doctestexamplesrrW) rhrencodingtextrr\rer}rr*rrDrDrEr2s&    zDoctestTextfile.collect)rorprqrrrr2rDrDrDrErLsrLr)rr+cs0ddltfdd|jD}|r,tddS)zVRaise pytest.skip() if all examples in the given DocTest have the SKIP option set.rNc3s|]}|jjdVqdS)FN)optionsgetZSKIPrrrDrErarbz%_check_all_skipped..z!all tests skipped by +SKIP option)rallrr)rZ all_skippedrDrrErsr)rr+cCst|ddduS)zmReturn if an object is possibly a mock object by checking the existence of a highly improbable attribute.Z1pytest_mock_example_attribute_that_shouldnt_existNrrrDrDrE _is_mockeds r)NNNc#s\tjddtdtftttgtftdfdd}|t_zdVWt_nt_0dS)zContext manager which replaces ``inspect.unwrap`` with a version that's aware of mock objects and doesn't recurse into them.Nstop.)funcrr+c szz:|dus|tur tdWS|fdddWStyt}z"td|ftWYd}~n d}~00dS)Nrcst|pSrH)rr_stoprrDrErbzF_patch_unwrap_mock_aware.._mock_aware_unwrap..zGot %r when unwrapping %r. 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_unwraprrE_mock_aware_unwrapsz4_patch_unwrap_mock_aware.._mock_aware_unwrap)inspectunwraprrr )rrDrrE_patch_unwrap_mock_awaresrc@seZdZeedddZdS)rKrGccsddl}Gddd|j}|jjdkrJ|jjj|j|jd|jjd}nRz t |j|jj|jdd}Wn0t y|j drt d |jnYn0|}t |}td |tt|jd }|||jD] }|jrtj||j||d VqdS) NrcsJeZdZdZfddZddfdd ZejdkrBfd d ZnZ S) z5DoctestModule.collect..MockAwareDocTestFinderzA 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 cs8t|trt|d|}t|dr*t|}t||S)a3Doctest code does not take into account `@property`, this is a hackish way to fix it. https://bugs.python.org/issue17446 Wrapped Doctests will need to be unwrapped so the correct line number is returned. This will be reported upstream. #8796 fget __wrapped__)rpropertygetattrhasattrrrrt _find_lineno)rhr source_linesrvrDrErs    zBDoctestModule.collect..MockAwareDocTestFinder._find_linenoNrGc sNt|r dSt(t|||||||Wdn1s@0YdSrH)rrrt_find)rhtestsrr\modulerreseenrvrDrErs z;DoctestModule.collect..MockAwareDocTestFinder._find) cs*ttdrt|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 cached_property)r functoolsrr rrt _from_module)rhrobjectrvrDrEr s  zBDoctestModule.collect..MockAwareDocTestFinder._from_module) rorprqrrrr version_infor rxrDrDrvrEMockAwareDocTestFinders  rz conftest.pyZ importmode)rootpath)rootmoder>zunable to import module %rFrr)rZ DocTestFinderrPr\rQrZ_importconftestrdrr" ImportErrorrrrrrrfindrorrrW)rhrrrfinderr}rrrDrDrEr2s>9      zDoctestModule.collectN)rorprqrrr2rDrDrDrErKsrK) doctest_itemr+cCsHdddd}i|_|jj}|j||ddd|_t|dd}||S) zEUsed by DoctestTextfile and DoctestItem to setup fixture information.NrGcSsdSrHrDrDrDrDrErUsz_setup_fixtures..funcF)noderrfuncargsT)Z _ispytest)rrcZ_fixturemanagerZgetfixtureinfoZ _fixtureinforZ _fillfixtures)rrfmrrDrDrErRs rcs*ddl}ddlGfddd|j}|S)NrcsfeZdZdjZdjZdjZe e e e dfdd Z e e e ddd Z ZS) 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+) ) ) )wantrr}r+cst|||rdS|t@}|t@}|t@}|sB|sB|sBdSttttdfdd }|rx||j|}||j|}|r||j|}||j|}|r| ||}t|||S)NTF)regexrZr+cs|d|S)Nz\1\2)sub)rrZrerDrEremove_prefixesszX_init_checker_class..LiteralsOutputChecker.check_output..remove_prefixes) rt check_outputrrrr r@_unicode_literal_re_bytes_literal_re_remove_unwanted_precision)rhrrr}Z allow_unicodeZ allow_bytesZ allow_numberr)rwrrDrErs"         z?_init_checker_class..LiteralsOutputChecker.check_output)rrr+c Sst|j|}t|j|}t|t|kr4|Sd}t||D]\}}|d}|d} | durp|d} |dur|dnt|} | dur| t| 8} t|tt|d| dkrB|d| |||| |d}|| | | | 7}qB|S)NrfractionZ exponent1Z exponent2 )abs) list _number_refinditerlenziprCrfloatr$startend) rhrrZwantsgotsoffsetwgr#exponent precisionrDrDrEr"s$    &.&zM_init_checker_class..LiteralsOutputChecker._remove_unwanted_precision)rorprqcompileUNICODEr r!VERBOSEr'r@rrrr"rxrDrrvrELiteralsOutputCheckerfsr7)rrZ OutputChecker)rr7rDrrE_init_checker_classbsQr8cCstdurtatS)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)r8rDrDrDrErsrcCsddl}|dS)z+Register and return the ALLOW_UNICODE flag.rNrrZregister_optionflagrrDrDrErsrcCsddl}|dS)z)Register and return the ALLOW_BYTES flag.rNrr9rrDrDrErsrcCsddl}|dS)z$Register and return the NUMBER flag.rNrr9rrDrDrErsr)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)r:rrDrDrErsrrc)scopecCstS)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)NNrT)frrr rosrrrrr contextlibrpathlibrtypingrrrrrr r r r r rrrZ_pytestrZ_pytest._code.coderrrZ _pytest._iorZ_pytest.compatrZ_pytest.configrZ_pytest.config.argparsingrZ_pytest.fixturesrrZ _pytest.nodesrrZ_pytest.outcomesrrZ_pytest.pathlibr!r"Z_pytest.pythonr#Z_pytest.python_apir$Z_pytest.warning_typesr%rr?r<r=r;r>rBrIr)__annotations__rFrJr[rrUrXrVrfrrrrrrrr@rrrrLrr rrrKrr8rrrrrrrDrDrDrEs                                   2  6     `X