bpo-45215: In Mock class, deprecate invalid name parent args and expand docs #28378
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This PR is stale because it has been open for 30 days with no activity. |
cjw296
reviewed
Jun 9, 2023
Comment on lines
+438
to
+454
| warnings.warn('parent argument should be a Mock instance', | ||
| DeprecationWarning, stacklevel=stacklevel) | ||
|
|
||
| if name is not None and not isinstance(name, str): | ||
| import warnings | ||
| if isinstance(self, NonCallableMagicMock): | ||
| stacklevel = 3 | ||
| elif isinstance(self, MagicMock): | ||
| stacklevel = 4 | ||
| elif isinstance(self, Mock): | ||
| stacklevel = 3 | ||
| elif isinstance(self, NonCallableMock): | ||
| stacklevel = 2 | ||
| else: | ||
| stacklevel = 1 | ||
| warnings.warn('name argument should be a string', | ||
| DeprecationWarning, stacklevel=stacklevel) |
There was a problem hiding this comment.
Why are these deprecation warnings rather than just exceptions?
I don't find warnings like this helpful, as the behaviour here is unlikely to ever be changed...
There was a problem hiding this comment.
This would be a backwards incompatible change with exceptions. Right now, using non-string arg is fine if you don't display the mock obj.
That said, I think this probably shouldn't be merged because it doesn't seem like people are running into this issue, as it was created a while ago and nobody else commented on it.
If you agree, we can close this issue and MR.
|
Closing given @akulakov 's comment above: #28378 (comment) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://bugs.python.org/issue45215