Skip to content

__class_getitem__ Unexpectedly Falls Back to the Metaclass #122634

Open
@ericsnowcurrently

Description

Bug report

Bug description:

A major point of __class_getitem__ (PEP 560) is to avoid metaclasses. This implies that the metaclass should never be involved in the mechanism. However, currently (and since the feature landed) we actually do fall back to the metaclass:

(example)
class Spam:
    def __class_getitem__(cls, key):
        return f'spam got {key!r}'


class Meta(type):
    def __class_getitem__(cls, key):
        return f'meta got {key!r}'


class Eggs(metaclass=Meta):
    def __class_getitem__(cls, key):
        return f'eggs got {key!r}'


class Ham(metaclass=Meta):
    pass

print(Spam[10])
print(Eggs[10])
print(Ham[10])

Output:

spam got 10
eggs got 10
meta got 10

I was expecting the last one to raise TypeError: type 'object' is not subscriptable, since Ham does not implement __class_getitem__. The actual outcome is surprising because the metaclass can already define __getitem__. Falling back to the metaclass __class_getitem__ doesn't make much sense and can be confusing. The metaclass __class_getitem__ should only be used when subscripting the metaclass, not its instances.

The PEP doesn't really address the question of a metaclass that defines __class_getiem__ 1 (nor does the documentation as far as I noticed). Overall, it seems like this was simply not noticed nor considered. It's certainly not an obvious case. Regardless, I think we should fix it.

The fix would involve skipping the metaclass part. That would be in the implementation for the subscript syntax (PyObject_GetItem() in Objects/abstract.c). There's a part where it specially handles the case where a class is being subscripted. In that case it looks up __class_getitem__ on the class. (See gh-4732.) However, currently it uses PyObject_GetOptionalAttr(), which involves descriptors and the metaclass (the object's type) and the type's __mro__. Again, the fix is to skip the metaclass part.

FWIW, __init_subclass__ is fairly similar, but it doesn't fall back to the metaclass. Instead, it effectively does getattr(super(cls), '__init_subclass__'). (See type_new_init_subclass() in Objects/typeobject.c.) We should probably do something similar in PyObject_GetItem().

CC @ilevkivskyi @gvanrossum

CPython versions tested on:

CPython main branch

Operating systems tested on:

No response

Linked PRs

Footnotes

  1. The PEP does say Note that this method is used as a fallback, so if a metaclass defines __getitem__, then that will have the priority. but that's specifically about falling back to meta.__getitem__.

Metadata

Assignees

Labels

3.10only security fixes3.11only security fixes3.12bugs and security fixes3.13bugs and security fixes3.14new features, bugs and security fixes3.7 (EOL)end of life3.8 (EOL)end of life3.9only security fixesinterpreter-core(Objects, Python, Grammar, and Parser dirs)topic-typingtype-bugAn unexpected behavior, bug, or error

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions