Skip to content

Commit

Permalink
Issue python#26750: unittest.mock.create_autospec() now works properly
Browse files Browse the repository at this point in the history
for subclasses of property() and other data descriptors.
  • Loading branch information
gpshead committed Aug 7, 2016
1 parent abfe28b commit 9854789
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 22 deletions.
10 changes: 9 additions & 1 deletion Lib/unittest/mock.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,20 @@ class _slotted(object):
__slots__ = ['a']


# Do not use this tuple. It was never documented as a public API.
# It will be removed. It has no obvious signs of users on github.
DescriptorTypes = (
type(_slotted.a),
property,
)


def _is_data_descriptor(obj):
# Data descriptors are Properties, slots, getsets and C data members.
return ((hasattr(obj, '__set__') or hasattr(obj, '__del__')) and
hasattr(obj, '__get__'))


def _get_signature_object(func, as_instance, eat_self):
"""
Given an arbitrary, possibly callable object, try to create a suitable
Expand Down Expand Up @@ -2130,7 +2138,7 @@ def create_autospec(spec, spec_set=False, instance=False, _parent=None,
_kwargs.update(kwargs)

Klass = MagicMock
if type(spec) in DescriptorTypes:
if _is_data_descriptor(spec):
# descriptors don't have a spec
# because we don't know what type they return
_kwargs = {}
Expand Down
60 changes: 39 additions & 21 deletions Lib/unittest/test/testmock/testhelpers.py
Original file line number Diff line number Diff line change
Expand Up @@ -802,35 +802,53 @@ def f(a, self):
a.f.assert_called_with(self=10)


def test_autospec_property(self):
class Foo(object):
@property
def foo(self):
return 3
def test_autospec_data_descriptor(self):
class Descriptor(object):
def __init__(self, value):
self.value = value

foo = create_autospec(Foo)
mock_property = foo.foo
def __get__(self, obj, cls=None):
if obj is None:
return self
return self.value

# no spec on properties
self.assertIsInstance(mock_property, MagicMock)
mock_property(1, 2, 3)
mock_property.abc(4, 5, 6)
mock_property.assert_called_once_with(1, 2, 3)
mock_property.abc.assert_called_once_with(4, 5, 6)
def __set__(self, obj, value):
pass

class MyProperty(property):
pass

def test_autospec_slots(self):
class Foo(object):
__slots__ = ['a']
__slots__ = ['slot']

@property
def prop(self):
return 3

@MyProperty
def subprop(self):
return 4

desc = Descriptor(42)

foo = create_autospec(Foo)
mock_slot = foo.a

# no spec on slots
mock_slot(1, 2, 3)
mock_slot.abc(4, 5, 6)
mock_slot.assert_called_once_with(1, 2, 3)
mock_slot.abc.assert_called_once_with(4, 5, 6)
def check_data_descriptor(mock_attr):
# Data descriptors don't have a spec.
self.assertIsInstance(mock_attr, MagicMock)
mock_attr(1, 2, 3)
mock_attr.abc(4, 5, 6)
mock_attr.assert_called_once_with(1, 2, 3)
mock_attr.abc.assert_called_once_with(4, 5, 6)

# property
check_data_descriptor(foo.prop)
# property subclass
check_data_descriptor(foo.subprop)
# class __slot__
check_data_descriptor(foo.slot)
# plain data descriptor
check_data_descriptor(foo.desc)


class TestCallList(unittest.TestCase):
Expand Down
3 changes: 3 additions & 0 deletions Misc/NEWS
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ Core and Builtins
Library
-------

- Issue #26750: unittest.mock.create_autospec() now works properly for
subclasses of property() and other data descriptors.

- Issue #27568: Prevent HTTPoxy attack (CVE-2016-1000110). Ignore the
HTTP_PROXY variable when REQUEST_METHOD environment is set, which indicates
that the script is in CGI mode.
Expand Down

0 comments on commit 9854789

Please sign in to comment.