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 proto-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)
The proto
variable now contains the string:
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.3.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1b112d4208e1a8123cb9effbb852cca6d9681f4f0210669c91080b213c160ccb |
|
MD5 | 8e2b6ffc3c720d9bfa21a70d1d8b101a |
|
BLAKE2b-256 | a35995b0f8d69b120f1b2bef9e633a66e59b7991d5408397d776cfa9b809f4a1 |
Hashes for proto_schema_parser-1.3.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e30bf0a749b275033f91f8fecc51840bbbec2194a2225e29b9013ac0dec680b8 |
|
MD5 | 1358175061842f97257565ead75d2458 |
|
BLAKE2b-256 | bc37d393cbdfd13fe7f9dfe87121b048f7847189b9fc67fdae49d3879349315e |