yIfe UdZddlZddlmZddlZddlZddlZddlmZddl 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:er ddl;Z;dd$l md'Z?d(Z@d)ZAe=e>e?e@eAfZBdaCdaDeed*eEd+<d,e)d-dfd.ZFd_d/ZGd0ed1e.d-eed2fd3ZHd4ed-eIfd5ZJd6e'd4ed1e.d-eIfd7ZKd4ed-eIfd8ZLGd9d:e!ZMGd;dZP d`d@ed*dAeeIdBeQdCeId-d=f dDZRGdEdFe/ZSd-eeTeQffdGZUd6e'd-eQfdHZVd6e'd-eIfdIZWGdJdKe6ZXdadNZYdOeZd-eIfdPZ[ed-edQfdRZ\GdSdTe6Z]d-ed*fdUZ^dbdVZ_d-eQfdWZ`d-eQfdXZad-eQfdYZbdZeTd-eQfd[Zce+d\]d-eeTeffd^ZddS)cz4Discover 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)Selfnonecdiffndiffudiffonly_first_failuredoctest.OutputChecker CHECKER_CLASSparserreturnc|ddddg|ddd |d }|d d d dd|dtjddt d|ddgddd|dd d dd|dd d d d!dS)"Ndoctest_optionflagszOption flags for doctestsargsELLIPSIS)typedefaultdoctest_encodingzEncoding used for doctest fileszutf-8)r5collectz--doctest-modules store_trueFzRun doctests in all .py modulesdoctestmodules)actionr5helpdestz--doctest-reportr*z9Choose another output format for diffs on doctest failure doctestreport)r4r5r;choicesr<z--doctest-globappendpatz2Doctests file matching pattern, default: test*.txt doctestglob)r:r5metavarr;r<z--doctest-ignore-import-errorsz Ignore doctest collection errorsdoctest_ignore_import_errorsz--doctest-continue-on-failurezz_is_doctest..s-88$z$%%888888rN)r\session isinitpath getoptionr^)r[rZrUglobss ` rLrbrbsh {&&&6>+D+DT+J+J&t   ] + + < }E 8888%888 8 88rNc|jdkS)Nz __main__.py)rerYs rLr`r`s 9 %%rNcVeZdZdeeeeefddfdZdeddfdZ dS)ReprFailDoctestreprlocation_linesr/Nc||_dSrP)rt)selfrts rL__init__zReprFailDoctest.__init__s#5rNtwc~|jD]4\}}|D]}||||5dSrP)rtline toterminal)rvrx reprlocationlinesrzs rLr{zReprFailDoctest.toterminalsZ#'#: ( ( L%    # #B ' ' ' ' ( (rN) __name__ __module__ __qualname__r rrrHrwrr{rRrNrLrsrssn5"*51A8C=1P+Q"R5 5555 (^(((((((rNrsc4eZdZdedddffd ZxZS)MultipleDoctestFailuresfailureszdoctest.DocTestFailurer/NcVt||_dSrP)superrwr)rvr __class__s rLrwz MultipleDoctestFailures.__init__s$   rN)r~rrr rw __classcell__rs@rLrrsQ!*B!C!!!!!!!!!!!rNrdoctest.DocTestRunnerc:ddlGfddj}|S)Nrc eZdZdZ ddeddeeded ed df fd Zd d ddded dffd Z d d ddde e e e e jfd dffd 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. NrTcheckerr,verbose optionflagscontinue_on_failurer/c^t|||||_dS)N)rrr)rrwr)rvrrrrrs rLrwz8_init_runner_class..PytestDoctestRunner.__init__s2 GG  Wg;  W W W':D $ $ $rNtestdoctest.DocTestexamplezdoctest.Examplegotchj|||}|jr||dS|rP)DocTestFailurerr?)rvoutrrrfailuredoctests rLreport_failurez>_init_runner_class..PytestDoctestRunner.report_failuresC-g,T7C@@G'  7##### rNexc_infoct|dtr|dt|dtjrt jdj|||}|jr||dS|)NzQuitting debugger) isinstancerbdbBdbQuitrexitUnexpectedExceptionrr?)rvrrrrrrs rLreport_unexpected_exceptionzK_init_runner_class..PytestDoctestRunner.report_unexpected_exceptions(1+'788 "qk!(1+s{33 3 12221g1$JJG'  7##### rNNNrT)r~rr__doc__r boolintrwrHrrr BaseExceptiontypes TracebackTyperr)rrs@rLPytestDoctestRunnerrs5  :>&* (,  ; ;56 ;d^ ;  ; "&  ;   ; ; ; ; ; ; $ '           $ '   D/@SST              rNr)r DebugRunner)rrs @rL_init_runner_classrsLNNN-------g1---^ rNTrrrrcRttat||||S)Nrrrr)rQrrs rL _get_runnerrs:)++  /    rNc eZdZdedddddddd f fd Zedddedddddd f fd Zdd ZddZddZ ddZ de e de eefffd Zdee defeeeffdZxZS) DoctestItemrerUz%Union[DoctestTextfile, DoctestModule]runnerrdtestrr/Nc t||||_||_d|_|jj}||dd}||_|j |_ | dS)N)nodefunccls) rrwrrobjrm_fixturemanagergetfixtureinfo _fixtureinfo names_closure fixturenames _initrequest)rvrerUrrfm fixtureinfors rLrwzDoctestItem.__init__s v&&&   \ )''T$'GG ''5 rNr&cNt||||S)zThe public named constructor.)rerUrr)rra)rrUrerrrs rLrazDoctestItem.from_parents'ww""VFRW"XXXrNc@i|_t|d|_dS)NT) _ispytest)funcargsr_requestrvs rLrzDoctestItem._initrequests!+- "44888 rNc|jt|jj}|jdD] \}}|||< |jj|dS)N) getfixturedoctest_namespace)r _fillfixturesdictgetfixturevalueitemsrrpupdate)rvrprevalues rLsetupzDoctestItem.setup#s ##%%% =>>>=889LMMSSUU  KD%E$KK &&&&&rNct|j|g}|j|j||rt |dS)N)r)_check_all_skippedr$_disable_output_capturing_for_darwinrrunr)rvrs rLruntestzDoctestItem.runtest*se4:&&& 1133335  111  4)(33 3 4 4rNcTtjdkrdS|jjd}|rm|d|\}}tj |tj |dSdS)zFDisable output capturing. Otherwise, stdout is lost to doctest (#985).DarwinNcapturemanagerT)in_) platformsystemr[ pluginmanager getpluginsuspend_global_captureread_global_capturesysstdoutwritestderr)rvcapmanrerrs rLrz0DoctestItem._disable_output_capturing_for_darwin4s ?   ( ( F*445EFF  "  ) )d ) 3 3 31133HC J  S ! ! ! J  S ! ! ! ! !  " "rNexcinfocddl}d}t|j|j|jfr |jg}n&t|jt r |jj}|!t|Sg}|D]}|j }|j j }j d}nj |j zdz}t|j} t||| } t!} t#|jd} |z|j jJ|j jd} j Jfdt-| D} | t/|j dz d|j dz} n>dg} d}|jD]}| d |d |d } t||jr3| | ||j| d z } nTt;j|j}| d tA|jzgz } | dtCj"|jDz } || | ftG|S)Nrrr=Fc:g|]\}}d|jzdz|fzS)z%03d %sr)lineno)rjixrs rL z,DoctestItem.repr_failure..fs?=CaIT[1!4a 88rN z?EXAMPLE LOCATION UNKNOWN, not showing all tests of that examplez>>>z???  z... zUNEXPECTED EXCEPTION: %sc8g|]}|dS)r)strip)rjrs rLrz,DoctestItem.repr_failure..zs/&'AGGDMMrN)$rrrrrrrr repr_failurerrfilenamerr4r~r _get_checker_get_report_choicer[ro docstring splitlines enumeratemaxsourcer?output_differencersplitr from_exc_inforrepr tracebackformat_exceptionrs)rvrrrrtrrrrmessager|r report_choicer}indentrz inner_excinforrs @rLrzDoctestItem.repr_failure@s     MG2G4OP   . HH  '> ? ? .}-H  77''00 0) =) =GoGA;MMNV#N5577##DLL!7!7!7!7!7888"FF'7#9:: 22W[-%++!. ;G3}->3 sL !>3>3>3>3>3>3@HE%(:C(?"@(3-QT"TUHHHHHHHHrNrc ddl}t|j|j|j|j|j|jttt S)Nr) DONT_ACCEPT_TRUE_FOR_1DONT_ACCEPT_BLANKLINENORMALIZE_WHITESPACEr3IGNORE_EXCEPTION_DETAILCOMPARISON_FLAGS ALLOW_UNICODE ALLOW_BYTESNUMBER) rrr r rr3rr_get_allow_unicode_flag_get_allow_bytes_flag_get_number_flagrs rL_get_flag_lookuprsaNNN &=%;$9! ' ? 1-//)++!!    rNcp|d}t}d}|D] }|||z}|S)Nr1r)getinir)r[optionflags_strflag_lookup_tableflag_accflags rLget_optionflagsrsKmm$9::O(**H,,%d++ OrNcb|d}|r|drd}|S)NrDusepdbF)getvalue)r[rs rL_get_continue_on_failurer#s? &0M N N( ??8 $ $ ("'  rNc*eZdZdZdeefdZdS)rWNr/c#Kddl}|jd}|j|}t |j}|jj}ddi}t|j}td|tt|j}|j } | ||||d} | j r't|| j|| VdSdS)Nrr6r~__main__Frrrrrerr)rr[rrZ read_textrHrerrrr# DocTestParser get_doctestexamplesrra) rvrencodingtextrrerprrr.rs rLr7zDoctestTextfile.collects;%%&899y""8,,ty>>y~Z(%dk22 # NN 8 E E    '&((!!$tXqAA = ))49V4*       rN)r~rrrr rr7rRrNrLrWrWs9 C+.rNrWrrcvddltfd|jD}|rtddSdS)zVRaise pytest.skip() if all examples in the given DocTest have the SKIP option set.rNc3XK|]$}|jjdV%dS)FN)optionsgetSKIP)rjrrs rLrlz%_check_all_skipped..s5PPQaimmGL%88PPPPPPrNz!all tests skipped by +SKIP option)rallr,r )r all_skippedrs @rLrrsYNNNPPPP$-PPPPPK2 01111122rNrc(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 rL _is_mockedr8s! SMtTT rN)NNNc#Ktjdddtdtfdtttgtfdtffd}|t_ dVt_dS#t_wxYw)zContext manager which replaces ``inspect.unwrap`` with a version that's aware of mock objects and doesn't recurse into them.Nstopr.r;r/c | |turtS|fdS#t$r'}tjd|ddtd}~wwxYw)Nr:c8t|p SrP)r8)r_stoprs rLzF_patch_unwrap_mock_aware.._mock_aware_unwrap..sjoo6TtrNzGot 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)r8 Exceptionwarningswarnr%)rr;er> real_unwraps` @rL_mock_aware_unwrapz4_patch_unwrap_mock_aware.._mock_aware_unwraps |tz11"{4j9999E;t*T*T*T*T*TUUU U    MCqCCTCCC      s55 A&"A!!A&)inspectunwraprrr )rErDs @rL_patch_unwrap_mock_awarerHs.KMQsCx +3HcUCZ4H+I "(GN% $$$$$s &A88Bc&eZdZdeefdZdS)rVr/c#JKddl}Gdd|j} |j}nH#tj$r6|jdrtd|jznYnwxYw|j j ||}t|j}td|tt|j}|||jD].}|jr%t&||j||V/dS) NrcZeZdZdZfdZ dfd Zejdkr fdZxZ SxZ S) 5DoctestModule.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 ct|trt|d|}t|drt j|}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__)rpropertygetattrhasattrrFrGr _find_lineno)rvr source_linesrs rLrSzBDoctestModule.collect..MockAwareDocTestFinder._find_linenosmc8,,4!#vs33C3 ...!.--Cww++ rNr/Nc t|rdSt5t|||||||ddddS#1swxYwYdSrP)r8rHr_find) rvtestsrremodulerTrpseenrs rLrVz;DoctestModule.collect..MockAwareDocTestFinder._findsc??F-//GGMMsD&,ts(AAA) ct|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)rvrXobjectrs rLr_zBDoctestModule.collect..MockAwareDocTestFinder._from_module#s= "&)*CDD-!'!77//???rNr ) r~rrrrSrVr version_infor_rrs@rLMockAwareDocTestFinderrLs        (       ')) @ @ @ @ @ @ @ @ @rNrbrCzunable to import module %rFr'r()r DocTestFinderrr CollectErrorr[r"r rZrmrparsefactoriesrrrr#findr~r,rrare)rvrrbrXfinderrrrs rLr7zDoctestModule.collectsv5 5 5 5 5 W%:5 5 5 n XFF%   {##$BCC 1DI=>>>>?>  $33D999('))%dk22 # NN 8 E E    KK88  D} !--tyt.  s#AA('A(N)r~rrr rr7rRrNrLrVrVs;T+.TTTTTTrNrVcBddl}ddlGfdd|j}|S)NrceZdZdjZdjZdjZde de de de ffd Z de de de fd Z xZS) 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+) ) ) wantrrr/ct|||rdS|tz}|tz}|t z}|s|s|sdSdt t dt dt f fd }|r"||j|}||j|}|r"||j|}||j|}|r| ||}t|||S)NTFregextxtr/c2|d|S)Nz\1\2)sub)rmrnres rLremove_prefixeszX_init_checker_class..LiteralsOutputChecker.check_output..remove_prefixes|svveWc222rN) r check_outputrrrr rH_unicode_literal_re_bytes_literal_re_remove_unwanted_precision) rvrkrr allow_unicode allow_bytes allow_numberrrrrqs rLrsz?_init_checker_class..LiteralsOutputChecker.check_outputqsIww##D#{;; t'*A*C*CCM%(=(?(??K&)9););;L   \ u 3ws| 3# 3# 3 3 3 3 3 3 E&t'?FF%od&>DD C&t'=tDD%od&.LiteralsOutputChecker._remove_unwanted_precisions11$7788E005566D5zzSYY&& FE4(( J J1*+''**=*=*+''+*>*># ww{33H!)!1AAs8}} 'X.I##veAGGII.>.>B N'S'S'SSS 0aggii&001AGGII=AEEGGfDTDVDV@WWaeegg 1QUUWWqwwyy5HIIFJrN)r~rrcompileUNICODErtruVERBOSErrHrrrsrvr)rrqs@rLLiteralsOutputCheckerrjSs !jj)CRZPPJJ'A2:NNZZ & J)  . @S @s @ @ @ @ @ @ @ @ @6 3 S S        rNr)rrq OutputChecker)rrrqs @rL_init_checker_classrOs_NNN IIIOOOOOOO 5OOOb ! rNcHttatS)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-rrRrNrLrrs+-- ??rNc*ddl}|jdS)z+Register and return the ALLOW_UNICODE flag.rNrrregister_optionflagrs rLrrsNNN &7 & 7 77rNc*ddl}|jdS)z)Register and return the ALLOW_BYTES flag.rNrrrs rLrrsNNN &7 &} 5 55rNc*ddl}|jdS)z$Register and return the NUMBER flag.rNrrrs rLrrsNNN &7 &x 0 00rNkeyc ddl}t|jt|jt |jt|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)rrs rLrrsH NNN $W%9#W%9#W%90'2S"A      rNrm)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`. )rrRrNrLrrs  66MrNr r)rrr/N)r/r,)err contextlibrr]rFospathlibrrrrrtypingrrrrr r r r r rrrrrA_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%rr&rrrrrrJrQr-__annotations__rMrSrcrr_rbr`rsr@rrrrrrHrrr#rWrr`r8rHrVrrrrrrrrRrNrLrsK::: %%%%%%    ,,,,,,//////++++++&&&&&&''''''!!!!!!,,,,,,$$$$$$''''''######------!!!!!!&&&&&&!!!!!!%%%%%%//////NNN#%%%+?(,  9= x456===/V/////d    e678    AtAAAAA99d9I9$9999&d&t&&&& ( ( ( ( (l ( ( (!!!!!i!!! 2D!892222l26" $  - . d^   (CHCHCHCHCH$CHCHCHL $sCx.     FsVf>2222Ft%),<"=%%%%:UUUUUFUUUpU!T"9:U!U!U!U!p(888886s66661#1111 C C    " y4S>rN