B Wcje@sUdZddlZddlZddlZddlZddlZddlZddlZddlZddl m Z ddl m Z ddl mZddl mZddl mZddl mZdd l mZdd l mZdd l mZdd l mZdd l mZddl mZddl mZddl mZddl mZddlmZddlmZddlmZddlm 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/m0Z0ddl/m1Z1dd l2m3Z3dd!l2m4Z4dd"l5m6Z6dd#l7m8Z8dd$l9m:Z:erddl;Z;d%Zd(Z?d)Z@ee?e@fZAdaBdaCeed*eDd+<e(dd,d-d.ZEdd/d0d1ZFe e-eed2d3d4d5ZGe eHd6d7d8ZIe&e e-eHd9d:d;ZJe eHd6dd?d?e ZLGd@dAdAeMZNedBd/dCdDZOdsed*eeHePeHdBdFdGdHZQGdIdJdJe.ZReeSePfd/dKdLZTdMdNZUdOdPZVGdQdRdRe6ZWdSddTdUdVZXeYeHdWdXdYZZe edZd/d[d\Z[Gd]d^d^e6Z\eRe+d_d`daZ]ed*d/dbdcZ^d*d/dddeZ_ePd/dfdgZ`ePd/dhdiZaePd/djdkZbeSePdldmdnZce*dodpeeSefd/dqdrZddS)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) PytestWarningZnoneZcdiffZndiffudiffZonly_first_failurezdoctest.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)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,r2choicesr3z--doctest-globappendpatz2Doctests file matching pattern, default: test*.txt doctestglob)r1r,metavarr2r3z--doctest-ignore-import-errorszIgnore doctest ImportErrorsdoctest_ignore_import_errorsz--doctest-continue-on-failurezsz_is_doctest..)rKsessionZ isinitpath getoptionrL)rJrIrHglobsr@)rIrArPsrPcCs |jdkS)Nz __main__.py)rT)rIr@r@rArNsrNc@s<eZdZeeeeefddddZeddddZ dS)ReprFailDoctestN)reprlocation_linesr'cCs ||_dS)N)r\)selfr\r@r@rA__init__szReprFailDoctest.__init__)twr'cCs:x4|jD]*\}}x|D]}||qW||qWdS)N)r\line toterminal)r]r_ reprlocationlinesr`r@r@rAras zReprFailDoctest.toterminal) __name__ __module__ __qualname__r r rr<r^rrar@r@r@rAr[sr[cs(eZdZedddfdd ZZS)MultipleDoctestFailureszdoctest.DocTestFailureN)failuresr'cst||_dS)N)superr^rh)r]rh) __class__r@rAr^s z MultipleDoctestFailures.__init__)rdrerfr r^ __classcell__r@r@)rjrArgsrgzdoctest.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. NrTzdoctest.OutputChecker)checkerverbose optionflagscontinue_on_failurer'cstj|||d||_dS)N)rlrmrn)rir^ro)r]rlrmrnro)rjr@rAr^sz8_init_runner_class..PytestDoctestRunner.__init__zdoctest.DocTestzdoctest.Example)testexamplegotr'cs(|||}|jr ||n|dS)N)DocTestFailureror6)r]outrprqrrfailure)doctestr@rAreport_failures z>_init_runner_class..PytestDoctestRunner.report_failure)rprqexc_infor'csXt|dtr|dt|dtjr0td|||}|jrP||n|dS)NzQuitting debugger) isinstancerbdbZBdbQuitrexitUnexpectedExceptionror6)r]rtrprqrxru)rvr@rAreport_unexpected_exceptions  zK_init_runner_class..PytestDoctestRunner.report_unexpected_exception)NNrT)rdrerf__doc__r boolintr^r<rwr r BaseExceptiontypes TracebackTyper~rkr@)rv)rjrAPytestDoctestRunners r)rvZ DebugRunner)rr@)rvrA_init_runner_classs/rT)rlrmrnror'cCstdkrtat||||dS)N)rlrmrnro)rCr)rlrmrnror@r@rA _get_runnersrcseZdZdedededddfdd Zededddfd d Zdd d d Zdd ddZ dd ddZ e e e eefdfdd Zee defeeefd ddZZS) DoctestItemNz%Union[DoctestTextfile, DoctestModule]zdoctest.DocTestRunnerzdoctest.DocTest)rTrHrunnerdtestr'cs*t||||_||_d|_d|_dS)N)rir^rrobjfixture_request)r]rTrHrr)rjr@rAr^s zDoctestItem.__init__)rHrTrrcstj||||dS)zThe public named constructor.)rTrHrr)rirO)clsrHrTrr)rjr@rArO s zDoctestItem.from_parent)r'cCsZ|jdk rVt||_t|jjd}x$|jdD]\}}|||<q4W|jj|dS)N)Z getfixturedoctest_namespace)r_setup_fixturesrdictZgetfixturevalueitemsrZupdate)r]rZrTvaluer@r@rAsetups   zDoctestItem.setupcCsT|jdk st|jdk stt|j|g}|jj|j|d|rPt|dS)N)rt)rAssertionErrorr_check_all_skipped$_disable_output_capturing_for_darwinrunrg)r]rhr@r@rAruntest!s zDoctestItem.runtestcCsVtdkrdS|jjd}|rR|jdd|\}}tj |tj |dS)zFDisable output capturing. Otherwise, stdout is lost to doctest (#985).ZDarwinNZcapturemanagerT)Zin_) platformsystemrJ pluginmanagerZ getpluginZsuspend_global_captureZread_global_capturesysstdoutwritestderr)r]Zcapmanrterrr@r@rAr-s    z0DoctestItem._disable_output_capturing_for_darwin)excinfor'csddl}d}t|j|j|jfr*|jg}nt|jtr>|jj}|dkrRt|Sg}x|D]z}|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} n:dg} d }x.|jD] }| d |d |d }qDWt||jr| | ||j| d 7} n:t|j }| dt!|jg7} | ddt"j#|j D7} || | fq^Wt$|S)Nrryr4Fcs&g|]\}}d|jd|fqS)z%03d %sry)lineno)rVix)rpr@rA `sz,DoctestItem.repr_failure.. z?EXAMPLE LOCATION UNKNOWN, not showing all tests of that examplez>>>z???  z... zUNEXPECTED EXCEPTION: %scSsg|]}|dqS)r)strip)rVrr@r@rArts)%rvrzrrsr}rgrhri repr_failurerqrpfilenamerr+rdr _get_checker_get_report_choicerJrYZ docstringr splitlines enumeratemaxsourcer6Zoutput_differencerrsplitrZ from_exc_inforxrepr tracebackformat_exceptionr[)r]rrvrhr\rurqrrmessagerbrlZ report_choicercindentr`Z inner_excinfo)rj)rprAr9sT            zDoctestItem.repr_failurezos.PathLike[str]cCs$|jdk st|j|jjd|jfS)Nz [doctest] %s)rrrIrrT)r]r@r@rA reportinfoyszDoctestItem.reportinfo)NN)rdrerfr<r r^ classmethodrOrrrrrrrrr rrrkr@r@)rjrArs  =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) rvrrrrr*rr_get_allow_unicode_flag_get_allow_bytes_flag_get_number_flag)rvr@r@rA_get_flag_lookup~srcCs4|jd}t}d}x|D]}|||O}qW|S)Nr(r)rJgetinir)rHZoptionflags_strZflag_lookup_tableZflag_accflagr@r@rAget_optionflagss   rcCs |d}|r|drd}|S)Nr;ZusepdbF)getvalue)rJror@r@rA_get_continue_on_failures   rc@s"eZdZdZeedddZdS)rFN)r'c csddl}|jd}|j|}t|j}|jj}ddi}t|}td|t t |jd}| } | ||||d} | j rtj|| j|| dVdS)Nrr-rd__main__F)rmrnrlro)rTrr)rvrJrrIZ read_textr<rTrrrrZ DocTestParserZ get_doctestexamplesrrO) r]rvencodingtextrrTrZrnrr&rpr@r@rAr.s"   zDoctestTextfile.collect)rdrerfrrrr.r@r@r@rArFsrFzdoctest.DocTest)rpr'cs0ddltfdd|jD}|r,tddS)zVRaise pytest.skip() if all examples in the given DocTest have the SKIP option set.rNc3s|]}|jjdVqdS)FN)ZoptionsgetZSKIP)rVr)rvr@rArWsz%_check_all_skipped..z!all tests skipped by +SKIP option)rvallrr)rpZ all_skippedr@)rvrArsr)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_existN)r)rr@r@rA _is_mockeds r)NNNc#sVtjddtdtftttgtftdfdd}|t_z dVWdt_XdS)zContext manager which replaces ``inspect.unwrap`` with a version that's aware of mock objects and doesn't recurse into them.N)stop.)funcrr'c sty6|dks|tkrtdS|fdddStk rn}ztd|ftWdd}~XYnXdS)N)rcst|pS)N)r)r)_stoprr@rAzF_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#)rre) real_unwrap)rrrA_mock_aware_unwraps z4_patch_unwrap_mock_aware.._mock_aware_unwrap)inspectunwraprrr )rr@)rrA_patch_unwrap_mock_awares  rc@seZdZeedddZdS)rE)r'ccsddl}Gddd|j}|jjdkrJ|jjj|j|jd|jjd}nTy t |j|jj|jdd}Wn2t k r|j drt d |jnYnX|}t |}td |tt|jd }x2|||jD] }|jrtj||j||d VqWdS) Nrcs2eZdZdZfddZddfdd ZZS)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__)rzpropertygetattrhasattrrrri _find_lineno)r]r source_lines)rjr@rArs    zBDoctestModule.collect..MockAwareDocTestFinder._find_linenoN)r'c s:t|r dStt|||||||WdQRXdS)N)rrri_find)r]ZtestsrrTmodulerrZseen)rjr@rArs z;DoctestModule.collect..MockAwareDocTestFinder._find)rdrerfrrrrkr@r@)rjrAMockAwareDocTestFinders rz conftest.pyZ importmode)rootpath)rootmoder:zunable to import module %rF)rmrnrlro)rTrr)rvZ DocTestFinderrIrTrJrZ_importconftestrYrr ImportErrorrrrrrrfindrdrrrO)r]rvrrfinderrnrrpr@r@rAr.s6'   zDoctestModule.collectN)rdrerfrrr.r@r@r@rArEsrE) doctest_itemr'cCsHdddd}i|_|jj}|j||ddd|_t|dd}||S) zEUsed by DoctestTextfile and DoctestItem to setup fixture information.N)r'cSsdS)Nr@r@r@r@rArBsz_setup_fixtures..funcF)ZnoderrfuncargsT)Z _ispytest)rrXZ_fixturemanagerZgetfixtureinfoZ _fixtureinforZ _fillfixtures)rrZfmrr@r@rAr?s 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+) ) ) )wantrrrnr'cst|||rdS|t@}|t@}|t@}|sB|sB|sBdSttttdfdd }|rx||j|}||j|}|r||j|}||j|}|r| ||}t|||S)NTF)regexrRr'cs|d|S)Nz\1\2)sub)rrR)rer@rAremove_prefixes|szX_init_checker_class..LiteralsOutputChecker.check_output..remove_prefixes) ri check_outputrrrr r<_unicode_literal_re_bytes_literal_re_remove_unwanted_precision)r]rrrrnZ allow_unicodeZ allow_bytesZ allow_numberr)rjrr@rArqs"         z?_init_checker_class..LiteralsOutputChecker.check_output)rrrr'c Sst|j|}t|j|}t|t|kr4|Sd}xt||D]\}}|d}|d} | dkrr|d} |dkr~dnt|} | dk r| t| 8} t|tt|d| dkrD|d| |||| |d}|| | | | 7}qDW|S)NrfractionZ exponent1Z exponent2 )abs) list _number_refinditerlenzipr?rfloatr"startend) r]rrrZwantsZgotsoffsetwgrZexponentZ precisionr@r@rArs"    &0(zM_init_checker_class..LiteralsOutputChecker._remove_unwanted_precision)rdrerfcompileUNICODErrVERBOSErr<rrrrrkr@)r)rjrALiteralsOutputCheckerSsr)rvrZ OutputChecker)rvrr@)rrA_init_checker_classOsQrcCstdkrtatS)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%rr@r@r@rArsrcCsddl}|dS)z+Register and return the ALLOW_UNICODE flag.rNr)rvregister_optionflag)rvr@r@rArsrcCsddl}|dS)z)Register and return the ALLOW_BYTES flag.rNr)rvr)rvr@r@rArsrcCsddl}|dS)z$Register and return the NUMBER flag.rNr)rvr)rvr@r@rArsr)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) rvDOCTEST_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)rrvr@r@rArsrrX)ZscopecCstS)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@rArsr)NNrT)err{rosrrrrr contextlibrZpathlibrtypingrrrrrr 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.pathlibrr Z_pytest.pythonr!Z_pytest.python_apir"Z_pytest.warning_typesr#rvrrrrrr>rCr%__annotations__rBrDrSrrMrPrNr[rrgrrrrr<rrrrFrobjectrrrErrrrrrrrr@r@r@rAs                                  2 6    NX