Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Provide a way to use a custom base class instead of betterproto.Message

Abierto
#664 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python
Área
tooling

Línea de trabajo

Comienza con el diseño del argumento de la CLI del compilador y la plantilla Jinja de init mencionada en la issue; después, inspecciona cómo las clases de mensajes generadas eligen betterproto.Message y cómo se escriben los archivos init.py generados. Se considera terminado cuando se utiliza una clase base personalizada configurada para los mensajes generados y los subpaquetes se pueden importar mediante la estructura de paquetes generada.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

enhancement
Summary

Allow to customize the base class, to provide helper methods and enrich the model

What is the feature request for?

The core library

The Problem

We developed an internal library on top of betterproto and pika rabbitmq packages.
During development, we found that

  1. betterproto lacks a way to customize the base class for the generated messages classes.
  2. it's not possible to access message classes in the following way:
import mylib as ml

ml.messages.device.settings.ConfigureDevice(*args)
The Ideal Solution

To ease all above, would be handy to provide:

  1. A way to use a MyMessageBaseClass(betterproto.Message) as base class for generated messages. This would probably be a new cli argument for the compiler e.g. --base_class=mylib.base.MyMessageBaseClass to use in the init jinja template.
  2. import subpackages (if any) in the __init__.py generated files.
The Current Solution

To enrich the classes with helper methods and to override some methods of the betterproto.Message class, we first patched the generated classes, to add mixins and overridden methods at runtime.

This is working well, but Python IDEs' support is limited.

We solved some of the issues above by adding a post compilation step at installation time, to add code to the betterproto generated files.
During this step, we also add subpackages imports to __init__.py files, to access messages conveniently using the fqn (see point 2. of the issue).

Lenguaje dominante
Python
Estrellas
1.8k
Forks
235
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de danielgtaylor/python-betterproto

Todos los issues de danielgtaylor/python-betterproto

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.