|d(Z?d)Z@ee?e@fZAdaBdaCeed* eDd+< d,e(d-dfd.ZEdad/ZFd0e d1e-d-eed2 fd3ZGd4e d-eHfd5ZId6e&d4e d1e-d-eHfd7ZJd4e d-eHfd8ZK G d9 d:e ZL G d; dZO dbd@ed* dAeeH dBePdCeHd-d=f
dDZQ G dE dFe. ZRd-eeSePf fdGZTdH ZUdI ZV G dJ dKe6 ZWdcdNZXdOeYd-eHfdPZZe
d-edQ fdR Z[ G dS dTe6 Z\dUeRd-e+fdVZ]d-ed* fdWZ^dddXZ_d-ePfdYZ`d-ePfdZZad-ePfd[Zbd\eSd-ePfd]Zc e*d^_ d-eeSef fd` ZddS )ez4Discover 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_CLASSparserreturnc | ddddg | ddd | d
}| d d d
dd | dt j ddt
d | ddg ddd | d d d
d d | d d d
d d! d S )"Ndoctest_optionflagszOption flags for doctestsargsELLIPSIS)typedefaultdoctest_encodingz Encoding used for doctest fileszutf-8)r5 collectz--doctest-modules
store_trueFz Run doctests in all .py modulesdoctestmodules)actionr5 helpdestz--doctest-reportr* z9Choose another output format for diffs on doctest failure
doctestreport)r4 r5 r; choicesr< z--doctest-globappendpatz2Doctests file matching pattern, default: test*.txt doctestglob)r: r5 metavarr; r< z --doctest-ignore-import-errorszIgnore doctest ImportErrors doctest_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.
Nr Tcheckerr, verbose optionflagscontinue_on_failurer/ c ^ t ||| || _ d S )N)r r r )r ry r )rx r r r r r s rL ry z8_init_runner_class..PytestDoctestRunner.__init__ s2
GG Wg; W W W':D $ $ $rN testdoctest.DocTestexamplezdoctest.Examplegotc h j ||| }| j r| | d S |rP )DocTestFailurer r? )rx outr r r failuredoctests rL report_failurez>_init_runner_class..PytestDoctestRunner.report_failure sC -g,T7C@@G'
7#####
rN exc_infoc t |d t r|d t |d t j rt j d j ||| }| j r| | d S |)N zQuitting debugger)
isinstancer bdbBdbQuitr exitUnexpectedExceptionr r? )rx r r r r r r s rL report_unexpected_exceptionzK_init_runner_class..PytestDoctestRunner.report_unexpected_exception s (1+'788
" qk!(1+s{33
3
12221g1$JJG'
7#####
rN NNr T)r r r __doc__r boolintry rH r r r
BaseExceptiontypes
TracebackTyper r )r r s @rL PytestDoctestRunnerr s5 :>&* (, ; ; 56 ; d^ ; ;
"& ;
; ; ; ; ; ; $ '
$ '
D / @S ST
rN r )r DebugRunner)r r s @rL _init_runner_classr sL NNN- - - - - - - g 1 - - - ^ rN Tr r r r c R t t a t | ||| S )Nr r r r )rQ r r s rL _get_runnerr s: )++ / rN c e Zd Z ddeddded ded d df
fd
Zedddeddddf fd Zdd Zdd
Z ddZ
de e d e
eef f fd Zd ee
def ee ef fdZ xZS ) DoctestItemNrg rU z%Union[DoctestTextfile, DoctestModule]runnerr dtestr r/ c t || || _ || _ d | _ d | _ d S rP )r ry r r objfixture_request)rx rg rU r r r s rL ry zDoctestItem.__init__ sB v&&&
9= rN c N t |||| S )z The public named constructor.)rg rU r r )r ra )clsrU rg r r r s rL ra zDoctestItem.from_parent
s' ww""VFRW"XXXrN c | j t | | _ t | j j }| j d D ]
\ }}|||< | j j | d S d S )N)
getfixturedoctest_namespace)r _setup_fixturesr dictgetfixturevalueitemsrr update)rx rr rg values rL setupzDoctestItem.setup s : !#24#8#8D D$8$HIIIE # 3 C C# egg
$
$ e $d J # #E * * * * * " !rN c | j J | j J t | j | g }| j | j | |rt | d S )N)r )r r _check_all_skipped$_disable_output_capturing_for_darwinrunr )rx r s rL runtestzDoctestItem.runtest! s z%%%{&&&4:&&& 1133335
111 4)(33 3 4 4rN c T t j dk rdS | j j d }|rm| d | \ }}t j | t j
| dS dS )zFDisable output capturing. Otherwise, stdout is lost to doctest (#985).DarwinNcapturemanagerT)in_) platformsystemr[
pluginmanager getpluginsuspend_global_captureread_global_capturesysstdoutwritestderr)rx capmanr errs rL r z0DoctestItem._disable_output_capturing_for_darwin- s ? ( ( F*445EFF " ) )d ) 3 3 3 1133HC J S ! ! ! J S ! ! ! ! ! " "rN excinfoc dd l }d }t |j |j |j f r |j g}n&t |j t
r |j j }|!t | S g }|D ]}|j }|j
j }j d }nj |j z dz }t | j } t ||| }
t! } t# | j d } |z|j
j J |j
j d }
j J fdt- |
D }
|
t/ |j dz
d |j dz }
n>dg}
d}|j D ] }|
d | d
| d } t ||j r3|
| ||j | d z
}
nTt; j |j }|
d
tA |j z gz
}
|
d tC j" |j D z
}
| |
|
f tG | S )Nr r r= Fc : g | ]\ }}d |j z dz |fz S )z%03d %sr )lineno)rl ixr s rL
z,DoctestItem.repr_failure.._ s? =CaIT[ 1!4a 88 rN z?EXAMPLE LOCATION UNKNOWN, not showing all tests of that examplez>>>z??? z...
zUNEXPECTED EXCEPTION: %sc 8 g | ]}| d S )r )strip)rl r s rL r z,DoctestItem.repr_failure..s s/ &'AGGDMM rN )$r r r r r r r r repr_failurer r filenamer r4 r r _get_checker_get_report_choicer[ rq docstring
splitlines enumeratemaxsourcer? output_differencer splitr
from_exc_infor repr tracebackformat_exceptionru )rx r r r rv r r r r messager~ r
report_choicer indentr|
inner_excinfor r s @rL r zDoctestItem.repr_failure9 s
MG 2G4OP
.
HH
'>
?
? . }-H 77''00 0 ) = ) =G oGA;M MN V #N 5 5 7 7 # #DLL!7!7!7!7!7888 "FF'7#9::
22W[- %++ !. ;G > > 8 > 01 >
)* >
> > > > > >
Y7
Y
Y
(
Y !
Y
Y
Y
Y
Y [
Y+ + + +
4
4
4
4 " " " ">3 }->3
sL !>3 >3 >3 >3 >3 >3@HE%(:C(?"@(3-QT"T U H H H H H H H HrN r c dd l } t | j | j | j | j | j | j t t t S )Nr ) DONT_ACCEPT_TRUE_FOR_1DONT_ACCEPT_BLANKLINENORMALIZE_WHITESPACEr3 IGNORE_EXCEPTION_DETAILCOMPARISON_FLAGS
ALLOW_UNICODE ALLOW_BYTESNUMBER) r r r r r r3 r r _get_allow_unicode_flag_get_allow_bytes_flag_get_number_flagr s rL _get_flag_lookupr ~ sa NNN & = % ; $ 9! ' ? 1-//)++ !!
rN c z | j d }t }d}|D ]
}||| z }|S )Nr1 r )r[ getinir )rU optionflags_strflag_lookup_tableflag_accflags rL get_optionflagsr sO m**+@AAO(**H , ,%d++ OrN c b | d }|r| d rd}|S )NrD usepdbF)getvalue)r[ r s rL _get_continue_on_failurer s? //*GHH ( ??8 $ $ ("' rN c * e Zd ZdZdee fdZdS )rW Nr/ c # K dd l }| j d }| j | }t | j }| j j }ddi}t | }t d|t t | j } |j } | ||||d }
|
j
r't | |
j ||
V d S d S )Nr r6 r __main__Fr r r r rg r r )r r[ r rZ read_textrH rg r r r r
DocTestParser get_doctestexamplesr ra ) rx r encodingtextr rg rr r r r. r s rL r7 zDoctestTextfile.collect s ;%%&899y""8,,ty>>y~Z(%d++ # NN 8 E E
'&((!!$tXqAA = ))49V4 *
rN )r r r r r r r7 rR rN rL rW rW s9
C+. rN rW r r c v ddl t fd| j D }|rt d dS dS )zVRaise pytest.skip() if all examples in the given DocTest have the SKIP
option set.r Nc 3 X K | ]$}|j j d V %dS )FN)optionsgetSKIP)rl r r s rL rn z%_check_all_skipped.. s5 PPQaimmGL%88PPPPPPrN z!all tests skipped by +SKIP option)r allr r )r all_skippedr s @rL r r sY NNNPPPP$-PPPPPK 2
0111112 2rN r c ( t | dd duS )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 )r s rL
_is_mockedr, s! SMtTT rN )NNNc # K t j dddt dt f dt t t gt f dt ffd} | t _ dV t _ dS # t _ w xY 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 | |t u r t S | fd S # t $ r'}t j d|d dt d }~ww xY w)Nr. c 8 t | p
S rP )r, )r _stopr0 s rL zF_patch_unwrap_mock_aware.._mock_aware_unwrap.. s joo6Tt rN 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& )r0 r/ er3 real_unwraps ` @rL _mock_aware_unwrapz4_patch_unwrap_mock_aware.._mock_aware_unwrap s |tz 1 1"{4j9999E ;t*T*T*T*T*TUUU U MM GHaaO
s 5 5
A&"A!!A&)inspectunwrapr r r )r: r9 s @rL _patch_unwrap_mock_awarer= s .K MQ sCx +3HcUCZ4H+I " (GN%
$$$$$s &A8 8Bc & e Zd Zdee fdZdS )rV r/ c # K dd l } G d d|j }| j j dk rJ| j j | j | j d | j j }n~ t | j | j j | j d }nC# t $ r6 | j d rt d | j z n Y nw xY w | }t | }t d
|t t! | j }| ||j D ].}|j r%t( | |j || V /d S )
Nr c 2 e Zd ZdZ fdZ d fd Z xZS )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
c t |t rt |d| }t |d rt j | }t
|| S )a3 Doctest 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__)r propertygetattrhasattrr; r< r _find_lineno)rx r source_linesr s rL rH zBDoctestModule.collect..MockAwareDocTestFinder._find_lineno sm c8,, 4!#vs33C3
.. .!.--C ww++ rN r/ Nc
t | rd S t 5 t ||||||| d d d d S # 1 swxY w Y d S rP )r, r= r _find) rx testsr rg modulerI rr seenr s rL rK z;DoctestModule.collect..MockAwareDocTestFinder._find s c?? F-// GGMM sD&,t s (AA Ar )r r r r rH rK r r s @rL MockAwareDocTestFinderrA sh
(
rN rO z conftest.py
importmode)rootpath)rootmoderC zunable to import module %rFr r )r
DocTestFinderrZ rg r[ r _importconftestrq rQ r# ImportErrorr r r r r r findr r r ra )rx r rO rM finderr r r s rL r7 zDoctestModule.collect s $ $ $ $ $ W%: $ $ $ L 9>] * *[.>> %%l33 - ? FF
$I - ..|<<
;''(FGG 5 ABBBB CB
('))%d++ # NN 8 E E
KK88 D}
!--tyt . s 59B/ /=C/.C/N)r r r r r r7 rR rN rL rV rV s; I+. I I I I I IrN rV doctest_itemc dd}i | _ | j j }| | |dd | _ t | d }| |S ) zEUsed by DoctestTextfile and DoctestItem to setup fixture information.r/ Nc d S rP rR rR rN rL r0 z _setup_fixtures..funcA s rN F)noder0 r funcargsT) _ispytestr )r] ro _fixturemanagergetfixtureinfo _fixtureinfor
_fillfixtures)rY r0 fmr s rL r r > s}
L -B " 1 1
$ !2 ! !L %\TBBBO!!### rN c B dd l } dd l G fdd| j }|S )Nr c e Zd Z dj Z dj Z dj Zde de de
de f fd 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+)
)
)
wantr r r/ c t ||| rdS |t z }|t z }|t z }|s|s|sdS dt
t dt dt f fd }|r" || j | } || j | }|r" || j | } || j | }|r| || }t ||| S )NTFregexrd r/ c 2 | d| S )Nz\1\2)sub)ri rd res rL remove_prefixeszX_init_checker_class..LiteralsOutputChecker.check_output..remove_prefixes{ s vveWc222rN )
r check_outputr r r
r rH _unicode_literal_re_bytes_literal_re_remove_unwanted_precision)
rx rg r r
allow_unicode allow_bytes allow_numberrm r rl s
rL rn z?_init_checker_class..LiteralsOutputChecker.check_outputp sI ww##D#{;;
t '*A*C*C CM%(=(?(??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_precision s 11$7788E005566D5zzSYY&&
FE4((
J
J1*+''**=*=*+''+*>*># ww{ 3 3H!)!1AAs8}} ' X .I##veAGGII.>.>B
N'S'S'SSS
0aggii& 0 01AGGII=AEEGGfDTDVDV@WW aeegg 1QUUWWqwwyy5H IIFJrN )r r r compileUNICODEro rp VERBOSEr| rH r r rn rq r )r rl s @rL LiteralsOutputCheckerrf R s
!jj)CRZ P P JJ'A2: N NZZ
&
J)
. @S @s @ @ @ @ @ @ @ @ @6 3 S S rN r )r rl
OutputChecker)r r rl s @rL _init_checker_classr N s_ NNN
IIIO O O O O O O 5 O O Ob ! rN c H t t a t S )a Return 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- r rR rN rL r r s +--
??rN c * ddl } | j d S )z+Register and return the ALLOW_UNICODE flag.r Nr r register_optionflagr s rL r r s NNN &7 & 7 77rN c * ddl } | j d S )z)Register and return the ALLOW_BYTES flag.r Nr r r s rL r r s NNN &7 &} 5 55rN c * ddl } | j d S )z$Register and return the NUMBER flag.r Nr r r s rL r
r
s NNN &7 &x 0 00rN keyc
ddl }t |j t |j t
|j t |j t 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.
r N)
r DOCTEST_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)r r s rL r r sH NNN $W%9#W%9#W%90'2S"A
rN ro )scopec t S )a Fixture 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`.
)r rR rN rL r r s
66MrN r r )r r r/ N)r/ r, )er r r; osr r r r r6
contextlibr pathlibr typingr r r r r r
r r r
r r r r _pytestr _pytest._code.coder r r _pytest._ior _pytest.compatr _pytest.configr _pytest.config.argparsingr _pytest.fixturesr r
_pytest.nodesr r _pytest.outcomesr r _pytest.pathlibr" r# _pytest.pythonr$ _pytest.python_apir% _pytest.warning_typesr& r r r r r r rJ rQ r- __annotations__rM rS re r r_ rb r` ru r5 r r r r r rH r r r rW r objectr, r= rV r r r r r r
r r rR rN rL r s9 : : :
% % % % % % , , , , , , / / / / / / + + + + + + & & & & & & ' ' ' ' ' ' ! ! ! ! ! ! , , , , , , $ $ $ $ $ $ + + + + + + # # # # # # - - - - - - ! ! ! ! ! ! & & & & & & ' ' ' ' ' ' ! ! ! ! ! ! % % % % % % / / / / / / NNN # % % % +? ( , 9=
x 456 = = =/V / / / / /d e678 "At A A A A A9 9d 9I 9$ 9 9 9 9&d &t & & & &
(
(
(
(
(l
(
(
(! ! ! ! !i ! ! ! 2 D!8 9 2 2 2 2 l 26 " $
-
.
d^
(H H H H H$ H H HD
$sCx.
f >2 2 2 2F t %),<"= % % % %:J J J J JF J J JZ
+
.
U!T"9 : U! U! U! U!p (8 8 8 8 86s 6 6 6 61# 1 1 1 1 C C " y4S> rN