gh-111874: Call `__set_name__` on objects that define the method inside a `typing.NamedTuple` class dictionary as part of the creation of that class by AlexWaygood · Pull Request #111876 · python/cpython

AlexWaygood · 2023-11-09T11:09:18Z

Closes #111874

Issue: Objects in NamedTuple class namespaces don't have __set_name__ called on them #111874

…d inside a `typing.NamedTuple` class dictionary as part of the creation of that class

…python into namedtuple-setname

Lib/test/test_typing.py

This reverts commit 7ccff63.

serhiy-storchaka

LGTM, but I have few minor suggestions.

Lib/typing.py

Lib/test/test_typing.py

AlexWaygood · 2023-11-16T07:46:17Z

Thanks @serhiy-storchaka! I applied your suggestions; would you mind taking another look? I discovered another interesting thing in the process: __set_name__ was also not being called for the values of annotated fields (which become namedtuple members). I changed that so that __set_name__ is called on these field values also. It's consistent with what e.g. dataclasses does:

Python 3.13.0a1+ (heads/main:e5dfcc2b6e, Nov 15 2023, 17:23:51) [MSC v.1932 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> from dataclasses import dataclass
>>> class Vanilla:
...     def __set_name__(self, owner, name):
...         self.name = name
...
>>> @dataclass
... class Foo:
...     v: Vanilla = Vanilla()
...
>>> f = Foo()
>>> f.v.name
'v'

serhiy-storchaka

I am not sure that __set_name__ should be called for annotated fields.

AlexWaygood · 2023-11-16T08:22:29Z

I am not sure that __set_name__ should be called for annotated fields.

Yes, I could be persuaded either way there.

Lib/test/test_typing.py

JelleZijlstra · 2023-11-17T15:29:23Z

Lib/typing.py

+                    setattr(nm_tpl, key, val)
+                try:
+                    set_name = type(val).__set_name__
+                except AttributeError:


Is it worth adding a test for the case where this yields some other exception (e.g. due to a weird metaclass)?

Good catch. Seems like for normal classes, if any strange exception is raised when trying to lookup __set_name__, the interpreter just swallows it and moves on:

>>> class Meta(type): ... def __getattribute__(self, attr): ... if attr == "__set_name__": ... raise BaseException("NO") ... >>> class VeryAnnoying(metaclass=Meta): pass ... >>> class Foo: ... attr = VeryAnnoying() ... >>>

We should do the same here (though I don't want to swallow BaseExceptions, since that would catch KeyboardInterrupt, SystemExit, etc. -- I think I'll just use except Exception).

Addressed in 1909fd5

Seems like for normal classes, if any strange exception is raised when trying to lookup __set_name__, the interpreter just swallows it and moves on:

It looks like a bug. I do not think it should be reproduced here. It is better to fix it for normal classes.

Okay, I opened #112453, and will revert the changes made here that reproduce the bug

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>

Lib/test/test_typing.py

Lib/typing.py

This reverts commit c2c65c6.

This reverts commit ed53fcb.

…et_name__`" This reverts commit 1909fd5.

serhiy-storchaka

LGTM.

Few minor suggestions which you can ignore.

Lib/test/test_typing.py

AlexWaygood · 2023-11-27T16:19:40Z

Thanks for the reviews!

# Release 4.9.0 (December 9, 2023) This feature release adds `typing_extensions.ReadOnly`, as specified by PEP 705, and makes various other improvements, especially to `@typing_extensions.deprecated()`. There are no changes since 4.9.0rc1. # Release 4.9.0rc1 (November 29, 2023) - Add support for PEP 705, adding `typing_extensions.ReadOnly`. Patch by Jelle Zijlstra. - All parameters on `NewType.__call__` are now positional-only. This means that the signature of `typing_extensions.NewType.__call__` now exactly matches the signature of `typing.NewType.__call__`. Patch by Alex Waygood. - Fix bug with using `@deprecated` on a mixin class. Inheriting from a deprecated class now raises a `DeprecationWarning`. Patch by Jelle Zijlstra. - `@deprecated` now gives a better error message if you pass a non-`str` argument to the `msg` parameter. Patch by Alex Waygood. - `@deprecated` is now implemented as a class for better introspectability. Patch by Jelle Zijlstra. - Exclude `__match_args__` from `Protocol` members. Backport of python/cpython#110683 by Nikita Sobolev. - When creating a `typing_extensions.NamedTuple` class, ensure `__set_name__` is called on all objects that define `__set_name__` and exist in the values of the `NamedTuple` class's class dictionary. Patch by Alex Waygood, backporting python/cpython#111876. - Improve the error message when trying to call `issubclass()` against a `Protocol` that has non-method members. Patch by Alex Waygood (backporting python/cpython#112344, by Randolph Scholz).

…d inside a `typing.NamedTuple` class dictionary as part of the creation of that class (python#111876) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>

pythongh-111874: Call __set_name__ on objects that define the metho…

e3b703d

…d inside a `typing.NamedTuple` class dictionary as part of the creation of that class

AlexWaygood requested review from JelleZijlstra and gvanrossum as code owners November 9, 2023 11:09

bedevere-app bot added the awaiting core review label Nov 9, 2023

bedevere-app bot mentioned this pull request Nov 9, 2023

Objects in NamedTuple class namespaces don't have __set_name__ called on them #111874

Closed

AlexWaygood added topic-typing needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Nov 9, 2023

AlexWaygood and others added 3 commits November 9, 2023 11:12

fixup news

f053310

Also add a test for TypedDict classes

7ccff63

Merge branch 'namedtuple-setname' of https://github.com/AlexWaygood/c…

0d13e83

…python into namedtuple-setname

AlexWaygood commented Nov 9, 2023

View reviewed changes

Lib/test/test_typing.py Outdated Show resolved Hide resolved

sobolevn reviewed Nov 9, 2023

View reviewed changes

Lib/test/test_typing.py Outdated Show resolved Hide resolved

AlexWaygood added 2 commits November 9, 2023 13:48

Revert "Also add a test for TypedDict classes"

e4e968a

This reverts commit 7ccff63.

Exception -> BaseException

e0c88f0

AlexWaygood requested a review from serhiy-storchaka November 15, 2023 23:37

serhiy-storchaka approved these changes Nov 16, 2023

View reviewed changes

Lib/typing.py Outdated Show resolved Hide resolved

Lib/test/test_typing.py Show resolved Hide resolved

bedevere-app bot added awaiting merge and removed awaiting core review labels Nov 16, 2023

Address review (and fix bug)

d8102fd

AlexWaygood requested a review from serhiy-storchaka November 16, 2023 07:46

serhiy-storchaka reviewed Nov 16, 2023

View reviewed changes

serhiy-storchaka requested a review from rhettinger November 16, 2023 08:21

AlexWaygood removed needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Nov 16, 2023

JelleZijlstra reviewed Nov 17, 2023

View reviewed changes

AlexWaygood and others added 2 commits November 17, 2023 15:44

Update Lib/test/test_typing.py

f2a57b2

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>

Handle strange exceptions raised on attempting to access __set_name__

1909fd5

AlexWaygood commented Nov 17, 2023

View reviewed changes

Lib/test/test_typing.py Outdated Show resolved Hide resolved

typo

ed53fcb

JelleZijlstra reviewed Nov 17, 2023

View reviewed changes

Lib/typing.py Outdated Show resolved Hide resolved

AlexWaygood and others added 5 commits November 17, 2023 16:21

big comment

c2c65c6

Revert "big comment"

e79ea37

This reverts commit c2c65c6.

Revert "typo"

9fd8b6b

This reverts commit ed53fcb.

Revert "Handle strange exceptions raised on attempting to access `__s…

fdab495

…et_name__`" This reverts commit 1909fd5.

Add a test that asserts the correct behaviour

3932d48

AlexWaygood force-pushed the namedtuple-setname branch from 0c9f2b9 to 3932d48 Compare November 27, 2023 13:16

serhiy-storchaka approved these changes Nov 27, 2023

View reviewed changes

Lib/test/test_typing.py Outdated Show resolved Hide resolved

Lib/test/test_typing.py Outdated Show resolved Hide resolved

Address Serhiy's second review pass

3359ff6

Merge branch 'main' into namedtuple-setname

ef628da

AlexWaygood enabled auto-merge (squash) November 27, 2023 16:20

AlexWaygood merged commit 22e411e into python:main Nov 27, 2023

AlexWaygood deleted the namedtuple-setname branch November 27, 2023 16:34

bedevere-app bot removed the awaiting merge label Nov 27, 2023

AlexWaygood mentioned this pull request Nov 29, 2023

Backport recent change to NamedTuple classes regarding __set_name__ python/typing_extensions#303

Merged

Uh oh!

Conversation

AlexWaygood commented Nov 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

AlexWaygood commented Nov 16, 2023

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

AlexWaygood commented Nov 16, 2023

Uh oh!

Uh oh!

JelleZijlstra Nov 17, 2023

Choose a reason for hiding this comment

Uh oh!

AlexWaygood Nov 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AlexWaygood Nov 17, 2023

Choose a reason for hiding this comment

Uh oh!

serhiy-storchaka Nov 27, 2023

Choose a reason for hiding this comment

Uh oh!

AlexWaygood Nov 27, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

AlexWaygood commented Nov 27, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

AlexWaygood commented Nov 9, 2023 •

edited

Loading

AlexWaygood Nov 17, 2023 •

edited

Loading