on_boarding.md

graph LR
    Protobuf_Code_Generator_Plugin_["Protobuf Code Generator (Plugin)"]
    Betterproto_Runtime_Library["Betterproto Runtime Library"]
    gRPC_Runtime_Client_Server_["gRPC Runtime (Client & Server)"]
    Casing_Utilities["Casing Utilities"]
    Generated_Protobuf_Code["Generated Protobuf Code"]
    User_Application["User Application"]
    Protobuf_Code_Generator_Plugin_ -- "Generates" --> Generated_Protobuf_Code
    Protobuf_Code_Generator_Plugin_ -- "Utilizes" --> Casing_Utilities
    Generated_Protobuf_Code -- "Depends On" --> Betterproto_Runtime_Library
    Generated_Protobuf_Code -- "Depends On" --> gRPC_Runtime_Client_Server_
    User_Application -- "Consumes" --> Generated_Protobuf_Code
    User_Application -- "Interacts With" --> Betterproto_Runtime_Library
    User_Application -- "Interacts With" --> gRPC_Runtime_Client_Server_
    click Protobuf_Code_Generator_Plugin_ href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/python-betterproto/Protobuf_Code_Generator_Plugin_.md" "Details"
    click Betterproto_Runtime_Library href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/python-betterproto/Betterproto_Runtime_Library.md" "Details"
    click gRPC_Runtime_Client_Server_ href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/python-betterproto/gRPC_Runtime_Client_Server_.md" "Details"

Loading

Details

The python-betterproto project is structured around a core Protobuf Code Generator (Plugin) that processes .proto definition files to produce Generated Protobuf Code. This generated code, which includes Python classes for messages, enums, and gRPC service stubs, forms the primary interface for User Applications. The Generated Protobuf Code relies heavily on the Betterproto Runtime Library for fundamental operations like serialization and deserialization, and on the gRPC Runtime (Client & Server) for asynchronous gRPC communication. During the code generation phase, the Protobuf Code Generator (Plugin) utilizes Casing Utilities to ensure proper naming conventions in the generated Python output. This architecture clearly separates the code generation concerns from the runtime execution, providing a robust framework for integrating Protobuf and gRPC into Python applications.

Protobuf Code Generator (Plugin) [Expand]

The protoc plugin responsible for parsing .proto definition files and generating Python source code.

Related Classes/Methods:

• betterproto.plugin.main
• betterproto.plugin.parser
• betterproto.plugin.models
• betterproto.plugin.typing_compiler

Betterproto Runtime Library [Expand]

The foundational Python library providing core mechanisms for generated Protobuf classes, including serialization/deserialization and field management.

Related Classes/Methods:

• betterproto.__init__
• betterproto.enum
• betterproto._types

gRPC Runtime (Client & Server) [Expand]

Provides asynchronous gRPC communication capabilities, supporting both client-side stubs and server-side service implementations.

Related Classes/Methods:

• betterproto.grpc.grpclib_client
• betterproto.grpc.grpclib_server
• betterproto.grpc.util.async_channel

Casing Utilities

A shared utility module for converting string casing and sanitizing names, primarily used during code generation.

Related Classes/Methods:

• betterproto.casing

Generated Protobuf Code

The Python classes, enums, and gRPC service stubs automatically generated by the Protobuf Code Generator (Plugin) from user-defined .proto definitions. This code serves as the primary user-facing interface for interacting with Protobuf messages and gRPC services. Its source code is dynamically created at build time based on user input, rather than being a static part of the betterproto library's codebase.

Related Classes/Methods: None

User Application

Represents external applications or services developed by users that integrate with and utilize the betterproto library. These applications consume the Generated Protobuf Code (e.g., message classes, gRPC stubs) and interact with the Betterproto Runtime Library and gRPC Runtime to send and receive Protobuf messages and make gRPC calls. Its source code resides outside the betterproto project.

Related Classes/Methods: None

FAQ