annotationlib: `ref.evaluate()` not working for generics as local variables

[dr-carlos]

Bug report

Bug description:

Usually, when a local variable is introduced after getting a ForwardRef, evaluate() picks this up and correctly evaluates it using the self.__cell__ short-circuit. However, this does not work when that local variable is a generic. It does still work for globals.

from annotationlib import Format, get_annotations

def works_global():
 class Demo:
 x: sequence_a[int]

 fwdref = get_annotations(Demo, format=Format.FORWARDREF)['x']
 print(f"Global {fwdref!r}")

 global sequence_a
 sequence_a = list
 evaluated = fwdref.evaluate()
 print(f"Evaluated {evaluated!r}")

def works_nongeneric():
 class Demo:
 nonlocal alias # Optional
 x: alias

 fwdref = get_annotations(Demo, format=Format.FORWARDREF)['x']
 print(f"Global {fwdref!r}")

 alias = int
 evaluated = fwdref.evaluate()
 print(f"Evaluated {evaluated!r}")


def fails():
 class Demo:
 nonlocal sequence_b
 x: sequence_b[int]

 fwdref = get_annotations(Demo, format=Format.FORWARDREF)['x']
 print(f"Local {fwdref!r}")

 sequence_b = list
 evaluated = fwdref.evaluate() # NameError
 print(f"Evaluated {evaluated!r}")


works_global()
works_nongeneric()
fails()

CPython versions tested on:

CPython main branch, 3.14

Operating systems tested on:

Linux

Linked PRs

• gh-138151: Fix ForwardRef.evaluate() for locally defined generics #138161
• gh-138151: Fix annotationlib handling of multiple nonlocals #138164
• [3.14] gh-138151: Fix annotationlib handling of multiple nonlocals (GH-138164) #140949

[JelleZijlstra]

I wouldn't expect your fails() to work: you set sequence_b only in that function's local scope, and that's not the scope the annotation was defined in.

[dr-carlos]

I wouldn't expect your fails() to work: you set sequence_b only in that function's local scope, and that's not the scope the annotation was defined in.

Thanks, this is a good point, I forgot to consider that when writing up the example.
I've edited the OP with more complete examples, and put the classes inside the function definitions so the scoping should be correct.

[JelleZijlstra]

The problem here is that we don't properly preserve a reference to the cell object that was used to create the ForwardRef. This should be done when we create the ForwardRef (i.e., in get_annotations or code called from it), not in ForwardRef.evaluate. We can probably fix this by putting more information in the __cell__ attribute of the ForwardRef.

[dr-carlos]

@JelleZijlstra Is #138161 still necessary given the broader fix in #138164 , or should I close it?

[JelleZijlstra]

I don't think #138161 is necessary, but someone will need to review #138164.