3
f7 @ sF dZ d
ZddlZddlZddlZddlZddlmZ ddlm Z m
Z
dd e eD Z e
fZdejkrzddlZe
ejjfZdZeZdd Zdd Zdd Zdd d Zd d Zd!d" Zd#d$ Z d%d& Z dd'd(Z d)d* Z d+d, Z G d-d. d.e!Z"G d/d0 d0e!Z#e# Z$e$j%Z%e$j&Z'e$j(Z)d1d2 Z*d3d4d5d6d7d8d9d:hZ+d;d< Z,G d=d> d>e-Z.d?d@ Z/G dAdB dBe!Z0G dCdD dDe!Z1G dEd d e1Z2dFdG Z3G dHdI dIe1Z4G dJd d e4e2Z5dKdL Z6dMdN Z7dOdP Z8G dQdR dRe!Z9dSdT Z:e%dd dddfdUdVZ;ddWdXZd\d] Z?d^d_ Z@e;e=_!e>e=_Ae# s r javaTc C s t t| tS )N)
issubclasstyper
)objr r r _is_instance_mock2 s r c C s t | tp t | to t| tS )N)
isinstanceBaseExceptionsr r )r r r r
_is_exception8 s
r c C s t | tr6| r6y
| j} W n tk
r. dS X d}n*t | ts`y
| j} W n tk
r^ dS X |rpt| d}n| }y| tj|fS t k
r dS X dS )z
Given an arbitrary, possibly callable object, try to create a suitable
signature object.
Return a (reduced func, signature) tuple, or None.
NT)
r r __init__AttributeError
FunctionTypes__call__r inspectZ signature
ValueError)funcZ as_instanceZeat_selfZsig_funcr r r _get_signature_object? s$
r( Fc sD t | || d krd S \} fdd}t| | |t|_d S )Nc s j || d S )N)bind)
_mock_selfargskwargs)sigr r checksigd s z"_check_signature..checksig)r( _copy_func_detailsr _mock_check_sig)r' mock skipfirstinstancer. r )r- r _check_signature_ s
r4 c # C s | j |_ | j|_y | j|_W n tk
r0 Y nX y | j|_W n tk
rR Y nX y | j|_W n tk
rt Y nX y | j|_W n tk
r Y nX d S )N)__name____doc____text_signature__r"
__module__ __defaults____kwdefaults__)r' funcopyr r r r/ j s$ r/ c C s& t | trdS t| dd d k r"dS dS )NTr$ F)r r getattr)r r r r _callable s
r= c C s t | ttfkS )N)r listtuple)r r r r _is_list s r@ c C sH t | tst| dddk S x(| f| j D ]}|jjddk r(dS q(W dS )ztGiven an object, return True if the object is callable.
For classes, return True if instances would be callable.r$ NTF)r r r< __mro____dict__get)r baser r r _instance_callable s
rE c s t |s d S t|t}t|||}|d kr.| S |\} fdd}t|| |j}|j s^d}|| d}d| } t| | || }
t|
| |
S )Nc s j | | d S )N)r) )r+ r, )r- r r r. s z _set_signature..checksigr; )Z
_checksig_r1 zYdef %s(*args, **kwargs):
_checksig_(*args, **kwargs)
return mock(*args, **kwargs)) r= r r r( r/ r5 isidentifierexec _setup_func) r1 originalr3 r2 resultr' r. r contextsrcr; r )r- r _set_signature s$
rM c
s _ tsd 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 | |S )N)assert_called_with)r+ r, )r1 r r rN s z'_setup_func..assert_called_withc s j | |S )N)
assert_called)r+ r, )r1 r r rO s z"_setup_func..assert_calledc s j | |S )N)assert_not_called)r+ r, )r1 r r rP s z&_setup_func..assert_not_calledc s j | |S )N)assert_called_once)r+ r, )r1 r r rQ s z'_setup_func..assert_called_oncec s j | |S )N)assert_called_once_with)r+ r, )r1 r r rR s z,_setup_func..assert_called_once_withc s j | |S )N)assert_has_calls)r+ r, )r1 r r rS s z%_setup_func..assert_has_callsc s j | |S )N)assert_any_call)r+ r, )r1 r r rT s z$_setup_func..assert_any_callc s: t _t _j j} t| r6| k r6| j d S )N) _CallList method_calls
mock_calls
reset_mock return_valuer )ret)r; r1 r r rX s z _setup_func..reset_mockFr )r1 r called
call_count call_argsrU call_args_listrV rW rY side_effect_mock_childrenrN rR rS rT rX rO rP rQ _mock_delegate)
r; r1 rN rO rP rQ rR rS rT rX r )r; r1 r rH s: rH c C s d| dd | kS )Nz__%s__ r )r r r r _is_magic s rd c @ s e Zd ZdZdd Zdd ZdS )_SentinelObjectz!A unique, named, sentinel object.c C s
|| _ d S )N)r )selfr r r r r! s z_SentinelObject.__init__c C s
d| j S )Nz sentinel.%s)r )rf r r r __repr__ s z_SentinelObject.__repr__N)r5 r8 __qualname__r6 r! rg r r r r re s re c @ s e Zd ZdZdd Zdd ZdS ) _SentinelzAAccess attributes to return a named object, usable as a sentinel.c C s
i | _ d S )N)
_sentinels)rf r r r r! s z_Sentinel.__init__c C s |dkr t | jj|t|S )N __bases__)r" rj
setdefaultre )rf r r r r __getattr__ s z_Sentinel.__getattr__N)r5 r8 rh r6 r! rm r r r r ri s ri c C s$ t | ttttfkr t | | S | S )N)r dictr> r? set)valuer r r _copy s rq rY _mock_return_valuer_ _mock_side_effect _mock_parent_mock_new_parent
_mock_name_mock_new_namec C s8 t j| d| }| |fdd}| |fdd}t||S )NZ_mock_c S s" | j }|d krt| |S t||S )N)ra r< )rf r _the_namer- r r r _get s
z"_delegating_property.._getc S s* | j }|d kr|| j|< n t||| d S )N)ra rB setattr)rf rp r rx r- r r r _set$ s z"_delegating_property.._set)_allowed_namesaddproperty)r rx ry r{ r r r _delegating_property s
r c @ s e Zd Zdd Zdd ZdS )rU c C sn t |tstj| |S t|}t| }||kr2dS x6td|| d D ] }| ||| }||krFdS qFW dS )NFr T)r r> __contains__lenrange)rf rp Z len_valueZlen_selfiZsub_listr r r r 1 s
z_CallList.__contains__c C s t jt| S )N)pprintZpformatr> )rf r r r rg ? s z_CallList.__repr__N)r5 r8 rh r rg r r r r rU / s rU c C sx t |s dS |js,|js,|jd k s,|jd k r0dS | }x |d k rR||krJdS |j}q6W |rd| |_||_|rt| |_||_dS )NFT)r rv rw rt ru )parentrp r new_name_parentr r r _check_and_set_parentC s$
r c @ s$ e Zd Zdd Zdd Zdd ZdS ) _MockIterc C s t || _d S )N)iterr )rf r r r r r! ] s z_MockIter.__init__c C s | S )Nr )rf r r r __iter___ s z_MockIter.__iter__c C s
t | jS )N)nextr )rf r r r __next__a s z_MockIter.__next__N)r5 r8 rh r! r r r r r r r \ s r c @ s e Zd ZeZdZdd ZdS )BaseNc O s d S )Nr )rf r+ r, r r r r! g s z
Base.__init__)r5 r8 rh r rr rs r! r r r r r d s r c @ sH e Zd ZdZdd ZdDddZd d
ZdEd d ZdFd
dZdd Z dd Z
dZ e e e
e Z
e dd ZedZedZedZedZedZdd Zd d Ze eeZdGddd d d!Zd"d# Zd$d% Zd&d' Zd(d) Z d*d+ Z d,d- Z d.d/ Z d0d1 Z d2d3 Z!d4d5 Z"d6d7 Z#d8d9 Z$d:d; Z%dd?Z'd@dA Z(dBdC Z)dS )Ir
z A non-callable version of `Mock`c O s$ t | j| fd| ji}tj|}|S )Nr6 )r r5 r6 object__new__)clsr+ kwnewr3 r r r r o s
zNonCallableMock.__new__N Fc K s |d kr |}| j }
||
d< ||
d< ||
d< ||
d< |d k rB|}d}|
d krR|d k }
| j||| |
i |
d< ||
d< d |
d< d |
d
< d |
d < d |
d
< t |
d< t |
d< t |
d< | |
d< | r| jf | tt| j|||||| d S )Nrt rv rw ru Tr` _mock_wrapsra FZ _mock_calledZ_mock_call_argsr Z_mock_call_countZ_mock_call_args_listZ_mock_mock_callsrV _mock_unsafe)rB _mock_add_specrU configure_mock _safe_superr
r! )rf specr r spec_setr _spec_state _new_name _new_parent_spec_as_instance _eat_selfZunsafer, rB r r r r! x s8
zNonCallableMock.__init__c C s( 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 )rt ru rv rw rz )rf r1 attributer r r attach_mock s
zNonCallableMock.attach_mockc C s | j || 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 )rf r r r r r
mock_add_spec s z NonCallableMock.mock_add_specc C s| d }d }|d k rRt | rRt|tr*|}nt|}t|||}|oH|d }t|}| j}||d< ||d< ||d< ||d< d S )Nr _spec_class _spec_set_spec_signature
_mock_methods)r@ r r
_get_classr( dirrB ) rf r r r r r r resrB r r r r s
z NonCallableMock._mock_add_specc C s8 | j }| jd k r| jj}|tkr4| j| dd}|| _|S )Nz())r r )rr ra rY r _get_child_mock)rf rZ r r r Z__get_return_value s
z"NonCallableMock.__get_return_valuec C s, | j d k r|| j _n|| _t| |d d d S )Nz())ra rY rr r )rf rp 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 krt| S | j S )N)r r )rf r r r __class__ s
zNonCallableMock.__class__r[ r\ r] r^ rW c C sT | j }|d kr| jS |j}|d k rPt| rPt|t rPt| rPt|}||_|S )N)ra rs r_ callabler r r )rf delegatedZsfr r r Z__get_side_effect s z!NonCallableMock.__get_side_effectc C s( t |}| j}|d kr || _n||_d S )N) _try_iterra rs r_ )rf rp r r r r Z__set_side_effect s
z!NonCallableMock.__set_side_effect)rY r_ c C s |dkr g }t | |kr dS |jt | d| _d| _d| _t | _t | _t | _|r^t | _
|rhd| _ x0| j j
D ]"}t|tst|tkrqt|j| qtW | j
}t|r|| k r|j| dS )z-Restore the mock object to its initial state.NFr )idappendr[ r] r\ rU rW r^ rV r rr rs r` valuesr
_SpecState_deletedrX r )rf ZvisitedrY r_ ZchildrZ r r r rX
s, zNonCallableMock.reset_mockc K s` xZt |j dd dD ]B\}}|jd}|j }| }x|D ]}t||}q:W t||| qW 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 j dS )Nr .)count)entryr r r 8 s z0NonCallableMock.configure_mock..)keyr N)sorteditemssplitpopr< rz )rf r, argvalr+ finalr r r r r r + s
z NonCallableMock.configure_mockc C s |dkrt |n:| jd k r<|| jks.|tkrLt d| nt|rLt || jsd|jdrdt || jj|}|tkrt |np|d krd }| j d k rt
| j |}| j | |||| d}|| j|< n.t |t
rt|j|j|j|j|j}|| j|< |S ) Nr r z Mock object has no attribute %rassertassret)r r r r r > r r )r r )r" r _all_magicsrd r r r` rC r r r< r r r r r r r3 r r )rf r rJ r r r r rm A s6
zNonCallableMock.__getattr__c
C s" | j g}| j}| }d}|dgkr$d}t }xT|d k r~|}|j|j | d}|j dkrZd}|j}t||krnP |jt| q,W tt|}|jpd}t |dkr|d d
kr|d7 }||d< dj
|}d}|dkrd | }d} | j d k rd
} | j rd } | | j j
} d t| j
|| t| f S )Nr ()r r1 r ().r mock.z name=%rz spec=%rz spec_set=%rz<%s%s%s id='%s'>)r r )r1 r )rw ru ro r r r} r> reversedrv r joinr r r5 r )
rf Z
_name_listr ZlastdotseenZ_firstr Z name_stringZ spec_stringr r r rg g sL
zNonCallableMock.__repr__c C sh t stj| S | jpg }tt| }t| j}dd |D }dd |D }tt || | t| j
S )z8Filter the output of `dir(mock)` to only useful members.c S s g | ]}|j d s|qS )r )r )r er r r
s z+NonCallableMock.__dir__..c S s$ g | ] }|j d s t|r|qS )r )r rd )r r r r r r s ) r r __dir__r r r r> rB r ro r` )rf ZextrasZ from_typeZ from_dictr r r r s
zNonCallableMock.__dir__c s" |t krtj||S jrHjd k rH|jkrH|jkrHtd| n|tkrbd| }t|n|tkrjd k r|jkrtd| t |st
t |t || | fdd}n(t
|d | t
t || |j|< n.|dk r|_d S t
|||r|j|< tj||S )Nz!Mock object has no attribute '%s'z.Attempting to set unsupported magic method %r.c s f| |S )Nr )r+ r )rI rf r r r s z-NonCallableMock.__setattr__..r )r| r __setattr__r r rB r" _unsupported_magicsr r rz r _get_methodr r` r )rf r rp msgr )rI rf r r s2
zNonCallableMock.__setattr__c C s |t kr2|t| jkr2tt| | || jkr2d S || jkrHtj| | | jj|t}|t krft
||tk rv| j|= t | j|< d S )N) r r rB delattrr __delattr__r` rC _missingr r" )rf r r r r r r s
zNonCallableMock.__delattr__c C s | j pd}t|||S )Nr1 )rv _format_call_signature)rf r+ r, r r r r _format_mock_call_signature s
z+NonCallableMock._format_mock_call_signaturec C sD d}| j ||}| j}t|dkr.|dd }| j | }|||f S )Nz!Expected call: %s
Actual call: %s r )r r] r )rf r+ r, messageexpected_stringr] Z
actual_stringr r r _format_mock_failure_message s
z,NonCallableMock._format_mock_failure_messagec C st | j }|dk rlt|dkr(d}|\}}n
|\}}}y||j||fS tk
rh } z
|jdS d}~X qpX 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.
Nrb r )r r r) TypeErrorwith_traceback)rf _callr- r r+ r, r r r r
_call_matcher s
z NonCallableMock._call_matcherc C s. | }|j dkr*d|jpd|j f }t|dS )z/assert that the mock was never called.
r z7Expected '%s' to not have been called. Called %s times.r1 N)r\ rv AssertionError)r* rf r r r r rP s
z!NonCallableMock.assert_not_calledc C s( | }|j dkr$d|j pd}t|dS )z6assert that the mock was called at least once
r z"Expected '%s' to have been called.r1 N)r\ rv r )r* rf r r r r rO s
z NonCallableMock.assert_calledc C s. | }|j dks*d|jpd|j f }t|dS )z3assert that the mock was called only once.
r z8Expected '%s' to have been called once. Called %s times.r1 N)r\ rv r )r* rf r r r r rQ s
z"NonCallableMock.assert_called_oncec s| | j dkr(j }td|f fdd}j f}jj }||krxt|trh|nd}t| |dS )zassert that the mock was called 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 Expected call: %s
Not calledc s j } | S )N)r )r )r+ r, rf r r _error_message' s z:NonCallableMock.assert_called_with.._error_message)r] r r r r Exception)r* r+ r, expectedr actualcauser )r+ r, rf r rN s
z"NonCallableMock.assert_called_withc O s6 | }|j dks*d|jpd|j f }t||j||S )ziassert that the mock was called exactly once and that that call was
with the specified arguments.r z1Expected '%s' to be called once. Called %s times.r1 )r\ rv r rN )r* r+ r, rf r r r r rR 1 s
z'NonCallableMock.assert_called_once_withc s fdd|D }t |tr |nd}t fdd jD }|sd||kr`tdt| jf |dS t|}g }x:|D ]2}y|j| W qv tk
r |j| Y qvX qvW |rtdt |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 | ]} j |qS r )r )r c)rf r r r F s z4NonCallableMock.assert_has_calls..Nc 3 s | ]} j |V qd S )N)r )r r )rf r r H s z3NonCallableMock.assert_has_calls..z(Calls not found.
Expected: %r
Actual: %rz %r not all found in call list)
r r rU rW r r> remover& r r? )rf ZcallsZ any_orderr r Z all_callsZ not_foundZkallr )rf r rS < s*
z NonCallableMock.assert_has_callsc sZ j ||f} fdd jD }||krVt|tr8|nd} j||}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.c s g | ]} j |qS r )r )r r )rf r r r f s z3NonCallableMock.assert_any_call..Nz%s call not found)r r^ r r r r )rf r+ r, r r r r r )rf r rT _ s z NonCallableMock.assert_any_callc K sF t | }t|ts2t|tr"t}q.) r r r r r r r r r r, attribute_namer )rf r r r r r i s z _patch.copyc C s t |tr| j|S | j|S )N)r r decorate_classdecorate_callable)rf r' r r r r$ v s
z_patch.__call__c C sR xLt |D ]@}|jtjs q
t||}t|ds2q
| j }t|||| q
W |S )Nr$ )r r r TEST_PREFIXr< r r rz )rf r attr
attr_valuer r r r r | s
z_patch.decorate_classc s< t dr jj| S t fdd| g_S )N patchingsc s g }g }t }zybxJjD ]@}|j }|j| |jd k rF|j| q|jtkr|j| qW | t |7 } | |S ||krt|r|j| t j
} Y nX W d xt |D ]}|j | qW X d S )N)
r? r __enter__r r updater r r sysexc_infor __exit__)r+ Zkeywargs
extra_argsZentered_patchersr patchingr )r' patchedr r r s*
z)_patch.decorate_callable..patched)r r r r )rf r' r )r' r r r s
z_patch.decorate_callablec C s | j }| j}t}d}y|j| }W n$ ttfk
rH t||t}Y nX d}|tkrft|t rfd| _
| j
r|tkrtd||f ||fS )NFTz!%s does not have the attribute %r) r r r rB r" KeyErrorr< _builtinsr r r )rf r r rI localr r r get_original s z_patch.get_originalc C s> | j | j| j }}}| j| j }}| j}| j | _|dkr@d}|dkrLd}|dkrXd}|dk rp|dk rptd|dk s|dk r|dkrtd| j \}}|t
ko|dkrTd} |dkr|}|dkr|}d}n&|dk r|dkr|}d}n |dkr|}|dk s
|dk r,|t
kr tdt |t r,d} t
}
i } |dk rD|}
nN|dk sX|dk r|} |dk rj|} t| r~d| k}
n
t| }
|
rt}
|dk r|| d< |dk r|| d < t |
t rt|
tr| jr| j| d
< | j| |
f | }| rt|r|} |dk r|} t| r2t| r2t}
| jd
|
f |d d | |_nl|dk r|t
k rptd
|t
krtdt|}|dkr|}t|f|| jd|}n|rtd|}|| _|| _ t | j| j| | j dk r:i }| j t
kr||| j < x.| j D ]$}|j }|j t
kr|j| qW |S |S )zPerform the patch.FNz Can't specify spec and autospecTz6Can't provide explicit spec_set *and* spec or autospecz!Can't use 'spec' with create=Truer$ r r r z())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)TN)!r r r r r, r r r r r r r r r r@ r r r r
r r
r rE r rY boolr
temp_originalr rz r r r )rf r r r r r, r rI r ZinheritKlass_kwargsZ this_specZ not_callableZnew_attrr r r r r r r s
z_patch.__enter__c G s t | std| jr4| jtk r4t| j| j| j nBt| j| j | j rvt
| j| j sd| jdkrvt| j| j| j | `| `| `x$t | j D ]}t |r|j
| qW dS ) zUndo the patch.z stop called on unstarted patcherr6 r8 r9 __annotations__r: N)r6 r8 r9 r r: )r RuntimeErrorr r r rz r r r r r r r r
)rf r r r r r r
H s z_patch.__exit__c C s | j }| jj| |S )z-Activate a patch, returning any created mock.)r _active_patchesr )rf rJ r r r start` s z _patch.startc C s. y| j j| W n tk
r$ Y nX | j S )zStop an active patch.)r r r& r
)rf r r r stopg s
z _patch.stop)r5 r8 rh r r r! r r$ r r r r r
r r r r r r r I s
(~r c sP y j dd\ }W n& ttfk
r: td f Y nX fdd}||fS )Nr r z.Need a valid target to patch. You supplied: %rc s t S )N)r r )r r r r y s z _get_target..)rsplitr r& )r r r r )r r _get_targets s r c
s$ 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.
c s S )Nr r )r r r r s z _patch_object..)r )
r r r r r r r r r, r r )r r
_patch_object} s
r! c
s t tkr fdd}n fdd}|s2tdt|j }|d \} }
t|| |
|||||i } | | _xB|dd D ]2\} }
t|| |
|||||i } | | _| jj| qvW | 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 )N)r r )r r r r s z!_patch_multiple..c s S )Nr r )r r r r s z=Must supply at least one keyword argument with patch.multipler r N) r strr& r> r r r r r )
r r r r r r r, r r r r r Z this_patcherr )r r _patch_multiple s&
r# c
K s$ t | \}} t|| ||||||| S )a
`patch` acts as a function decorator, class decorator or a context
manager. Inside the body of the function or with statement, the `target`
is patched with a `new` object. When the function/with statement exits
the patch is undone.
If `new` is omitted, then the target is replaced with a
`MagicMock`. 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 `MagicMock` is
used.
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
the `Mock` (or `new_callable`) on construction.
`patch.dict(...)`, `patch.multiple(...)` and `patch.object(...)` are
available for alternate use-cases.
)r r )
r r r r r r r r, r r r r r r s E
c @ sV e Zd ZdZf dfddZdd Zdd Zd d
Zd d Zd
d Z dd Z
eZ e
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.
Fc K s> t |trt|}|| _t|| _| jj| || _d | _d S )N) r r" r in_dictrn r r
clear _original)rf r% r r& r, r r r r! 0 s
z_patch_dict.__init__c s. t trj S t fdd}|S )Nc
s" j z
| |S j X d S )N)r$
_unpatch_dict)r+ r )frf r r _inner> s
z$_patch_dict.__call__.._inner)r r r r )rf r) r* r )r) rf r r$ ; s
z_patch_dict.__call__c C s\ xVt |D ]J}t||}|jtjr
t|dr
t| j| j| j }||}t
||| q
W |S )Nr$ ) r r< r r r r r$ r% r r& rz )rf r r r Z decoratorZ decoratedr r r r I s
z_patch_dict.decorate_classc C s | j dS )zPatch the dict.N)r$ )rf r r r r T s z_patch_dict.__enter__c C s | j }| j}| j}y |j }W n2 tk
rP i }x|D ]}|| ||< q8W Y nX || _|rdt| y|j| W n. tk
r x|D ]}|| ||< qW Y nX d S )N)r r% r& r r" r' _clear_dictr
)rf r r% r& rI r r r r r$ Y s"
z_patch_dict._patch_dictc C sV | j }| j}t| y|j| W n. tk
rP x|D ]}|| ||< q8W Y nX d S )N)r% r' r+ r
r" )rf r% rI r r r r r( s s
z_patch_dict._unpatch_dictc G s | j dS )zUnpatch the dict.F)r( )rf r+ r r r r
s z_patch_dict.__exit__N)
r5 r8 rh r6 r! r$ r r r$ r( r
r r r r r r r$ s
r$ c C sB y | j W n0 tk
r< t| }x|D ]
}| |= q*W Y nX d S )N)r& r" r> )r% keysr r r r r+ s
r+ c C s xt tjD ] } | j q W dS )z7Stop all active patches. LIFO to unroll nested patches.N)r r r r )r r r r _patch_stopall s r- Ztestzlt 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 trunc floor ceil bool next 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 r s r c c s | ]}d | V qdS )zr%sNr )r r/ r r r r s __get____set__
__delete__ __reversed__ __missing__
__reduce__
__reduce_ex__Z__getinitargs____getnewargs__ __getstate__ __setstate__
__getformat__
__setformat__rg r __subclasses__
__format____getnewargs_ex__c s fdd}| |_ |S )z:Turns a callable object (like a mock) into a real functionc s | f||S )Nr )rf r+ r )r' r r method s z_get_method..method)r5 )r r' r? r )r' r r s r c C s h | ] }d | qS )z__%s__r )r r? r r r r s rm r r! r __prepare____instancecheck____subclasscheck____del__c C s
t j| S )N)r __hash__)rf r r r r s r c C s
t j| S )N)r __str__)rf r r r r s c C s
t j| S )N)r
__sizeof__)rf r r r r s )rD rE rF r y ?g ?) __lt____gt____le____ge____int__r __len__r
__complex__ __float____bool__ __index__c s fdd}|S )Nc s$ j j}|tk r|S | kr dS tS )NT)__eq__rr r NotImplemented)otherret_val)rf r r rQ s z_get_eq..__eq__r )rf rQ r )rf r _get_eq s rU c s fdd}|S )Nc s j jtk rtS | kr dS tS )NF)__ne__rr r rR )rS )rf r r rV s
z_get_ne..__ne__r )rf rV r )rf r _get_ne s rW c s fdd}|S )Nc s j j} | tkrtg S t| S )N)r rr r r )rT )rf r r r s z_get_iter..__iter__r )rf r r )rf r _get_iter s rX )rQ rV r c C s t j|t}|tk r ||_d S tj|}|d k rdy || }W n tk
rX t|}Y nX ||_d S tj|}|d k r|| |_d S )N)_return_valuesrC r rY _calculate_return_valuer" _side_effect_methodsr_ )r1 r? r ZfixedZreturn_calulatorrY Z
side_effectorr r r _set_return_value s
r\ c @ s e Zd Zdd Zdd ZdS )
MagicMixinc O s& | j tt| j|| | j d S )N)_mock_set_magicsr r] r! )rf r+ r r r r r! ( s zMagicMixin.__init__c C s t }t| dd d k rTt j| j}t }t | }x$|D ] }|t| jkr4t| | q4W |tt| j }t| }x |D ]}t||t || qtW d S )Nr )
_magicsr< intersectionr ro r rB r rz
MagicProxy)rf Z these_magicsZ
remove_magicsr r r r r r^ . s
zMagicMixin._mock_set_magicsN)r5 r8 rh r! 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 | j || | j 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 r^ )rf r r r r r r G s z"NonCallableMagicMock.mock_add_specN)F)r5 r8 rh r6 r r r r r r E s 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 | j || | j 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 r^ )rf r r r r r r ] s zMagicMock.mock_add_specN)F)r5 r8 rh r6 r r r r r r R s
c @ s. e Zd Zdd Zdd Zdd Zd
dd ZdS ) ra c C s || _ || _d S )N)r r )rf r r r r r r! i s zMagicProxy.__init__c O s | j }|||S )N) create_mock)rf r+ r, mr r r r$ m s zMagicProxy.__call__c C s8 | j }| j}|j|||d}t||| t||| |S )N)r r r )r r r rz r\ )rf r r rc r r r rb q s zMagicProxy.create_mockNc C s | j S )N)rb )rf r r r r r r0 z s zMagicProxy.__get__)N)r5 r8 rh r! r$ rb r0 r r r r ra h s ra c @ s( e Zd ZdZdd Zdd Zdd ZdS ) _ANYz2A helper object that compares equal to everything.c C s dS )NTr )rf rS r r r rQ s z _ANY.__eq__c C s dS )NFr )rf rS r r r rV s z _ANY.__ne__c C s dS )Nzr )rf r r r rg s z
_ANY.__repr__N)r5 r8 rh r6 rQ rV rg r r r r rd s rd c C sd d| }d}dj dd |D }dj dd t|j D }|rD|}|r\|rT|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 rp r r r r s )r r r )r r+ r, r Zformatted_argsZ args_stringZ
kwargs_stringr r r r s r c @ sv e Zd ZdZf ddddfddZf ddddfdd Zd
d ZejZd d
Z dd Z
dd Z dd Z dd Z
dd 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 NFTc C s f }i }t |}|dkr$|\}}}nr|dkrd|\} }
t| trX| }t|
trR|
}qb|
}q| |
}}n2|dkr|\}t|tr|}nt|tr|}n|}|rtj| ||fS tj| |||fS )Nr rb r )r r r" r? r ) r rp r r r from_kallr+ r, _lenfirstsecondr r r r s.
z
_Call.__new__c C s || _ || _|| _d S )N)rv rt _mock_from_kall)rf rp r r r rf r r r r! s z_Call.__init__c C sf |t kr dS y t|}W n tk
r, dS X d}t| dkrH| \}}n
| \}}}t| dd rzt|dd rz| j|jkrzdS d}|dkrf i }}n|dkr|\}}}n|dkr|\} t| tr| }i }n"t| tr| }f i }}nf }| }nV|dkr>|\}
} t|
tr2|
}t| tr&| i }}n
f | }}n
|
| }}ndS |rV||krVdS ||f||fkS ) NTFr rb rt r r r )r r r r< rt r r? r" ) rf rS Z len_otherZ self_nameZ self_argsZ self_kwargsZ
other_nameZ
other_argsZ other_kwargsrp rh ri r r r rQ sP
z _Call.__eq__c O s< | j d kr td||fddS | j d }t| j ||f|| dS )Nr z())r )r r )rv r )rf r+ r, r r r r r$ s
z_Call.__call__c C s2 | j d krt|ddS d| j |f }t|| ddS )NF)r rf z%s.%s)r r rf )rv r )rf r r r r r rm s
z_Call.__getattr__c O s | j d||S )Nr )rm )rf r+ r, r r r r $ s z _Call.countc O s | j d||S )Nindex)rm )rf r+ r, r r r rk ' s z _Call.indexc C s| | j s&| jpd}|jdr"d| }|S t| dkr@d}| \}}n0| \}}}|sTd}n |jdshd| }nd| }t|||S )Nr z()zcall%srb zcall.%s)rj rv r r r )rf r r+ r, r r r rg * s
z_Call.__repr__c C s8 g }| }x"|dk r*|j r"|j| |j}q
W tt|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)rj r rt rU r )rf valsr r r r call_list? s
z_Call.call_list)r5 r8 rh r6 r r! rQ r rV r$ rm r rk rg rm r r r r r s 7r )rf c K s, t | rt| } t| t}d| i}|r0d| i}n | dkr.r rx rx rx rx )r bytesr ) read_dataZ data_as_listliner )rw r _iterate_read_data s
r| r c s fdd}fdd}fdd t dkr`ddl}ttt|jjtt|ja | dkrttd t d
} tt d j
_ t dgdj
_ dj_ dj_ dj_ |j_ d < d j_|j_ fd
d}|| _| _ | 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` methoddline`, and `readlines` of the
file handle to return. This is an empty string by default.
c s j jd k rj jS t d S )Nr ) readlinesrY r> )r+ r, )_statehandler r _readlines_side_effect( s z)mock_open.._readlines_side_effectc s( j jd k rj jS t j d S )Nr )readrY r r )r+ r, )r~ r rz r r _read_side_effect- s z$mock_open.._read_side_effectc 3 sJ j jd k r xj jV qW x d D ]
} | V q&W xt V q6W d S )Nr )readlinerY r )r{ )r~ r rz r r _readline_side_effect2 s
z(mock_open.._readline_side_effectNr open)r r )r r c s6 t d< jjd kr2 d< d j_tS )Nr r )r| r r_ r )r+ r, )r r~ r rz r r
reset_dataS s
z mock_open..reset_data) file_spec_ior> ro r
TextIOWrapperunionBytesIOr r r rY r| writer r r} r_ )r1 rz r r r r r )r r~ r rz r r s. "
c @ s( e Zd ZdZdd Zdd Zdd 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 |S )N)r )rf r, r r r r i s z PropertyMock._get_child_mockc C s | S )Nr )rf r Zobj_typer r r r0 l s zPropertyMock.__get__c C s | | d S )Nr )rf r r r r r r1 n s zPropertyMock.__set__N)r5 r8 rh r6 r r0 r1 r r r r r
` s )
r r r r r r r r r r
r r r
)F)F)NFNNN)FFNN)Nr )o__all__ __version__r% r r builtinstypesr functoolsr r r r
BaseExceptionr platformr ZlangZ Throwabler superr r r r( r4 r/ r= r@ rE rM rH rd r re ri r r ZMISSINGr ZDELETEDr rq r| r r> rU r r r r
r r r r r r r r r! r# r r$ r+ r- rn ZmultipleZstopallr Z
magic_methodsZnumericsr r ZinplacerightZ
_non_defaultsr r_ r r rZ rR rY rU rW rX r[ r\ r] r r ra rd r r r? r r r rn r r r rQ r# r0 rr r r| r r
r r r r s
4 i5 ,
1Jv
,
w
D