Protocol Buffers using Python type annotations
Project description
pure-protobuf
Wow! Such annotated! Very buffers!
⚠️ Note |
---|
This README describes the upcoming major version update. For 2.x please refer to: https://github.com/eigenein/protobuf/tree/2.2.3 |
Documentation
Quick examples
.proto
definition
It's not needed for pure-protobuf
, but for the sake of an example, let's consider the following definition:
syntax = "proto3";
message SearchRequest {
string query = 1;
int32 page_number = 2;
int32 result_per_page = 3;
}
And here's the same via pure-protobuf
:
With dataclasses
from dataclasses import dataclass
from io import BytesIO
from pure_protobuf.annotations import Field
from pure_protobuf.message import BaseMessage
from typing_extensions import Annotated
@dataclass
class SearchRequest(BaseMessage):
query: Annotated[str, Field(1)] = ""
page_number: Annotated[int, Field(2)] = 0
result_per_page: Annotated[int, Field(3)] = 0
request = SearchRequest(query="hello", page_number=1, result_per_page=10)
buffer = bytes(request)
assert buffer == b"\x0A\x05hello\x10\x01\x18\x0A"
assert SearchRequest.read_from(BytesIO(buffer)) == request
With pydantic
from io import BytesIO
from pure_protobuf.annotations import Field
from pure_protobuf.message import BaseMessage
from pydantic import BaseModel
from typing_extensions import Annotated
class SearchRequest(BaseMessage, BaseModel):
query: Annotated[str, Field(1)] = ""
page_number: Annotated[int, Field(2)] = 0
result_per_page: Annotated[int, Field(3)] = 0
request = SearchRequest(query="hello", page_number=1, result_per_page=10)
buffer = bytes(request)
assert buffer == b"\x0A\x05hello\x10\x01\x18\x0A"
assert SearchRequest.read_from(BytesIO(buffer)) == request
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pure_protobuf-3.0.0a5.tar.gz
(18.4 kB
view hashes)
Built Distribution
Close
Hashes for pure_protobuf-3.0.0a5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 29a3e278bd2f620b8bf54ed34911c3d2160fb8a41db9873735b80effd998be46 |
|
MD5 | 04e813831f1b7735012c7634dfc793cb |
|
BLAKE2b-256 | a8c3a684bda96fd01f0f9ca7947e9d97c32649bdea5ac19abab87afd1371dafd |