a
i @ s d Z ddlZddlZddlZddlZddlZddlZddlZddlmZ ddl m
Z
m Z m Z ddl
mZ ddlmZmZ dd eeD Zd ZeZd
d Zd d
Zdd Zdd Zdd Zdd Z dddZ dd Z dd Z d d Z d d Z!dd!d"Z"d#d$ Z#d%d& Z$d'd( Z%G d)d* d*e&Z'G d+d, d,e&Z(e( Z)e)j*Z*e)j+Z,e)j-Z.h d-Z/d.d/ Z0G d0d1 d1e1Z2d2d3 Z3G d4d5 d5e&Z4G d6d7 d7e&Z5G d8d9 d9e5Z6e7e6j8Z9G d:d; d;e1Z:dd? d?e5ZdDdE Z?G dFdG dGe&Z@dHdI ZAe*dddddfdJdKZBddLdMZCe*dddddfdNdOZDG dPdQ dQe&ZEdRdS ZFdTdU ZGeBeD_&eEeD_HeCeD_IeGeD_JdVeD_KdWZLdXZMdYNdZd[ eMO D ZPdYNd\d[ eMO D ZQh d]ZRd^d_ ZSd`d dYNeLeMePeQgO D ZTh daZUdbhZVeUeVB ZWeTeRB ZXeXeWB ZYh dcZZddde dfde dgde dhde diZ[e\e\e\e\djddddkdld djddm
Z]dndo Z^dpdq Z_drds Z`dtdu Zae^e_e`eadvZbdwdx ZcG dydz dze5ZdG d{d| d|ede6ZeG d}d~ d~edZfG dd dede=ZgG dd de5ZhG dd de5ZiG dd deiefe=ZjG dd de&Zkek Zldd ZmG dd denZoeoddZpdddZqdd ZrG dd de&ZseteqeteljufZvdawdd ZxdddZyG dd de=Zzdd Z{G dd dZ|dS ))Mock MagicMockpatchsentinelDEFAULTANYcallcreate_autospec AsyncMock
FILTER_DIRNonCallableMockNonCallableMagicMock mock_open PropertyMockseal N)iscoroutinefunction)CodeType
ModuleType
MethodType) safe_repr)wrapspartialc C s h | ]}| d s|qS _
startswith).0name r %/usr/lib64/python3.9/unittest/mock.py ' r Tc C s< t | rt| tsdS t| dr*t| d} t| p:t| S )NF__func__)_is_instance_mock
isinstancer hasattrgetattrr inspectZ isawaitableobjr r r
_is_async_obj/ s
r* c C s t | dd rt| S dS d S )N__code__F)r& r funcr r r _is_async_func7 s r. c C s t t| tS N)
issubclasstyper r( r r r r# > s r# c C s t | tp t | to t| tS r/ )r$
BaseExceptionr1 r0 r( r r r
_is_exceptionD s
r3 c C s" t | trt| dr| jS | S d S Nmock)r$
FunctionTypesr% r5 r( r r r
_extract_mockK s r7 c C s t | tr|s| j} d}n*t | tsDz
| j} W n tyB Y dS 0 |rTt| d}n| }z| t|fW S t y| Y dS 0 dS )z
Given an arbitrary, possibly callable object, try to create a suitable
signature object.
Return a (reduced func, signature) tuple, or None.
TN)
r$ r1 __init__r6 __call__AttributeErrorr r' signature
ValueError)r- Z as_instanceZeat_selfZsig_funcr r r _get_signature_objectT s
r= Fc sN t | || d u rd S \} fdd}t| | |t|_ t|_d S )Nc s j |i | d S r/ bindselfargskwargssigr r checksigv s z"_check_signature..checksig)r= _copy_func_detailsr1 _mock_check_sig
__signature__)r- r5 skipfirstinstancerF r rD r _check_signatureq s
rL c C s8 dD ].}zt ||t| | W q ty0 Y q0 qd S )N)__name____doc____text_signature__
__module__ __defaults____kwdefaults__)setattrr& r: )r- funcopy attributer r r rG } s
rG c C s@ t | trdS t | tttfr(t| jS t| dd d ur rB rC rD r r rF s z _set_signature..checksigrT )Z
_checksig_r5 zYdef %s(*args, **kwargs):
_checksig_(*args, **kwargs)
return mock(*args, **kwargs))r$ r1 r= rG rM isidentifierexec _setup_func) r5 originalrK rJ resultr- rF r contextsrcrT r rD r _set_signature s$
ri c s _ fdd}fdd}fdd}fdd}fd d
}fd d }fd
d} fdd}
d _d _d _t _t _t _j _j _ j
_
| _ | _ | _
| _|
_| _| _| _| _ _d S )Nc s j | i |S r/ )assert_called_withra r5 r r rj s z'_setup_func..assert_called_withc s j | i |S r/ )
assert_calledra rk r r rl s z"_setup_func..assert_calledc s j | i |S r/ )assert_not_calledra rk r r rm s z&_setup_func..assert_not_calledc s j | i |S r/ )assert_called_oncera rk r r rn s z'_setup_func..assert_called_oncec s j | i |S r/ )assert_called_once_withra rk r r ro s z,_setup_func..assert_called_once_withc s j | i |S r/ )assert_has_callsra rk r r rp s z%_setup_func..assert_has_callsc s j | i |S r/ )assert_any_callra rk r r rq s z$_setup_func..assert_any_callc s: t _t _ j} t| r6| ur6| d S r/ ) _CallList method_calls
mock_calls
reset_mock return_valuer# )retrT r5 r r ru s z _setup_func..reset_mockFr )r5 called
call_count call_argsrr call_args_listrs rt rv side_effect_mock_childrenrj ro rp rq ru rl rm rn rI _mock_delegate) rT r5 rE rj rl rm rn ro rp rq ru r rx r rd s8 rd c sJ t jj _d _d _t _ fdd}dD ]}t |t|| q.d S )Nr c s t j| |i |S r/ )r& r5 )attrrB rC rk r r wrapper s z"_setup_async_mock..wrapper)assert_awaitedassert_awaited_onceassert_awaited_withassert_awaited_once_withassert_any_awaitassert_has_awaitsassert_not_awaited) asyncio
coroutines
_is_coroutine await_count
await_argsrr await_args_listrS r )r5 r rU r rk r _setup_async_mock s
r c C s d| dd | kS )N__%s__ r r r r r _is_magic s r c @ s( e Zd ZdZdd Zdd Zdd ZdS ) _SentinelObjectz!A unique, named, sentinel object.c C s
|| _ d S r/ r rA r r r r r8 s z_SentinelObject.__init__c C s
d| j S Nz sentinel.%sr rA r r r __repr__ s z_SentinelObject.__repr__c C s
d| j S r r r r r r
__reduce__ s z_SentinelObject.__reduce__N)rM rP __qualname__rN r8 r r r r r r r s r c @ s( e Zd ZdZdd Zdd Zdd ZdS ) _SentinelzAAccess attributes to return a named object, usable as a sentinel.c C s
i | _ d S r/ )
_sentinelsr r r r r8 " s z_Sentinel.__init__c C s |dkr t | j|t|S )N __bases__)r: r
setdefaultr r r r r __getattr__% s z_Sentinel.__getattr__c C s dS )Nr r r r r r r + s z_Sentinel.__reduce__N)rM rP r rN r8 r r r r r r r s r > _mock_return_value_mock_new_parentrv
_mock_name _mock_parent_mock_new_namer} _mock_side_effectc C s8 t | d| }| |fdd}| |fdd}t||S )NZ_mock_c S s" | j }|d u rt| |S t||S r/ )r r& )rA r _the_namerE r r r _get@ s
z"_delegating_property.._getc S s* | j }|d u r|| j|< n t||| d S r/ )r r] rS )rA valuer r rE r r r _setE s z"_delegating_property.._set)_allowed_namesaddproperty)r r r r r r r _delegating_property= s
r c @ s e Zd Zdd Zdd ZdS )rr c C sl t |tst| |S t|}t| }||kr2dS td|| d D ]"}| ||| }||krD dS qDdS )NFr T)r$ rY __contains__lenrange)rA r Z len_valueZlen_selfiZsub_listr r r r R s
z_CallList.__contains__c C s t t| S r/ )pprintZpformatrY r r r r r ` s z_CallList.__repr__N)rM rP r r r r r r r rr P s rr c C s| t |}t|sdS |js4|js4|jd us4|jd ur8dS | }|d urX||u rPdS |j}q<|rh| |_||_|rx| |_||_dS )NFT)r7 r# r r r r )parentr r new_name_parentr r r _check_and_set_parentd s* r c @ s e Zd Zdd Zdd ZdS ) _MockIterc C s t || _d S r/ )iterr) )rA r) r r r r8 s z_MockIter.__init__c C s
t | jS r/ )nextr) r r r r __next__ s z_MockIter.__next__N)rM rP r r8 r r r r r r s r c @ s e Zd ZeZdZdd ZdS )BaseNc O s d S r/ r r@ r r r r8 s z
Base.__init__)rM rP r r r r r8 r r r r r s r c @ sd e Zd ZdZdd ZdLddZd d
ZdMd d ZdNd
dZdd Z dd Z
dZ e e e
e Z
e dd ZedZedZedZedZedZdd Zd d Ze eeZdOddd d d!Zd"d# Zd$d% Zd&d' Zd(d) Z d*d+ Z d,d- Z d.d/ Z d0d1 Z dPd3d4Z!d5d6 Z"d7d8 Z#d9d: Z$d;d< Z%d=d> Z&d?d@ Z'dAdB Z(dQdCdDZ)dEdF Z*dGdH Z+dRdJdKZ,dS )Sr z A non-callable version of `Mock`c O s| | f}t | tsTtj| g|R i |j}|d|d}|d urTt|rTt| f}t| j|d| j i}t
t | |}|S )Nspec_setspecrN )
r0 AsyncMockMixin _MOCK_SIGZ bind_partialZ argumentsr^ r* r1 rM rN _safe_superr __new__)clsrB kwbasesZ
bound_argsZspec_argnewrK r r r r s
zNonCallableMock.__new__N Fc K s |d u r |}| j }
||
d< ||
d< ||
d< ||
d< d|
d< |d urJ|}d}|
d u rZ|d u}
| ||| |
i |
d< ||
d < d |
d
< d|
d < d |
d < d
|
d< t |
d< t |
d< t |
d< | |
d< | r| jf i | tt| |||||| d S )Nr r r r F _mock_sealedTr~ _mock_wrapsr Z _mock_calledZ_mock_call_argsr Z_mock_call_countZ_mock_call_args_listZ_mock_mock_callsrs _mock_unsafe)r] _mock_add_specrr configure_mockr r r8 )rA r r r r r _spec_state _new_name _new_parent_spec_as_instance _eat_selfZunsaferC r] r r r r8 s<
zNonCallableMock.__init__c C s0 t |}d|_d|_d|_d|_t| || dS )z
Attach a mock as an attribute of this one, replacing its name and
parent. Calls to the attached mock will be recorded in the
`method_calls` and `mock_calls` attributes of this one.Nr )r7 r r r r rS )rA r5 rU Z
inner_mockr r r attach_mock s zNonCallableMock.attach_mockc C s | || dS zAdd a spec to a mock. `spec` can either be an object or a
list of strings. Only attributes on the `spec` can be fetched as
attributes from the mock.
If `spec_set` is True then only attributes on the spec can be set.N)r rA r r r r r
mock_add_spec s z NonCallableMock.mock_add_specc C s d }d }g }t |D ] }tt||d r|| q|d ur|t|s|t|trT|}nt|}t|||} | or| d }t |}| j}
||
d< ||
d< ||
d< ||
d< ||
d< d S )Nr _spec_class _spec_set_spec_signature
_mock_methods _spec_asyncs) dirr r& appendr[ r$ r1 r= r] ) rA r r r r r r r r resr] r r r r s*
z NonCallableMock._mock_add_specc C s8 | j }| jd ur| jj}|tu r4| j| dd}|| _|S )N()r r )r r rv r _get_child_mock)rA rw r r r Z__get_return_value s
z"NonCallableMock.__get_return_valuec C s, | j d ur|| j _n|| _t| |d d d S )Nr )r rv r r )rA r r r r Z__set_return_value s
z"NonCallableMock.__set_return_valuez1The value to be returned when the mock is called.c C s | j d u rt| S | j S r/ )r r1 r r r r __class__ s
zNonCallableMock.__class__ry rz r{ r| rt c C sN | j }|d u r| jS |j}|d urJt|sJt|tsJt|sJt|}||_|S r/ )r r r} callabler$ r r3 )rA delegatedZsfr r r Z__get_side_effect' s z!NonCallableMock.__get_side_effectc C s( t |}| j}|d u r || _n||_d S r/ ) _try_iterr r r} )rA r r r r r Z__set_side_effect2 s
z!NonCallableMock.__set_side_effectrv r} c C s |du r g }t | |v r dS |t | d| _d| _d| _t | _t | _t | _|r^t | _
|rhd| _ | j
D ](}t|tsr|tu rqr|j|||d qr| j
}t|r|| ur|| dS )z-Restore the mock object to its initial state.NFr r )idr ry r{ rz rr rt r| rs r r r r~ valuesr$
_SpecState_deletedru r# )rA Zvisitedrv r} childrw r r r ru = s, zNonCallableMock.reset_mockc K sX t | dd dD ]>\}}|d}| }| }|D ]}t||}q6t||| qdS )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 S s | d dS )Nr .)count)entryr r r h r! z0NonCallableMock.configure_mock..)keyr N)sorteditemssplitpopr& rS )rA rC argvalrB finalr) r r r r r [ s
z NonCallableMock.configure_mockc C s |dv rt |n:| jd ur<|| jvs.|tv rLt d| nt|rLt || jsd|drdt d| j|}|tu rt |np|d u rd }| j d urt
| j |}| j | |||| d}|| j|< n.t |t
rt|j|j|j|j|j}|| j|< |S )N> r r z Mock object has no attribute %r)assertZassretz1Attributes cannot start with 'assert' or 'assret')r r r r r )r: r _all_magicsr r r r~ r^ r r r& r r$ r r r r rK r r )rA r rf r r r r r q s:
zNonCallableMock.__getattr__c C s | j g}| j}| }d}|dgkr$d}|d urZ|}||j | d}|j dkrRd}|j}q$tt|}|jpnd}t|dkr|d dvr|d7 }||d< d|S )Nr r r r5 r )r z().r )r r r rY reversedr r join)rA Z
_name_listr lastdotZ_firstr r r _extract_mock_name s(
z"NonCallableMock._extract_mock_namec C s^ | }d}|dvr d| }d}| jd urDd}| jr8d}|| jj }dt| j||t| f S )Nr )r5 zmock.z name=%rz spec=%rz spec_set=%rz<%s%s%s id='%s'>)r r r rM r1 r )rA r Z name_stringZ spec_stringr r r r s
zNonCallableMock.__repr__c C sv t st| S | jpg }tt| }t| j}dd | j D }dd |D }dd |D }t
t || | | S )z8Filter the output of `dir(mock)` to only useful members.c S s g | ]\}}|t ur|qS r )r )r Zm_nameZm_valuer r r
s z+NonCallableMock.__dir__..c S s g | ]}| d s|qS r r r er r r r r! c S s" g | ]}| d rt|r|qS r )r r r r r r r s ) r
object__dir__r r r1 rY r] r~ r r set)rA extrasZ from_typeZ from_dictZfrom_child_mocksr r r r s
zNonCallableMock.__dir__c sT |t v rt||S jrHjd urH|jvrH|jvrHtd| n|tv rbd| }t|n|tv rjd ur|jvrtd| t |st
t |t || | fdd}n(t
|d | t
t || |j|< n,|dkr|_d S t
|||r|j|< jrFt|sF d| }td| t||S )Nz!Mock object has no attribute '%s'z.Attempting to set unsupported magic method %r.c s g| R i |S r/ r rB r re rA r r r r! z-NonCallableMock.__setattr__..r r z Cannot set )r r __setattr__r r r] r: _unsupported_magicsr r# rS r1 _get_methodr r~ r r r% r )rA r r msg mock_namer r r r s<
zNonCallableMock.__setattr__c C s |t v r2|t| jv r2tt| | || jvr2d S | j|t}|| jv r\tt| | n|t
u rlt ||tur|| j|= t
| j|< d S r/ ) r r1 r] delattrr~ r^ _missingr r __delattr__r r: )rA r r) r r r r s
zNonCallableMock.__delattr__c C s | j pd}t|||S r4 )r _format_call_signaturerA rB rC r r r r _format_mock_call_signature s
z+NonCallableMock._format_mock_call_signaturer c C s. d}| ||}| j}| j | }||||f S )Nz.expected %s not found.
Expected: %s
Actual: %s)r r{ )rA rB rC actionmessageexpected_stringr{ Z
actual_stringr r r _format_mock_failure_message s
z,NonCallableMock._format_mock_failure_messagec C sj |s
| j S d}|ddd}| j}|D ]:}||}|du sJt|trP qfq*t|}|j}|j }q*|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 replacer r~ r^ r$ r r7 )rA r rE namesZchildrenr r r r _get_call_signature_from_name s
z-NonCallableMock._get_call_signature_from_namec
C s t |tr&t|dkr&| |d }n| j}|durt|dkrNd}|\}}n
|\}}}z"|j|i |}t||j|jW S t y } z|
dW Y d}~S d}~0 0 n|S dS )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$ rZ r r r r? r rB rC TypeErrorwith_traceback)rA _callrE r rB rC Z
bound_callr r r r
_call_matcherA s
"z NonCallableMock._call_matcherc C s0 | j dkr,d| jpd| j | f }t|dS )z/assert that the mock was never called.
r z9Expected '%s' to not have been called. Called %s times.%sr5 Nrz r _calls_reprAssertionErrorrA r r r r rm \ s
z!NonCallableMock.assert_not_calledc C s$ | j dkr d| jpd }t|dS )z6assert that the mock was called at least once
r z"Expected '%s' to have been called.r5 N)rz r r r! r r r rl f s
z NonCallableMock.assert_calledc C s0 | j dks,d| jpd| j | f }t|dS )z3assert that the mock was called only once.
r z:Expected '%s' to have been called once. Called %s times.%sr5 Nr r! r r r rn n s
z"NonCallableMock.assert_called_oncec s j du r. }d}d||f }t| fdd}t fdd}j }||krt|trv|nd}t| |dS )zassert that the last call was made with the specified arguments.
Raises an AssertionError if the args and keyword args passed in are
different to the last call to the mock.Nz not called.z0expected call not found.
Expected: %s
Actual: %sc s } | S r/ r r rB rC rA r r _error_message s z:NonCallableMock.assert_called_with.._error_messageTtwo)r{ r r r _Callr$ Exception)rA rB rC expectedactualZ
error_messager% causer r$ r rj x s
z"NonCallableMock.assert_called_withc O s< | j dks,d| jpd| j | f }t|| j|i |S )ziassert that the mock was called exactly once and that that call was
with the specified arguments.r z3Expected '%s' to be called once. Called %s times.%sr5 )rz r r r rj rA rB rC r r r r ro s
z'NonCallableMock.assert_called_once_withc s fdd|D }t dd |D d}t fdd jD }|s||vr|du rXd}ndd d |D }t| d
t| jd d d
|dS t|}g }|D ]0}z|| W q t y |
| Y q0 q|rtd j pdt ||f |dS )a assert the mock has been called with the specified calls.
The `mock_calls` list is checked for the calls.
If `any_order` is False (the default) then the calls must be
sequential. There can be extra calls before or after the
specified calls.
If `any_order` is True then the calls can be in any order, but
they must all appear in `mock_calls`.c s g | ]} |qS r r r cr r r r r! z4NonCallableMock.assert_has_calls..c s s | ]}t |tr|V qd S r/ r$ r) r r r r r! z3NonCallableMock.assert_has_calls..Nc 3 s | ]} |V qd S r/ r. r/ r r r r2 r! zCalls not found.z+Error processing expected calls.
Errors: {}c S s g | ]}t |tr|nd qS r/ r1 r r r r r s
Expected: ZActual)prefixr z@%r does not contain all of %r in its call list, found %r insteadr5 )
r rr rt formatr r rstriprY remover< r r rZ ) rA calls any_orderr* r, Z all_callsproblem not_foundkallr r r rp sN
z NonCallableMock.assert_has_callsc sj t||fdd}t|tr$|nd} fdd jD }|sL|t|vrf ||}td| |dS )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& Nc s g | ]} |qS r r. r/ r r r r r! z3NonCallableMock.assert_any_call..z%s call not found)r r( r$ r) r| _AnyComparerr r rA rB rC r* r, r+ r r r r rq s z NonCallableMock.assert_any_callc K s | d}|| jd v r&tf i |S | jrZd|v rBd|d nd}| | }t|t| }t|trz|t v rzt}nbt|t
r|t v s| j r|| j v rt}qt}n4t|t
st|trt}qt|trt}n
|jd }|f i |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).r r r r r r )r^ r] r r r r: r1 r0 r _async_method_magicsr _all_sync_magicsr
CallableMixinr r r r\ )rA r r rU r _typeklassr r r r s2
z NonCallableMock._get_child_mockCallsc C s" | j s
dS d| 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 )rt r )rA r4 r r r r s zNonCallableMock._calls_repr) NNNNNNr NFNF)F)FF)N)r )F)rD )-rM rP r rN r r8 r r r Z"_NonCallableMock__get_return_valueZ"_NonCallableMock__set_return_valueZ"_NonCallableMock__return_value_docr rv r r ry rz r{ r| rt Z!_NonCallableMock__get_side_effectZ!_NonCallableMock__set_side_effectr} ru r r r r r r r r r r r rm rl rn rj ro rp rq r r r r r r r s`
-
''
!
-&r c @ s e Zd ZdZdd ZdS )r= zA list which checks if it contains a call which may have an
argument of ANY, flipping the components of item and self from
their traditional locations so that ANY is guaranteed to be on
the left.c C s@ | D ]6}t |t |ks J tdd t||D r dS qdS )Nc S s g | ]\}}||kqS r r )r r* r+ r r r r s z-_AnyComparer.__contains__..TF)r allzip)rA itemr r r r r s z_AnyComparer.__contains__N)rM rP r rN r r r r r r=
s r= c C sJ | d u r | S t | r| S t| r$| S z
t| W S tyD | Y S 0 d S r/ )r3 rX r r r( r r r r s
r c
@ sR e Zd Zddedddddddf
ddZdd Zdd Zd d
Zd d Zd
d Z dS )rA Nr c K s: || j d< tt| j||||||| |
fi | || _d S )Nr )r] r rA r8 r} ) rA r r} rv r r r r r r r rC r r r r8 . s
zCallableMixin.__init__c O s d S r/ r r@ r r r rH : s z CallableMixin._mock_check_sigc O s0 | j |i | | j|i | | j|i |S r/ )rH _increment_mock_call
_mock_callr@ r r r r9 ? s zCallableMixin.__call__c O s | j |i |S r/ )_execute_mock_callr@ r r r rJ G s zCallableMixin._mock_callc O s d| _ | jd7 _t||fdd}|| _| j| | jd u}| j}| j}|dk}| j td||f | j
}|d ur|r|j t|||f |jd u}|r|jd | }t|||f} |j | |jr|rd}
nd}
|jdk}|j|
| }|j
}qpd S )NTr r& r r r ) ry rz r( r{ r| r r r r rt r rs ) rA rB rC r Zdo_method_callsZmethod_call_nameZmock_call_nameZ is_a_callr Zthis_mock_callr r r r rI J s4
z"CallableMixin._increment_mock_callc O s | j }|d urTt|r |n,t|s:t|}t|rH|n||i |}|turT|S | jturd| jS | jd ur~| j|i |S | jS r/ )r} r3 rX r r r rv r )rA rB rC effectrf r r r rK x s
z CallableMixin._execute_mock_call)
rM rP r r r8 rH r9 rJ rI rK r r r r rA , s
.rA c @ s e Zd ZdZdS )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.
* `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.
NrM rP r rN r r r r r s r c C s6 z t | |W S ty0 t| t | | Y S 0 d S r/ )r& r:
__import__)thingcomp import_pathr r r _dot_lookup s
rR c C sB | d}|d}t|}|D ] }|d| 7 }t|||}q |S )Nr r z.%s)r r rN rR )target
componentsrQ rO rP r r r _importer s
rU c @ sz e Zd ZdZg Zdd Zdd Zdd Zdd Ze j
d
d Z d d
Z dd Z
dd Zdd Zdd Zdd Zdd ZdS )_patchNc
C sn |d ur(|t urtd|d ur(td|| _|| _|| _|| _|| _|| _d| _|| _ || _
| | _ g | _ d S )Nz,Cannot use 'new' and 'new_callable' togetherz1Cannot use 'autospec' and 'new_callable' togetherF)
r r< getterrU r new_callabler createZ has_localr autospecrC additional_patchers)
rA rW rU r r rY r rZ rX rC r r r r8 s( z_patch.__init__c
C sH t | j| j| j| j| j| j| j| j| j }| j
|_
dd | j D |_ |S )Nc S s g | ] }| qS r )copy)r pr r r r s z _patch.copy..) rV rW rU r r rY r rZ rX rC attribute_namer[ )rA patcherr r r r\ s z _patch.copyc C s2 t |tr| |S t|r(| |S | |S r/ )r$ r1 decorate_classr' r decorate_async_callabledecorate_callablerA r- r r r r9 s
z_patch.__call__c C sN t |D ]@}|tjsqt||}t|ds0q| }t|||| q|S Nr9 )r r r TEST_PREFIXr& r% r\ rS )rA rC r
attr_valuer_ r r r r` s
z_patch.decorate_classc c s g }t f}|jD ]8}||}|jd ur8|| q|jtu r|| q|t |7 }||fV W d n1 sx0 Y d S r/ )
contextlib ExitStack patchings
enter_contextr^ updater r r rZ )rA patchedrB keywargs
extra_args
exit_stackpatchingr r r r decoration_helper s
z_patch.decoration_helperc s> t dr j S t fddg_S )Nri c sD | |"\}} |i |W d S 1 s60 Y d S r/ rq rB rm ZnewargsZ newkeywargsr- rl rA r r rl 3 s z)_patch.decorate_callable..patchedr% ri r r rc r rt r rb - s
z_patch.decorate_callablec s> t dr j S t fddg_S )Nri c sJ | |(\}} |i |I d H W d S 1 s<0 Y d S r/ rr rs rt r r rl D s z/_patch.decorate_async_callable..patchedru rc r rt r ra > s
z _patch.decorate_async_callablec C s | }| j}t}d}z|j| }W n" ttfyF t||t}Y n0 d}|tv rdt|t rdd| _
| j
s|tu rtd||f ||fS )NFTz!%s does not have the attribute %r) rW rU r r] r: KeyErrorr& _builtinsr$ r rY )rA rS r re localr r r get_originalO s
z_patch.get_originalc C s | j | j| j }}}| j| j }}| j}| | _|du r@d}|du rLd}|du rXd}|durp|durptd|dus|dur|dvrtd| \}}|t
u r|du rd} |du r|}|du r|}d}n&|dur|du r|}d}n |du r|}|dus |dur.|t
u r tdt |t r.d} |du rHt
|rHt}
nt}
i } |dur`|}
n^|dust|dur|} |dur|} t| rd| v}
n
t| }
t
| rt}
n
|
rt}
|dur|| d < |dur|| d
< t |
t r t|
tr | jr | j| d < | | |
f i | }| rt|r|} |durF|} t| s^t| s^t}
| d |
f |d d
| |_nl|dur|t
urtd|t
u rtdt|}|du r|}t |f|| jd|}n|rtd|}|| _ || _ t | _!zrt"| j| j| | j#durti }| j t
u r>||| j#< | j$D ](}| j!%|}|j t
u rD|| qD|W S |W S | j&t'( s Y n0 dS )zPerform the patch.FNz Can't specify spec and autospec)TNz6Can't provide explicit spec_set *and* spec or autospecTz!Can't use 'spec' with create=Truer9 r r r r r zBautospec creates the mock for you. Can't specify autospec and new.z%Can't use 'autospec' with create=True)r _namez.Can't pass kwargs to a mock we aren't creating))r r r rZ rC rX rW rS r ry r r$ r1 r* r r r[ r r r0 r rU rk r# r` r rv boolr
temp_originalis_localrg rh _exit_stackrS r^ r[ rj __exit__sysexc_info)rA r r r rZ rC rX re rx ZinheritKlass_kwargsZ this_specZ not_callableZnew_attrrn rp r r r r __enter__g s
z_patch.__enter__c G s | j r$| jtur$t| j| j| j n>t| j| j | jsbt| j| jrP| jdv rbt| j| j| j | `| ` | `| j }| ` |j
| S )zUndo the patch.)rN rP rQ __annotations__rR ) r} r| r rS rS rU r
rY r% r~ r )rA r ro r r r r s z_patch.__exit__c C s | }| j| |S z-Activate a patch, returning any created mock.)r _active_patchesr rA rf r r r start s z _patch.startc C s4 z| j | W n ty$ Y dS 0 | dddS zStop an active patch.N)r r7 r< r r r r r stop s
z _patch.stop)rM rP r r^ r r8 r\ r9 r` rg contextmanagerrq rb ra ry r r r r r r r r rV s
rV c
sP z dd\ }W n& tttfy: td Y n0 fdd}||fS )Nr r z,Need a valid target to patch. You supplied: c s t S r/ rU r rS r r r r! z _get_target..)rsplitr r< r: )rS rU rW r r r _get_target s
r c
s> t tu rt d fdd} 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 S r/ r r r r r r 5 r! z _patch_object..)r1 strr rV )
rS rU r r rY r rZ rX rC rW r r r
_patch_object s
r c
s t tu r fdd}n fdd}|s2tdt| }|d \} }
t|| |
|||||i } | | _|dd D ]2\} }
t|| |
|||||i } | | _| j| qt| 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 t S r/ r r r r r r S r! z!_patch_multiple..c s S r/ r r r r r r U r! z=Must supply at least one keyword argument with patch.multipler r N) r1 r r< rY r rV r^ r[ r )
rS r rY r rZ rX rC rW r rU r r_ Z this_patcherr r r _patch_multiple< s, r c
K s$ t | \}} t|| ||||||| S )az
`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` 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 rV )
rS r r rY r rZ rX rC rW rU r r r r m s
G
r c @ sZ e Zd ZdZdddZdd Zdd Zd
d Zd d
Zdd Z dd Z
dd Z dd Z dS ) _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.
r Fc K s, || _ t|| _| j| || _d | _d S r/ )in_dictdictr rk clear _original)rA r r r rC r r r r8 s
z_patch_dict.__init__c s. t tr S t fdd}|S )Nc s0 z | i |W S 0 d S r/ )r
_unpatch_dictr frA r r _inner s z$_patch_dict.__call__.._inner)r$ r1 r` r )rA r r r r r r9 s
z_patch_dict.__call__c C sX t |D ]J}t||}|tjrt|drt| j| j| j }||}t
||| q|S rd ) r r& r r re r% r r r r rS )rA rC r rf decoratorZ decoratedr r r r` s
z_patch_dict.decorate_classc C s | | jS )zPatch the dict.)r r r r r r r s z_patch_dict.__enter__c C s | j }t| jtr t| j| _| j}| j}z | }W n, tyb i }|D ]}|| ||< qLY n0 || _|rvt | z|
| W n( ty |D ]}|| ||< qY n0 d S r/ ) r r$ r r rU r r\ r: r _clear_dictrk )rA r r r re r r r r r s& z_patch_dict._patch_dictc C sP | j }| j}t| z|| W n( tyJ |D ]}|| ||< q4Y n0 d S r/ )r r r rk r: )rA r re r r r r r s z_patch_dict._unpatch_dictc G s | j dur| dS )zUnpatch the dict.NF)r r )rA rB r r r r ) s
z_patch_dict.__exit__c C s | }tj| |S r )r rV r r r r r r r 0 s z_patch_dict.startc C s4 zt j| W n ty$ Y dS 0 | dddS r )rV r r7 r< r r r r r r 7 s
z_patch_dict.stopN)r F)
rM rP r rN r8 r9 r` r r r r r r r r r r r s
r c C s< z | W n* ty6 t| }|D ]
}| |= q&Y n0 d S r/ )r r: rY )r keysr r r r r B s r c C s t tjD ] } | q
dS )z7Stop all active patches. LIFO to unroll nested patches.N)r rV r r )r r r r _patch_stopallK s r 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 zHadd sub mul matmul div floordiv mod lshift rshift and xor or pow truediv c c s | ]}d | V qdS )zi%sNr r nr r r r2 j r! r2 c c s | ]}d | V qdS )zr%sNr r r r r r2 k r! >
__setformat__ __setstate____get__
__getformat__r r __getstate____getinitargs__
__reduce_ex__
__format__
__delete____getnewargs__ __missing____set____subclasses____getnewargs_ex__r __reversed__c s fdd}| |_ |S )z:Turns a callable object (like a mock) into a real functionc s | g|R i |S r/ r rA rB r r, r r method| s z_get_method..method)rM )r r- r r r, r r
z s r
c C s h | ] }d | qS )r r )r r r r r r s > __anext__ __aexit__
__aenter__ __aiter__> __subclasscheck__r r r __del____instancecheck__r8 __prepare__c C s
t | S r/ )r __hash__r r r r r r! r c C s
t | S r/ )r __str__r r r r r r! c C s
t | S r/ )r
__sizeof__r r r r r r! c C s" t | j d| dt| S )N/)r1 rM r r r r r r r r! )r r r
__fspath__r y ?g ?)
__lt____gt____le____ge____int__r __len__r __complex__ __float____bool__ __index__r c s fdd}|S )Nc s$ j j}|tur|S | u r dS tS NT)__eq__r r NotImplemented)otherret_valr r r r s z_get_eq..__eq__r )rA r r r r _get_eq s r c s fdd}|S )Nc s j jturtS | u r dS tS NF)__ne__r r r )r r r r r s
z_get_ne..__ne__r )rA r r r r _get_ne s r c s fdd}|S )Nc s j j} | tu rtg S t| S r/ )__iter__r r r r r r r r s z_get_iter..__iter__r )rA r r r r _get_iter s r c s fdd}|S )Nc s( j j} | tu r ttg S tt| S r/ )r r r _AsyncIteratorr r r r r r s z"_get_async_iter..__aiter__r )rA r r r r _get_async_iter s r )r r r r c C sb t |t}|tur ||_d S t|}|d urB|| }||_d S t|}|d ur^|| |_d S r/ )_return_valuesr^ r rv _calculate_return_value_side_effect_methodsr} )r5 r r fixedZreturn_calculatorrv Z
side_effectorr r r _set_return_value s
r c @ s e Zd Zdd Zdd ZdS )
MagicMixinc O s* | tt| j|i | | d S r/ )_mock_set_magicsr r r8 r r r r r8 s zMagicMixin.__init__c C s t tB }|}t| dd d urX|| j}t }|| }|D ] }|t| jv r:t| | q:|tt| j }t| }|D ]}t ||t
|| qvd S )Nr ) _magicsr? r& intersectionr r r1 r] r
rS
MagicProxy)rA Z orig_magicsZ these_magicsZ
remove_magicsr rB r r r r s zMagicMixin._mock_set_magicsN)rM rP r r8 r r r r r r s r c @ s e Zd ZdZdddZdS )r z-A version of `MagicMock` that isn't callable.Fc C s | || | dS r r r r r r r r s z"NonCallableMagicMock.mock_add_specN)FrM rP r rN r r r r r r s r c @ s e Zd Zdd ZdS )AsyncMagicMixinc O s* | tt| j|i | | d S r/ )r r r r8 r r r r r8 s zAsyncMagicMixin.__init__NrM rP r r8 r r r r r s r c @ s e Zd ZdZdddZdS )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 C s | || | dS r r r r r r r + s zMagicMock.mock_add_specN)Fr r r r r r s
r c @ s& e Zd Zdd Zdd ZdddZdS ) r c C s || _ || _d S r/ r r )rA r r r r r r8 7 s zMagicProxy.__init__c C s8 | j }| j}|j|||d}t||| t||| |S )N)r r r )r r r rS r )rA r r mr r r create_mock; s zMagicProxy.create_mockNc C s | S r/ )r )rA r) rB r r r r D s zMagicProxy.__get__)N)rM rP r r8 r r r r r r r 6 s r c s e Zd ZedZedZedZ fddZdd Zdd Z d
d Z
d d
Z dd Z dd Z
dddZdd Z fddZ ZS )r r r r c s` t j|i | tjj| jd< d| jd< d | jd< t | jd< ttd}t j
|_ || jd< d S )Nr r Z_mock_await_countZ_mock_await_argsZ_mock_await_args_listr r+ ) superr8 r r r r] rr r r r' Z CO_COROUTINEco_flags)rA rB rC code_mockr r r r8 M s
zAsyncMockMixin.__init__c s t ||fdd}| jd7 _|| _| j| | j}|d urt|rL|nft|sz t|}W n t yv t
Y n0 t|r|n,t |r||i |I d H }n||i |}|t ur|S | j
t ur| jS | jd ur
t | jr| j|i |I d H S | j|i |S | jS )NTr& r )r( r r r r r} r3 rX r
StopIterationStopAsyncIterationr r r rv r )rA rB rC r rL rf r r r rK ] s6
z!AsyncMockMixin._execute_mock_callc C s( | j dkr$d| jpd d}t|dS )zA
Assert that the mock was awaited at least once.
r Expected r5 z to have been awaited.Nr r r r! r r r r s
z AsyncMockMixin.assert_awaitedc C s0 | j dks,d| jpd d| j d}t|dS )z@
Assert that the mock was awaited exactly once.
r r r5 $ to have been awaited once. Awaited times.Nr r! r r r r s
z"AsyncMockMixin.assert_awaited_oncec s j du r& }td| d fdd}t fdd}j }||kr~t|trn|nd}t| |dS )zN
Assert that the last await was with the specified arguments.
NzExpected await: z
Not awaitedc s j dd} | S )Nawait)r r" r# r$ r r r% s z:AsyncMockMixin.assert_awaited_with.._error_messageTr& )r r r r r( r$ r) )rA rB rC r* r% r+ r, r r$ r r s
z"AsyncMockMixin.assert_awaited_withc O s< | j dks,d| jpd d| j d}t|| j|i |S )zi
Assert that the mock was awaited exactly once and with the specified
arguments.
r r r5 r r )r r r r r- r r r r s
z'AsyncMockMixin.assert_awaited_once_withc sj t||fdd}t|tr$|nd} fdd jD }|sL|t|vrf ||}td| |dS )zU
Assert the mock has ever been awaited with the specified arguments.
Tr& Nc s g | ]} |qS r r. r/ r r r r r! z3AsyncMockMixin.assert_any_await..z%s await not found)r r( r$ r) r r= r r r> r r r r s z AsyncMockMixin.assert_any_awaitFc s fdd|D }t dd |D d}t fdd jD }|s||vr|du rXd}ndd d |D }t| d
t| d j |dS t|}g }|D ]0}z|| W q ty || Y q0 q|rtd t |f |dS )
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 s g | ]} |qS r r. r/ r r r r r! z4AsyncMockMixin.assert_has_awaits..c s s | ]}t |tr|V qd S r/ r1 r r r r r2 r! z3AsyncMockMixin.assert_has_awaits..Nc 3 s | ]} |V qd S r/ r. r/ r r r r2 r! zAwaits not found.z,Error processing expected awaits.
Errors: {}c S s g | ]}t |tr|nd qS r/ r1 r r r r r s r3 z
Actual: z %r not all found in await list)
r rr r r5 r rY r7 r< r rZ ) rA r8 r9 r* r, Z
all_awaitsr: r; r< r r r r sF z AsyncMockMixin.assert_has_awaitsc C s0 | j dkr,d| jpd d| j d}t|dS )z9
Assert that the mock was never awaited.
r r r5 z# to not have been awaited. Awaited r Nr r! r r r r s
z!AsyncMockMixin.assert_not_awaitedc s* t j|i | d| _d| _t | _dS )z0
See :func:`.Mock.reset_mock()`
r N)r ru r r rr r r@ r r r ru s zAsyncMockMixin.reset_mock)F)rM rP r r r r r r8 rK r r r r r r r ru
__classcell__r r r r r H s (
, r c @ s e Zd ZdZdS )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.
NrM r r r r r s r c @ s( e Zd ZdZdd Zdd Zdd ZdS ) _ANYz2A helper object that compares equal to everything.c C s dS r r rA r r r r r - s z _ANY.__eq__c C s dS r r r r r r r 0 s z _ANY.__ne__c C s dS )Nzr r r r r r 3 s z
_ANY.__repr__N)rM rP r rN r r r r r r r r * s r c C s` d| }d}d dd |D }d dd | D }|r@|}|rX|rP|d7 }||7 }|| S )Nz%s(%%s)r z, c S s g | ] }t |qS r )repr)r r r r r r = r! z*_format_call_signature..c S s g | ]\}}d ||f qS )z%s=%rr )r r r r r r r > s )r r )r rB rC r Zformatted_args args_stringZ
kwargs_stringr r r r : s
r c @ sz e Zd ZdZd ddZd d d
Zd d ZejZd
d Z dd Z
dd Z dd Z e
dd Ze
dd Zdd Zdd ZdS ) 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.
r r NFTc C s d}i }t |}|dkr$|\}}}nr|dkrd|\} }
t| trX| }t|
trR|
}qb|
}q| |
}}n2|dkr|\}t|tr|}nt|tr|}n|}|rt| ||fS t| |||fS )Nr r r )r r$ r rZ r ) r r r r r' from_kallrB rC _lenfirstsecondr r r r _ s.
z
_Call.__new__c C s || _ || _|| _d S r/ )r r _mock_from_kall)rA r r r r' r r r r r8 s z_Call.__init__c C s\ z t |}W n ty" t Y S 0 d}t | dkr>| \}}n
| \}}}t| dd rpt|dd rp| j|jkrpdS d}|dkrdi }}n|dkr|\}}}n|dkr|\} t| tr| }i }n"t| tr| }di }}nd}| }nV|dkr4|\}
} t|
tr(|
}t| tr | i }}n
d| }}n
|
| }}ndS |rL||krLdS ||f||fkS ) Nr r r Fr r r r )r r r r& r r$ rZ r ) rA r Z len_otherZ self_nameZ self_argsZ self_kwargsZ
other_nameZ
other_argsZ other_kwargsr r r r r r r sN
z _Call.__eq__c O s< | j d u r td||fddS | j d }t| j ||f|| dS )Nr r r r r r( r r r r r9 s
z_Call.__call__c C s2 | j d u rt|ddS d| j |f }t|| ddS )NF)r r z%s.%s)r r r r )rA r r r r r r s
z_Call.__getattr__c C s |t jv rtt | |S r/ )rZ r] r: __getattribute__)rA r r r r r s
z_Call.__getattribute__c C s( t | dkr| \}}n
| \}}}||fS )Nr )r r r r r _get_call_arguments s
z_Call._get_call_argumentsc C s | d S Nr r r r r r rB s z
_Call.argsc C s | d S )Nr r r r r r rC s z _Call.kwargsc C s| | j s&| jpd}|dr"d| }|S t| dkr@d}| \}}n0| \}}}|sTd}n |dshd| }nd| }t|||S )Nr r zcall%sr zcall.%s)r r r r r )rA r rB rC r r r r s
z_Call.__repr__c C s4 g }| }|dur(|j r || |j}qtt|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.N)r r r rr r )rA ZvalsrO r r r call_list s
z_Call.call_list)r r NFT)r NNFT)rM rP r rN r r8 r r r r9 r r r r rB rC r r r r r r r( L s&
5
r( )r c K sh t | rt| } t| t}t| }d| i}|r8d| i}n | du rDi }|rT|rTd|d< || t} t| rri }n8|r|rtdt } n"t
| st } n|r|rt | st } |
d|}|}
|du rd}
| f |||
|d |} t| trt| | } |rt| nt| | || |dur,|s,| |j|< |rV|sVd
|vrVt| |dd | d | _t| D ]} t| rrq^zt| | }
W n ty Y q^Y n0 d|
i}|rd|
i}t|
tst|
|| | |}|| j| < nn| }t| tr| j}t| | |}||d
< t |
rt }nt}|f || | |d|}|| j| < t|
||d t|tr^t | | | q^| S )aI 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` also takes arbitrary keyword arguments that are passed to
the constructor of the created mock.r r NTr zJInstance can not be True when create_autospec is mocking an async functionr r )r r r r rv r )rK rz r r )r r r r )rJ ) r[ r1 r$ r. rk r r' Zisdatadescriptor RuntimeErrorr rX r r` r r6 ri r rL r~ r rv r r r& r: r r5
_must_skipr rS )r r rK r rz rC is_typeZ
is_async_funcr r r r5 r re r r rJ Z child_klassr r r r
s
r c C sx t | ts$|t| di v r dS | j} | jD ]H}|j|t}|tu rFq*t |tt frZ dS t |t
rl| S dS q*|S )z[
Return whether we should skip the first argument on spec's `entry`
attribute.
r] F) r$ r1 r& r r\ r] r^ r rV rW r6 )r r r rC rf r r r r
s
r
c @ s e Zd ZdddZdS )r FNc C s( || _ || _|| _|| _|| _|| _d S r/ )r idsr r rK r )rA r r r r r rK r r r r8
s z_SpecState.__init__)FNNNFr r r r r r
s r c C s" t | trt| S t| S d S r/ )r$ bytesioBytesIOStringIO) read_datar r r
_to_stream
s
r r c s& t }|dgfdd}fdd} fddfdd fd
d }tdu rd dl}ttt|jtt|ja| du rt d
t
d} t tdj _ dj
_ dj_ dj_ dj_ |j_ d< d j_|j_ j_|j_fdd}|| _| _ | 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 s( j jd urj jS d j | i |S r ) readlinesrv ra _statehandler r _readlines_side_effect
s z)mock_open.._readlines_side_effectc s( j jd urj jS d j | i |S r )readrv ra r r r _read_side_effect
s z$mock_open.._read_side_effectc ? s( E d H d j | i |V q d S r )readlinera )_iter_side_effectr r r _readline_side_effect
s z(mock_open.._readline_side_effectc 3 s0 j jd urj jV q d D ]
} | V q d S r )r rv )liner r r r
s z$mock_open.._iter_side_effectc s j jd urj jS t d S r )r rv r r r r r _next_side_effect
s z$mock_open.._next_side_effectr open)r r )r r c s6 t d< jjd kr2 d< d j_tS )Nr r )r r r} r ra )r r r r r r
reset_data s
z mock_open..reset_data)r file_spec_iorY r r
TextIOWrapperunionr r r r rv writer r r r} r r )r5 r Z
_read_datar r r r" r r )r r r r r r r
s8 "
r
c @ s* e Zd ZdZdd Zd ddZdd ZdS )
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 K s t f i |S r/ )r )rA rC r r r r s z PropertyMock._get_child_mockNc C s | S r/ r )rA r) Zobj_typer r r r s zPropertyMock.__get__c C s | | d S r/ r )rA r) r r r r r ! s zPropertyMock.__set__)N)rM rP r rN r r r r r r r r s
r c C sp d| _ t| D ]\}zt| |}W n ty6 Y qY n0 t|tsDqt|j|trXq|j | u rt
| qdS )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& r: r$ r r~ r^ r r r )r5 r r r r r r % s
r c @ s e Zd ZdZdd Zdd ZdS )r z8
Wraps an iterator in an asynchronous iterator.
c C s& || _ ttd}tj|_|| jd< d S )Nr r+ )iteratorr r r' ZCO_ITERABLE_COROUTINEr r] )rA r& r r r r r8 A s
z_AsyncIterator.__init__c s( z t | jW S ty Y n0 td S r/ )r r& r r r r r r r G s
z_AsyncIterator.__anext__N)rM rP r rN r8 r r r r r r = s r )F)F)NFNNN)FFNN)Nr )}__all__r rg r r' r r builtinsr typesr r r Z
unittest.utilr functoolsr r r rw r
r r r* r. r# r3 r7 r= rL rG rX r[ r` ri rd r r r r r r r MISSINGr ZDELETEDr r r rY rr r r r r r; r8 r r= r rA r rR rU rV r r r r r r r r ZmultipleZstopallre Z
magic_methodsZnumericsr r ZinplacerightZ
_non_defaultsr
r r? Z_sync_async_magicsZ
_async_magicsr@ r r r r r r r r r r r r r r r r r r r r r rZ r( r r r
r r1 r r6 r! r r
r r r r r r r s0
1 h4 <
2
N
8+ :
N