o hh @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+<d,e)d-dfd.d/ZFdwd0d1ZGd2e d3e.d-eed4fd5d6ZHd7e d-eIfd8d9ZJd:e'd7e d3e.d-eIfd;d<ZKd7e d-eIfd=d>ZLGd?d@d@e!ZMGdAdBdBeNZOd-edCfdDdEZP    FdxdGed*dHeeIdIeQdJeId-dCf dKdLZRGdMdNdNe/ZSd-eeTeQffdOdPZUdQdRZVdSdTZWGdUdVdVe7ZXdydYdZZYd[eZd-eIfd\d]Z[e d-ed^fd_d`Z\Gdadbdbe7Z]dceSd-e,fdddeZ^d-ed*fdfdgZ_dzdhdiZ`d-eQfdjdkZad-eQfdldmZbd-eQfdndoZcdpeTd-eQfdqdrZde+dsdtd-eeTeffdudvZedS){z4Discover 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) PytestWarningnonecdiffndiffudiffonly_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)r3collectz--doctest-modules store_trueFzRun doctests in all .py modulesdoctestmodules)actionr3helpdestz--doctest-reportr)z9Choose another output format for diffs on doctest failure doctestreport)r2r3r9choicesr:z--doctest-globappendpatz2Doctests file matching pattern, default: test*.txt doctestglob)r8r3metavarr9r:z--doctest-ignore-import-errorszIgnore doctest ImportErrorsdoctest_ignore_import_errorsz--doctest-continue-on-failurezsz_is_doctest..)rWsession isinitpath getoptionrY)rVrUrQglobsrJrTrKr]sr]cCs |jdkS)Nz __main__.py)rarTrJrJrKr[s r[c@s@eZdZdeeeeefddfddZdeddfddZ dS) ReprFailDoctestreprlocation_linesr.NcCs ||_dSrM)rl)selfrlrJrJrK__init__s zReprFailDoctest.__init__twcCs2|jD]\}}|D]}||q ||qdSrM)rlline toterminal)rmro reprlocationlinesrprJrJrKrqs   zReprFailDoctest.toterminal) __name__ __module__ __qualname__r r rrFrnrrqrJrJrJrKrks rkcs*eZdZdedddffdd ZZS)MultipleDoctestFailuresfailureszdoctest.DocTestFailurer.Ncst||_dSrM)superrnrxrmrx __class__rJrKrns  z MultipleDoctestFailures.__init__)rtrurvr rn __classcell__rJrJr{rKrws"rwdoctest.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)rrr)ryrnr)rmrrrrr{rJrKrns z8_init_runner_class..PytestDoctestRunner.__init__testdoctest.DocTestexamplezdoctest.Examplegotcs&|||}|jr||dS|rM)DocTestFailurerr=)rmoutrrrfailuredoctestrJrKreport_failuresz>_init_runner_class..PytestDoctestRunner.report_failureexc_infocsVt|dtr |dt|dtjrtd|||}|jr)||dS|)NzQuitting debugger) isinstancerbdbBdbQuitrexitUnexpectedExceptionrr=)rmrrrrrrrJrKreport_unexpected_exceptions zK_init_runner_class..PytestDoctestRunner.report_unexpected_exceptionNNrT)rtrurv__doc__r boolintrnrFrr r BaseExceptiontypes TracebackTyperr}rJrr{rKPytestDoctestRunnersF  r)r DebugRunner)rrJrrK_init_runner_classs/rTrrrrcCstdurtat||||dS)Nrrrr)rNrrrJrJrK _get_runnersrc seZdZ  ddedddeddedd df fd d Zedddeddddffd d ZdddZdddZ dddZ de e d e eefffdd Zd ee defeeeffddZZS) DoctestItemNrarQz%Union[DoctestTextfile, DoctestModule]runnerr~dtestrr.cs*t||||_||_d|_d|_dSrM)ryrnrrobjfixture_request)rmrarQrrr{rJrKrns  zDoctestItem.__init__cstj||||dS)zThe public named constructor.)rarQrr)ryr\)clsrQrarrr{rJrKr\ s zDoctestItem.from_parentcCsZ|jdur+t||_t|jjd}|jdD]\}}|||<q|jj|dSdS)N) getfixturedoctest_namespace)r_setup_fixturesrdictgetfixturevalueitemsrjupdate)rmrjravaluerJrJrKsetups   zDoctestItem.setupcCsT|jdusJ|jdusJt|j|g}|jj|j|d|r(t|dS)N)r)rr_check_all_skipped$_disable_output_capturing_for_darwinrunrwrzrJrJrKruntest"s zDoctestItem.runtestcCsZtdkrdS|jjd}|r+|jdd|\}}tj |tj |dSdS)zFDisable output capturing. Otherwise, stdout is lost to doctest (#985).DarwinNcapturemanagerT)in_) platformsystemrV pluginmanager getpluginsuspend_global_captureread_global_capturesysstdoutwritestderr)rmcapmanrerrrJrJrKr.s    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)Nrrr;Fcs&g|]\}}d|jd|fqS)z%03d %sr)lineno)rdixrrJrK `sz,DoctestItem.repr_failure.. z?EXAMPLE LOCATION UNKNOWN, not showing all tests of that examplez>>>z???  z... zUNEXPECTED EXCEPTION: %scSsg|]}|dqS)r)striprdrrJrJrKrts )$rrrrrrwrxry repr_failurerrfilenamerr2rtr _get_checker_get_report_choicerVri docstring splitlines enumeratemaxsourcer=output_differencersplitr from_exc_inforrepr tracebackformat_exceptionrk)rmrrrxrlrrrrmessagerrr report_choicersindentrp inner_excinfor{rrKr:sd           zDoctestItem.repr_failurezos.PathLike[str]cCs$|jdusJ|j|jjd|jfS)Nz [doctest] %s)rrUrra)rmrJrJrK reportinfozszDoctestItem.reportinfo)NNr.N)rtrurvrFr rn classmethodr\rrrrrrrrr rrr}rJrJr{rKrsB    ,@rc Cs4ddl}t|j|j|j|j|j|jtt t d S)Nr) DONT_ACCEPT_TRUE_FOR_1DONT_ACCEPT_BLANKLINENORMALIZE_WHITESPACEr1IGNORE_EXCEPTION_DETAILCOMPARISON_FLAGS ALLOW_UNICODE ALLOW_BYTESNUMBER) rrrrrr1rr_get_allow_unicode_flag_get_allow_bytes_flag_get_number_flagrrJrJrK_get_flag_lookupsrcCs0|jd}t}d}|D]}|||O}q |S)Nr/r)rVgetinir)rQoptionflags_strflag_lookup_tableflag_accflagrJrJrKget_optionflagss rcCs |d}|r|drd}|S)NrBusepdbF)getvalue)rVrrJrJrK_get_continue_on_failures  rc@s"eZdZdZdeefddZdS)rSNr.c csddl}|jd}|j|}t|j}|jj}ddi}t|}td|t t |jd}| } | ||||d} | j rKtj|| j|| dVdSdS)Nrr4rt__main__Frrrrrarr)rrVrrU read_textrFrarrrr DocTestParser get_doctestexamplesrr\) rmrencodingtextrrarjrrr-rrJrJrKr5s*     zDoctestTextfile.collect)rtrurvrrrr5rJrJrJrKrSsrSrrcs4ddltfdd|jD}|rtddSdS)zVRaise pytest.skip() if all examples in the given DocTest have the SKIP option set.rNc3s |] }|jjdVqdS)FN)optionsgetSKIPrrrJrKrfsz%_check_all_skipped..z!all tests skipped by +SKIP option)rallrr)r all_skippedrJrrKrs  rrcCst|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_existNrrrJrJrK _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.Nstopfunc.r r.c sjz|dus |turtdWS|fdddWSty4}z td|ftd}~ww)Nr cst|pSrM)r r_stopr rJrKszF_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%)r r e real_unwrapr rK_mock_aware_unwrapsz4_patch_unwrap_mock_aware.._mock_aware_unwrap)inspectunwraprrr )rrJrrK_patch_unwrap_mock_awares rc@seZdZdeefddZdS)rRr.ccsddl}Gddd|j}|jjdkr&|jjj|j|jd|jjd}n)zt |j|jj|jdd}Wnt yN|j drKt d |jnYnw|}t |}td |tt|jd }|||jD]}|jrytj||j||d VqidS) 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__)rpropertygetattrhasattrrrry _find_lineno)rmr source_linesr{rJrKrs    zBDoctestModule.collect..MockAwareDocTestFinder._find_linenor.Nc sPt|rdStt|||||||WddS1s!wYdSrM)r rry_find)rmtestsrramoduler rjseenr{rJrKr!s"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'r ry _from_module)rmr#objectr{rJrKr)s zBDoctestModule.collect..MockAwareDocTestFinder._from_moduler) rtrurvrrr!r version_infor)r}rJrJr{rKMockAwareDocTestFinders   r,z conftest.py importmode)rootpath)rootmoderAzunable to import module %rFrr)r DocTestFinderrUrarVr_importconftestrir.r" ImportErrorrrrrrrfindrtrrr\)rmrr,r#finderrrrrJrJrKr5sH 9     zDoctestModule.collectN)rtrurvrrr5rJrJrJrKrRsrR doctest_itemcCsDd dd}i|_|jj}|j||ddd|_t|dd}||S) zEUsed by DoctestTextfile and DoctestItem to setup fixture information.r.NcSsdSrMrJrJrJrJrKr Usz_setup_fixtures..funcF)noder rfuncargsT) _ispytestr)r8rg_fixturemanagergetfixtureinfo _fixtureinfor _fillfixtures)r6r fmrrJrJrKrRs  rcs*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+) ) ) wantrrr.cst|||r dS|t@}|t@}|t@}|s!|s!|s!dSdttdtdtffdd }|r>||j|}||j|}|rL||j|}||j|}|rT| ||}t|||S)NTFregexr_r.cs|d|S)Nz\1\2)sub)r@r_rerJrKremove_prefixesszX_init_checker_class..LiteralsOutputChecker.check_output..remove_prefixes) ry check_outputrrrr rF_unicode_literal_re_bytes_literal_re_remove_unwanted_precision)rmr?rr allow_unicode allow_bytes allow_numberrD)r|rCrJrKrEs"         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 exponent2 )abs) list _number_refinditerlenziprIrfloatr$startend) rmr?rwantsgotsoffsetwgrLexponent precisionrJrJrKrHs&    &.$zM_init_checker_class..LiteralsOutputChecker._remove_unwanted_precision)rtrurvcompileUNICODErFrGVERBOSErRrFrrrErHr}rJrBr{rKLiteralsOutputCheckerfs rc)rrC OutputChecker)rrcrJrBrK_init_checker_classbsQrecCstdurtatS)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,rerJrJrJrKrsrcCddl}|dS)z+Register and return the ALLOW_UNICODE flag.rNrrregister_optionflagrrJrJrKr rcCrf)z)Register and return the ALLOW_BYTES flag.rNrrgrrJrJrKrrircCrf)z$Register and return the NUMBER flag.rNrrgrrJrJrKrrirkeyc 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)rjrrJrJrKrsrrg)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`. )rrJrJrJrKrsrrr)rrr.N)r.r+)frrr(rosrrrrr contextlibrpathlibrtypingrrrrrr r r r r rrr_pytestr_pytest._code.coderrr _pytest._ior_pytest.compatr_pytest.configr_pytest.config.argparsingr_pytest.fixturesrr _pytest.nodesrr_pytest.outcomesrr_pytest.pathlibr!r"_pytest.pythonr#_pytest.python_apir$_pytest.warning_typesr%rrsrmrorkrqrHrNr,__annotations__rLrOr`rrZr]r[rkrrwrrrrrFrrrrSrr*r rrRrrerrrrrrrJrJrJrKs                                    2   6     ` X