PyFunction_GetAnnotations returning Tuple vs Dict

[cpu]

BPO	46236
Nosy	@methane, @serhiy-storchaka, @pablogsal, @miss-islington, @sweeneyde, @cpu
PRs	bpo-46236: Fix PyFunction_GetAnnotations() returned tuple. #30409 [3.10] bpo-46236: Fix PyFunction_GetAnnotations() returned tuple. (GH-30409) #30420

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2022-01-05.13:12:40.577>
created_at = <Date 2022-01-03.03:16:05.001>
labels = ['expert-C-API', '3.10', '3.11']
title = 'PyFunction_GetAnnotations returning Tuple vs Dict'
updated_at = <Date 2022-01-05.13:12:40.576>
user = 'https://github.com/cpu'

bugs.python.org fields:

activity = <Date 2022-01-05.13:12:40.576>
actor = 'pablogsal'
assignee = 'none'
closed = True
closed_date = <Date 2022-01-05.13:12:40.577>
closer = 'pablogsal'
components = ['C API']
creation = <Date 2022-01-03.03:16:05.001>
creator = 'cpu'
dependencies = []
files = []
hgrepos = []
issue_num = 46236
keywords = ['patch']
message_count = 6.0
messages = ['409555', '409726', '409729', '409730', '409759', '409763']
nosy_count = 6.0
nosy_names = ['methane', 'serhiy.storchaka', 'pablogsal', 'miss-islington', 'Dennis Sweeney', 'cpu']
pr_nums = ['30409', '30420']
priority = None
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue46236'
versions = ['Python 3.10', 'Python 3.11']

[cpu]

Hi there,

This is my first Python bug, hope I haven't missed anything important.

I noticed that the PyFunction_GetAnnotations function from the C API is returning a PyTuple when I link Python 3.10 where historically it returned a PyDict.

The documentation for PyFunction_GetAnnotations for 3.10 (here0) says its return can be:

a mutable dictionary or NULL

I'm not sure if:

• This is user error and I should adapt to this case in my dependent code when using Python 3.10+.
• This is a documentation error, and it should say "a mutable dictionary, set, or NULL"
• This is a regression in the C API that should be fixed.

I've made a small reproduction program (here1) that can be used to quickly demonstrate the difference in return type between the two Python versions for the same C program and .py inputs.

I also noticed that bpo-42202 (here2) landed an optimization in 3.10.x that changed the internal representation of annotations to a set - could that possibly be related? I'm not 100% sure!

Thanks!

[sweeneyde]

Pablo, should this be a release blocker?

[pablogsal]

Yeah, the docs mention explicitly that is a dictionary or NULL.

[pablogsal]

I am quite sure this is due to PR 23316

[miss-islington]

New changeset 46e4c25 by Inada Naoki in branch 'main':
bpo-46236: Fix PyFunction_GetAnnotations() returned tuple. (GH-30409)
46e4c25

[miss-islington]

New changeset da8be15 by Miss Islington (bot) in branch '3.10':
bpo-46236: Fix PyFunction_GetAnnotations() returned tuple. (GH-30409)
da8be15