Extend patch decorator to add methods to class types #11932
Merged
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
thrau
requested changes
Nov 26, 2024
Comment on lines
136
to
138
| if inspect.isclass(target): | ||
| # Special case: when a class type is passed, we bound the function to the class type patching __getattr__ | ||
| return Patch._extend_class(target, fn) |
There was a problem hiding this comment.
i think having this check here doesn't make a ton of sense, since this is explicitly to patch functions. i think this check should be in patch
| @@ -111,8 +121,22 @@ def __exit__(self, exc_type, exc_val, exc_tb): | |||
| self.undo() | |||
| return self | |||
|
|
|||
| @staticmethod | |||
| def _extend_class(target: Callable, fn: Callable): | |||
There was a problem hiding this comment.
i would put this on the same footing as function
Suggested change
| def _extend_class(target: Callable, fn: Callable): | |
| def extend_class(target: Callable, fn: Callable): |
Comment on lines
92
to
101
| try: | ||
| self.old = getattr(self.obj, name) | ||
| if self.old and name == "__getattr__": | ||
| raise Exception("You can't patch class types implementing __getattr__") | ||
| except AttributeError as e: | ||
| # When we want to add a function to a class type, we want to intercept this exception and check if the | ||
| # name is `__getattr__`. | ||
| if name != "__getattr__": | ||
| raise e | ||
| self.old = None |
There was a problem hiding this comment.
i think this check should be in apply so we don't cause exceptions while instantiating the object
thrau
approved these changes
Nov 27, 2024
| @@ -111,6 +119,16 @@ def __exit__(self, exc_type, exc_val, exc_tb): | |||
| self.undo() | |||
| return self | |||
|
|
|||
| @staticmethod | |||
| def extend_class(target: Callable, fn: Callable): | |||
There was a problem hiding this comment.
nit: sorry i missed this, but the type hint should by Type, right?
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.
Motivation
Our
patchdecorator easily allows us to patch a class method and extend its behavior.However, it does not support the case where a given type does not implement a function and we want to add it.
Patch now would support the following use case:
If the class already implements a method with the given name, the patch won't have any effect.
Like our current implementation, a patch can be easily undone:
Changes
patchto support the use case of adding a new function to a class type;