Skip to content
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

gh-124342: Wrap __annotate__ functions in functools.update_wrapper #124346

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

JelleZijlstra
Copy link
Member

@JelleZijlstra JelleZijlstra commented Sep 23, 2024

Copy link
Member

@vstinner vstinner left a comment

Choose a reason for hiding this comment

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

LGTM.

I was just surprised that updating func.__annotations__ after update_wrapper(wrapper, func) doesn't update wrapper.__annotations__. Don't get me wrong, I'm fine with this behavior.

Lib/functools.py Outdated
Comment on lines 72 to 73
func = _get_get_annotations()
return func(wrapped, format=format)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
func = _get_get_annotations()
return func(wrapped, format=format)
get_annotations = _get_get_annotations()
return get_annotations(wrapped, format=format)

@vstinner
Copy link
Member

Another surprising behavior. I'm discovering __annotate__() so it's maybe by design, I don't know :-)

When I update annotations of the wrapped function, __annotate__() of the wrapped function doesn't change, whereas __annotate__() of the wrapper is updated.

$ ./python
>>> import functools
>>> def f(x: int = 1): return x
>>> def wrapper(*args): pass
>>> functools.update_wrapper(wrapper, f)
<function f at 0x7f19f44d3e90>

>>> f.__annotations__['x']
<class 'int'>
>>> import annotationlib
>>> f.__annotate__(annotationlib.Format.VALUE)
{'x': <class 'int'>}
>>> wrapper.__annotate__(annotationlib.Format.VALUE)
{'x': <class 'int'>}

>>> f.__annotations__['x'] = float
>>> f.__annotate__(annotationlib.Format.VALUE)  # <=== HERE
{'x': <class 'int'>}
>>> wrapper.__annotate__(annotationlib.Format.VALUE)  # <=== HERE
{'x': <class 'float'>}

I would expect getting the same value for both cases. Either <class 'int'> or <class 'float'>.

@vstinner
Copy link
Member

cc @sobolevn

@JelleZijlstra
Copy link
Member Author

This is because we use get_annotations, which always returns a fresh dictionary. Maybe I should change that.

@JelleZijlstra
Copy link
Member Author

I made some changes to align with @ncoghlan's original proposal and @vstinner's feedback above, but I now think it's better to stick with what's currently on main. I'll write that up on the issue.

@rhettinger rhettinger removed their request for review September 25, 2024 22:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants