o
0is @ s d Z ddlZddlZddlZddlZddlZddlZddlZddlmZ ddl m
Z
m Z m Z ddl
mZ ddlmZmZ ddlmZ G dd d eZd
d eeD Zd ZeZd
d Zdd Z dd Z dd Z dd Z dd Z dddZ!d d Z"d d 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/Z0e-j1Z2h d0Z3d1d2 Z4G d3d4 d4e5Z6d5d6 Z7G d7d8 d8e*Z8G d9d: d:e*Z9G d;d< d d>e5Z>d?d@ Z?G dAdB dBe9Z@G dCdD dDe@e:ZAdEdF ZBdGdH ZCdIdJ ZDG dKdL dLe*ZEdMdN ZFe.dddddfddOdPdQZG ddRdSZHe.dddddfddOdTdUZIG dVdW dWe*ZJdXdY ZKdZd[ ZLeGeI_*eJeI_MeHeI_NeLeI_Od\eI_Pd]ZQd^ZRd_Sd`da eRT D ZUd_Sdbda eRT D ZVh dcZWddde ZXdfd d_SeQeReUeVgT D ZYh dgZZdhhZ[eZe[B Z\eYeWB Z]e]e\B Z^h diZ_djdk dldk dmdk dndk doZ`eaeaeaeadpddddqdrd dpdds
Zbdtdu Zcdvdw Zddxdy Zedzd{ Zfecedeeefd|Zgd}d~ ZhG dd de9ZiG dd deie:ZjG dd deiZkG dd deieAZlG dd de9ZmG dd de9ZnG dd denekeAZoG dd de*Zpep Zqdd ZrG dd desZtetddZu dddOddZvdd ZwG dd de*ZxeyeveyeqjzfZ{da|dd Z}dddZ~G dd deAZdd ZG dd dZdS ))Mock MagicMockpatchsentinelDEFAULTANYcallcreate_autospec AsyncMock
FILTER_DIRNonCallableMockNonCallableMagicMock mock_open PropertyMockseal N)iscoroutinefunction)CodeType
ModuleType
MethodType) safe_repr)wrapspartial)RLockc @ e Zd ZdZdS )InvalidSpecErrorz8Indicates that an invalid value was used as a mock spec.N__name__
__module__ __qualname____doc__ r r 4/opt/alt/python310/lib64/python3.10/unittest/mock.pyr ( r c C s h | ] }| d s|qS _
startswith).0namer r r! , r) Tc C s< t | r t| ts dS t| drt| d} t| p t| S )NF__func__)_is_instance_mock
isinstancer hasattrgetattrr inspectZ isawaitableobjr r r!
_is_async_obj4 s
r3 c C s t | dd r
t| S dS )N__code__F)r/ r funcr r r! _is_async_func< s r7 c C s t t| tS N)
issubclasstyper r1 r r r! r, C s r, c C s t | tpt | tot| tS r8 )r-
BaseExceptionr: r9 r1 r r r!
_is_exceptionI s
r< c C s t | tr
t| dr
| jS | S Nmock)r-
FunctionTypesr. r> r1 r r r!
_extract_mockP s r@ c C s~ t | tr
|s
| j} d}nt | ts"z| j} W n
ty! Y dS w |r*t| d}n| }z| t|fW S t y> Y dS 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- r: __init__r? __call__AttributeErrorr r0 signature
ValueError)r6 Z as_instanceZeat_selfZsig_funcr r r! _get_signature_objectY s"
rF Fc sN t | || d u r d S \} fdd}t| | |t|_ t|_d S )Nc s j |i | d S r8 bindselfargskwargssigr r! checksig{ z"_check_signature..checksig)rF _copy_func_detailsr: _mock_check_sig
__signature__)r6 r> skipfirstinstancerO r rM r! _check_signaturev s
rV c C s6 dD ]}z t ||t| | W q ty Y qw d S )N)r r __text_signature__r __defaults____kwdefaults__)setattrr/ rC )r6 funcopy attributer r r! rQ s rQ c C s@ t | trdS t | tttfrt| jS t| dd d ur dS dS )NTrB F)r- r: staticmethod classmethodr _callabler+ r/ r1 r r r! r_ s
r_ c C s t | ttfv S r8 )r: listtupler1 r r r! _is_list s rb c C sF t | ts
t| ddduS | f| j D ]
}|jddur dS qdS )ztGiven an object, return True if the object is callable.
For classes, return True if instances would be callable.rB NTF)r- r: r/ __mro____dict__get)r2 baser r r! _instance_callable s
rg c s t |t}t|||}|d u r| S |\} fdd}t|| |j}| s)d}|| d}d| } t| | || }
t|
| |
S )Nc s j | i | d S r8 rG rK rL rM r r! rO rP z _set_signature..checksigr[ )Z
_checksig_r> zYdef %s(*args, **kwargs):
_checksig_(*args, **kwargs)
return mock(*args, **kwargs))r- r: rF rQ r isidentifierexec _setup_func) r> originalrU rT resultr6 rO r( contextsrcr[ r rM r! _set_signature s$
rp 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 j | i |S r8 )assert_called_withrh r> r r! rr z'_setup_func..assert_called_withc rq r8 )
assert_calledrh rs r r! ru rt z"_setup_func..assert_calledc rq r8 )assert_not_calledrh rs r r! rv rt z&_setup_func..assert_not_calledc rq r8 )assert_called_oncerh rs r r! rw rt z'_setup_func..assert_called_oncec rq r8 )assert_called_once_withrh rs r r! rx rt z,_setup_func..assert_called_once_withc rq r8 )assert_has_callsrh rs r r! ry rt z%_setup_func..assert_has_callsc rq r8 )assert_any_callrh rs r r! rz rt z$_setup_func..assert_any_callc sB t _t _ j} t| r | ur | d S d S d S r8 ) _CallList method_calls
mock_calls
reset_mock return_valuer, )retr[ r> r r! r~ s z _setup_func..reset_mockFr )r> called
call_count call_argsr{ call_args_listr| r} r side_effect_mock_childrenrr rx ry rz r~ ru rv rw rS _mock_delegate) r[ r> rN rr ru rv rw rx ry rz r~ r r r! rk s8
rk c sJ t jj _d _d _t _ fdd}dD ] }t |t|| qd S )Nr c s t j| |i |S r8 )r/ r> )attrrK rL rs r r! wrapper 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_argsr{ await_args_listrZ r )r> r r\ r rs r! _setup_async_mock s
r c C s d| dd | kS )N__%s__ r r( r r r! _is_magic rP r c @ ( e Zd ZdZdd Zdd Zdd ZdS ) _SentinelObjectz!A unique, named, sentinel object.c C s
|| _ d S r8 r rJ r( r r r! rA
z_SentinelObject.__init__c C
d| j S Nz sentinel.%sr rJ r r r! __repr__ r z_SentinelObject.__repr__c C r r r r r r r!
__reduce__! r z_SentinelObject.__reduce__N)r r r r rA r r r r r r! r s
r c @ r ) _SentinelzAAccess attributes to return a named object, usable as a sentinel.c C s
i | _ d S r8 )
_sentinelsr r r r! rA ' r z_Sentinel.__init__c C s |dkrt | j|t|S )N __bases__)rC r
setdefaultr r r r r! __getattr__* s z_Sentinel.__getattr__c C dS )Nr r r r r r! r 0 z_Sentinel.__reduce__N)r r r r rA r r r r r r! r % s
r > _mock_parentr _mock_side_effectr
_mock_name_mock_new_name_mock_new_parent_mock_return_valuec C s8 t | d| }| |fdd}| |fdd}t||S )NZ_mock_c S s" | j }|d u r t| |S t||S r8 )r r/ )rJ r( _the_namerN r r r! _getE s
z"_delegating_property.._getc S s, | j }|d u r|| j|< d S t||| d S r8 )r rd rZ )rJ valuer( r rN r r r! _setJ s z"_delegating_property.._set)_allowed_namesaddproperty)r( r r r r r r! _delegating_propertyB s
r c @ e Zd Zdd Zdd ZdS )r{ c C sl t |ts t| |S t|}t| }||krdS td|| d D ]}| ||| }||kr3 dS q"dS )NFr T)r- r` __contains__lenrange)rJ r Z len_valueZlen_selfiZsub_listr r r! r W s
z_CallList.__contains__c C s t t| S r8 )pprintZpformatr` r r r r! r e z_CallList.__repr__N)r r r r r r r r r! r{ U s r{ c C s t |}t|s
dS |js|js|jd us|jd ur dS | }|d ur/||u r(dS |j}|d us"|r7| |_||_|r?| |_||_dS )NFT)r@ r, r r r r )parentr r( new_name_parentr r r! _check_and_set_parenti s(
r c @ r ) _MockIterc C s t || _d S r8 )iterr2 )rJ r2 r r r! rA r z_MockIter.__init__c C s
t | jS r8 )nextr2 r r r r! __next__ r z_MockIter.__next__N)r r r rA r r r r r! r s r c @ s e Zd ZeZdZdd ZdS )BaseNc O d S r8 r rI r r r! rA r z
Base.__init__)r r r r r r rA r r r r! r s r c @ st e Zd ZdZe Zdd Z dLddZd d
ZdMd d Z dNd
dZ
dd Z dd Z dZ
ee e e
Zedd ZedZedZedZedZedZdd Zd d ZeeeZdOddd d d!Zd"d# Zd$d% Z d&d' Z d(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*dMdCdDZ+dEdF Z,dGdH Z-dQdJdKZ.dS )Rr z A non-callable version of `Mock`c O s| | f}t | ts*tj| g|R i |j}|d|d}|d ur*t|r*t| f}t| j|d| j i}t
t | |}|S )Nspec_setspecr )
r9 AsyncMockMixin _MOCK_SIGZ bind_partialZ argumentsre r3 r: r r _safe_superr __new__)clsrK kwbasesZ
bound_argsZspec_argnewrU r r r! r s
zNonCallableMock.__new__N Fc K s |d u r|}| j }
||
d< ||
d< ||
d< ||
d< d|
d< |d ur%|}d}|
d u r-|d u}
| ||| |
i |
d< ||
d < d |
d
< d|
d < d |
d < d
|
d< t |
d< t |
d< t |
d< | |
d< | rj| jdi | 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_callsr| _mock_unsafer )rd _mock_add_specr{ configure_mockr r rA )rJ r r r( r r _spec_state _new_name _new_parent_spec_as_instance _eat_selfunsaferL rd r r r! rA 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 )r@ r r r r rZ )rJ r> r\ 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 rJ 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|tr*|}nt|}t|||} | o9| d }t |}| j}
||
d< ||
d< ||
d< ||
d< ||
d< d S )Nr _spec_class _spec_set_spec_signature
_mock_methods _spec_asyncs) dirr r/ appendrb r- r: rF rd ) rJ r r r r r r r r resrd r r r! r s,
z NonCallableMock._mock_add_specc C s8 | j }| jd ur | jj}|tu r| j| dd}|| _|S )N()r r )r r r r _get_child_mock)rJ r r r r! Z__get_return_value s
z"NonCallableMock.__get_return_valuec C s. | j d ur || j _d S || _t| |d d d S )Nr )r r r r )rJ 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 r t| S | j S r8 )r r: r r r r! __class__' s
zNonCallableMock.__class__r r r r r} c C sN | j }|d u r
| jS |j}|d ur%t|s%t|ts%t|s%t|}||_|S r8 )r r r callabler- r r< )rJ delegatedZsfr r r! Z__get_side_effect4 s z!NonCallableMock.__get_side_effectc C s* t |}| j}|d u r|| _d S ||_d S r8 ) _try_iterr r r )rJ r r r r r! Z__set_side_effect? s
z!NonCallableMock.__set_side_effectr r c C s |du rg }t | |v rdS |t | d| _d| _d| _t | _t | _t | _|r/t | _
|r4d| _ | j
D ]}t|tsD|tu rEq9|j|||d q9| j
}t|r`|| urb|| dS dS dS )z-Restore the mock object to its initial state.NFr r )idr r r r r{ r} r r| r r r r valuesr-
_SpecState_deletedr~ r, )rJ Zvisitedr r childr r r r! r~ J s. zNonCallableMock.reset_mockc K sX t | dd dD ] \}}|d}| }| }|D ]}t||}qt||| q
dS )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! u s z0NonCallableMock.configure_mock..)keyr N)sorteditemssplitpopr/ rZ )rJ rL argvalrK finalr2 r r r r! r h s
z NonCallableMock.configure_mockc C s |dv rt || jd ur || jvs|tv r t d| nt|r%t || js?| jr0|| jvr?|dr?t |d|dtj | j |}|t
u rQt ||d u rrd }| j d urbt | j |}| j
| |||| d}|| j|< nJt|trzt|j|j|j|j|j}W n ty | jd p| }td|d |d
| d |jd w || j|< W d |S W d |S W d |S 1 sw Y |S )
N> r r z Mock object has no attribute %r)assertZassretZasertZaseertZassrtz6 is not a valid assertion. Use a spec for the mock if z is meant to be an attribute.)r r( r r r r Cannot autospec attr
from target , as it has already been mocked out. [target=, attr=])rC r _all_magicsr r r& r _lockr re r r r/ r r- r r r r rU r r( r rd )rJ r( rm r target_namer r r! r ~ sr
zNonCallableMock.__getattr__c C s | j g}| j}| }d}|dgkrd}|d ur0|}||j | d}|j dkr)d}|j}|d ustt|}|jp:d}t|dkrK|d dvrK|d7 }||d< d|S )Nr r r r> r )r z().r )r r r r` reversedr r join)rJ Z
_name_listr ZlastdotZ_firstr r r! _extract_mock_name s*
z"NonCallableMock._extract_mock_namec C s^ | }d}|dvrd| }d}| jd ur"d}| jr d}|| jj }dt| j||t| f S )Nr )r> zmock.z name=%rz spec=%rz spec_set=%rz<%s%s%s id='%s'>)r r r r r: r )rJ r( Z name_stringZ spec_stringr r r! r s
zNonCallableMock.__repr__c C sv t st| S | jp g }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 r
t|r|qS r# )r& r r r r r! r s
) r
object__dir__r r r: r` rd r r r set)rJ ZextrasZ from_typeZ from_dictZfrom_child_mocksr r r! r s
zNonCallableMock.__dir__c sJ |t v r t||S jr#jd ur#|jvr#|jvr#td| |tv r/d| }t||tv rqjd urC|jvrCtd| t |s\t
t |t || | fdd}n*t
|d | t
t || |j|< n|dkrz|_d S t
|||r|j|< jrt|s 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 r8 r rK r rl rJ r r! r z-NonCallableMock.__setattr__..r r z Cannot set )r r __setattr__r r rd rC _unsupported_magicsr r, rZ r: _get_methodr r r r r. r )rJ r( r msg mock_namer r r! r s8
zNonCallableMock.__setattr__c C s |t v r|t| jv rtt| | || jvrd S | j|t}|| jv r.tt| | n|t
u r6t ||tur>| j|= t
| j|< d S r8 ) r r: rd delattrr re _missingr r __delattr__r rC )rJ r( r2 r r r! r' s
zNonCallableMock.__delattr__c C s | j pd}t|||S r= )r _format_call_signaturerJ rK rL 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 )rJ rK rL 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 s%t|tr( |S 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 re r- r r@ )rJ r( rN nameschildrenr r r r! _get_call_signature_from_name6 s
z-NonCallableMock._get_call_signature_from_namec
C s t |trt|dkr| |d }n| j}|durUt|dkr'd}|\}}n|\}}}z|j|i |}t||j|jW S t yT } z |
dW Y d}~S d}~ww |S )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- ra r r2 r rH r rK rL TypeErrorwith_traceback)rJ _callrN r( rK rL Z
bound_callr r r r!
_call_matcherW s
z NonCallableMock._call_matcherc C s0 | j dkrd| jp
d| j | f }t|dS )z/assert that the mock was never called.
r z9Expected '%s' to not have been called. Called %s times.%sr> Nr r _calls_reprAssertionErrorrJ r# r r r! rv r
z!NonCallableMock.assert_not_calledc C s$ | j dkrd| jp
d }t|dS )z6assert that the mock was called at least once
r z"Expected '%s' to have been called.r> N)r r r9 r: r r r! ru | s
z NonCallableMock.assert_calledc C s0 | j dksd| jp
d| j | f }t|dS )z3assert that the mock was called only once.
r z:Expected '%s' to have been called once. Called %s times.%sr> Nr7 r: r r r! rw r; z"NonCallableMock.assert_called_oncec s j du r }d}d||f }t| fdd}t fdd}j }||krCt|tr;|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 r8 r. r# rK rL rJ r r! _error_message s z:NonCallableMock.assert_called_with.._error_messageTtwo)r r* r9 r6 _Callr- Exception)rJ rK rL expectedactualZ
error_messager? causer r> r! rr s
z"NonCallableMock.assert_called_withc O s< | j dksd| jp
d| 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.%sr> )r r r8 r9 rr rJ rK rL r# r r r! rx s
z'NonCallableMock.assert_called_once_withc s fdd|D }t dd |D d}t fdd jD }|sM||vrK|du r,d}n
dd d |D }t| d
t| jd d d
|dS t|}g }|D ]}z|| W qU t yl |
| Y qUw |r~td j pudt ||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 g | ]} |qS r r6 r' cr r r! r r z4NonCallableMock.assert_has_calls..c s | ]
}t |tr|V qd S r8 r- rC r r r r! z3NonCallableMock.assert_has_calls..Nc 3 | ]} |V qd S r8 rI rJ r r r! rN zCalls not found.z+Error processing expected calls.
Errors: {}c S g | ] }t |tr |nd qS r8 rM r r r r! r
Expected: ZActual)prefixr z@%r does not contain all of %r in its call list, found %r insteadr> )
r r{ r} formatr9 r8 rstripr` removerE r r ra ) rJ calls any_orderrD rF Z all_callsproblem not_foundkallr r r! ry sV
z NonCallableMock.assert_has_callsc j t||fdd}t|tr|nd} fdd jD }|s&|t|vr3 ||}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 rH r rI rJ r r r! r r z3NonCallableMock.assert_any_call..z%s call not found)r6 rB r- rC r _AnyComparerr* r9 rJ rK rL rD rF rE r- r r r! rz s z NonCallableMock.assert_any_callc K s | j rd|v rd|d nd}| | }t||d}|| jd v r-tdi |S t| }t|tr=|t v r=t}n1t|t
rT|t v sN| j rQ|| j v rQt}n t}nt|t
sit|trat}n
t|trht}n|jd }|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).r( r r r r r Nr )r r rC re rd r r: r9 r _async_method_magicsr _all_sync_magicsr
CallableMixinr r r rc )rJ r r\ r$ r _typeklassr r r! r s2
z NonCallableMock._get_child_mockCallsc C s" | j sdS 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 )r} r )rJ rU r r r! r8 s zNonCallableMock._calls_repr) NNNNNNr NFNFF)FFr8 )r )rf )/r r r r r r r rA r r r Z"_NonCallableMock__get_return_valueZ"_NonCallableMock__set_return_valueZ"_NonCallableMock__return_value_docr r r r r r r r r} Z!_NonCallableMock__get_side_effectZ!_NonCallableMock__set_side_effectr r~ r r r r r r r' r* r. r2 r6 rv ru rw rr rx ry rz r r8 r r r r! r sd
-
0'
!
-&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 ]}t dd t||D r dS qdS )Nc S s g | ]\}}||kqS r r )r' rD rE r r r! r + s z-_AnyComparer.__contains__..TF)allzip)rJ itemr5 r r r! r ( s z_AnyComparer.__contains__N)r r r r r r r r r! r_ # s r_ c C sF | d u r| S t | r | S t| r| S zt| W S ty" | Y S w r8 )r< r_ r r3 r1 r r r! r 3 s
r c
@ sR e Zd Zddedddddddf
ddZdd Zdd Zd d
Zd d Zd
d Z dS )rc Nr c K s: || j d< tt| j||||||| |
fi | || _d S )Nr )rd r rc rA r ) rJ r r r r r( r r r r r rL r r r! rA D s
zCallableMixin.__init__c O r r8 r rI r r r! rR P s z CallableMixin._mock_check_sigc O s0 | j |i | | j|i | | j|i |S r8 )rR _increment_mock_call
_mock_callrI r r r! rB U s zCallableMixin.__call__c O s | j |i |S r8 )_execute_mock_callrI r r r! rm ] rt zCallableMixin._mock_callc O s
d| _ | jd7 _t||fdd}|| _| j| | jd u}| j}| j}|dk}| j td||f | j
}|d ur|rW|j t|||f |jd u}|rW|jd | }t|||f} |j | |jrz|rld}
nd}
|jdk}|j|
| }|j
}|d us| j|i |S | jS r8 )r r< r_ r r r r r )rJ rK rL effectrm r r r! rn s"
z CallableMixin._execute_mock_call)
r r r r rA rR rB rm rl rn r r r r! rc B s
.rc c @ r )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.
Nr r r r r! r r" r c C s2 zt | |W S ty t| t | | Y S w r8 )r/ rC
__import__)thingcomp import_pathr r r! _dot_lookup s rt c C sB | d}|d}t|}|D ]}|d| 7 }t|||}q|S )Nr r z.%s)r r rp rt )targetZ
componentsrs rq rr r r r! _importer s
rv c C s( d}|D ]
}|| v rt |dqd S )N)Z autospectZ auto_specZset_specz5 might be a typo; use unsafe=True if this is intended) RuntimeError)Zkwargs_to_checkZtyposZtypor r r! _check_spec_arg_typos s rx c @ s e Zd ZdZg ZddddZdd Zdd Zd
d Ze j
d d
Z dd Z dd Z
dd Zdd Zdd Zdd Zdd ZdS ) _patchNFr c
C s |d ur|t ur td|d urtd|
st| t|r)td|d|dt|r8td|d|d|| _|| _|| _|| _|| _ || _
d| _ || _ || _
| | _g | _d S )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 rE rx r, r getterr\ r new_callabler createZ has_localr autospecrL additional_patchers) rJ r{ r\ r r r} r r~ r| rL r r r r! rA sD
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 - z _patch.copy..) ry r{ r\ r r r} r r~ r| rL attribute_namer )rJ patcherr r r! r & s z _patch.copyc C 2 t |tr
| |S t|r| |S | |S r8 r- r: decorate_classr0 r decorate_async_callabledecorate_callablerJ r6 r r r! rB 3
z_patch.__call__c C sN t |D ] }|tjs
qt||}t|dsq| }t|||| q|S NrB )r r& r TEST_PREFIXr/ r. r rZ )rJ re r
attr_valuer r r r! r ; s
z_patch.decorate_classc c s g }t 4}|jD ] }||}|jd ur || q |jtu r'|| q |t |7 }||fV W d d S 1 s>w Y d S r8 )
contextlib ExitStack patchings
enter_contextr updater r r ra )rJ patchedrK keywargs
extra_args
exit_stackpatchingr r r r! decoration_helperI s
"z_patch.decoration_helperc > t dr
j S t fddg_S )Nr c sD | |\}} |i |W d S 1 sw Y d S r8 r rK r ZnewargsZ newkeywargsr6 r rJ r r! r ^ s $z)_patch.decorate_callable..patchedr. r r r r r r r! r X
z_patch.decorate_callablec r )Nr c sL | |\}} |i |I d H W d S 1 s w Y d S r8 r r r r r! r o s $z/_patch.decorate_async_callable..patchedr r r r r! r i r z _patch.decorate_async_callablec C s | }| j}t}d}z|j| }W n ttfy# t||t}Y nw d}|tv r2t|t r2d| _
| j
sA|tu rAtd||f ||fS )NFTz!%s does not have the attribute %r) r{ r\ r rd rC KeyErrorr/ _builtinsr- r r} )rJ ru r( rl localr r r! get_originalz s"
z_patch.get_originalc
C s | j | j| j}}}| j| j}}| j}| | _|du r d}|du r&d}|du r,d}|dur8|dur8td|dus@|durH|dvrHtd| \}}|t
u r.|du r.d} |du ri|}|du rh|}d}n|durv|du ru|}d}n|du r||}|dus|dur|t
u rtdt |t rd} |du rt
|rt}
nt}
i } |dur|}
n)|dus|dur|} |dur|} t| rd| v}
nt| }
t
| rt}
n|
rt}
|dur|| d < |dur|| d
< t |
t rt|
tr| jr| j| d < | | |
di | }| r-t|r-|} |dur|} t| s t| s t}
| d |
d|d d
| |_nl|dur|t
ur.)rsplitr3 rE rC )ru r\ r{ r r r! _get_targetL s r rz c sB t tu r
t d fdd}
t|
|||||||| |d
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 r8 r r r r r! r l z _patch_object..rz )r: strr3 ry ) ru r\ r r r} r r~ r| r rL r{ r r r!
_patch_objectV s
r c
s t tu r
fdd}n fdd}|stdt| }|d \} }
t|| |
|||||i } | | _|dd D ]\} }
t|| |
|||||i } | | _| j| q:| 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 r r8 r r r r r! r r z!_patch_multiple..c r r8 r r r r r! r r z=Must supply at least one keyword argument with patch.multipler r N) r: r rE r` r ry r r r )
ru r r} r r~ r| rL r{ r r\ r r Z this_patcherr r r! _patch_multiples s, r c K s( t | \} }
t| |
||||||||d
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.
rz )r ry ) ru r r r} r r~ r| r rL r{ r\ r r r! r s
K
r c @ sj e Zd ZdZdddZdd Zdd Zd
d Zd d
Zdd Z dd Z
dd Z dd Z dd Z
dd ZdS ) _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 r8 )in_dictdictr r clear _original)rJ r r r rL r r r! rA s
z_patch_dict.__init__c C r r8 r )rJ fr r r! rB r z_patch_dict.__call__c t fdd}|S )Nc s, z | i |W S w r8 r
_unpatch_dictr r rJ r r! _inner% s z-_patch_dict.decorate_callable.._innerr rJ r r r r r! r $ z _patch_dict.decorate_callablec r )Nc s4 z | i |I d H W S w r8 r r r r r! r 1 s
z3_patch_dict.decorate_async_callable.._innerr r r r r! r 0 r z#_patch_dict.decorate_async_callablec C sX t |D ]%}t||}|tjr)t|dr)t| j| j| j }||}t
||| q|S r ) r r/ r& r r r. r r r r rZ )rJ re r r Z decoratorZ decoratedr r r! r < s
z_patch_dict.decorate_classc C s | | jS )zPatch the dict.)r r r r r r! r G s z_patch_dict.__enter__c C s | j }t| jtrt| j| _| j}| j}z| }W n ty1 i }|D ]}|| ||< q&Y nw || _|r;t | z|
| W d S tyX |D ]}|| ||< qLY d S w r8 ) r r- r r rv r r rC r _clear_dictr )rJ r r r rl r r r r! r M s. z_patch_dict._patch_dictc C sP | j }| j}t| z|| W d S ty' |D ]}|| ||< qY d S w r8 )r r r r rC )rJ r rl r r r r! r i s z_patch_dict._unpatch_dictc G s | j dur | dS )zUnpatch the dict.NF)r r )rJ rK r r r! r v s
z_patch_dict.__exit__c C s | }tj| |S r )r ry r r r r r r! r } r z_patch_dict.startc C s4 zt j| W n
ty Y dS w | dddS r )ry r rX rE r r r r r! r r z_patch_dict.stopN)r F)r r r r rA rB r r r r r r r r r r r r r! r s
r c C s< z| W d S ty t| }|D ]}| |= qY d S w r8 )r rC r` )r keysr r r r! r s r c C s t tjD ]} | qdS )z7Stop all active patches. LIFO to unroll nested patches.N)r ry r r )r r r r! _patch_stopall 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 | ]}d | V qdS )zi%sNr r' nr r r! rN rN c c r )zr%sNr r r r r! rN r > __getstate____get__ __setstate__ __reversed____set__
__format__
__reduce_ex__r
__delete__ __missing__
__getformat__
__setformat__r r __getnewargs__Z__getinitargs____getnewargs_ex____subclasses__c s fdd}| |_ |S )z:Turns a callable object (like a mock) into a real functionc s | g|R i |S r8 r rJ rK r r5 r r! method r z_get_method..method)r )r( r6 r r r5 r! r" s r" c C s h | ]}d | qS )r r )r' r r r r! r) r > __aexit__ __anext__
__aenter__ __aiter__> __subclasscheck__r __instancecheck__ __prepare__r r __del__rA c C
t | S r8 )r __hash__r r r r! r
r c C r r8 )r __str__r r r r! r r c C r r8 )r
__sizeof__r r r r! r r c C s" t | j d| dt| S )N/)r: r r r r r r r! r s " )r r r
__fspath__r y ?g ?)
__lt____gt____le____ge____int__r __len__r __complex__ __float____bool__ __index__r c fdd}|S )Nc s$ j j}|tur
|S | u rdS tS NT)__eq__r r NotImplemented)otherret_valr r r! r s z_get_eq..__eq__r )rJ r r r r! _get_eq r
c r )Nc s j jturtS | u rdS tS NF)__ne__r r r )r r r r! r
s
z_get_ne..__ne__r )rJ r
r r r! _get_ne s r c r )Nc s j j} | tu r tg S t| S r8 )__iter__r r r r r r r! r s z_get_iter..__iter__r )rJ r r r r! _get_iter r r c r )Nc s( j j} | tu rttg S tt| S r8 )r r r _AsyncIteratorr r r r r! r s z"_get_async_iter..__aiter__r )rJ r r r r! _get_async_iter s r )r r
r r c C sf t |t}|tur||_d S t|}|d ur!|| }||_d S t|}|d ur1|| |_d S d S r8 )_return_valuesre r r _calculate_return_value_side_effect_methodsr )r> r r( ZfixedZreturn_calculatorr Z
side_effectorr r r! _set_return_value* s
r c @ r )
MagicMixinc O * | tt| j|i | | d S r8 )_mock_set_magicsr r rA r r r r! rA = zMagicMixin.__init__c C s t tB }|}t| dd d ur,|| j}t }|| }|D ]}|t| jv r+t| | q |tt| j }t| }|D ] }t ||t
|| q;d S )Nr ) _magicsra r/ intersectionr r r: rd r% rZ
MagicProxy)rJ Z orig_magicsZ these_magicsZ
remove_magicsr rd r r r! r C s
zMagicMixin._mock_set_magicsN)r r r rA r r r r r! r < s r c @ e Zd ZdZdddZdS )r z-A version of `MagicMock` that isn't callable.Fc C | || | dS r r r r r r r! r ] z"NonCallableMagicMock.mock_add_specNrh r r r r r r r r r! r [ s r c @ s e Zd Zdd ZdS )AsyncMagicMixinc O r r8 )r r r$ rA r r r r! rA h r zAsyncMagicMixin.__init__Nr r r rA r r r r! r$ g s r$ c @ r )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 r r r! r r r r! r x r" zMagicMock.mock_add_specNrh r# r r r r! r m s
r c @ s& e Zd Zdd Zdd ZdddZdS ) r c C s || _ || _d S r8 r( r )rJ r( r r r r! rA s
zMagicProxy.__init__c C s8 | j }| j}|j|||d}t||| t||| |S )N)r( r r )r( r r rZ r )rJ r r mr r r! create_mock s zMagicProxy.create_mockNc C s | S r8 )r( )rJ r2 rd r r r! r s zMagicProxy.__get__r8 )r r r rA r( r r r r r! r 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| jd < t | jd
< i | jd < d | jd < d S )
Nr r Z_mock_await_countZ_mock_await_argsZ_mock_await_args_listr r4 r r rX rY r )
superrA r r r rd r{ r r r0 Z CO_COROUTINEco_flagsra )rJ rK rL code_mockr r r! rA s
zAsyncMockMixin.__init__c s
t ||fdd}| jd7 _|| _| j| | j}|d ur]t|r&|t|sAzt|}W n t y9 t
w t|r@|nt |rP||i |I d H }n||i |}|t ur]|S | j
t ure| jS | jd urt | jrz| j|i |I d H S | j|i |S | jS )NTr@ r )rB r r r r r r< r_ r
StopIterationStopAsyncIterationr r r r r )rJ rK rL r5 ro rm r r r! rn s<
z!AsyncMockMixin._execute_mock_callc C s( | j dkrd| jp
d d}t|dS )zA
Assert that the mock was awaited at least once.
r Expected r> z to have been awaited.Nr r r9 r: r r r! r s
z AsyncMockMixin.assert_awaitedc C s0 | j dksd| jp
d d| j d}t|dS )z@
Assert that the mock was awaited exactly once.
r r0 r> $ to have been awaited once. Awaited times.Nr1 r: r r r! r
z"AsyncMockMixin.assert_awaited_oncec s j du r }td| d fdd}t fdd}j }||kr?t|tr7|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* r9 r6 rB r- rC )rJ rK rL rD r? rE rF r r> r! r s
z"AsyncMockMixin.assert_awaited_withc O s< | j dksd| jp
d d| j d}t|| j|i |S )zi
Assert that the mock was awaited exactly once and with the specified
arguments.
r r0 r> r2 r3 )r r r9 r rG r r r! r s
z'AsyncMockMixin.assert_awaited_once_withc r^ )zU
Assert the mock has ever been awaited with the specified arguments.
Tr@ Nc rH r rI rJ r r r! r
r z3AsyncMockMixin.assert_any_await..z%s await not found)r6 rB r- rC r r_ r* r9 r` r r r! r s z AsyncMockMixin.assert_any_awaitFc s fdd|D }t dd |D d}t fdd jD }|sH||vrF|du r,d}n
dd d |D }t| d
t| d j |dS t|}g }|D ]}z|| W qP tyg || Y qPw |rttd 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 rH r rI rJ r r r! r r z4AsyncMockMixin.assert_has_awaits..c s rL r8 rM r r r r! rN rO z3AsyncMockMixin.assert_has_awaits..Nc 3 rP r8 rI rJ r r r! rN rQ zAwaits not found.z,Error processing expected awaits.
Errors: {}c S rR r8 rM r r r r! r ' rS rT z
Actual: z %r not all found in await list)
r r{ r rV r9 r` rX rE r ra ) rJ rY rZ rD rF Z
all_awaitsr[ r\ r] r r r! r sN z AsyncMockMixin.assert_has_awaitsc C s0 | j dkrd| jp
d d| j d}t|dS )z9
Assert that the mock was never awaited.
r r0 r> z# to not have been awaited. Awaited r3 Nr1 r: r r r! r = r4 z!AsyncMockMixin.assert_not_awaitedc s* t j|i | d| _d| _t | _dS )z0
See :func:`.Mock.reset_mock()`
r N)r* r~ r r r{ r rI r- r r! r~ F s zAsyncMockMixin.reset_mockrh )r r r r r r r rA rn r r r r r r r r~
__classcell__r r r- r! r s (
, r c @ r )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 P r" r c @ r ) _ANYz2A helper object that compares equal to everything.c C r r r rJ r r r r! r ~ r z _ANY.__eq__c C r r r r8 r r r! r
r z _ANY.__ne__c C r )Nzr r r r r! r r z
_ANY.__repr__N)r r r r r r
r r r r r! r7 { s
r7 c C s` d| }d}d dd |D }d dd | D }|r |}|r,|r(|d7 }||7 }|| S )Nz%s(%%s)r z, c S s g | ]}t |qS r )repr)r' r r r r! r s 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( rK rL r, Zformatted_argsZ args_stringZ
kwargs_stringr r r! r( s
r( c @ s e Zd ZdZ d ddZ d d d
Zd d ZejZd
d Z dd Z
dd Z dd Z e
dd Ze
dd Zdd Zdd ZdS ) rB 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|\}}}n9|dkr2|\} }
t| tr,| }t|
tr)|
}n"|
}n | |
}}n|dkrK|\}t|trA|}n
t|trI|}n|}|rUt| ||fS t| |||fS )Nr r r )r r- r ra r ) r r r( r rA from_kallrK rL _lenfirstsecondr r r! r s.
z
_Call.__new__c C s || _ || _|| _d S r8 )r r _mock_from_kall)rJ r r( r rA r; r r r! rA s
z_Call.__init__c C sR zt |}W n ty t Y S w d}t | dkr | \}}n| \}}}t| dd r8t|dd r8| j|jkr8dS d}|dkrDdi }}nU|dkrN|\}}}nK|dkrq|\} t| tr_| }i }n:t| trl| }di }}n-d}| }n(|dkr|\}
} t|
tr|
}t| tr| i }}nd| }}n|
| }}ndS |r||krdS ||f||fkS ) Nr r r Fr r r: r )r r3 r r/ r r- ra r ) rJ 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 rtd||fddS | j d }t| j ||f|| dS )Nr r r r& r rB r) r r r! rB
s
z_Call.__call__c C s2 | j d u r t|ddS d| j |f }t|| ddS )NF)r( r; z%s.%s)r( r r; r@ )rJ r r( r r r! r
s
z_Call.__getattr__c C s |t jv rtt | |S r8 )ra rd rC __getattribute__)rJ r r r r! rA
s
z_Call.__getattribute__c C s. t | dkr| \}}||fS | \}}}||fS )Nr )r r) r r r! _get_call_arguments$
s
z_Call._get_call_argumentsc C | d S Nr rB r r r r! rK ,
z
_Call.argsc C rC )Nr rE r r r r! rL 0
rF z _Call.kwargsc C s| | j s| jpd}|drd| }|S t| dkr d}| \}}n| \}}}|s*d}n|ds4d| }nd| }t|||S )Nr r zcall%sr zcall.%s)r? r r& r r( )rJ r( rK rL r r r! r 4
s
z_Call.__repr__c C s: g }| }|dur|j r|| |j}|dustt|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 r{ r )rJ Zvalsrq r r r! call_listI
s
z_Call.call_list)r r NFT)r NNFT)r r r r r rA r r r
rB r rA rB r rK rL r rG r r r r! rB s(
5
rB )r; c K sh t | rt| } t| t}t| rtd| dt| }d| i} |r(d| i} n| du r.i } | r6|r6d| d< |s
_must_skipr rZ )r r rU r r r rL is_typeZ
is_async_funcr r r r> r rl r r rT Z child_klassr r r! r Y
s
r c C sv t | ts|t| di v rdS | j} | jD ]#}|j|t}|tu r#qt |tt fr- dS t |t
r6| S dS |S )z[
Return whether we should skip the first argument on spec's `entry`
attribute.
rd F) r- r: r/ r rc rd re r r] r^ r? )r r rI re rm r r r! rH
s
rH c @ s e Zd Z dddZdS )r FNc C s( || _ || _|| _|| _|| _|| _d S r8 )r idsr r rU r( )rJ r r r r( rJ rU r r r! rA s
z_SpecState.__init__)FNNNFr% r r r r! r s r c C s t | tr
t| S t| S r8 )r- bytesioBytesIOStringIO) read_datar r r!
_to_stream s
rP r c s& t }|dgfdd}fdd} fddfdd fd
d }tdu rDd dl}ttt|jtt|ja| du rNt 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 ( j jd ur
j jS d j | i |S rD ) readlinesr rh _statehandler r! _readlines_side_effect. z)mock_open.._readlines_side_effectc rQ rD )readr rh rS r r! _read_side_effect3 rW z$mock_open.._read_side_effectc ? s( E d H d j | i |V qNTr )readlinerh )_iter_side_effectrT r r! _readline_side_effect8 s
z(mock_open.._readline_side_effectc 3 s4 j jd ur j jV q d D ]} | V qd S rZ )r[ r )linerS r r! r\ = s
z$mock_open.._iter_side_effectc s j jd ur
j jS t d S rD )r[ r r r rS r r! _next_side_effectD s z$mock_open.._next_side_effectr open)r( r )r r c s6 t d< jjd kr d< d j_tS )Nr r )rP r[ r r rh )r] rT rU rO r r!
reset_data` s
z mock_open..reset_data)rP file_spec_ior` r r
TextIOWrapperunionrM r r` r r writerX r[ rR r r r )r> rO Z
_read_datarV rY r_ rc ra r )r\ r] rT rU rO 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 di |S )Nr )r )rJ rL r r r! r v r z PropertyMock._get_child_mockNc C s | S r8 r )rJ r2 Zobj_typer r r! r y s zPropertyMock.__get__c C s | | d S r8 r )rJ r2 r r r r! r { s zPropertyMock.__set__r8 )r r r r r r r r r r r! r m s
r c C sl d| _ t| D ],}zt| |}W n ty Y qw t|ts qt|j|tr*q|j | u r3t
| 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/ rC r- r r re r r r )r> 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) r4 )iteratorr r r0 ZCO_ITERABLE_COROUTINEr+ rd )rJ rg r, r r r! rA s
z_AsyncIterator.__init__c s$ zt | jW S ty Y tw r8 )r rg r. r/ r r r r! r s z_AsyncIterator.__anext__N)r r r r rA r r r r r! r s r rh )NFNNN)FFNN)Nr )__all__r r rL r0 r r builtinsr typesr r r Z
unittest.utilr functoolsr r Z threadingr rC r r r r
r* r r3 r7 r, r< r@ rF rV rQ r_ rb rg rp rk r r r r r r r MISSINGr& ZDELETEDr r r r` r{ r r r r rD rA r r_ r rc r rt rv rx ry r r r r r r r r ZmultipleZstopallr Z
magic_methodsZnumericsr r ZinplacerightZ
_non_defaultsr" r ra Z_sync_async_magicsZ
_async_magicsrb r r! r r r r
r r r r r r r r$ r r r r r7 r r( ra rB r r rH r r: r r? rb rP r
r r r r r r r! sD
1 h4
R
2 R
<+
:
N