ldproto 0.1.5

No project description provided

Length-Delimited Proto

When protobuf messages are either across the wire, or put in intermediary storage, it is helpful to be able to read and write individual messages in a streaming format.

This package exposes two methods:

• write_ld(writer, protomsg) - writes one instance of a protobuf message to the stream
• read_ld(reader, msgtype) -> protomsg - reads one protobuf message from the stream, using the type as the constructor

This package uses an unsigned 32-bit integer as the length-prefix.

Example

Assuming there is a protobuf message with the type name "User"

from ldproto import read_ld, write_ld
import myproto as pb

# .ld is for length-delimited
with open('out.user.ld', 'wb') as f:
    for user in users:
        write_ld(f, user)

parsed_users = []
with open('out.user.ld', 'rb') as f:
    while True:
        # Replace pb.User here with the protobuf
        user = read_ld(f, pb.User)
        if user is None:
            print('done reading messages')
            break
        parsed_users.append(user)

To write to / from a bytestream in-memory, use BytesIO in-place of the files in the example.