python / python/cpython

Improve metaclass conflict error message with clearer terminology and contextual information

Aberta
#134,902 2 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

interpreter-core type-feature
Linguagem predominante
Python
Estrelas
77.2k
Forks
35.9k
Métricas de merge de PRs
Métricas de PR pendentes

Descrição

Feature or enhancement

Proposal:

Improve Metaclass Conflict Error Message

Summary

Improve the error message raised during metaclass conflicts to specify the
base with incompatible metaclass.


Motivation

Class inheritance has a well-established terminology across languages, but
Python's metaclass system introduces a distinct mechanism that lacks clear
linguistic conventions. This feature proposes the following
terminologies.

  • A class is derived from its metaclass
  • A class is based on its base classes
  • A metaclass is any subclass of type

Example

In the following code, MetaFoo and MetaBar are both subclasses of type
making them metaclasses according to the previous terminology suggestion.
Since neither is a subclass of the other, they are incompatible as metaclasses.
Foo derives from MetaFoo and Bar derives from MetaBar, but because
Bar is based on Foo; the conflicting metaclasses cause the TypeError
relating to metaclass conflict.

class MetaFoo(type): pass

class MetaBar(type): pass

class Foo(metaclass=MetaFoo): pass

class Bar(Foo, metaclass=MetaBar): pass  # raises

Current Behaviour

The TypeError currently raised looks like this:

TypeError: metaclass conflict: the metaclass of a derived class must be a
(non-strict) subclass of the metaclasses of all its bases

Proposed Behaviour

The improved error message would add contextual details and adopt the new
terminology: (Line breaks included for clarity).

Metaclass conflict while creating a new class!
- Declared metaclass: 'MetaBar'
- Incompatible base class: 'Foo'
- That base is derived from metaclass: 'MetaFoo'
All base classes must be based on classes derived from the same metaclass or a
subclass thereof.

Notes

This change requires changes to the _PyType_CalculateMetaclass function only.
Including the name (Bar in the example) in the error message would require
changes to multiple functions across the codebase.

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

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece pela função _PyType_CalculateMetaclass mencionada na issue e reproduza o exemplo de MetaFoo, MetaBar, Foo e Bar. Compare o TypeError resultante com a redação proposta, incluindo a metaclasse declarada, a classe base incompatível e sua metaclasse; considera-se concluído quando o conflito relata essas informações contextuais usando a terminologia indicada.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
backend
Tipo de issue
Funcionalidade
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Claramente especificada
Facilidade para iniciantes
45/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.