From 9854789efec0c707fff871b32b2833f32b078fb3 Mon Sep 17 00:00:00 2001 From: "Gregory P. Smith" Date: Sun, 7 Aug 2016 08:52:26 -0700 Subject: [PATCH] Issue #26750: unittest.mock.create_autospec() now works properly for subclasses of property() and other data descriptors. --- Lib/unittest/mock.py | 10 +++- Lib/unittest/test/testmock/testhelpers.py | 60 +++++++++++++++-------- Misc/NEWS | 3 ++ 3 files changed, 51 insertions(+), 22 deletions(-) diff --git a/Lib/unittest/mock.py b/Lib/unittest/mock.py index 7f30b287ae0..83e9c46676e 100644 --- a/Lib/unittest/mock.py +++ b/Lib/unittest/mock.py @@ -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 @@ -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 = {} diff --git a/Lib/unittest/test/testmock/testhelpers.py b/Lib/unittest/test/testmock/testhelpers.py index 1dbc0b64ba5..34776347daa 100644 --- a/Lib/unittest/test/testmock/testhelpers.py +++ b/Lib/unittest/test/testmock/testhelpers.py @@ -802,35 +802,53 @@ class SpecSignatureTest(unittest.TestCase): a.f.assert_called_with(self=10) - def test_autospec_property(self): + def test_autospec_data_descriptor(self): + class Descriptor(object): + def __init__(self, value): + self.value = value + + def __get__(self, obj, cls=None): + if obj is None: + return self + return self.value + + def __set__(self, obj, value): + pass + + class MyProperty(property): + pass + class Foo(object): + __slots__ = ['slot'] + @property - def foo(self): + def prop(self): return 3 - foo = create_autospec(Foo) - mock_property = foo.foo + @MyProperty + def subprop(self): + return 4 - # 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 test_autospec_slots(self): - class Foo(object): - __slots__ = ['a'] + 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): diff --git a/Misc/NEWS b/Misc/NEWS index cdbb1a4d6aa..e6548c283ab 100644 --- a/Misc/NEWS +++ b/Misc/NEWS @@ -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.