python / python/cpython

Resolution / determining of metaclass docs don't align with what really happens

Offen
#99,505 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

docs
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
36k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Documentation

I'm not 100% sure if this is an issue with the docs or the interpreter. But it's evident that the docs don't match what the interpreter does.

The docs say here:

The appropriate metaclass for a class definition is determined as follows:

  • if no bases and no explicit metaclass are given, then :func:type is used;
  • if an explicit metaclass is given and it is not an instance of
    :func:type, then it is used directly as the metaclass;
  • if an instance of :func:type is given as the explicit metaclass, or
    bases are defined, then the most derived metaclass is used.

The most derived metaclass is selected from the explicitly specified
metaclass (if any) and the metaclasses (i.e. type(cls)) of all specified
base classes. The most derived metaclass is one which is a subtype of all
of these candidate metaclasses. If none of the candidate metaclasses meets
that criterion, then the class definition will fail with TypeError.

So according to that, the metaclass of D in this code

class M1(type): pass
class M2(type): pass
class Mx(M1, M2): pass

class A1(metaclass=M1): pass
class A2(A1): pass

class B1(metaclass=M2): pass

class C1(metaclass=Mx): pass

class D(A2, B1, C1): pass

should be Mx as it's the most derived of all candidates (M1, M2, Mx). But instead the cpython exitis with

    class D(A2, B1, C1): pass
TypeError: metaclass conflict: the metaclass of a derived class must be a (non-strict) subclass of the metaclasses of all its bases

Note that class D(A2, C1, B1): pass works.

Some additional context:

As said above, I'm not even sure what the actually algorithm is that determines the implicit metaclass. From my experimentation, I assume it's:

  • If there's an explicit metaclass, it is checked to be a sub-class of the metaclass of each parent
  • If there's no explicit metaclass, the parents are checked from left to right:
    • When a new metaclass is encountered, it is checked to be a sub-class of the previous implicit metaclass and, if it is, set as the new implicit metaclass.
Linked PRs
  • gh-123349

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit dem Abschnitt zu Metaclasses in Doc/reference/datamodel.rst und führe die mitgelieferten Beispiele für Klassendefinitionen unter CPython aus, um das dokumentierte und das beobachtete Verhalten zu vergleichen. Sieh dir den verknüpften PR gh-123349 und das darin referenzierte historische Issue für die aktuelle Untersuchung an. Abgeschlossen ist die Aufgabe, wenn das Verhalten des Interpreters und die Dokumentation mit einer klaren Lösung in Einklang gebracht sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.