gh-115165: Fix Annotated for immutable types by dave-shawley · Pull Request #115213 · python/cpython

dave-shawley · 2024-02-09T12:45:23Z

This PR widens the list of ignored exceptions when setting the __orig_class__ attribute on the return value from an annotated callable. Only AttributeError was caught yet instances can raise any Exception from __setattr__. After this PR, it will catch any Exception instead. This change was motivated by the uuid.UUID.__setattr__ implementation raises TypeError.

Issue: typing.Annotated fails for functions returning UUIDs #115165

The return value from an annotated callable can raise any exception from __setattr__ for the `__orig_class__` property.

JelleZijlstra

Thanks!

I think this is safe to backport to the bugfix versions (3.11 and 3.12).

Misc/NEWS.d/next/Library/2024-02-09-07-20-16.gh-issue-115165.yfJLXA.rst

AlexWaygood

Thanks! This is really great for a first contribution :)

A few small points below:

Lib/test/test_typing.py

Lib/typing.py

Misc/NEWS.d/next/Library/2024-02-09-07-20-16.gh-issue-115165.yfJLXA.rst

Update news blurb for pythongh-115165

Add comment justifying `except Exception`

Renamed test_annotated_callable_returning_immutable to test_instantiate_immutable and moved it near the other instantiation tests.

Add a test for generic instantiation that trips the same __setattr__ exception in Annotation.

dave-shawley · 2024-02-09T18:36:36Z

@AlexWaygood and @JelleZijlstra -- thanks for the suggestions. I've addressed them locally. Do you prefer "fixup! ..." commits for auto-squashing or independent commits that will be preserved?

JelleZijlstra · 2024-02-09T18:42:10Z

It doesn't really matter, we squash the commits on merge. The only thing we generally ask for is to avoid force-pushing to your branch; that makes review harder.

AlexWaygood · 2024-02-09T18:42:40Z

@AlexWaygood and @JelleZijlstra -- thanks for the suggestions. I've addressed them locally. Do you prefer "fixup! ..." commits for auto-squashing or independent commits that will be preserved?

All commits will be squash-merged into a single commit by GitHub when we merge your PR into the main branch, so you don't need to worry about keeping a clean history on your PR branch here. We prefer for contributors to avoid force-pushing where possible, so that we can easily see what changed between commits :)

AlexWaygood

Thanks!

miss-islington-app · 2024-02-09T22:11:40Z

Thanks @dave-shawley for the PR, and @AlexWaygood for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

…-115213) The return value from an annotated callable can raise any exception from __setattr__ for the `__orig_class__` property. (cherry picked from commit 5643856) Co-authored-by: dave-shawley <daveshawley@gmail.com>

bedevere-app · 2024-02-09T22:12:12Z

GH-115227 is a backport of this pull request to the 3.12 branch.

…-115213) The return value from an annotated callable can raise any exception from __setattr__ for the `__orig_class__` property. (cherry picked from commit 5643856) Co-authored-by: dave-shawley <daveshawley@gmail.com>

bedevere-app · 2024-02-09T22:12:19Z

GH-115228 is a backport of this pull request to the 3.11 branch.

…) (#115227) gh-115165: Fix `typing.Annotated` for immutable types (GH-115213) The return value from an annotated callable can raise any exception from __setattr__ for the `__orig_class__` property. (cherry picked from commit 5643856) Co-authored-by: dave-shawley <daveshawley@gmail.com>

…) (#115228) gh-115165: Fix `typing.Annotated` for immutable types (GH-115213) The return value from an annotated callable can raise any exception from __setattr__ for the `__orig_class__` property. (cherry picked from commit 5643856) Co-authored-by: dave-shawley <daveshawley@gmail.com>

…15213) The return value from an annotated callable can raise any exception from __setattr__ for the `__orig_class__` property.

aminalaee · 2024-05-13T11:19:35Z

@JelleZijlstra @AlexWaygood Can this be backported to older versions too?

JelleZijlstra · 2024-05-13T12:30:01Z

Looks like it was backported to 3.11 and 3.12. Older versions only receive security fixes now, which this isn't.

pythongh-115165: Fix Annotated for immutable types

b87995b

The return value from an annotated callable can raise any exception from __setattr__ for the `__orig_class__` property.

dave-shawley requested review from AlexWaygood and JelleZijlstra as code owners February 9, 2024 12:45

bedevere-app bot added the awaiting review label Feb 9, 2024

bedevere-app bot mentioned this pull request Feb 9, 2024

typing.Annotated fails for functions returning UUIDs #115165

Closed

JelleZijlstra added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Feb 9, 2024

JelleZijlstra approved these changes Feb 9, 2024

View reviewed changes

Misc/NEWS.d/next/Library/2024-02-09-07-20-16.gh-issue-115165.yfJLXA.rst Outdated Show resolved Hide resolved

bedevere-app bot added awaiting merge and removed awaiting review labels Feb 9, 2024

AlexWaygood reviewed Feb 9, 2024

View reviewed changes

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

Lib/typing.py Show resolved Hide resolved

Misc/NEWS.d/next/Library/2024-02-09-07-20-16.gh-issue-115165.yfJLXA.rst Outdated Show resolved Hide resolved

dave-shawley added 4 commits February 9, 2024 13:32

fixup! pythongh-115165: Fix Annotated for immutable types

1d7e6e5

Update news blurb for pythongh-115165

fixup! pythongh-115165: Fix Annotated for immutable types

ff5e885

Add comment justifying `except Exception`

fixup! pythongh-115165: Fix Annotated for immutable types

7289af4

Renamed test_annotated_callable_returning_immutable to test_instantiate_immutable and moved it near the other instantiation tests.

fixup! pythongh-115165: Fix Annotated for immutable types

7fcb394

Add a test for generic instantiation that trips the same __setattr__ exception in Annotation.

Small tweaks

702ba2c

AlexWaygood approved these changes Feb 9, 2024

View reviewed changes

AlexWaygood enabled auto-merge (squash) February 9, 2024 21:54

AlexWaygood merged commit 5643856 into python:main Feb 9, 2024

bedevere-app bot removed the awaiting merge label Feb 9, 2024

bedevere-app bot removed the needs backport to 3.12 only security fixes label Feb 9, 2024

bedevere-app bot removed the needs backport to 3.11 only security fixes label Feb 9, 2024

dave-shawley deleted the gitlab-115165 branch February 9, 2024 22:38

ezio-melotti mentioned this pull request Feb 12, 2024

Remove stray backtick in NEWS entry #115356

Merged

AlexWaygood mentioned this pull request Mar 12, 2024

can't specify generic types when instantiating frozen dataclass with slots #116669

Closed

nanne-aben mentioned this pull request Apr 11, 2024

Python 3.11.9 catches all exceptions raised in Generic.__setattr__("__orig_class__", type_parameter) #117744

Closed

This was referenced May 13, 2024

TypeError: UUID objects are immutable" when try view, delete, update user from fastapi-users in sqladmin panel aminalaee/sqladmin#668

Closed

TypeError: UUID objects are immutable (fastapi_users) aminalaee/sqladmin#765

Closed

Uh oh!

Conversation

dave-shawley commented Feb 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JelleZijlstra left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

AlexWaygood left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dave-shawley commented Feb 9, 2024

Uh oh!

JelleZijlstra commented Feb 9, 2024

Uh oh!

AlexWaygood commented Feb 9, 2024

Uh oh!

AlexWaygood left a comment

Choose a reason for hiding this comment

Uh oh!

miss-islington-app bot commented Feb 9, 2024

Uh oh!

bedevere-app bot commented Feb 9, 2024

Uh oh!

bedevere-app bot commented Feb 9, 2024

Uh oh!

aminalaee commented May 13, 2024

Uh oh!

JelleZijlstra commented May 13, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

dave-shawley commented Feb 9, 2024 •

edited

Loading