Protocol Buffers file formatter.
Project description
proto-formatter
Protocol Buffers file formatter.
Install
pip install proto-formatter
Usage
- Format protobuf file using default config: indents=2, all_top_comments=False, equal_sign=False, new_fp=None.
Original protobuf file
test.proto
will be rewritten with formatted content.
from proto_formatter import format_file
format_file('test.proto')
- Format protobuf file with specified config: indents=4, all_top_comments=True, equal_sign=True, new_fp='formatted.proto'.
Original protobuf file
test.proto
not be rewritten, create new protobuf fileformatted.proto
instead.
from proto_formatter import format_file
format_file('test.proto', indents=4, all_top_comments=True, equal_sign=True, new_fp='formatted.proto')
- Format protobuf string align with equal sign: equal_sign=True, other configs are default values.
from proto_formatter import format_str
proto_str = """
/*
Person balabala
*/
message Person {
// comment of name a
required string name = 1; // comment of name b
/*
comment of id a
// comment of id b
*/
required int32 id = 2;// comment of id c
optional string email = 3;// comment of email
}
"""
formatted_proto_str = format_str(proto_str, equal_sign=True)
The formatted_proto_str is:
/*
Person balabala
*/
message Person {
/*
comment of name a
*/
required string name = 1; // comment of name b
/*
comment of id a
comment of id b
*/
required int32 id = 2; // comment of id c
optional string email = 3; // comment of email
}
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
proto-formatter-0.1.1.tar.gz
(11.5 kB
view hashes)
Built Distribution
Close
Hashes for proto_formatter-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3c6ae752d26f12a21bb7fb114d2e5c8b3c278b70a90a4d1a1737ec9f39182beb |
|
MD5 | 33f74fcdd85bee9a9a202d4b1bec5018 |
|
BLAKE2b-256 | 6c8aa772eaece9a856859c08f0e1ba43379fb69a82ce97b5a77fa6d58898f5e2 |