o Zhe @sUdZddlZddlmZddlZddlZddlZddlmZddl Z ddl Z ddl Z ddl Z ddl mZddl mZddl mZddl mZdd l mZdd l mZdd l mZdd l mZdd l mZddl mZddl mZddl mZddl mZddlZddlmZddlmZddlm 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!l5m6Z6dd"l7m8Z8dd#l9m:Z:erddl;Z;dd$l md'Z?d(Z@d)ZAe=e>e?e@eAfZBdaCdaDeed*eEd+<d,e)d-dfd.d/ZFdtd0d1ZGd2ed3e.d-eed4fd5d6ZHd7ed-eIfd8d9ZJd:e'd7ed3e.d-eIfd;d<ZKd7ed-eIfd=d>ZLGd?d@d@e!ZMGdAdBdBeNZOd-edCfdDdEZP    FdudGed*dHeeIdIeQdJeId-dCf dKdLZRGdMdNdNe/ZSd-eeTeQffdOdPZUd:e'd-eQfdQdRZVd:e'd-eIfdSdTZWGdUdVdVe6ZXdvdYdZZYd[eZd-eIfd\d]Z[ed-ed^fd_d`Z\Gdadbdbe6Z]d-ed*fdcddZ^dwdedfZ_d-eQfdgdhZ`d-eQfdidjZad-eQfdkdlZbdmeTd-eQfdndoZce+dpdqd-eeTeffdrdsZddS)xz4Discover 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) TopRequest) Collector)Item)OutcomeException)skip fnmatch_ex)Module)approx) PytestWarning)SelfnoneZcdiffZndiffudiffZonly_first_failuredoctest.OutputChecker CHECKER_CLASSparserreturncCs|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-errorsz Ignore doctest collection errorsdoctest_ignore_import_errorsz--doctest-continue-on-failurezsz_is_doctest..)rQsessionZ isinitpath getoptionrS)rPrOrKglobsrDrNrErWsrWcCs |jdkS)Nz __main__.py)rYrNrDrDrErUs rUc@s@eZdZdeeeeefddfddZdeddfddZ dS) ReprFailDoctestreprlocation_linesr+NcCs ||_dSrG)rc)selfrcrDrDrE__init__s zReprFailDoctest.__init__twcCs2|jD]\}}|D]}||q ||qdSrG)rcline toterminal)rdrf reprlocationlinesrgrDrDrErhs   zReprFailDoctest.toterminal) __name__ __module__ __qualname__r r rr@rerrhrDrDrDrErbs rbcs*eZdZdedddffdd ZZS)MultipleDoctestFailuresfailureszdoctest.DocTestFailurer+Ncst||_dSrG)superrerordro __class__rDrEres  z MultipleDoctestFailures.__init__)rkrlrmr re __classcell__rDrDrrrErns"rndoctest.DocTestRunnercs"ddlGfdddj}|S)Nrc seZdZdZ    ddeddeeded ed df fd d Zd dddded dffdd Z d dddde e e e e jfd dffdd 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. NrTcheckerr(verbose optionflagscontinue_on_failurer+cstj|||d||_dS)N)rvrwrx)rprery)rdrvrwrxryrrrDrEres z8_init_runner_class..PytestDoctestRunner.__init__testdoctest.DocTestexamplezdoctest.Examplegotcs&|||}|jr||dS|rG)DocTestFailureryr:)rdoutrzr|r}failuredoctestrDrEreport_failuresz>_init_runner_class..PytestDoctestRunner.report_failureexc_infocsVt|dtr |dt|dtjrtd|||}|jr)||dS|)NzQuitting debugger) isinstancerbdbZBdbQuitrexitUnexpectedExceptionryr:)rdrrzr|rrrrDrEreport_unexpected_exceptions zK_init_runner_class..PytestDoctestRunner.report_unexpected_exceptionNNrT)rkrlrm__doc__r boolintrer@rr r BaseExceptiontypes TracebackTyperrtrDrrrrEPytestDoctestRunnersF  r)rZ DebugRunner)rrDrrE_init_runner_classs/rTrvrwrxrycCstdurtat||||dS)Nrvrwrxry)rHrrrDrDrE _get_runnersrc seZdZdedddddddd f fd d Zedddedddddd f fd d ZdddZdddZdddZ dddZ de e de eefffdd Zdee defeeeffddZZS) DoctestItemrYrKz%Union[DoctestTextfile, DoctestModule]runnerrudtestr{r+NcsRt||||_||_d|_|jj}|j|ddd}||_|j |_ | dS)N)nodefunccls) rprerrobjr__fixturemanagerZgetfixtureinfoZ _fixtureinfoZ names_closureZ fixturenames _initrequest)rdrYrKrrfmZ fixtureinforrrDrEres zDoctestItem.__init__r%cstj||||dS)zThe public named constructor.)rYrKrr)rprV)rrKrYrrrrrDrErVs zDoctestItem.from_parentcCsi|_t|dd|_dS)NT)Z _ispytest)Zfuncargsr_requestrdrDrDrErszDoctestItem._initrequestcCsL|jt|jjd}|jdD]\}}|||<q|jj|dS)N)Z getfixturedoctest_namespace)rZ _fillfixturesdictZgetfixturevalueitemsrraupdate)rdrarYvaluerDrDrEsetup"s  zDoctestItem.setupcCs8t|j|g}|jj|j|d|rt|dS)N)r)_check_all_skippedr$_disable_output_capturing_for_darwinrrunrnrqrDrDrEruntest)s zDoctestItem.runtestcCsZtdkrdS|jjd}|r+|jdd|\}}tj |tj |dSdS)zFDisable output capturing. Otherwise, stdout is lost to doctest (#985).DarwinNZcapturemanagerT)in_) platformsystemrPZ pluginmanagerZ getpluginZsuspend_global_captureZread_global_capturesysstdoutwritestderr)rdZcapmanrerrrDrDrEr3s    z0DoctestItem._disable_output_capturing_for_darwinexcinfocsddl}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}| dt |jg7} | ddt!j"|jD7} || | fq-t#|S)Nrrr8Fcs&g|]\}}d|jd|fqS)z%03d %sr)lineno)r\ixrzrDrE esz,DoctestItem.repr_failure.. z?EXAMPLE LOCATION UNKNOWN, not showing all tests of that examplez>>>z???  z... zUNEXPECTED EXCEPTION: %scSsg|]}|dqS)r)stripr\rrDrDrErys )$rrrr~rrnrorp repr_failurer|rzfilenamerr/rkr _get_checker_get_report_choicerPr` docstring splitlines enumeratemaxsourcer:Zoutput_differencer}splitrZ from_exc_inforrepr tracebackformat_exceptionrb)rdrrrorcrr|rrmessagerirvZ report_choicerjindentrgZ inner_excinforrrrEr?sd           zDoctestItem.repr_failurezos.PathLike[str]cCs|j|jjd|jfS)Nz [doctest] %s)rOrrrYrrDrDrE reportinfoszDoctestItem.reportinfor+N)rkrlrmr@re classmethodrVrrrrrrrrrr r rrrtrDrDrrrErsD     ,@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_lookupsrcCs.|d}t}d}|D]}|||O}q |S)Nr,r)getinir)rPZoptionflags_strZflag_lookup_tableZflag_accflagrDrDrEget_optionflagss rcCs |d}|r|drd}|S)Nr?ZusepdbF)getvalue)rPryrDrDrE_get_continue_on_failures  rc@s"eZdZdZdeefddZdS)rMNr+c csddl}|jd}|j|}t|j}|jj}ddi}t|j}td|t t |jd}| } | ||||d} | j rLtj|| j|| dVdSdS)Nrr1rk__main__FrwrxrvryrYrr)rrPrrO read_textr@rYrrrrZ DocTestParserZ get_doctestexamplesrrV) rdrencodingtextrrYrarxrr*rzrDrDrEr2s*      zDoctestTextfile.collect)rkrlrmrrrr2rDrDrDrErMsrMrzr{cs4ddltfdd|jD}|rtddSdS)zVRaise pytest.skip() if all examples in the given DocTest have the SKIP option set.rNc3s |] }|jjdVqdS)FN)optionsgetZSKIPrrrDrEr^sz%_check_all_skipped..z!all tests skipped by +SKIP option)rallrr)rzZ all_skippedrDrrErs  rrcCst|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`tjdddtdtfdtttgtfdtffdd}|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.Nstopr.rr+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$)rreZ real_unwraprrE_mock_aware_unwrapsz4_patch_unwrap_mock_aware.._mock_aware_unwrap)inspectunwraprrr )rrDrrE_patch_unwrap_mock_awares rc@seZdZdeefddZdS)rLr+ccsddl}Gddd|j}z|j}Wntjy,|jdr)td|jnYnw|j j ||}t |j}t d|tt|jd}|||jD]}|jr_tj||j||dVqOdS) NrcsReZdZdZfddZ  d fdd Zejdkr$fd d ZZ S Z 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|tr t|d|}t|drt|}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__)rpropertygetattrhasattrrrrp _find_lineno)rdr source_linesrrrDrErs    zBDoctestModule.collect..MockAwareDocTestFinder._find_linenor+Nc sPt|rdStt|||||||WddS1s!wYdSrG)rrrp_find)rdZtestsrrYmodulerraseenrrrDrErs"z;DoctestModule.collect..MockAwareDocTestFinder._find) 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_propertyrrp _from_module)rdrobjectrrrDrEr "s zBDoctestModule.collect..MockAwareDocTestFinder._from_moduler) rkrlrmrrrr version_infor rtrDrDrrrEMockAwareDocTestFinders   rr>zunable to import module %rFrr)rZ DocTestFinderrrZ CollectErrorrPrrrOr_rZparsefactoriesrrrrfindrkrrrVrY)rdrrrfinderrxrrzrDrDrEr2s67    zDoctestModule.collectN)rkrlrmrrr2rDrDrDrErLsrLcs*ddl}ddlGfddd|j}|S)NrcspeZdZdjZdjZdjZde de de de ffdd Z de de de fd d 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+) ) ) wantr}rxr+cst|||r dS|t@}|t@}|t@}|s!|s!|s!dSdttdtdtffdd }|r>||j|}||j|}|rL||j|}||j|}|rT| ||}t|||S)NTFregextxtr+cs|d|S)Nz\1\2)sub)rrrerDrEremove_prefixes{szX_init_checker_class..LiteralsOutputChecker.check_output..remove_prefixes) rp check_outputrrrr r@_unicode_literal_re_bytes_literal_re_remove_unwanted_precision)rdrr}rxZ allow_unicodeZ allow_bytesZ allow_numberr)rsrrDrErps"         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)NrfractionZ exponent1Z exponent2 )abs) list _number_refinditerlenziprCrfloatr#startend) rdrr}Zwantsgotsoffsetwgrexponent precisionrDrDrErs&    &.$zM_init_checker_class..LiteralsOutputChecker._remove_unwanted_precision)rkrlrmcompileUNICODErrVERBOSEr r@rrrrrtrDrrrrELiteralsOutputCheckerRs r0)rrZ OutputChecker)rr0rDrrE_init_checker_classNsQr1cCstdurtatS)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)r1rDrDrDrErsrcCddl}|dS)z+Register and return the ALLOW_UNICODE flag.rNrrZregister_optionflagrrDrDrEr rcCr2)z)Register and return the ALLOW_BYTES flag.rNrr3rrDrDrErr4rcCr2)z$Register and return the NUMBER flag.rNrr3rrDrDrErr4rkeyc 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)r5rrDrDrErsrr_)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`. )rrDrDrDrErsrrr)rzr{r+N)r+r()err contextlibrr rospathlibrrrrrtypingrrrrrr r r r r rrrrZ_pytestrZ_pytest._code.coderrrZ _pytest._iorZ_pytest.compatrZ_pytest.configrZ_pytest.config.argparsingrZ_pytest.fixturesrrZ _pytest.nodesrrZ_pytest.outcomesrrZ_pytest.pathlibr!Z_pytest.pythonr"Z_pytest.python_apir#Z_pytest.warning_typesr$rr%r:r7r8r6r9rBrHr)__annotations__rFrIrXrrTrWrUrbrrnrrrrr@rrrrMrr rrrLr1rrrrrrrDrDrDrEs                                    2   6     X X