crazyhatfish / protopy

tiny pure python protobuf implementation

ProtoPy

tiny pure python protobuf implementation

this isn't anywhere near a good implementation (actually not complete either) of Protobufs (see Google's) but it doesn't require any non-std libraries and the runtime is around 400 lines.

Example usage

First, compile the Protobufs to Python with the protobuf_compile.py script.

python protobuf_compile.py < exampleproto.proto > exampleproto.py

Then the Protobufs can be used as follows:

from exampleproto import *

# encoding
>>> game = CMsgClientGamesPlayed.Game()
>>> game.game_id = 1234
>>> game.game_name = "blah"
>>> game.game_version = EGameVersion.k_EGameVersionNone

>>> msg = CMsgClientGamesPlayed()
>>> msg.game_ip_address = 0x11223344
>>> msg.game_port = 1337
>>> msg.games = [game]
>>> msg.token = "TOKENTOKENTOKENTOKEN"

>>> encoded = msg.encode()
>>> encoded
'\x10\xc4\xe6\x88\x89\x01\x18\xb9\n*\x14TOKENTOKENTOKENTOKENR\x11\t\xd2\x04\x00\x00\x00\x00\x00\x00\x12\x04blah(\x00'

# decoding
>>> msg = CMsgClientGamesPlayed()
>>> msg.decode(encoded)
>>> msg.games
[{'game_id': 1234L, 'game_name': 'blah', 'game_version': 0L}]
>>> msg.games[0].game_name
'blah'
>>> msg.token
'TOKENTOKENTOKENTOKEN'
>>> msg.to_dict()
{'game_port': 1337, 'token': 'TOKENTOKENTOKENTOKEN', 'game_ip_address': 287454020, 'games': [{'game_id': 1234, 'game_name': 'blah', 'game_version': 0}]}

protopy's Issues

Encode raw data fast

If I already have my messages represented as list and dict, I must construct intermediate objects which waste a lot of overhead. I would like to encode by a way like

buf = encode_dict(CustomMessageType, dict_data)

or

buf = CustomMessageType.encode_dict(dict_data)

Moving __lookup__ from object variable to class variable will decrease overhead and be helpful to complete this feature.

please forgive my poor English :)

Embedded messages, global enums not implemented

Also there seems to be a problem with enums currently, they're just left as integers, support for using them by their name should also be implemented.

Add a LICENSE file?

If you intend for others to use this legally, it would be very helpful to choose an open source licence.

Support json-like format to print Message object

When I print the msg object in Example , the result is
<exampleproto.CMsgClientGamesPlayed instance at 0xxxxxxxx>

And the msg.__dict__ isn't friendly with embedded Message.
{'token': 'TOKENTOKENTOKENTOKEN', 'games': [<exampleproto.Game instance at 0xxxxxxxxx>], 'game_port': 1337, 'game_ip_address': 287454020}

I think the json-like/dict-like format is very helpful to debug decoding result, such as
{'game_ip_address': 287454020, 'game_port': 1337, 'token': 'TOKENTOKENTOKENTOKEN', 'games': [{'game_id': 1234, 'game_name': 'blah', 'game_version': 0}]}