-
Notifications
You must be signed in to change notification settings - Fork 14
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.
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
FAQ entry on calling un-patched function inside patch #136
Open
kleinschmidt
wants to merge
1
commit into
JuliaTesting:main
Choose a base branch
from
kleinschmidt:patch-1
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains 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
I've added an FAQ entry on how to call the "un-patched" version of a function inside a patch (if you e.g. want to modify the arguments before calling a function). @omus mentioned that using `@mock` inside a patch can be useful as well but I couldn't immediately come up with an example off the top of my head, so I just left a short note about that being possible.
omus
reviewed
Oct 10, 2024
Comment on lines
+38
to
+57
Simply call the patched function without `@mock`: | ||
|
||
```julia | ||
julia> f(x) = x + 1 | ||
f (generic function with 1 method) | ||
|
||
julia> g(x) = @mock(f(x)) * 2 | ||
g (generic function with 1 method) | ||
|
||
julia> fp = @patch f(x) = f(-x) | ||
Patch{typeof(f)}(f, var"##f_patch#240") | ||
|
||
julia> g(3) | ||
8 # = (3 + 1) * 2 | ||
|
||
julia> apply(fp) do | ||
g(3) | ||
end | ||
-4 # = (-3 + 1) * 2 | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here's probably a more useful example:
Suggested change
Simply call the patched function without `@mock`: | |
```julia | |
julia> f(x) = x + 1 | |
f (generic function with 1 method) | |
julia> g(x) = @mock(f(x)) * 2 | |
g (generic function with 1 method) | |
julia> fp = @patch f(x) = f(-x) | |
Patch{typeof(f)}(f, var"##f_patch#240") | |
julia> g(3) | |
8 # = (3 + 1) * 2 | |
julia> apply(fp) do | |
g(3) | |
end | |
-4 # = (-3 + 1) * 2 | |
``` | |
Simply call the function without using `@mock` within the patch. For example we can count the number of calls a recursive function does like this: | |
```julia | |
function fibonacci(n) | |
if n <= 1 | |
return n | |
else | |
return @mock(fibonacci(n - 1)) + @mock(fibonacci(n - 2)) | |
end | |
end | |
calls = Ref(0) | |
p = @patch function fibonacci(n) | |
calls[] += 1 | |
return fibonacci(n) # Calls original function | |
end | |
apply(p) do | |
@test @mock(fibonacci(1)) == 1 | |
@test calls[] == 1 | |
calls[] = 0 | |
@test @mock(fibonacci(4)) == 3 | |
@test calls[] == 9 | |
end | |
``` |
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.
I've added an FAQ entry on how to call the "un-patched" version of a function inside a patch (if you e.g. want to modify the arguments before calling a function).
@omus mentioned that using
@mock
inside a patch can be useful as well but I couldn't immediately come up with an example off the top of my head, so I just left a short note about that being possible.