protoruf 0.1.4

A Python library written in Rust for JSON/Protobuf conversion

protoruf

High-performance JSON ↔ Protobuf conversion for Python, powered by Rust

📖 Documentation • 💻 Source • 🐛 Issues

---

A high-performance Python library written in Rust for converting between JSON and Protobuf messages.

Features

• ⚡ Fast — JSON ↔ Protobuf conversion powered by Rust
• 🔒 Type-safe — Explicit message type specification
• 📦 Built-in proto compilation — Uses Rust protox, no external dependencies

Installation

pip install protoruf

Quick Start

from protoruf import json_to_protobuf, protobuf_to_json, compile_proto

# 1. Compile your .proto file
descriptor = compile_proto("message.proto")

# 2. Convert JSON to Protobuf
json_data = '{"id": "123", "content": "Hello", "priority": 1}'
protobuf_bytes = json_to_protobuf(json_data, descriptor, message_type="message.Message")

# 3. Convert Protobuf back to JSON
json_str = protobuf_to_json(protobuf_bytes, descriptor, message_type="message.Message", pretty=True)
print(json_str)

API Reference

compile_proto(proto_path, include_paths=None, output_path=None)

Compile a .proto file to a descriptor set.

Parameter	Type	Description
proto_path	str	Path to the .proto file
include_paths	list[str] | None	Optional include paths for imports
output_path	str | None	Optional path to save the descriptor

Returns: bytes — The compiled descriptor set.

---

load_descriptor(descriptor_path)

Load a pre-compiled descriptor set from a file.

Parameter	Type	Description
descriptor_path	str	Path to the .desc file

Returns: bytes — The descriptor set.

---

json_to_protobuf(json_str, descriptor_bytes, message_type)

Convert a JSON string to a Protobuf message.

Parameter	Type	Description
json_str	str	JSON string to convert
descriptor_bytes	bytes	Compiled protobuf descriptor set
message_type	str	Full message type name (e.g. "message.Message")

Returns: bytes — The Protobuf message.

---

protobuf_to_json(protobuf_bytes, descriptor_bytes, message_type, pretty=False)

Convert a Protobuf message to a JSON string.

Parameter	Type	Description
protobuf_bytes	bytes	Protobuf message as bytes
descriptor_bytes	bytes	Compiled protobuf descriptor set
message_type	str	Full message type name (e.g. "message.Message")
pretty	bool	If True, format JSON with indentation

Returns: str — The JSON representation.

---

pydantic_to_protobuf(pydantic_model, descriptor_bytes, message_type)

Convert a Pydantic model directly to a Protobuf message.

Parameter	Type	Description
pydantic_model	BaseModel	Pydantic model instance to convert
descriptor_bytes	bytes	Compiled protobuf descriptor set
message_type	str	Full message type name (e.g. "message.Message")

Returns: bytes — The Protobuf message.

---

protobuf_to_pydantic(protobuf_bytes, descriptor_bytes, model_class, message_type)

Convert a Protobuf message directly to a Pydantic model instance.

Parameter	Type	Description
protobuf_bytes	bytes	Protobuf message as bytes
descriptor_bytes	bytes	Compiled protobuf descriptor set
model_class	Type[T]	The Pydantic model class to instantiate
message_type	str	Full message type name (e.g. "message.Message")

Returns: T — An instance of the specified Pydantic model class.

Usage with Pydantic

protoruf provides built-in functions for seamless Pydantic integration:

from pydantic import BaseModel
from protoruf import compile_proto, pydantic_to_protobuf, protobuf_to_pydantic

class Message(BaseModel):
    id: str = ""
    content: str = ""
    priority: int = 0

descriptor = compile_proto("message.proto")
msg = Message(id="123", content="Hello", priority=1)

# Direct conversion from Pydantic to Protobuf
protobuf_bytes = pydantic_to_protobuf(msg, descriptor, message_type="message.Message")

# Direct conversion from Protobuf back to Pydantic
result = protobuf_to_pydantic(protobuf_bytes, descriptor, Message, message_type="message.Message")

Links

• 📖 Full Documentation: https://EdwinAlkins.github.io/protoruf/
• 💻 Source Code: https://github.com/EdwinAlkins/protoruf
• 🐛 Bug Reports: https://github.com/EdwinAlkins/protoruf/issues
• 📦 PyPI: https://pypi.org/project/protoruf/

License

MIT