Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Add additional parameters to to_json() and to_dict() methods #384

Merged
merged 12 commits into from Sep 8, 2023
Merged

feat: Add additional parameters to to_json() and to_dict() methods #384

Changes from 3 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
9522581
feat: Add additional parameters to `to_json()` and `to_dict()` methods
holtskinner Aug 3, 2023
a81ee7c
chore: Update min protobuf version to 3.20.0 to support `ensure_ascii`
holtskinner Aug 4, 2023
4b54464
Removed `ensure_ascii` to prevent version compatibility errors
holtskinner Aug 4, 2023
c9a990c
Update proto/message.py
holtskinner Sep 1, 2023
c843a77
test: Add tests for `sort_keys` and `float_precision`
holtskinner Sep 5, 2023
ec014f6
Fix test checks
holtskinner Sep 5, 2023
f890177
Remove indent from float_precision test and add re.compile to sortkey…
holtskinner Sep 5, 2023
0137ab3
Add spaces to float precision check, add dotall to sortkeys check
holtskinner Sep 5, 2023
eaf901b
Remove indent from sort_keys test, add space to float precision test
holtskinner Sep 5, 2023
4b7b1e2
Changed match to search
holtskinner Sep 5, 2023
eea1fe6
test: Add test for `to_dict()` with `float_precision`
holtskinner Sep 6, 2023
5456326
Added TODOs for `float_precision` issue
holtskinner Sep 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 13 additions & 2 deletions proto/message.py
View file
Open in desktop
Expand Up @@ -376,7 +376,9 @@ def to_json(
use_integers_for_enums=True,
including_default_value_fields=True,
preserving_proto_field_name=False,
sort_keys=False,
indent=2,
float_precision=None,
) -> str:
"""Given a message instance, serialize it to json

Expand All @@ -389,10 +391,13 @@ def to_json(
preserving_proto_field_name (Optional(bool)): An option that
determines whether field name representations preserve
proto case (snake_case) or use lowerCamelCase. Default is False.
indent: The JSON object will be pretty-printed with this indent level.
sort_keys (Optional(bool)): If True, then the output will be sorted by field names.
Default is False.
indent (int): The JSON object will be pretty-printed with this indent level.
holtskinner marked this conversation as resolved.
Show resolved Hide resolved
An indent level of 0 or negative will only insert newlines.
Pass None for the most compact representation without newlines.

float_precision (Optional(int)): If set, use this to specify float field valid digits.
Default is None.
Returns:
str: The json string representation of the protocol buffer.
"""
Expand All @@ -401,7 +406,9 @@ def to_json(
use_integers_for_enums=use_integers_for_enums,
including_default_value_fields=including_default_value_fields,
preserving_proto_field_name=preserving_proto_field_name,
sort_keys=sort_keys,
indent=indent,
float_precision=float_precision,
)

def from_json(cls, payload, *, ignore_unknown_fields=False) -> "Message":
Expand All @@ -428,6 +435,7 @@ def to_dict(
use_integers_for_enums=True,
preserving_proto_field_name=True,
including_default_value_fields=True,
float_precision=None,
) -> "Message":
"""Given a message instance, return its representation as a python dict.

Expand All @@ -443,6 +451,8 @@ def to_dict(
including_default_value_fields (Optional(bool)): An option that
determines whether the default field values should be included in the results.
Default is True.
float_precision (Optional(int)): If set, use this to specify float field valid digits.
Default is None.

Returns:
dict: A representation of the protocol buffer using pythonic data structures.
Expand All @@ -454,6 +464,7 @@ def to_dict(
including_default_value_fields=including_default_value_fields,
preserving_proto_field_name=preserving_proto_field_name,
use_integers_for_enums=use_integers_for_enums,
float_precision=float_precision,
)

def copy_from(cls, instance, other):
Expand Down