Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Add getnewargs_ex to Enum base class to fix Ray serialization error

Aberta
  • Algo errado?
#658 5 comentários 4 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
48/100
Tipo de issue
Bug
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
python
Domínio
backend-api-design

Direção de pesquisa

Localize a classe base Enum do betterproto e reproduza a falha de serialização do Ray com o exemplo Event mostrado na issue. Verifique a alteração serializando e desserializando um membro de Enum por meio do Ray sem registrar um serializador personalizado e confirme que o TypeError de Enum.new() não ocorre mais.

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

Descrição

When using betterproto enums in a Ray environment, I encounter a pickling error when a task attempts to deserialize an enum member. For example, given an enum defined as follows:

class Event(betterproto.Enum):
    START = 0
    STOP = 1

and using this enum as part of a task’s arguments, I see the following error when deserializing:

ray.exceptions.RaySystemError: System error: Enum.__new__() takes 1 positional argument but 2 were given

This occurs during the call to ray.util.get_objects() (or similar), where Ray’s unpickler passes an extra argument to the Enum’s new method.

Workaround:
I found that manually registering serializers and deserializes for each enum (e.g., using:

ray.util.register_serializer(
    Event,
    serializer=lambda obj: obj.value,
    deserializer=lambda value: Event(value),
)

solves the problem.

Proposed Solution:
The core issue seems to be that the default pickling mechanism for betterproto’s Enum (a subclass of IntEnum) is not handling the construction correctly in the Ray environment. The standard approach to helping pickle an enum instance correctly is implementing the getnewargs_ex method.

For example, adding the following method to the Enum base class:

def __getnewargs_ex__(self):
    # Provide no positional arguments and the keyword arguments needed for __new__
    return (), {"name": self.name, "value": self.value}

allows the default pickle protocol to serialize and deserialize the enum members properly. With this change, Ray’s deserialization will invoke the Enum’s new with the correct keyword arguments, avoiding the TypeError.

Additional Context:

  • Environment: betterproto 2.0.0b7, Python 3.10 (with Ray)

Request:

  • Would it be possible to incorporate a getnewargs_ex method in the base Enum class of betterproto? This would allow the standard pickle mechanism (and hence Ray’s object deserialization) to work without additional registration steps.
Linguagem predominante
Python
Estrelas
1.8k
Forks
235
Nenhum PR com merge em 30d

Preparar o ambiente

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.

Mais de danielgtaylor/python-betterproto

Todas as issues de danielgtaylor/python-betterproto

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

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