Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở
  • Có gì không ổn?
#664 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
tooling

Hướng nghiên cứu

Bắt đầu với thiết kế đối số CLI của compiler và template Jinja init được đề cập trong issue, sau đó kiểm tra cách các lớp message được sinh ra chọn betterproto.Message và cách các tệp init.py được sinh ra được ghi. Công việc được xem là hoàn tất khi một lớp cơ sở tùy chỉnh đã cấu hình được sử dụng cho các message được sinh ra và các subpackage có thể được import thông qua cấu trúc package được sinh ra.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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).

Ngôn ngữ chính
Python
Star
1.8k
Fork
235
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của danielgtaylor/python-betterproto

Tất cả issue của danielgtaylor/python-betterproto

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.