֦iM d Z ddlZddlZddlZddlZddlZddlZddlZddlZddlm Z ddl
m Z m Z m
Z
ddlmZ ddlmZmZ ddlmZ G d d e Z ee D ch c] } | j1 d
r| c} Zd ZeZ d Z d
Z d Z d Z d Z!d Z"dydZ#d Z$d Z%d Z&d Z'dydZ(d Z)d Z*d Z+ G d d e, Z- G d d e, Z. e. Z/e/j` Z0e/jb Z2e/jf Z4h d Z5d! Z6 G d" d#e7 Z8d$ Z9 G d% d&e, Z: G d' d(e, Z; G d) d*e; Z< e= ee< D ch c]$ } | j1 d+ r| j} d+ & c} Z? G d, d-e7 Z@d. ZA G d/ d0e; ZB G d1 d2eBe< ZCd3 ZD G d4 d5e, ZEd6 ZFe0dddddfdd7d8ZG dzd9ZHe0dddddfdd7d:ZI G d; d ZLeGeI_, eJeI_M eHeI_N eLeI_O d?eI_P d@ZQdAZRdBj dC eRj D ZUdBj dD eRj D ZVh dEZWdF ZXdBj eQeReUeVg j D ch c] }dG|z c}ZYh dHZZdIhZ[eZe[z Z\eYeWz Z]e]e\z Z^h dJZ_dK dL dM dN dOZ`eaeaeaeadPddddQdRd dPddS
ZbdT ZcdU ZddV ZedW ZfecedeeefdXZgdY Zh G dZ d[e; Zi G d\ d]eie< Zj G d^ d_ei Zk G d` daeieC Zl G db dce; Zm ej ee j d Zp ee Zq G dd dee; Zs G df dgesekeC Zt G dh die, Zu eu Zvdj Zw G dk dlex Zy eydm Zz d{dd7dnZ{do Z| G dp dqe, Z} e~e{ e~evj fZdadadr Zd|dsZ G dt dueC Zdv Z G dw dx Zyc c} w c c} w c c}w # er$ r dZpY w xY w)})Mock MagicMockpatchsentinelDEFAULTANYcallcreate_autospec AsyncMock
FILTER_DIRNonCallableMockNonCallableMagicMock mock_open PropertyMockseal N)iscoroutinefunction)CodeType
ModuleType
MethodType) safe_repr)wrapspartial)RLockc e Zd ZdZy)InvalidSpecErrorz8Indicates that an invalid value was used as a mock spec.N__name__
__module__ __qualname____doc__ &/usr/lib64/python3.12/unittest/mock.pyr r ) s Br" r _Tc t | rt | t syt | d r t | d } t | xs t
j | S )NF__func__)_is_instance_mock
isinstancer
hasattrgetattrr inspect isawaitableobjs r#
_is_async_objr/ 5 sG ji&@sJ c:& s # ?w':':3'??r" c 4 t | dd r t | S y)N__code__F)r* r )funcs r# _is_async_funcr3 = s tZ&"4((r" c 4 t t | t S N)
issubclasstyper r- s r# r' r' D s d3i 11r" c j t | t xs" t | t xr t | t S r5 )r(
BaseExceptionr7 r6 r- s r#
_is_exceptionr: J s- 3
& A3 @*S-"@r" c V t | t rt | d r | j S | S Nmock)r(
FunctionTypesr) r= r- s r#
_extract_mockr? Q s% #}%'#v*>xx
r" c v t | t r|s| j } d}nRt | t t f r t | t rd}| j
} n t | t s
| j } |r
t | d }n| } | t j | fS # t $ r Y yw xY w# t $ r Y yw xY w)z
Given an arbitrary, possibly callable object, try to create a suitable
signature object.
Return a (reduced func, signature) tuple, or None.
TN)
r( r7 __init__ classmethod staticmethodr& r> __call__AttributeErrorr r+ signature
ValueError)r2 as_instanceeat_selfsig_funcs r# _get_signature_objectrK Z s $ k}} D; 5 6 dK (H}}
m
, ==D 4&W&&x000 s$ ( B B, B)(B), B87B8Fc t | || y \ } fd}t | | |t | _ t | _ y )Nc * j |i | y r5 bind)selfargskwargssigs r# checksigz"_check_signature..checksig $!&!r" )rK _copy_func_detailsr7 _mock_check_sig
__signature__)r2 r= skipfirstinstancerT rS s @r# _check_signaturer[ } sI
h
:C
{ID#"tX&!)DJ "DJ r" c ` dD ] } t ||t | | y # t $ r Y )w xY w)N)r r __text_signature__r __defaults____kwdefaults__)setattrr* rE )r2 funcopy attributes r# rV rV s: GYi(@ A s ! --c t | t ryt | t t t f rt | j S t | dd yy)NTrD F)r( r7 rC rB r _callabler& r* r- s r# rd rd sD #t # k:>? &&sJ%1 r" c 0 t | t t fv S r5 )r7 listtupler- s r# _is_listrh s 9u
%%r" c t | t st | dd duS | f| j z D ] }|j j d y y)ztGiven an object, return True if the object is callable.
For classes, return True if instances would be callable.rD NTF)r( r7 r* __mro____dict__get)r. bases r# _instance_callablern sV c4 sJ-T99 $ == Z ( 4 % r" c t |t }t ||| }|| S |\ } fd}t || |j }|j sd}|| d}d|z } t
| | || }
t |
| |
S )Nc * j | i | y r5 rN )rQ rR rS s r# rT z _set_signature..checksig rU r" ra )
_checksig_r= zYdef %s(*args, **kwargs):
_checksig_(*args, **kwargs)
return mock(*args, **kwargs))r( r7 rK rV r isidentifierexec _setup_func) r= originalrZ rY resultr2 rT namecontextsrcra rS s @r# _set_signaturerz s
8T*I
"8Xy
AF
~ ID#"tX& D %t4G $&* +C #wdmGs# Nr" c _ fd}fd}fd}fd}fd}fd}fd} fd}
d _ d
_ d _ t _ t _ t _ j _ j _ j _
| _ | _ | _
| _ |
_ | _ | _ | _ | _ _ y ) Nc ( j | i |S r5 )assert_called_withrQ rR r= s r# r} z'_setup_func..assert_called_with &t&&777r" c ( j | i |S r5 )
assert_calledr~ s r# r z"_setup_func..assert_called s !t!!42622r" c ( j | i |S r5 )assert_not_calledr~ s r# r z&_setup_func..assert_not_called s %t%%t6v66r" c ( j | i |S r5 )assert_called_oncer~ s r# r z'_setup_func..assert_called_once r r" c ( j | i |S r5 )assert_called_once_withr~ s r# r z,_setup_func..assert_called_once_with s +t++T.assert_has_calls s $t$$d5f55r" c ( j | i |S r5 )assert_any_callr~ s r# r z$_setup_func..assert_any_call s #t##T4V44r" c t _ t _ j j } t | r| ur| j y y y r5 ) _CallList method_calls
mock_calls
reset_mock return_valuer' )retra r= s r# r z _setup_func..reset_mock sL ({ &[ "" S !#+ NN +6 !r" Fr )r= called
call_count call_argsr call_args_listr r r side_effect_mock_childrenr} r r r r r r r rX _mock_delegate) ra r= rS r} r r r r r r r s `` r# rt rt s GL8378=65 GNG G &[G$;G"G ,,G **G ! 0 0G!3G &=G# /G -G#G )G 1G !3G G!Dr" c t j j _ d _ d _ t _ fd}dD ] }t |t || y )Nr c < t j | |i |S r5 )r* r= )attrrQ rR r= s r# wrapperz"_setup_async_mock..wrapper
s 'wtyy$'888r" )assert_awaitedassert_awaited_onceassert_awaited_withassert_awaited_once_withassert_any_awaitassert_has_awaitsassert_not_awaited) asyncio
coroutines
_is_coroutine await_count
await_argsr await_args_listr` r )r= r rb s ` r# _setup_async_mockr sV ++99DDDO$;D
9, i)!<=,r" c d| dd z | k( S )N__%s__ r! rw s r# _is_magicr s d1Rj D ((r" c " e Zd ZdZd Zd Zd Zy)_SentinelObjectz!A unique, named, sentinel object.c || _ y r5 r rP rw s r# rA z_SentinelObject.__init__" s r" c d| j z S Nz sentinel.%sr rP s r# __repr__z_SentinelObject.__repr__% tyy((r" c d| j z S r r r s r#
__reduce__z_SentinelObject.__reduce__( r r" N)r r r r rA r r r! r" r# r r s '))r" r c " e Zd ZdZd Zd Zd Zy) _SentinelzAAccess attributes to return a named object, usable as a sentinel.c i | _ y r5 )
_sentinelsr s r# rA z_Sentinel.__init__. s r" c b |dk( rt | j j |t | S )N __bases__)rE r
setdefaultr r s r# __getattr__z_Sentinel.__getattr__1 s, ; ))$0EFFr" c y)Nr r! r s r# r z_Sentinel.__reduce__7 s r" N)r r r r rA r r r! r" r# r r , s K G r" r >
_mock_namer _mock_parentr _mock_new_name_mock_new_parent_mock_side_effect_mock_return_valuec f t j | d| z }| |fd}| |fd}t || S )N_mock_c N | j }| t | | S t || S r5 )r r* )rP rw _the_namerS s r# _getz"_delegating_property.._getL s, !! ;4+ +sD!!r" c Z | j }||| j |< y t ||| y r5 )r rk r` )rP valuerw r rS s r# _setz"_delegating_property.._setQ s, !! ;',DMM) $ Cu %r" )_allowed_namesaddproperty)rw r r r s r# _delegating_propertyr I s> t 4I "
$y & D$ r" c e Zd Zd Zd Zy)r c t |t st j | | S t | }t | }||kD ryt d||z
dz D ] }| |||z }||k( s y y)NFr T)r( rf __contains__lenrange)rP r len_valuelen_selfisub_lists r# r z_CallList.__contains__^ sw %&$$T51 1J t9 x q(Y.23AAa k*H5 4 r" c > t j t | S r5 )pprintpformatrf r s r# r z_CallList.__repr__l s ~~d4j))r" N)r r r r r r! r" r# r r \ s *r" r c t | }t | sy|j s$|j s|j |j
y| }|||u ry|j
}||r| |_ ||_ |r| |_ ||_ y)NFT)r? r' r r r r )parentr rw new_name_parents r# _check_and_set_parentr p s % E U # U 1 1 ' +G
e **
!' ' # r" c e Zd Zd Zd Zy) _MockIterc $ t | | _ y r5 )iterr. )rP r. s r# rA z_MockIter.__init__ s
9r" c , t | j S r5 )nextr. r s r# __next__z_MockIter.__next__ s DHH~ r" N)r r r rA r r! r" r# r r s r" r c e Zd ZeZdZd Zy)BaseNc y r5 r! rP rQ rR s r# rA z
Base.__init__ s r" )r r r r r r rA r! r" r# r r s
r" r c e Zd ZdZ e Z d,dZ d,dZd Zd-dZ d.dZ
d Z d
Z d Z
ee e e
Zed Z ed
Z ed Z ed Z ed Z ed Zd Zd Z eee Zd/ddddedefdZd Z d Z d Z d Z d Z d Z!d Z"d Z#d0d Z$d! Z%d" Z&d# Z'd$ Z(d% Z)d& Z*d' Z+d-d(Z,d) Z-d* Z.d1d+Z/y)2r z A non-callable version of `Mock`NFc | f}
t | t s|xs |}|t | rt | f}
t | j |
d| j
i }t
t | j | }|S )Nr ) r6 AsyncMockMixinr/ r7 r r _safe_superr __new__)clsspecr rw spec_setr _spec_state _new_name _new_parent_spec_as_instance _eat_selfunsaferR basesspec_argnewrZ s r# r zNonCallableMock.__new__ sm #~. '4H#
h(?'-3<<CKK(@A 4<d . . 6&& D ' C !$D
r" c j | j || j _ y || _ t | |d d y )Nr% )r r r r )rP r s r# __set_return_valuez"NonCallableMock.__set_return_value* s2 */4D ,&+D # !$tT :r" z1The value to be returned when the mock is called.c H | j t | S | j S r5 )r r7 r s r# __class__zNonCallableMock.__class__6 s$ #: r" r r r r r c | j }| | j S |j }|8t | s-t |t
s t
| st | }||_ |S r5 )r r r callabler( r r: )rP delegatedsfs r# __get_side_effectz!NonCallableMock.__get_side_effectC s\ '' )) )
"
" N8B<"2y1-:K2 B$&I ! r" c T t | }| j }||| _ y ||_ y r5 ) _try_iterr r r )rP r r/ s r# __set_side_effectz!NonCallableMock.__set_side_effectN s- % '' %*D "$)I !r" r r r r c |g }t | |v ry|j t | d| _ d| _ d| _ t | _ t | _ t | _ |r t | _
|rd| _ | j j D ]/ }t |t s|t u r |j# ||| 1 | j }t% | r|| ur|j# | yyy)z-Restore the mock object to its initial state.NFr r5 )idr! r r r r r r r r r r r valuesr(
_SpecState_deletedr r' )rP visitedr r childr s r# r zNonCallableMock.reset_mockY s ?G
d8w r$x #+ 'k %K &-D # %)D "((//1E%,0A W<[ Y 2
%% S !co NN7 # '6 !r" c t |j d D ]H \ }}|j d }|j }| }|D ] }t || } t ||| J y)aZ Set attributes on the mock through keyword arguments.
Attributes plus return values and side effects can be set on child
mocks using standard dot notation and unpacking a dictionary in the
method call:
>>> attrs = {'method.return_value': 3, 'other.side_effect': KeyError}
>>> mock.configure_mock(**attrs)c * | d j d S )Nr .)count)entrys r# z0NonCallableMock.configure_mock.. s q 1Dr" )keyr? N)sorteditemssplitpopr* r` )rP rR argvalrQ finalr. rA s r# r z NonCallableMock.configure_mocky sh v||~ $E FHC
99S>DHHJEC c5) C $Fr" c
|dv r t | | j $|| j vs|t v r$t d|z t | r t | | j sD| j r|| j vr*|j d s|t v rt |d|d t j 5 | j j | }|t u r t | |Jd }| j t | j | }| j | |||| }|| j |< nat |t rQ t# |j$ |j& |j( |j* |j, }|| j |< d d d |S # t. $ r6 | j0 d xs | }t/ d|d |d
| d |j$ d w xY w# 1 sw Y S xY w)
N> r r z Mock object has no attribute %r)assertassretasertaseertassrtz6 is not a valid assertion. Use a spec for the mock if z is meant to be an attribute.)r rw r r r r Cannot autospec attr
from target , as it has already been mocked out. [target=, attr=r )rE r _all_magicsr r
startswith_ATTRIB_DENY_LISTr _lockr rl r: r r* r' r( r9 r r r rZ r rw r rk )rP rw rv r target_names r# r zNonCallableMock.__getattr__ s
4 4 & &
+4---1D$%F%MNN
t_ & & $*<*<DL^L^@^ OPTX\mTm$h ''+h.KMN N
"
"((,,T2F!$T** ##/ $D$4$4d ;E -- d%4 $ . .4##D)FJ/
D , V__foo
v{{ F .4##D); #>
( D"&-- "="EK*/x}&/ *##'('&++ CD DD/ #>
s& 6B G AF G ?GG G(c | | j g}| j }| }d}|dgk( rd}|B|}|j |j |z d}|j dk( rd}|j }|Bt t | }|j
xs d}t
| dkD r |d dvr|dz
}||d< dj | S )Nr? r% r r= r )r% z().r )r r r! rf reversedr r join)rP
_name_listr lastdot_firsts r# _extract_mock_namez"NonCallableMock._extract_mock_name s ))*
'' $ C!D g 4 4s : ;C%%- ..G ! (:./
*F z?Q !}M1#
1
wwz""r" c | j }d}|dvrd|z }d}| j )d}| j rd}|| j j z }dt | j ||dt | dS ) Nr )r= zmock.z name=%rz spec=%rz spec_set=%r)ra r r r r7 r7 )rP rw name_string spec_strings r# r zNonCallableMock.__repr__ s &&( ( ($t+K '$K~~ , %(8(8(A(AAK J tH
r" c t st j | S | j xs g }t t | }t
| j }| j j D cg c] \ }}|t ur| }}}|D cg c] }|j d r| }}|D cg c] }|j d r t | r|" }}t t ||z |z |z S c c}}w c c}w c c}w )z8Filter the output of `dir(mock)` to only useful members.r$ )r object__dir__r r r7 rf rk r rE r: rV r rD set)rP extras from_type from_dictm_namem_valuefrom_child_mockses r# rh zNonCallableMock.__dir__ s >>$' '##)rT
O ' *.*=*=*C*C*E (*Evwh&
*E ( !*C 1 c1BQ C ) # 1 c1B q\ #c&9,y8;KKLMM ( D#s 2C2
C8$C8.%C=c ` |t v rt j || S j r6 j *| j vr | j
vrt
d|z |t v rd|z }t
| |t v r j | j vrt
d|z t | s)t t |t || | fd}n^t |d | t t || | j |< n*|dk( r| _ y t ||| r| j |< j r/t# | s# j% d| }t
d| t' |t( r| j
|< y t j || S )Nz!Mock object has no attribute '%s'z.Attempting to set unsupported magic method %r.c g| i |S r5 r! )rQ kwru rP s r# rB z-NonCallableMock.__setattr__.. s HT,GD,GB,Gr" r, r? z Cannot set )r rg __setattr__r r rk rE _unsupported_magicsrU r' r` r7 _get_methodr r r r r) ra r( r )rP rw r msg mock_nameru s ` @r# rt zNonCallableMock.__setattr__ s > !%%dD%8 8nn!3!3!? ** *
% !Dt!KL L
(
(BTIC % %
[
!!-$d>P>P2P$%H4%OPP$U+T
D+dE*BC G &dE4>T
D%0,1##D)
[
$D $T5$=,1##D) WT4%8 2245Qtf=I ;yk!:; ; e\ *"'DMM$ !!$e44r" c |t v r;|t | j v r$t t | | || j vry | j j |t }|| j v r t t | j | n|t u r t | |t ur
| j |= t | j |< y r5 ) rU r7 rk delattrr rl _missingr r __delattr__r: rE )rP rw r. s r# r| zNonCallableMock.__delattr__+ s ; 44:+>+>#> DJ %4==( !!%%dH5 4== . : :4 @
H_ & & h ##D)$,D!r" c < | j xs d}t ||| S r< )r _format_call_signaturerP rQ rR rw s r# _format_mock_call_signaturez+NonCallableMock._format_mock_call_signature= s (&%dD&99r" c p d}| j || }| j } | j | }||||fz S )Nz0expected %s not found.
Expected: %s
Actual: %s)r r )rP rQ rR actionmessageexpected_stringr
actual_strings r# _format_mock_failure_messagez,NonCallableMock._format_mock_failure_messageB sF F ::4HNN 888)D
&/=AAAr" c |s | j S d}|j dd j d }| j }|D ]K }|j | }|t |t r |S t | }|j }|j }M |S )aH
* If call objects are asserted against a method/function like obj.meth1
then there could be no name for the call object to lookup. Hence just
return the spec_signature of the method/function being asserted against.
* If the name is not empty then remove () and split by '.' to get
list of names to iterate through the children until a potential
match is found. A child mock is created only during attribute access
so if we get a _SpecState then no attributes of the spec were accessed
and can be safely exited.
Nr% r r? )r replacerF r rl r( r9 r? )rP rw rS nameschildrenr< s r# _get_call_signature_from_namez-NonCallableMock._get_call_signature_from_nameJ s '' ' T2&,,S1&&D LL&E}
5* =
&e, //++
r" c v t |t r#t | dkD r| j |d }n | j }|Pt | dk( rd}|\ }}n|\ }}} |j
|i |}t
||j |j S |S # t $ r}|j d cY d}~S d}~ww xY w)a
Given a call (or simply an (args, kwargs) tuple), return a
comparison key suitable for matching with other calls.
This is a best effort method which relies on the spec's signature,
if available, or falls back on the arguments themselves.
r r Nr ) r( rg r r r rO r rQ rR TypeErrorwith_traceback)rP _callrS rw rQ rR
bound_callrp s r#
_call_matcherz NonCallableMock._call_matcherk s eU #E
Q44U1X>C&&C ?5zQ $ f%*"dF
. %SXXt 6v 6
D*//:3D3DEE L
.''--
.s 2B B8 B3-B83B8c | j dk7 r._error_message s 33D&ACJr" Ttwo)r r r r _Callr( Exception)rP rQ rR expectedactual
error_messager causes ``` r# r} z"NonCallableMock.assert_called_with s
>> !77fEH"F )M / / %%eT6N&EF##DNN3 X *8Y ?HTE !12 = r" c | j dk( sz3NonCallableMock.assert_has_calls.. FAZ9-Ea Nc 3 @ K | ] }j | y wr5 r r crP s r# r z3NonCallableMock.assert_has_calls.. s M_d 0 0 3_ zCalls not found.z+Error processing expected calls.
Errors: {}
Expected: z Actual)prefixr? r= z does not contain all of z in its call list, found z instead)r r r r formatr( r r r rstriprf removerG r! r rg ) rP calls any_orderr r r all_callsproblemrp not_foundkalls ` r# r z NonCallableMock.assert_has_calls s~ 4995aD&&q)59FFM MT__ MM y(= 0G ,-3V-5$7-5 *4Ay)AAt$K-5$7.8 % i !!*5!1 2''z':AA#FGI
O D
' &
&*oo&?&?&+I&6 C
7 :$7
' &
's D +D# D((EEc " | j t ||fd }t |t r|nd}| j D cg c] }| j | }}|s
|t | vr!| j
|| }t d|z |yc c}w )zassert the mock has been called with the specified arguments.
The assert passes if the mock has *ever* been called, unlike
`assert_called_with` and `assert_called_once_with` that only pass if
the call is the most recent one.Tr Nz%s call not found)r r r( r r _AnyComparerr r rP rQ rR r r r r r s r# r z NonCallableMock.assert_any_call s %%eT6N&EF &x ;151D1DE1DA$$$Q'1DE HL$88 " > >tV LO #o5
9 F B c J | j r,d|v rd|d nd}| j |z }t | |j d }|| j d v r t di |S t
| }t |t r|t v rt
}nt |t r0|t v s| j r|| j v rt }nTt
}nMt |t s.t |t rt }n&t |t rt }n|j" d } di |S )aP Create the child mocks for attributes and return value.
By default child mocks will be the same type as the parent.
Subclasses of Mock may want to override this to customize the way
child mocks are made.
For non-callable mocks the callable variant will be used (rather than
any custom subclass).rw r? r% r r r r! )r ra rE rl rk r
r7 r6 r _async_method_magicsr _all_sync_magicsr
CallableMixinr
r r rj )rP rs rb rx r _typeklasss r# r' z NonCallableMock._get_child_mock s ,2bL!BvJ<(dI //1I=I + +FF;'
n5 5 ?r? "T
eY 'I9M,M E
~
. --&&98J8J+J!!E=1%!56!E?3 MM!$E{r{r" c T | j syd| dt | j dS )zRenders self.mock_calls as a string.
Example: "
Calls: [call(1), call(2)]."
If self.mock_calls is empty, an empty string is returned. The
output will be truncated if very long.
r
z: r? )r r )rP r s r# r zNonCallableMock._calls_repr' s- F82i 8 9;;r" ) NNNNNNr NFNFF)FFr5 )r )Calls)0r r r r r rX r rA r r r "_NonCallableMock__get_return_value"_NonCallableMock__set_return_value"_NonCallableMock__return_value_docr r r, r r r r r r !_NonCallableMock__get_side_effect!_NonCallableMock__set_side_effectr boolr r r ra r rh rt r| r r r r r r r r} r r r r' r r! r" r# r r s` *
GE =AEIBEI, 8*Z
#L
!,!;!;c!AN!R &66K- %r" c | j }|Bt | r|t | st | }t | r
| ||i |}|t ur|S | j
t ur | j S | j r(| j j t ur | j S | j | j |i |S | j S r5 ) r r: rd r r r r r r )rP rQ rR effectrv s r# r z CallableMixin._execute_mock_call s !! V$ v& f ( L 00W$
" "' 1$$ $ 4#6#6#C#C7#R$$ $ '#4##T4V4 4 r" )
r r r r rA rW rD r r r r! r" r# r r [ s8 d$d !RT '
08,7\!r" r c e Zd ZdZy)r a
Create a new `Mock` object. `Mock` takes several optional arguments
that specify the behaviour of the Mock object:
* `spec`: This can be either a list of strings or an existing object (a
class or instance) that acts as the specification for the mock object. If
you pass in an object then a list of strings is formed by calling dir on
the object (excluding unsupported magic attributes and methods). Accessing
any attribute not in this list will raise an `AttributeError`.
If `spec` is an object (rather than a list of strings) then
`mock.__class__` returns the class of the spec object. This allows mocks
to pass `isinstance` tests.
* `spec_set`: A stricter variant of `spec`. If used, attempting to *set*
or get an attribute on the mock that isn't on the object passed as
`spec_set` will raise an `AttributeError`.
* `side_effect`: A function to be called whenever the Mock is called. See
the `side_effect` attribute. Useful for raising exceptions or
dynamically changing return values. The function is called with the same
arguments as the mock, and unless it returns `DEFAULT`, the return
value of this function is used as the return value.
If `side_effect` is an iterable then each call to the mock will return
the next value from the iterable. If any of the members of the iterable
are exceptions they will be raised instead of returned.
* `return_value`: The value returned when the mock is called. By default
this is a new Mock (created on first access). See the
`return_value` attribute.
* `unsafe`: By default, accessing any attribute whose name starts with
*assert*, *assret*, *asert*, *aseert*, or *assrt* raises an AttributeError.
Additionally, an AttributeError is raised when accessing
attributes that match the name of an assertion method without the prefix
`assert_`, e.g. accessing `called_once` instead of `assert_called_once`.
Passing `unsafe=True` will allow access to these attributes.
* `wraps`: Item for the mock object to wrap. If `wraps` is not None then
calling the Mock will pass the call through to the wrapped object
(returning the real result). Attribute access on the mock will return a
Mock object that wraps the corresponding attribute of the wrapped object
(so attempting to access an attribute that doesn't exist will raise an
`AttributeError`).
If the mock has an explicit `return_value` set then calls are not passed
to the wrapped object and the `return_value` is returned instead.
* `name`: If the mock has a name then it will be used in the repr of the
mock. This can be useful for debugging. The name is propagated to child
mocks.
Mocks can also be called with arbitrary keyword arguments. These will be
used to set attributes on the mock after it is created.
Nr r! r" r# r r s 7r" r c : d}|D ] }|| v st |d y )N) autospect auto_specset_specz5 might be a typo; use unsafe=True if this is intended) RuntimeError)kwargs_to_checktypostypos r# _check_spec_arg_typosr s1 2E ? " (OP
r" c e Zd ZdZg ZdddZd Zd Zd Ze j d Z d Z d
Z
d Zd Zd
Zd Zd Zy)_patchNFr c
~ | |t ur t d | t d |
s t | t | rt d|d|d t | rt d|d|d || _ || _ || _ || _ || _ || _
d| _ || _ || _
| | _ g | _ d| _ y )Nz,Cannot use 'new' and 'new_callable' togetherz1Cannot use 'autospec' and 'new_callable' togetherzCannot spec attr z0 as the spec has already been mocked out. [spec=r z? as the spec_set target has already been mocked out. [spec_set=F)r rG r r' r getterrb r new_callabler create has_localr autospecrR additional_patchers
is_started) rP r rb r r r r r r rR r s r# rA z_patch.__init__ s #'! B # G !& ) T ""#I= 166:XQ@A
A X &"#I= 1AAI AOP
P " (
#% r" c f t | j | j | j | j | j
| j | j | j | j }| j |_
| j D cg c] }|j c}|_ |S c c}w r5 )
r r rb r r r r r r rR attribute_namer copy)rP patcherps r# r z _patch.copy7 s KK 499 KK MM4,,dkk
"&!4!4 " 6 6'
6AFFH 6'
# '
s
B.c t |t r| j | S t j | r| j | S | j
| S r5 r( r7 decorate_classr+ r decorate_async_callabledecorate_callable)rP r2 s r# rD z_patch.__call__D sM dD !&&t, , & &t ,//5 5%%d++r" c t | D ]^ }|j t j s#t || }t |d s<| j
}t || || ` |S NrD )r rV r TEST_PREFIXr* r) r r` )rP r r
attr_valuer s r# r z_patch.decorate_classL sa JD??5#4#45 -J:z2iikG E4!4 5 r" c # R K g }t j 5 }|j D ]U }|j | }|j |j | 2|j t u sE|j | W |t | z
}||f d d d y # 1 sw Y y xY wwr5 )
contextlib ExitStack patchings
enter_contextr updater r r! rg )rP patchedrQ keywargs
extra_args
exit_stackpatchingrH s r# decoration_helperz_patch.decoration_helperZ s
!
!
#z # - - ..x8**6 OOC( \\W, %%c* .
E*% %D" " $
#
#s# B'AB+'B B'B$ B'c t d r j j S t fd g_ S )Nr c l j | | 5 \ }} |i |cd d d S # 1 sw Y y xY wr5 r rQ r newargs newkeywargsr2 r rP s r# r z)_patch.decorate_callable..patchedo s= ''(,(025Kg{W4 42 2 2s *3r) r r! r rP r2 r s ``@r# r z_patch.decorate_callablei sK 4 % NN ! !$ 'K t 5
5 "Fr" c t d r j j S t fd g_ S )Nr c K j | | 5 \ }} |i | d { cd d d S 7
# 1 sw Y y xY wwr5 r r s r# r z/_patch.decorate_async_callable..patched sN ''(,(025Kg{ !7 :k ::2 2 ;2 2s# A646
A6?Ar" r# s ``@r# r
z _patch.decorate_async_callablez sK 4 % NN ! !$ 'K t ;
; "Fr" c H | j }| j }t }d} |j | }d}|t v rt |t rd| _
| j s|t u rt |d| ||fS # t t
f$ r t
||t }Y iw xY w)NFTz does not have the attribute ) r rb r rk rE KeyErrorr* _builtinsr( r r )rP targetrw ru locals r# get_originalz_patch.get_original s ~~ t,H E 9 FJ!? DK{{x7 2 7=tD
) 6 vtW5H 6s A> > B! B!c J | j r t d | j | j | j }}}| j
| j }}| j }| j | _ |du rd}|du rd}|du rd}|
| t d |||dvr t d | j \ }}|t u rl|id} |du r |}|du r|}d}n| |du r |}d}n|du r|}||%|t u r t d t |t rd} ||}
nb|t | rt }
nN||D|} ||} t# | rd | v} n t% | } t | rt }
n| rt& }
n
t( }
nt( }
i }
|||
d
< |||
d < t |
t r+t+ |
t, r| j. r| j. |
d < |
j1 | |
di |
}| rFt3 | r:|} ||} t# | st5 | st& }
|
j7 d |
d|d
d|
|_ n||t ur t d |t u r t d t; | }|du r|}t3 | j r)t= d| j. d| j d|d t3 | rMt? | j d| j }t= d| j. d|d| j d|d tA |f|| j. d|}n
|r t d |}|| _! || _" tG jH | _% d| _ tM | j | j. | | jN ui }| j t u r||| jN < | jP D ]A }| jJ jS | }|j t u s1|j1 | C |S |S # | jT tW jX s Y yxY w)zPerform the patch.zPatch is already startedFNz Can't specify spec and autospec)TNz6Can't provide explicit spec_set *and* spec or autospecTz!Can't use 'spec' with create=TruerD r r rw r% r& zBautospec creates the mock for you. Can't specify autospec and new.z%Can't use 'autospec' with create=TruerQ z: as the patch target has already been mocked out. [target=rT r r rR rS )r _namez.Can't pass kwargs to a mock we aren't creatingr! )-r r r r r r rR r r r) r r+ r r( r7 r/ r
rh r. r
r r6 r rb r r' rn rG r r r r* r
temp_originalis_localr r _exit_stackr` r r r __exit__sysexc_info)rP r r r r rR r ru r* inheritKlass this_spec not_callable_kwargsrY new_attrr r rH s r# __enter__z_patch.__enter__ s ?? 9: : "hh 4==8T ==$++&(( kkm 5=D u H u H 4 => >
!5 L ( TU U ++-% '>h .Gt| t# 'H D!t# #H DT!# 8#7w&#$GHH h- "G '$ -"9!!X%9 ' (II&#-Y#>L'/ ':#:L + %E! 0E %E!G "&#&.
# 5$'5/2t~~"&.. NN6 ""'"C,S1 ! ' (I +&y1 0E F##( $4SD $4+2$4
! '! ( 7" GHHH~H4 # -&+DNN+= > #{{oWXLCD D !* %dkk:t{{ K &+DNN+=]"o & #{{oWXLCD D
"( BX(,B:@BC
LM M %
%//1 DKK :"".
88w&7:Jt 2 23 $ 8 8H **88BC ||w."))#. !9 "!J 4==#,,.1 2s B O< %O< :O< <$P"c | j sy| j r>| j t ur,t | j
| j | j nt | j
| j | j sYt | j
| j r| j dv r+t | j
| j | j | `| `| `| j }| `
d| _ |j | S )zUndo the patch.N)r r r^ __annotations__r_ F) r r/ r. r r` r) rb rz r r) r0 r1 )rP r3 r s r# r1 z_patch.__exit__= s ==T / /w > DKK 1C1C D DKK 0;; T^^(L += = T^^T5G5GH M K%%
"z""H--r" c \ | j }| j j | |S z-Activate a patch, returning any created mock.)r: _active_patchesr! rP rv s r# startz _patch.startV s' ! ##D)
r" c ~ | j j | | j ddd S # t $ r Y yw xY wzStop an active patch.N)r? r rG r1 r s r# stopz _patch.stop] sD ' ' -
}}T4.. s 0 <<)r r r r r? rA r rD r r contextmanagerr r r
r+ r: r1 rA rD r! r" r# r r sg NO AF# L
, # # "" 0Xt.2/r" r c | j dd \ } }t t
j | |fS # t t t f$ r t d| w xY w)Nr? r z,Need a valid target to patch. You supplied: )rsplitr rG rE r pkgutil resolve_name)r) rb s r# _get_targetrJ i sj G "MM#q 1 7'' 0) ;;
z> 2 G:6* EG GGs 3 #Ar c v t t u rt d fd}
t |
|||||||| |
S )a
patch the named member (`attribute`) on an object (`target`) with a mock
object.
`patch.object` can be used as a decorator, class decorator or a context
manager. Arguments `new`, `spec`, `create`, `spec_set`,
`autospec` and `new_callable` have the same meaning as for `patch`. Like
`patch`, `patch.object` takes arbitrary keyword arguments for configuring
the mock object it creates.
When used as a class decorator `patch.object` honours `patch.TEST_PREFIX`
for choosing which methods to wrap.
z3 must be the actual object to be patched, not a strc S r5 r! r) s r# rB z _patch_object.. s Vr" r )r7 strr r ) r) rb r r r r r r r rR r s ` r#
_patch_objectrO r sS $ F|sjK L
F 3f(L& r" c ~ t t u rt t j }n fd}|s t d t
|j }|d \ } }
t || |
|||||i } | | _ |dd D ]: \ } }
t || |
|||||i } | | _ | j j | < | S )a Perform multiple patches in a single call. It takes the object to be
patched (either as an object or a string to fetch the object by importing)
and keyword arguments for the patches::
with patch.multiple(settings, FIRST_PATCH='one', SECOND_PATCH='two'):
...
Use `DEFAULT` as the value if you want `patch.multiple` to create
mocks for you. In this case the created mocks are passed into a decorated
function by keyword, and a dictionary is returned when `patch.multiple` is
used as a context manager.
`patch.multiple` can be used as a decorator, class decorator or a context
manager. The arguments `spec`, `spec_set`, `create`,
`autospec` and `new_callable` have the same meaning as for `patch`. These
arguments will be applied to *all* patches done by `patch.multiple`.
When used as a class decorator `patch.multiple` honours `patch.TEST_PREFIX`
for choosing which methods to wrap.
c S r5 r! rM s r# rB z!_patch_multiple.. s r" z=Must supply at least one keyword argument with patch.multipler r N) r7 rN r rH rI rG rf rE r r r r! )
r) r r r r r rR r rE rb r r this_patchers
` r# _patch_multiplerS s , F|s--v6 K
E1XNIs 3fh,G 'G ) 3 IsD&( lB
'0 ###**<8
$ Nr" c H t | \ } }
t | |
||||||||
S )a:
`patch` acts as a function decorator, class decorator or a context
manager. Inside the body of the function or with statement, the `target`
is patched with a `new` object. When the function/with statement exits
the patch is undone.
If `new` is omitted, then the target is replaced with an
`AsyncMock if the patched object is an async function or a
`MagicMock` otherwise. If `patch` is used as a decorator and `new` is
omitted, the created mock is passed in as an extra argument to the
decorated function. If `patch` is used as a context manager the created
mock is returned by the context manager.
`target` should be a string in the form `'package.module.ClassName'`. The
`target` is imported and the specified object replaced with the `new`
object, so the `target` must be importable from the environment you are
calling `patch` from. The target is imported when the decorated function
is executed, not at decoration time.
The `spec` and `spec_set` keyword arguments are passed to the `MagicMock`
if patch is creating one for you.
In addition you can pass `spec=True` or `spec_set=True`, which causes
patch to pass in the object being mocked as the spec/spec_set object.
`new_callable` allows you to specify a different class, or callable object,
that will be called to create the `new` object. By default `AsyncMock` is
used for async functions and `MagicMock` for the rest.
A more powerful form of `spec` is `autospec`. If you set `autospec=True`
then the mock will be created with a spec from the object being replaced.
All attributes of the mock will also have the spec of the corresponding
attribute of the object being replaced. Methods and functions being
mocked will have their arguments checked and will raise a `TypeError` if
they are called with the wrong signature. For mocks replacing a class,
their return value (the 'instance') will have the same spec as the class.
Instead of `autospec=True` you can pass `autospec=some_object` to use an
arbitrary object as the spec instead of the one being replaced.
By default `patch` will fail to replace attributes that don't exist. If
you pass in `create=True`, and the attribute doesn't exist, patch will
create the attribute for you when the patched function is called, and
delete it again afterwards. This is useful for writing tests against
attributes that your production code creates at runtime. It is off by
default because it can be dangerous. With it switched on you can write
passing tests against APIs that don't actually exist!
Patch can be used as a `TestCase` class decorator. It works by
decorating each test method in the class. This reduces the boilerplate
code when your test methods share a common patchings set. `patch` finds
tests by looking for method names that start with `patch.TEST_PREFIX`.
By default this is `test`, which matches the way `unittest` finds tests.
You can specify an alternative prefix by setting `patch.TEST_PREFIX`.
Patch can be used as a context manager, with the with statement. Here the
patching applies to the indented block after the with statement. If you
use "as" then the patched object will be bound to the name after the
"as"; very useful if `patch` is creating a mock object for you.
Patch will raise a `RuntimeError` if passed some common misspellings of
the arguments autospec and spec_set. Pass the argument `unsafe` with the
value True to disable that check.
`patch` takes arbitrary keyword arguments. These will be passed to
`AsyncMock` if the patched object is asynchronous, to `MagicMock`
otherwise or to `new_callable` if specified.
`patch.dict(...)`, `patch.multiple(...)` and `patch.object(...)` are
available for alternate use-cases.
r )rJ r ) r) r r r r r r r rR r rb s r# r r s7 V $F+FI 3f(L& r" c T e Zd ZdZddZd Zd Zd Zd Zd Z d Z
d Z d
Z d Z
d Zy
) _patch_dicta#
Patch a dictionary, or dictionary like object, and restore the dictionary
to its original state after the test.
`in_dict` can be a dictionary or a mapping like container. If it is a
mapping then it must at least support getting, setting and deleting items
plus iterating over keys.
`in_dict` can also be a string specifying the name of the dictionary, which
will then be fetched by importing it.
`values` can be a dictionary of values to set in the dictionary. `values`
can also be an iterable of `(key, value)` pairs.
If `clear` is True then the dictionary will be cleared before the new
values are set.
`patch.dict` can also be called with arbitrary keyword arguments to set
values in the dictionary::
with patch.dict('sys.modules', mymodule=Mock(), other_module=Mock()):
...
`patch.dict` can be used as a context manager, decorator or class
decorator. When used as a class decorator `patch.dict` honours
`patch.TEST_PREFIX` for choosing which methods to wrap.
c || _ t | | _ | j j | || _ d | _ y r5 )in_dictdictr8 r clear _original)rP rX r8 rZ rR s r# rA z_patch_dict.__init__/ s4 6l 6"
r" c t |t r| j | S t j | r| j | S | j
| S r5 r )rP fs r# rD z_patch_dict.__call__8 sM a &&q) ) & &q )//2 2%%a((r" c 2 t fd }|S )Nc j | i |j S # j w xY wr5 rV
_unpatch_dictrQ rs r] rP s r# _innerz-_patch_dict.decorate_callable.._innerA s8
%$~"~""$""$s + =r rP r] rc s `` r# r z _patch_dict.decorate_callable@ q %
%
r" c 2 t fd }|S )Nc K j | i | d { j S 7 # j w xY wwr5 r` rb s r# rc z3_patch_dict.decorate_async_callable.._innerM sD
% ^^+""$ ,""$s% A 7 57 A 7 A A rd re s `` r# r
z#_patch_dict.decorate_async_callableL rf r" c t | D ]{ }t || }|j t j s/t |d s>G - NN8 $ - '} -s 7 AAc < | j | j y)zUnpatch the dict.F)r[ ra )rP rQ s r# r1 z_patch_dict.__exit__ s >> % r" c d | j }t j j | |S r> )r: r r? r! r@ s r# rA z_patch_dict.start s' ! %%d+
r" c t j j | | j ddd S # t $ r Y yw xY wrC )r r? r rG r1 r s r# rD z_patch_dict.stop sD " " ) )$ /
}}T4.. s 4 A A N)r! F)r r r r rA rD r r
r r: rV ra r1 rA rD r! r" r# rV rV s> 8 ) +8
-/r" rV c n | j y # t $ r t | }|D ] }| |= Y y w xY wr5 )rZ rE rf )rX keysrC s r# rn rn s9
G}C s 44c ` t t j D ] } | j y)z7Stop all active patches. LIFO to unroll nested patches.N)r[ r r? rD )r s r# _patch_stopallrv s &001
2r" testzlt le gt ge eq ne getitem setitem delitem len contains iter hash str sizeof enter exit divmod rdivmod neg pos abs invert complex int float index round trunc floor ceil bool next fspath aiter zDadd sub mul matmul truediv floordiv mod lshift rshift and xor or pow c # & K | ] }d |z yw)zi%sNr! r ns r# r r s 7&6519&6 c # & K | ] }d |z yw)zr%sNr! rz s r# r r s 5$4q$4r| > rh __get____set__r
__delete__
__format__r __missing__ __getstate__ __reversed__ __setstate__
__getformat__
__reduce_ex____getnewargs____subclasses____getinitargs____getnewargs_ex__c fd}| |_ |S )z:Turns a callable object (like a mock) into a real functionc | g|i |S r5 r! )rP rQ rs r2 s r# methodz_get_method..method s D&4&2&&r" )r )rw r2 r s ` r# rv rv s 'FO Mr" r > __aexit__ __anext__
__aenter__ __aiter__> __del__r rA r __prepare__rt __instancecheck____subclasscheck__c , t j | S r5 )rg __hash__r s r# rB rB s
V__T 2r" c , t j | S r5 )rg __str__r s r# rB rB s
FNN4 0r" c , t j | S r5 )rg
__sizeof__r s r# rB rB s v 0 0 6r" c j t | j d| j dt | S )N/)r7 r ra r7 r s r# rB rB s3 $t*"5"5!6a8O8O8Q7RRSTVW[T\S] ^r" )r r r
__fspath__r y ?g ?)
__lt____gt____le____ge____int__r __len__r1 __complex__ __float____bool__ __index__r c fd}|S )Nc Z j j }|t ur|S | u ryt S NT)__eq__r r NotImplemented)otherret_valrP s r# r z_get_eq..__eq__ s/ ++00 ' !N 5= r" r! )rP r s ` r# _get_eqr s Mr" c fd}|S )Nc ^ j j t urt S | u ryt S NF)__ne__r r r )r rP s r# r z_get_ne..__ne__# s* ;; ) ) 8N 5= r" r! )rP r s ` r# _get_ner " s Mr" c fd}|S )Nc l j j } | t u r t g S t | S r5 )__iter__r r r r rP s r# r z_get_iter..__iter__, s/ --22 g 8O G} r" r! )rP r s ` r# _get_iterr + s Or" c fd}|S )Nc j j } | t u rt t g S t t | S r5 )r r r _AsyncIteratorr r s r# r z"_get_async_iter..__aiter__6 s8 ..33 g !$r(+ + d7m,,r" r! )rP r s ` r# _get_async_iterr 5 s -
r" )r r r r c t j |t }|t ur||_ y t j | }| || }||_ y t
j | }| || |_ y y r5 )_return_valuesrl r r _calculate_return_value_side_effect_methodsr )r= r rw fixedreturn_calculatorr
side_effectors r# _set_return_valuer F s{ tW -E G #/33D9$(. *(,,T2M *4 0 !r" c e Zd Zd Zd Zy)
MagicMixinc | j t t | j |i | | j y r5 )_mock_set_magicsr r rA )rP rQ rs s r# rA zMagicMixin.__init__Y s6 . J%..;; r" c z t t z }|}t | dd U|j | j }t }||z
}|D ]& }|t
| j v st | | ( |t t
| j z
}t
| }|D ] }t ||t || y )Nr ) _magicsr r* intersectionr ri r7 rk rz r`
MagicProxy)rP orig_magics these_magics
remove_magicsrA r s r# r zMagicMixin._mock_set_magics_ s 44 " 4 $ / ;&33D4F4FGL EM ', 6M&DJ / //D%( ' $c$t**=*=&>> T
!E E5*UD"9 : "r" N)r r r rA r r! r" r# r r X s ;r" r c e Zd ZdZddZy)r
z-A version of `MagicMock` that isn't callable.c H | j || | j yr r r r s r# r z"NonCallableMagicMock.mock_add_specy
D(+ r" Nr )r r r r r r! r" r# r
r
w s
7 r" r
c e Zd Zy)AsyncMagicMixinN)r r r r! r" r# r r s r" r c 6 e Zd ZdZddZdddef fdZ xZS )r a
MagicMock is a subclass of Mock with default implementations
of most of the magic methods. You can use MagicMock without having to
configure the magic methods yourself.
If you use the `spec` or `spec_set` arguments then *only* magic
methods that exist in the spec will be created.
Attributes and the return value of a `MagicMock` will also be `MagicMocks`.
Fc H | j || | j yr r r s r# r zMagicMock.mock_add_spec r r" )r r c |r#| j rt | j rd} t j |d|i| y )NFr )r r superr )rP r rQ rR r, s r# r zMagicMock.reset_mock s< $//*
!LDF|FvFr" r )r r r r r r r
__classcell__r, s @r# r r s& 9>
G
G
Gr" r c e Zd Zd Zd ZddZy)r c || _ || _ y r5 rw r )rP rw r s r# rA zMagicProxy.__init__ s r" c | j }| j }|j ||| }t ||| t ||| |S )N)rw r r )rw r r' r` r )rP rA r ms r# create_mockzMagicProxy.create_mock sM " "/5
#
7q!&!U+r" Nc " | j S r5 )r )rP r. r s r# r~ zMagicProxy.__get__ s !!r" r5 )r r r rA r r~ r! r" r# r r s "r" r c e Zd Z ed Z ed Z ed Z fdZd Zd Z d Z
d Z d Z d
Z
dd Zd Z fd
Z xZS )r r r r c t j |i | t j j | j
d< d| j
d< d | j
d< t
| j
d< t r7t t }t |j
d< t |j
d< nt t }t j t j z t j z |_ d|_ d |_ d|_ d|_ || j
d
< d | j
d < t) | j
d
< i | j
d< d | j
d< y )Nr r _mock_await_count_mock_await_args_mock_await_args_listr r r )rQ rR r1 r
r r^ r_ r< )r rA r r r rk r _CODE_SIGr _CODE_ATTRSr r+ CO_COROUTINE
CO_VARARGSCO_VARKEYWORDSco_flags co_argcount co_varnamesco_posonlyargcountco_kwonlyargcountrg )rP rQ rR code_mockr, s r# rA zAsyncMockMixin.__init__ s6 $)&) *1););)I)I
o&-.
)*,0
()1:
-. '=I08I } -4=I 0 1':I
!$$
%
!" 2 '( $&' #$-
j!$/
j!(-
n%*,
&'+/
'(r" c K t ||fd }| xj dz
c_ || _ | j j | | j
}|_t
| r|t | s t | }t
| r&|t | r ||i | d { }n ||i |}|t ur|S | j t ur | j S | j At | j r | j |i | d { S | j |i |S | j S # t $ r t w xY w7 7 7w)NTr r )r r r r r! r r: rd r
StopIterationStopAsyncIterationr r r r r )rP rQ rR r r rv s r# r z!AsyncMockMixin._execute_mock_call sT tVn$/ A ##E*!! V$ v&- !&\F
!( L$V, %t 6v 66 00W$
" "' 1$$ $ '"4#3#34 -T - -t >v >>>#4##T4V4 4 - % - -,- 7 ?s= A-E0 D- ;#E E A+E
E "E-D==EEc ` | j dk( r d| j xs d d}t | y)zA
Assert that the mock was awaited at least once.
r Expected r= z to have been awaited.Nr r r r s r# r z AsyncMockMixin.assert_awaited s; q doo 7 88NOC % % !r" c z | j dk( s,d| j xs d d| j d}t | y)z@
Assert that the mock was awaited exactly once.
r r r= $ to have been awaited once. Awaited r Nr r s r# r z"AsyncMockMixin.assert_awaited_once sM 1$ t 8& 9 : # / / 09C % % %r" c 8 j ! j }t d| d fd} j t fd } j j }||k7 r%t |t r|nd}t | |y)zN
Assert that the last await was with the specified arguments.
NzExpected await: z
Not awaitedc 0 j d } | S )Nawait)r r r s r# r z:AsyncMockMixin.assert_awaited_with.._error_message( s 33D&3QCJr" Tr )r r r r r r( r )rP rQ rR r r r r s ``` r# r z"AsyncMockMixin.assert_awaited_with s ?? "77fEH #3H:]!KL L %%eT6N&EF##DOO4 X *8Y ?HTE !12 = r" c | j dk( s,d| j xs d d| j d}t | | j |i |S )zi
Assert that the mock was awaited exactly once and with the specified
arguments.
r r r= r r )r r r r r s r# r z'AsyncMockMixin.assert_awaited_once_with2 s`
1$ t 8& 9 : # / / 09C % %'t''888r" c " | j t ||fd }t |t r|nd}| j D cg c] }| j | }}|s
|t | vr!| j
|| }t d|z |yc c}w )zU
Assert the mock has ever been awaited with the specified arguments.
Tr Nz%s await not found)r r r( r r r r r r s r# r z AsyncMockMixin.assert_any_await= s %%eT6N&EF &x ;151E1EF1EA$$$Q'1EF HL$88 " > >tV LO $6
9 Gr c @ |D cg c] } j | }}t d |D d }t fd j D }|sb||vr]|d}n1dj |D cg c] }t |t r|nd c} }t | dt | d j |yt | }g } |D ] }
|j |
| rt t | d |yc c}w c c}w # t $ r | j |
Y Xw xY w) a
Assert the mock has been awaited with the specified calls.
The :attr:`await_args_list` list is checked for the awaits.
If `any_order` is False (the default) then the awaits must be
sequential. There can be extra calls before or after the
specified awaits.
If `any_order` is True then the awaits can be in any order, but
they must all appear in :attr:`await_args_list`.
c 3 B K | ] }t |t s| y wr5 r r s r# r z3AsyncMockMixin.assert_has_awaits..W r r Nc 3 @ K | ] }j | y wr5 r r s r# r z3AsyncMockMixin.assert_has_awaits..X s S>Rt 1 1! 4>Rr zAwaits not found.z,Error processing expected awaits.
Errors: {}r z
Actual: z not all found in await list)
r r r r r r( r r rf r rG r! rg ) rP r r r r r
all_awaitsr rp r r s ` r# r z AsyncMockMixin.assert_has_awaitsJ s\ 4995aD&&q)59FFM Sd>R>R SS
z)= 1G ,-3V-5$7-5 *4Ay)AAt$K-5$7.8 % i !!*5!1 2 3 # 3 3 46
*%
D
'!!$'
49)4DF
7 :$7
' &
's C6+C;D D D c z | j dk7 r,d| j xs d d| j d}t | y)z9
Assert that the mock was never awaited.
r r r= z# to not have been awaited. Awaited r Nr r s r# r z!AsyncMockMixin.assert_not_awaitedv sM q t 8& 9 : # / / 09C % % !r" c t t j |i | d| _ d| _ t | _ y)z0
See :func:`.Mock.reset_mock()`
r N)r r r r r r )rP rQ rR r, s r# r zAsyncMockMixin.reset_mock s5 D+F+ ({ r" r )r r r r r r r rA r r r r r r r r r r r s @r# r r s\ &}5K%l3J*+<=O 0B&!P&&>$ 9 *X&+ +r" r c e Zd ZdZy)r
aY
Enhance :class:`Mock` with features allowing to mock
an async function.
The :class:`AsyncMock` object will behave so the object is
recognized as an async function, and the result of a call is an awaitable:
>>> mock = AsyncMock()
>>> iscoroutinefunction(mock)
True
>>> inspect.isawaitable(mock())
True
The result of ``mock()`` is an async function which will have the outcome
of ``side_effect`` or ``return_value``:
- if ``side_effect`` is a function, the async function will return the
result of that function,
- if ``side_effect`` is an exception, the async function will raise the
exception,
- if ``side_effect`` is an iterable, the async function will return the
next value of the iterable, however, if the sequence of result is
exhausted, ``StopIteration`` is raised immediately,
- if ``side_effect`` is not defined, the async function will return the
value defined by ``return_value``, hence, by default, the async function
returns a new :class:`AsyncMock` object.
If the outcome of ``side_effect`` or ``return_value`` is an async function,
the mock async function obtained when the mock object is called will be this
async function itself (and not an async function returning an async
function).
The test author can also specify a wrapped object with ``wraps``. In this
case, the :class:`Mock` object behavior is the same as with an
:class:`.Mock` object: the wrapped object may have methods
defined as async function functions.
Based on Martin Richard's asynctest project.
Nr r! r" r# r
r
s 'r" r
c " e Zd ZdZd Zd Zd Zy)_ANYz2A helper object that compares equal to everything.c yr r! rP r s r# r z _ANY.__eq__ s r" c yr r! r s r# r z _ANY.__ne__ s r" c y)Nzr! r s r# r z
_ANY.__repr__ s r" N)r r r r r r r r! r" r# r r s 8r" r c d| z }d}dj |D cg c]
}t | c} }dj |j D cg c] \ }}|d| c}} } |r|}| r |r|dz
}|| z
}||z S c c}w c c}}w )Nz%s(%%s)r z, =)r\ reprrE )
rw rQ rR r formatted_argsrH args_stringrC r
kwargs_strings
r# r~ r~ s $ GN))$ 7$3T#Y$ 78KII17 1?:33 M $ d "N-' ^ ## 8 s A>B
c e Zd ZdZ ddZ ddZd Zej Zd Z d Z
d Z d Z e
d
Ze
d Zd Zd
Zy)r a
A tuple for holding the results of a call to a mock, either in the form
`(args, kwargs)` or `(name, args, kwargs)`.
If args or kwargs are empty then a call tuple will compare equal to
a tuple without those values. This makes comparisons less verbose::
_Call(('name', (), {})) == ('name',)
_Call(('name', (1,), {})) == ('name', (1,))
_Call(((), {'a': 'b'})) == ({'a': 'b'},)
The `_Call` object provides a useful shortcut for comparing with call::
_Call(((1, 2), {'a': 3})) == call(1, 2, a=3)
_Call(('foo', (1, 2), {'a': 3})) == call.foo(1, 2, a=3)
If the _Call has no name then it will match any name.
Nc n d}i }t | }|dk( r|\ }}}nh|dk( r2|\ } }
t | t r| }t |
t r|
}n9|
}n6| |
}}n1|dk( r,|\ }t |t r|}nt |t r|}n|}|rt j | ||f S t j | |||f S )Nr! r r )r r( rN rg r ) r r rw r r from_kallrQ rR _lenfirstseconds r# r z
_Call.__new__ s 5z 19!& D$
QY !ME6%% fe,!D #F $ff
QYFE%% E5) ==tVn5 5}}S4v"677r" c . || _ || _ || _ y r5 )r r _mock_from_kall)rP r rw r r r s r# rA z_Call.__init__
s " ( r" c " t | }d}t | dk( r| \ }}n| \ }}}t | dd r't |dd r| j |j k7 ryd}|dk( rdi }}n|dk( r|\ }}}nv|dk( r5|\ } t | t r| }i }nXt | t r| }di }}nAd}| }n<|dk( r6|\ }
} t |
t r |
}t | t r| i }}n d| }}n|
| }}ny|r||k7 ry||f||fk( S # t $ r t cY S w xY w) Nr r r Fr r! r r )r r r r* r r( rg rN ) rP r len_other self_name self_args self_kwargs
other_name
other_args other_kwargsr r r s r# r z _Call.__eq__
sV "E
I t9>%) "I{04 -Iy+ D.$ /GE>SW4X%%););;
>')2 J
!^38 0J
L
!^FE%' "
! E3' "
+-rL
$
!^ !ME6%% "
fe,/5r J/16 J+0&L
y0 L)i-EEE_ "! ! "s C< <D
Dc | j t d||fd S | j dz }t | j ||f|| S )Nr r% r r r r r s r# rD z_Call.__call__H
sH ?? ""dF+$7 7%dootV44MMr" c r | j
t |d S | j d|}t || d S )NF)rw r r? )rw r r r) )rP r rw s r# r z_Call.__getattr__P
s6 ?? "de4 4 //40$tu==r" c ^ |t j v rt t j | | S r5 )rg rk rE __getattribute__)rP r s r# r, z_Call.__getattribute__W
s' 5>> ! %%dD11r" c D t | dk( r | \ }}||fS | \ }}}||fS )Nr )r r s r# _get_call_argumentsz_Call._get_call_arguments]
s: t9> LD& V| "& D$V|r" c ( | j d S Nr r. r s r# rQ z
_Call.argse
'')!,,r" c ( | j d S )Nr r1 r s r# rR z _Call.kwargsi
r2 r" c | j s(| j xs d}|j d rd|z }|S t | dk( rd}| \ }}n'| \ }}}|sd}n |j d sd|z }nd|z }t ||| S )Nr r% zcall%sr zcall.%s)r r rV r r~ )rP rw rQ rR s r# r z_Call.__repr__m
s ##??,fDt$ $K t9>D LD&!% D$ __T* 4' $%dD&99r" c g }| }|,|j r|j | |j }|,t t | S )zFor a call object that represents multiple calls, `call_list`
returns a list of all the intermediate calls as well as the
final call.)r r! r r r[ )rP valsthings r# call_listz_Call.call_list
sM $$ E"&&E $ ((r" )r! r NFT)r! NNFT)r r r r r rA r rg r rD r r, r. r rQ rR r r8 r! r" r# r r s| $ :? 8@ >C )2Fj ]]FN>2 - - - -:*
)r" r )r c t | r t | } t | t }t | rt d| d t | }d| i} |rd| i} n| i } | r|rd| d< |s t
| |j d| }|}
|d }
| j | t } t j | ri } n=|r|r t d
t } n't | st } n|r|rt! | st } | d|||
|d | } t | t" rt% | | } |rt' | nt) | | || ||s| |j* |< |j d d }
|r |sd
|vrt- | |dd| |
| _ t1 | D ] }t3 | r t5 | | }d|i}|
r t9 |
| r|j | |rd|i}t |t" s t; ||| || }|| j* |< n~| }t | t" r | j< }t? | || }||d< tA | rt }nt } |d||||d|}|| j* |< | |_ t) ||| t |t" stC | || t | r|r | jD di | | S # t6 $ r Y Cw xY w)a Create a mock object using another object as a spec. Attributes on the
mock will use the corresponding attribute on the `spec` object as their
spec.
Functions or methods being mocked will have their arguments checked
to check that they are called with the correct signature.
If `spec_set` is True then attempting to set attributes that don't exist
on the spec object will raise an `AttributeError`.
If a class is used as a spec then the return value of the mock (the
instance of the class) will have the same spec. You can use a class as the
spec for an instance object by passing `instance=True`. The returned mock
will only be callable if instances of the mock are callable.
`create_autospec` will raise a `RuntimeError` if passed some common
misspellings of the arguments autospec and spec_set. Pass the argument
`unsafe` with the value True to disable that check.
`create_autospec` also takes arbitrary keyword arguments that are passed to
the constructor of the created mock.z'Cannot autospec a Mock object. [object=r r r NTr rw r zJInstance can not be True when create_autospec is mocking an async function)r r r rw r r r% )rZ r- r r rd r )r rw r r )rY r! )#rh r7 r( r' r r3 r rG r r r+ isdatadescriptorr r
rd r
rn r> rz r r[ r r r r r r* rE r) r9 r=
_must_skipr r` r )r r rZ r r- r rR is_type
is_async_funcr8 r r5 r= wrappedrA ru child_kwargsr r rY child_klasss r# r r
s . ~ Dzt$G "**. 4 5 5"4(MtnG t$
8'+#$ f% JJvu %EI NN6 E % > ?
?
t_$ X&8&>$ (W ( & (D $
& dD) d #tWh78(, u% jj$'GxN&$@ +D(T2629 ; T U tU+H ) ww. h / &1L(M2 XxuhGC),D &F$
. "48I(1L %"8, ' ' BV%5*0B4@BC),D & *}C Xsi @ c= ) D% %g n 6%f% KU s J?? K K c , t | t s |t | di v ry| j } | j D ]X }|j
j
|t }|t u r,t |t t f r yt |t r|c S y |S )z[
Return whether we should skip the first argument on spec's `entry`
attribute.
rk F) r( r7 r* r, rj rk rl r rC rB r> )r rA r< r rv s r# r; r; ( s
dD ! GD*b1 1~~ ##E73 W f|[ 9 :
. N Nr" c e Zd Z ddZy)r9 Nc X || _ || _ || _ || _ || _ || _ y r5 )r idsr r rZ rw )rP r r r rw rD rZ s r# rA z_SpecState.__init__F s,
r" )FNNNF)r r r rA r! r" r# r9 r9 D s
48/4r" r9 c v t | t rt j | S t j | S r5 )r( bytesioBytesIOStringIO) read_datas r#
_to_streamrK \ s* )U#zz)$${{9%%r" c d
t }|dg
fd}
fd}
fd
fd
fd}t Vddl}t t t |j j t t |j at +ddl}t t t |j a | t dt } t t
j _
d j _
d j _
d j _
d j" _
| j _
d <
d j _ | j" _ j& _ | j( _
fd }|| _ | _
| S )
a
A helper function to create a mock to replace the use of `open`. It works
for `open` called directly or used as a context manager.
The `mock` argument is the mock object to configure. If `None` (the
default) then a `MagicMock` will be created for you, with the API limited
to methods or attributes available on standard file handles.
`read_data` is a string for the `read`, `readline` and `readlines` of the
file handle to return. This is an empty string by default.
Nc j j j j S d j | i |S r0 ) readlinesr rQ rR _statehandles r# _readlines_side_effectz)mock_open.._readlines_side_effectr sC ( ( 4##00 0"vay""D3F33r" c j j j j S d j | i |S r0 )readr rO s r# _read_side_effectz$mock_open.._read_side_effectw s= ;; # # /;;++ + vay~~t.v..r" c ? ` K E d { d j | i | 7 wr0 )readline)rQ rR _iter_side_effectrP s r# _readline_side_effectz(mock_open.._readline_side_effect| s< $&&&$&)$$d5f5 5 's ., .c 3 K j j j j d D ] } | y wr0 )rW r )linerP rQ s r# rX z$mock_open.._iter_side_effect sB ?? ' ' 3 oo222 1IDJ s A Ac x j j j j S t d S r0 )rW r r )rP rQ s r# _next_side_effectz$mock_open.._next_side_effect s1 ?? ' ' 3??// /F1I r" r open)rw r )r r c t d< j j d k( r d< d j _ t S )Nr r )rK rW r r )rQ rR rY rP rQ rJ s r#
reset_dataz mock_open..reset_data sH y)q ?? & &&) 3-/F1I*0)FOO 'r" )rK file_spec_iorf ri r
TextIOWrapperunionrH open_specr^ r r: r writerT rW rN r r r ) r= rJ
_read_datarR rU r] rb r` rX rY rP rQ s ` @@@@r# r r c sW I&J$
F4
/
6
S!2!2 34::3s3;;?O;PQR S]+, |f95
I
&F$*F! $FLL #FKK #'FOO $(F! /FKK%'F1I"()FOO #9F "3FOO "3FOO "D D Kr" c $ e Zd ZdZd ZddZd Zy)r aW
A mock intended to be used as a property, or other descriptor, on a class.
`PropertyMock` provides `__get__` and `__set__` methods so you can specify
a return value when it is fetched.
Fetching a `PropertyMock` instance from an object calls the mock, with
no args. Setting it calls the mock with the value being set.
c t di |S )Nr! )r )rP rR s r# r' z PropertyMock._get_child_mock s "6""r" Nc | S r5 r! )rP r. obj_types r# r~ zPropertyMock.__get__ s v
r" c | | y r5 r! )rP r. rI s r# r zPropertyMock.__set__ s S r" r5 )r r r r r' r~ r r! r" r# r r s #r" r c d| _ t | D ]d } t | | }t |t
s!t |j j | t rK|j | u sZt | f y# t $ r Y sw xY w)a Disable the automatic generation of child mocks.
Given an input Mock, seals it to ensure no further mocks will be generated
when accessing an attribute that was not already defined.
The operation recursively seals the mock passed in, meaning that
the mock itself, any mocks generated by accessing one of its attributes,
and all assigned mocks without a name or spec will be sealed.
TN) r r r* rE r( r r rl r9 r r )r= r r s r# r r s DD d#A !_- a&&**40* = % G s A;; BBc e Zd ZdZd Zd Zy)r z8
Wraps an iterator in an asynchronous iterator.
c z || _ t t }t j |_ || j d< y )Nr r1 )iteratorr r r+ CO_ITERABLE_COROUTINEr rk )rP rp r s r# rA z_AsyncIterator.__init__ s/
#X6 $ : : $-
j!r" c ^ K t | j S # t $ r Y t w xY wwr5 )r rp r r r s r# r z_AsyncIterator.__anext__ s1
& & s - - *-*-N)r r r r rA r r! r" r# r r s . !r" r r )NFNNN)FFNN)Nr )__all__r r rG r+ r r2 builtinsrH r typesr r r
unittest.utilr functoolsr r threadingr r r r rV r( r r r r/ r3 r' r: r? rK r[ rV rd rh rn rz rt r r rg r r r r MISSINGr{ DELETEDr: r r rf r r r r r frozenset removeprefixrW r r3 r r r r rJ rO rS r rV rn rv rY multiplestopallr
magic_methodsnumericsr\ rF inplaceright
_non_defaultsrv r r _sync_async_magics
_async_magicsr rU ru r r r r r r r r r r r
r r r rF rA r r rG r r
r r r~ rg r r r r; r9 r7 r r> ra re rK r r r r )rw r s 00r# r s &
' 2 2 # $ Cy C "(m Hmd4??33GTm H
@2 F #
& 6."b>6) )f ) ;
&* *(6
6
X
: j G
D GB" "$!!!'(*;*;T"BCIh-K
E+T E+P( (V
6
f$$v)E v)r
u CG S*/Sl8
&Od4 $0! !e]
IP l d Is* N;3N;0)O & O:+O
OO