Skip to content

bpo-41403: Improve error message for invalid mock target #30833

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
iritkatriel merged 3 commits into from
Jan 23, 2022
Merged

bpo-41403: Improve error message for invalid mock target #30833

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d7d4e0b
bpo-41403: Improve error message for invalid mock target
iritkatriel Jan 23, 2022
6460ea1
add news
iritkatriel Jan 23, 2022
461e59e
use format string
iritkatriel Jan 23, 2022
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
Next Next commit
bpo-41403: Improve error message for invalid mock target
  • Loading branch information
@iritkatriel
iritkatriel committed Jan 23, 2022
commit d7d4e0b0b65101247275179dd88cf8a74b71f0b0
2 changes: 1 addition & 1 deletion Lib/unittest/mock.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1589,7 +1589,7 @@ def stop(self):
def _get_target(target):
try:
target, attribute = target.rsplit('.', 1)
except (TypeError, ValueError):
except (TypeError, ValueError, AttributeError):
raise TypeError("Need a valid target to patch. You supplied: %r" %
(target,))

@arhadthedev arhadthedev Jan 23, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
raise TypeError("Need a valid target to patch. You supplied: %r" %
(target,))
raise TypeError(f"Need a valid target to patch. You supplied: {target}")

since there is a change of nearby lines anyway. Plus, "b'%r' is deprecated, but will not be removed during the 3.x series" in the docs.

@iritkatriel iritkatriel Jan 23, 2022

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Should be {target!r} I suppose?

@arhadthedev arhadthedev Jan 23, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ah, yes. I was optimistic seeing string-only nature of target:

cpython/Lib/unittest/mock.py

Line 1693 in 461e59e

`target` should be a string in the form `'package.module.ClassName'`. The

Like, once it was an object requiring some special formatting but now it's just a string. However, I forgot that %r additionally escapes non-ascii code points.

@iritkatriel iritkatriel Jan 23, 2022

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Right, also this bpo is about the case where the error is that you passed in some non-string object.

return partial(pkgutil.resolve_name, target), attribute
Expand Down
9 changes: 7 additions & 2 deletions Lib/unittest/test/testmock/testpatch.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1933,8 +1933,13 @@ def test(mock):


def test_invalid_target(self):
with self.assertRaises(TypeError):
patch('')
class Foo:
pass

for target in ['', 12, Foo()]:
with self.subTest(target=target):
with self.assertRaises(TypeError):
patch(target)


def test_cant_set_kwargs_when_passing_a_mock(self):
Expand Down