python / python/cpython

Improve error message for return in metaclass __new__()

Offen
#132,343 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

interpreter-core type-feature
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
35.9k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Feature or enhancement

Proposal:

Case1: When overriding new in a custom Meta class and forgetting to return a class object (e.g. by omitting return super().new(..)) Python raises the following error:
TypeError: 'NoneType' object is not callable

Case2: When returning something else other than class object it raises following error:
TypeError: 'str' object is not callable

This messages, while technically correct, lacks guidance for common scenarios and can confuse developers - especially those new to Meta class.

Steps to Reproduce:

Case1:
class NewMeta(type):
def new(cls, name, bases, dct):
print ("Forgot to return!")

class MyClass(metaclass = NewMeta):
def greet(self):
pass

m = MyClass()

Output: TypeError: 'NoneType' object is not callable

Case2:
class NewMeta(type):
def new(cls, name, bases, dct):
return ("Return non-callable object")

class MyClass(metaclass = NewMeta):
def greet(self):
pass

m = MyClass()

Output: TypeError: 'str' object is not callable

Suggested Improvement:
Improve the error message to something like:
TypeError: metaclass new must return a class object. Recommendation: super().new(metacls, name, bases, namespace)?

This small change could save significant debugging time and make advanced features like metaclasses more approachable.

Python Version:
Tested in Python 3.12.4 (tags/v3.12.4:8e8a4ba, Jun 6 2024, 19:30:16) [MSC v.1940 64 bit (AMD64)]

Why This Matters:

  1. Metaclass usage is already an advanced topic.
  2. Improving the DX (developer experience) here will help advanced learners and reduce friction.
  3. Similar improvements have already been adopted in recent Python versions for other common errors.
Has this already been discussed elsewhere?

This is a minor feature, which does not need previous discussion elsewhere

Links to previous discussion of this feature:

No response

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 damit, beide im Issue beschriebenen Fälle von metaclass new zu reproduzieren und den Laufzeiteinstiegspunkt nachzuverfolgen, der den aktuellen TypeError auslöst. Aktualisiere die Diagnosen für eine fehlende oder nicht als Klasse erfolgende Rückgabe, füge anschließend Abdeckung für beide Beispiele hinzu und überprüfe, dass die Meldungen den erforderlichen Rückgabewert klar erklären.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
compilers
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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