Skip to content

bpo-17185: Add __signature__ to mock that can be used by inspect for signature #11048

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cjw296 merged 6 commits into from
Dec 12, 2018
Merged

bpo-17185: Add __signature__ to mock that can be used by inspect for signature #11048

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ce36d17
Fix partial and partial method signatures in mock
tirkarthi Dec 5, 2018
e73a549
Add more calls
tirkarthi Dec 9, 2018
bf5289b
Add NEWS entry
tirkarthi Dec 9, 2018
3b3f805
Use assertEquals and fix markup in NEWS
tirkarthi Dec 9, 2018
21bfc2c
Refactor branching and add markup reference for functools
tirkarthi Dec 10, 2018
68bdf07
Revert partial object related changes and fix pr comments
tirkarthi Dec 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions Lib/unittest/mock.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ def checksig(_mock_self, *args, **kwargs):
sig.bind(*args, **kwargs)
_copy_func_details(func, checksig)
type(mock)._mock_check_sig = checksig
type(mock).__signature__ = sig


def _copy_func_details(func, funcopy):
Expand Down Expand Up @@ -172,11 +173,11 @@ def checksig(*args, **kwargs):
return mock(*args, **kwargs)""" % name
exec (src, context)
funcopy = context[name]
_setup_func(funcopy, mock)
_setup_func(funcopy, mock, sig)
return funcopy


def _setup_func(funcopy, mock):
def _setup_func(funcopy, mock, sig):
funcopy.mock = mock

# can't use isinstance with mocks
Expand Down Expand Up @@ -224,6 +225,7 @@ def reset_mock():
funcopy.assert_called = assert_called
funcopy.assert_not_called = assert_not_called
funcopy.assert_called_once = assert_called_once
funcopy.__signature__ = sig

mock._mock_delegate = funcopy

Expand Down
30 changes: 30 additions & 0 deletions Lib/unittest/test/testmock/testhelpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import inspect
import time
import types
import unittest
Expand Down Expand Up @@ -901,6 +902,35 @@ def __getattr__(self, attribute):
self.assertFalse(hasattr(autospec, '__name__'))


def test_spec_inspect_signature(self):

def myfunc(x, y):
pass

mock = create_autospec(myfunc)
mock(1, 2)
mock(x=1, y=2)

@cjw296 cjw296 Dec 11, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be good to see some assertions about mock_calls here.


self.assertEqual(inspect.getfullargspec(mock), inspect.getfullargspec(myfunc))
self.assertEqual(mock.mock_calls, [call(1, 2), call(x=1, y=2)])
self.assertRaises(TypeError, mock, 1)


def test_spec_inspect_signature_annotations(self):

def foo(a: int, b: int=10, *, c:int) -> int:
return a + b + c

@cjw296 cjw296 Dec 11, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please split this out into its own test case.


mock = create_autospec(foo)
mock(1, 2, c=3)
mock(1, c=3)

@cjw296 cjw296 Dec 11, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mock_calls assertions here too please.


self.assertEqual(inspect.getfullargspec(mock), inspect.getfullargspec(foo))
self.assertEqual(mock.mock_calls, [call(1, 2, c=3), call(1, c=3)])
self.assertRaises(TypeError, mock, 1)
self.assertRaises(TypeError, mock, 1, 2, 3, c=4)


class TestCallList(unittest.TestCase):

def test_args_list_contains_call_list(self):
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2018-12-09-17-04-15.bpo-17185.SfSCJF.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Set ``__signature__`` on mock for :mod:`inspect` to get signature.
Patch by Karthikeyan Singaravelan.