A Pure Python Protobuf .proto Parser
Project description
Protobuf Schema Parser
Protobuf Schema Parser is a pure-Python library that parses and writes Protobuf schemas to and from an abstract syntax tree (AST).
The library uses proto_schema_parser.parser.Parser
to parse the CST into an AST. The proto_schema_parser.generator.Generator
class converts the AST back into a CST (a Protobuf schema string).
The lexer and parser are autogenerated from Buf's ANTLR lexer and parser grammar files.
Features
- ✅ proto2 and proto3 support
- ✅ message, field, enum, optional, required, repeated
- ✅ import, package, oneof, map, and option
- ✅ group and extend (in proto2)
- ✅ service, rpc, and stream
- ✅ line and block comment preservation
Installation
Install the package via pip:
pip install protobuf-schema-parser
Usage
To parse a protobuf schema, create a Parser
object and call the parse
method:
from proto_schema_parser.parser import Parser
text = """
syntax = "proto3";
message SearchRequest {
string query = 1;
int32 page_number = 2;
int32 result_per_page = 3;
}
"""
result = Parser().parse(text)
This will return an AST object (ast.File
) representing the parsed protobuf schema.
File(syntax='proto3',
file_elements=[Message(name='SearchRequest',
elements=[Field(name='query',
number=1,
type='string',
cardinality=None,
options=[]),
Field(name='page_number',
number=2,
type='int32',
cardinality=None,
options=[]),
Field(name='result_per_page',
number=3,
type='int32',
cardinality=None,
options=[])])])
To write the AST back to a protobuf schema, create a Generator
object and call the generate
method:
from proto_schema_parser.generator import Generator
proto = Generator().generate(result)
This will print:
syntax = "proto3";
message SearchRequest {
string query = 1;
int32 page_number = 2;
int32 result_per_page = 3;
}
Contributing
I welcome contributions!
- Submit a PR and I'll review it as soon as I can.
- Open an issue if you find a bug or have a feature request.
License
Protobuf Schema Parser is licensed under the MIT license.
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
Built Distribution
Hashes for proto_schema_parser-1.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 510762609a610463bf44662e02ef064fd748be869e6372e28d1c15f17804f6ac |
|
MD5 | 6ba829edd57c1506f7fb966af7341519 |
|
BLAKE2b-256 | 1f17654df99dcf0cc7b5a4d38a285a699bf6b4d1d6124feddd0298afc28d326b |
Hashes for proto_schema_parser-1.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8331209ddb86eeb51dbcf5112c2ca8a59d34d8f3e1329f558890a1873ffb7433 |
|
MD5 | def923c0b04bf4f962049ae305a240f0 |
|
BLAKE2b-256 | 43678500f06f05cbbcba32c5fb26da227c8d5263ad8b34815ef456bd7a40a6ae |