def __init__(self, method_name, target):
"""
:param str method_name: The name of the method to double.
:param Target target: A ``Target`` object containing the object with the method to double.
"""
self._method_name = method_name
self._target = target
self._verify_method()
self._allowances = []
self._expectations = []
self._proxy_method = ProxyMethod(
target, method_name,
lambda args, kwargs: self._find_matching_double(args, kwargs))
def __init__(self, method_name, target):
"""
:param str method_name: The name of the method to double.
:param Target target: A ``Target`` object containing the object with the method to double.
"""
self._method_name = method_name
self._target = target
self._verify_method()
self._allowances = []
self._expectations = []
self._proxy_method = ProxyMethod(
target,
method_name,
lambda args, kwargs: self._find_matching_double(args, kwargs)
)
class MethodDouble(object):
"""A double of an individual method."""
def __init__(self, method_name, target):
"""
:param str method_name: The name of the method to double.
:param Target target: A ``Target`` object containing the object with the method to double.
"""
self._method_name = method_name
self._target = target
self._verify_method()
self._allowances = []
self._expectations = []
self._proxy_method = ProxyMethod(
target,
method_name,
lambda args, kwargs: self._find_matching_double(args, kwargs)
)
def add_allowance(self, caller):
"""Adds a new allowance for the method.
:param: tuple caller: A tuple indicating where the method was called
:return: The new ``Allowance``.
:rtype: Allowance
"""
allowance = Allowance(self._target, self._method_name, caller)
self._allowances.insert(0, allowance)
return allowance
def add_expectation(self, caller):
"""Adds a new expectation for the method.
:return: The new ``Expectation``.
:rtype: Expectation
"""
expectation = Expectation(self._target, self._method_name, caller)
self._expectations.insert(0, expectation)
return expectation
def restore_original_method(self):
"""Removes the proxy method on the target and replaces it with its original value."""
self._proxy_method.restore_original_method()
def verify(self):
"""Verifies all expectations on the method.
:raise: ``MockExpectationError`` on the first expectation that is not satisfied, if any.
"""
for expectation in self._expectations:
if not expectation.is_satisfied():
expectation.raise_failure_exception()
def _find_matching_allowance(self, args, kwargs):
"""Return a matching allowance.
Returns the first allowance that matches the ones declared. Tries one with specific
arguments first, then falls back to an allowance that allows arbitrary arguments.
:return: The matching ``Allowance``, if one was found.
:rtype: Allowance, None
"""
for allowance in self._allowances:
if allowance.satisfy_exact_match(args, kwargs):
return allowance
for allowance in self._allowances:
if allowance.satisfy_custom_matcher(args, kwargs):
return allowance
for allowance in self._allowances:
if allowance.satisfy_any_args_match():
return allowance
def _find_matching_double(self, args, kwargs):
"""Returns the first matching expectation or allowance.
Returns the first allowance or expectation that matches the ones declared. Tries one
with specific arguments first, then falls back to an expectation that allows arbitrary
arguments.
:return: The matching ``Allowance`` or ``Expectation``, if one was found.
:rtype: Allowance, Expectation, None
"""
expectation = self._find_matching_expectation(args, kwargs)
if expectation:
return expectation
allowance = self._find_matching_allowance(args, kwargs)
if allowance:
return allowance
def _find_matching_expectation(self, args, kwargs):
"""Return a matching expectation.
Returns the first expectation that matches the ones declared. Tries one with specific
arguments first, then falls back to an expectation that allows arbitrary arguments.
:return: The matching ``Expectation``, if one was found.
:rtype: Expectation, None
"""
for expectation in self._expectations:
if expectation.satisfy_exact_match(args, kwargs):
return expectation
for expectation in self._expectations:
if expectation.satisfy_custom_matcher(args, kwargs):
return expectation
for expectation in self._expectations:
if expectation.satisfy_any_args_match():
return expectation
def _verify_method(self):
"""Verify that a method may be doubled.
Verifies that the target object has a method matching the name the user is attempting to
double.
:raise: ``VerifyingDoubleError`` if no matching method is found.
"""
# TODO: Find a way to set class_level without manual type checking.
if isinstance(self._target.obj, ClassDouble):
class_level = True
elif isinstance(self._target.obj, InstanceDouble):
class_level = False
else:
class_level = self._target.is_class()
verify_method(self._target, self._method_name, class_level=class_level)
