A Pure Python Protobuf 3 .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
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-0.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d255415fa1571419d644cd61dd43b56d88ac28ac188c4f44db2180197099eade |
|
MD5 | bb261a10006782633426fcfa9f4c5986 |
|
BLAKE2b-256 | efd348bf167c1fcc47cf8b1154ab22a85b6e3874b95970cbc2e795b5ba1abbf4 |
Hashes for proto_schema_parser-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3531d01e25be7ac8c08a11da85d41999a497b3a3414e4753cb0118bd68a66f3a |
|
MD5 | d11a868b42929e40f0ef7bf44cb9d760 |
|
BLAKE2b-256 | 59e7aa4d9e47f39231c8ffe24e534135e3a3fdf91d1f0bc008bdfd321f3a8df5 |