B `b@sUdZddlZddlZddlZddlZddlZddlZddlZddlm Z ddl m Z ddl m Z ddl m Z ddl mZddl mZdd l mZdd l mZdd l mZdd l mZdd l mZddl mZddl mZddl mZddlZddlZddlmZddlmZddlmZddlm Z ddl!m"Z"ddl#m$Z$ddl%m&Z&ddl'm(Z(ddl)m*Z*ddl+m,Z,ddl-m.Z.ddl/m0Z0ddl1m2Z2ddl3m4Z4erddl5Z5dZ6d Z7d!Z8d"Z9d#Z:e6e7e8e9e:fZ;dad%<e(dd&d'd(Z?dd)d*d+Z@ejAjBe,eed,d-d.d/ZCejAjBeDd0d1d2ZEe&ejAjBeDd3d4d5ZFGd6d7d7e ZGGd8d9d9eHZIed:d)d;d<ZJdked$eeDeKeDd:d>d?d@ZLGdAdBdBejMZNe eOeKfd)dCdDZPdEdFZQdGdHZRGdIdJdJejSZTdKddLdMdNZUeVeDdOdPdQZWe edRd)dSdTZXGdUdVdVejSZYeNe*dWdXdYZZed$d)dZd[Z[d$d)d\d]Z\eKd)d^d_Z]eKd)d`daZ^eKd)dbdcZ_eOeKdddedfZ`ejadgdhe eOe fd)didjZbdS)lz4Discover and run doctests in modules and test files.N)contextmanager)Any)Callable)Dict) Generator)Iterable)List)Optional)Pattern)Sequence)Tuple)Type) TYPE_CHECKING)Union)outcomes) ExceptionInfo)ReprFileLocation) TerminalRepr)TerminalWriter) safe_getattr)Config)Parser)FixtureRequest) Collector)OutcomeException) import_path)approx) PytestWarningnoneZcdiffZndiffudiffZonly_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-reportrz9choose another output format for diffs on doctest failure doctestreport)r&r'r-choicesr.z--doctest-globappendpatz2doctests file matching pattern, default: test*.txt doctestglob)r,r'metavarr-r.z--doctest-ignore-import-errorszignore doctest ImportErrorsdoctest_ignore_import_errorsz--doctest-continue-on-failurez.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"csjj||||d||_dS)N)rhrirj) DebugRunnerrZrk)rYrhrirjrk)doctestr;r<rZsz8_init_runner_class..PytestDoctestRunner.__init__zdoctest.DocTestzdoctest.Example)testexamplegotr"cs(|||}|jr ||n|dS)N)DocTestFailurerkr1)rYoutrnrorpfailure)rmr;r<report_failures z>_init_runner_class..PytestDoctestRunner.report_failure)rnroexc_infor"csXt|dtr|dt|dtjr0td|||}|jrP||n|dS)NzQuitting debugger) isinstancerbdbZBdbQuitrexitUnexpectedExceptionrkr1)rYrrrnrorurs)rmr;r<report_unexpected_exceptions  zK_init_runner_class..PytestDoctestRunner.report_unexpected_exception)NNrT)r`rarb__doc__r boolintrZr7rtr r BaseExceptiontypes TracebackTyper{r;)rmr;r<PytestDoctestRunners r)rmrl)rr;)rmr<_init_runner_classs-rT)rhrirjrkr"cCstdkrtat||||dS)N)rhrirjrk)r>r)rhrirjrkr;r;r< _get_runnersrcseZdZdedededddfdd Zededddfd d Zdd d d Zdd ddZ dd ddZ e e e eefdfdd ZddZZS) DoctestItemNz%Union[DoctestTextfile, DoctestModule]zdoctest.DocTestRunnerzdoctest.DocTest)namerCrunnerdtestr"cs*t||||_||_d|_d|_dS)N)rerZrrobjfixture_request)rYrrCrr)rfr;r<rZs zDoctestItem.__init__)rCrrrcstj||||dS)zThe public named constructor.)rrCrr)rerI)clsrCrrr)rfr;r<rIs zDoctestItem.from_parent)r"cCsZ|jdk rVt||_t|jjd}x$|jdD]\}}|||<q4W|jj|dS)N)Z getfixturedoctest_namespace)r_setup_fixturesrdictZgetfixturevalueitemsrUupdate)rYrUrvaluer;r;r<setup s   zDoctestItem.setupcCsT|jdk st|jdk stt|j|g}|jj|j|d|rPt|dS)N)rr)rAssertionErrorr_check_all_skipped$_disable_output_capturing_for_darwinrunrc)rYrdr;r;r<runtests zDoctestItem.runtestcCsVtdkrdS|jjd}|rR|jdd|\}}tj |tj |dS)zFDisable output capturing. Otherwise, stdout is lost to doctest (#985).DarwinNZcapturemanagerT)Zin_) platformsystemrE pluginmanagerZ getpluginZsuspend_global_captureZread_global_capturesysstdoutwritestderr)rYZcapmanrrerrr;r;r<r#s    z0DoctestItem._disable_output_capturing_for_darwin)excinfor"csddl}d}t|j|j|jfr*|jg}nt|jtr>|jj}|dk rg}x|D]x}|j}|jj }j dkr|d}nj |j d}t |j } t ||| } t} t|jd} |dk r$|jjdk st|jjd} j dk stfddt| D} | t|j dd|j d} n:dg} d }x.|jD] }| d |d |d }q:Wt||jr| | ||j| d 7} n8t|j}| dt|jg7} | ddtj |jD7} || | fqTWt!|St"#|SdS)Nrrvr/Fcs&g|]\}}d|jd|fqS)z%03d %srv)lineno).0ix)rnr;r< Usz,DoctestItem.repr_failure.. z?EXAMPLE LOCATION UNKNOWN, not showing all tests of that examplez>>>z???  z... zUNEXPECTED EXCEPTION: %scSsg|]}|dqS)r)strip)rrr;r;r<rjs)$rmrwrrqrzrcrdrornfilenamerr&r`r _get_checker_get_report_choicerErSZ docstringr splitlines enumeratemaxsourcer1Zoutput_differencerpsplitrrurepr tracebackformat_exceptionrWre repr_failure)rYrrmrdrXrsrorrmessager^rhZ report_choicer_indentr\Z inner_excinfo)rf)rnr<r/sZ              zDoctestItem.repr_failurecCs$|jdk st|j|jjd|jfS)Nz [doctest] %s)rrrDrr)rYr;r;r< reportinforszDoctestItem.reportinfo)NN)r`rarbr7r rZ classmethodrIrrrrrrrrrrgr;r;)rfr<rs   Arc 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) rmrrrrr%rr_get_allow_unicode_flag_get_allow_bytes_flag_get_number_flag)rmr;r;r<_get_flag_lookupwsrcCs4|jd}t}d}x|D]}|||O}qW|S)Nr#r)rEgetinir)rCZoptionflags_strZflag_lookup_tableZflag_accflagr;r;r<get_optionflagss   rcCs |d}|r|drd}|S)Nr6ZusepdbF)getvalue)rErkr;r;r<_get_continue_on_failures   rc@s"eZdZdZeedddZdS)rAN)r"c csddl}|jd}|j|}t|j}|jj}ddi}t|}td|t t |jd}| } | ||||d} | j rtj|| j|| dVdS)Nrr(r`__main__F)rirjrhrk)rrr)rmrErrD read_textr7rNrrrrZ DocTestParserZ get_doctestexamplesrrIr) rYrmencodingtextrrrUrjrr!rnr;r;r<r)s"   zDoctestTextfile.collect)r`rarbrrrr)r;r;r;r<rAsrAzdoctest.DocTest)rnr"cs2ddltfdd|jD}|r.tddS)zVRaise pytest.skip() if all examples in the given DocTest have the SKIP option set.rNc3s|]}|jjdVqdS)FN)optionsgetZSKIP)rr)rmr;r< sz%_check_all_skipped..z!all tests skipped by +SKIP option)rmallrpytestskip)rnZ all_skippedr;)rmr<rsr)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;r< _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;r<zF_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)rrr<_mock_aware_unwraps z4_patch_unwrap_mock_aware.._mock_aware_unwrap)inspectunwraprrr )rr;)rr<_patch_unwrap_mock_awares  rc@seZdZeedddZdS)r@)r"c#sddlGfdddj}|jjdkrF|jj|j|jd}nDyt|j}Wn4t k r|j drt d|jnYnX|}t |}td|tt|jd }x2|||jD] }|jrtj||j||d VqWdS) Nrcs.eZdZdZfddZddfdd ZdS)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 cs&t|trt|d|}j|||S)zDoctest code does not take into account `@property`, this is a hackish way to fix it. https://bugs.python.org/issue17446 fget)rwpropertygetattr DocTestFinder _find_lineno)rYr source_lines)rmr;r<rs  zBDoctestModule.collect..MockAwareDocTestFinder._find_linenoN)r"c s<t|r dSt j||||||||WdQRXdS)N)rrr_find)rYtestsrrmodulerrUseen)rmr;r<rs z;DoctestModule.collect..MockAwareDocTestFinder._find)r`rarbr|rrr;)rmr;r<MockAwareDocTestFinders rz conftest.pyZ importmoder5zunable to import module %rF)rirjrhrk)rrr)rmrrDrNrErZ_importconftestrSr ImportErrorrrrrrrrfindr`rrrIr)rYrrfinderrjrrnr;)rmr<r)s,  zDoctestModule.collectN)r`rarbrrr)r;r;r;r<r@sr@) 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;r<r.sz_setup_fixtures..funcF)noderrfuncargsT)Z _ispytest)rrRZ_fixturemanagerZgetfixtureinfoZ _fixtureinforZ _fillfixtures)rrZfmrr;r;r<r+s rcs,ddlddlGfdddj}|S)NrcsbeZdZdjZdjZdjZe e e e dfdd Z e e e ddd Z d S) 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+) ) ) )wantrprjr"csj||||rdS|t@}|t@}|t@}|sD|sD|sDdSttttdfdd }|rz||j|}||j|}|r||j|}||j|}|r| ||}j||||S)NTF)regexrLr"cs|d|S)Nz\1\2)sub)rrL)rer;r<remove_prefixeshszX_init_checker_class..LiteralsOutputChecker.check_output..remove_prefixes) OutputChecker check_outputrrrr r7_unicode_literal_re_bytes_literal_re_remove_unwanted_precision)rYrrprjZ allow_unicodeZ allow_bytesZ allow_numberr)rmrr;r<r]s"         z?_init_checker_class..LiteralsOutputChecker.check_output)rrpr"c Sst|j|}t|j|}t|t|kr4|Sd}xt||D]\}}|d}|d} | dkrr|d} |dkrd} nt|} | dk r| t| 8} t|tt|d| dkrD|d| |||| |d}|| | | | 7}qDW|S)NrfractionZ exponent1Z exponent2 )abs) list _number_refinditerlenzipr:r~floatrstartend) rYrrpZwantsgotsoffsetwgrexponentZ precisionr;r;r<rxs&    &0(zM_init_checker_class..LiteralsOutputChecker._remove_unwanted_precisionN)r`rarbcompileUNICODErrVERBOSErr7r~r}rrr;)rmrr;r<LiteralsOutputChecker?sr)rmrr)rr;)rmrr<_init_checker_class;sTrcCstdkrtatS)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;r<rsrcCsddl}|dS)z+Register and return the ALLOW_UNICODE flag.rNr)rmregister_optionflag)rmr;r;r<rsrcCsddl}|dS)z)Register and return the ALLOW_BYTES flag.rNr)rmr)rmr;r;r<rsrcCsddl}|dS)z$Register and return the NUMBER flag.rNr)rmr)rmr;r;r<rsr)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) rmDOCTEST_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)rrmr;r;r<rsrrR)ZscopecCstS)zaFixture that returns a :py:class:`dict` that will be injected into the namespace of doctests.)rr;r;r;r<rsr)NNrT)cr|rxrrrrrr contextlibrtypingrrrrrrr r r r r rrZpy.pathpyrZ_pytestrZ_pytest._code.coderrrZ _pytest._iorZ_pytest.compatrZ_pytest.configrZ_pytest.config.argparsingrZ_pytest.fixturesrZ _pytest.nodesrZ_pytest.outcomesrZ_pytest.pathlibrZ_pytest.python_apirZ_pytest.warning_typesrrmrrrrrr9r>r __annotations__r=r?rBlocalrMr}rHrJrWrrcrr~rZItemrr7rrrModulerArobjectrrr@rrrrrrrZfixturerr;r;r;r<s                            2   4    A[