PROTOBUF_VERSION = google.protobuf.__version__

# extract the major version code

_PROTOBUF_MAJOR_VERSION = PROTOBUF_VERSION.partition(".")[0]

_upb = has_upb() # Important to cache result here.

including_default_value_fields (Optional(bool)): The value of `including_default_value_fields` set by the user.

"""

if (

PROTOBUF_VERSION[0] not in ("3", "4")

_PROTOBUF_MAJOR_VERSION not in ("3", "4")

and including_default_value_fields is not None

):

warnings.warn(

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.

Default is None. [DEPRECATED] float_precision was removed in Protobuf 7.x.

always_print_fields_with_no_presence (Optional(bool)): If True, fields without

presence (implicit presence scalars, repeated fields, and map fields) will

always be serialized. Any field that supports presence is not affected by

Returns:

str: The json string representation of the protocol buffer.

"""

print_fields = cls._normalize_print_fields_without_presence(

always_print_fields_with_no_presence, including_default_value_fields

)

if PROTOBUF_VERSION[0] in ("3", "4"):

return MessageToJson(

cls.pb(instance),

use_integers_for_enums=use_integers_for_enums,

including_default_value_fields=print_fields,

preserving_proto_field_name=preserving_proto_field_name,

sort_keys=sort_keys,

indent=indent,

float_precision=float_precision,

)

else:

# The `including_default_value_fields` argument was removed from protobuf 5.x

# and replaced with `always_print_fields_with_no_presence` which very similar but has

# handles optional fields consistently by not affecting them.

# The old flag accidentally had inconsistent behavior between proto2

# optional and proto3 optional fields.

return MessageToJson(

cls.pb(instance),

use_integers_for_enums=use_integers_for_enums,

always_print_fields_with_no_presence=print_fields,

preserving_proto_field_name=preserving_proto_field_name,

sort_keys=sort_keys,

indent=indent,

float_precision=float_precision,

)

return _message_to_map(map_fn=MessageToJson, **locals())

def from_json(cls, payload, *, ignore_unknown_fields=False) -> "Message":

"""Given a json string representing an instance,

This value must match `always_print_fields_with_no_presence`,

if both arguments are explicitly set.

float_precision (Optional(int)): If set, use this to specify float field valid digits.

Default is None.

Default is None. [DEPRECATED] float_precision was removed in Protobuf 7.x.

always_print_fields_with_no_presence (Optional(bool)): If True, fields without

presence (implicit presence scalars, repeated fields, and map fields) will

always be serialized. Any field that supports presence is not affected by

Messages and map fields are represented as dicts,

repeated fields are represented as lists.

"""

print_fields = cls._normalize_print_fields_without_presence(

always_print_fields_with_no_presence, including_default_value_fields

)

if PROTOBUF_VERSION[0] in ("3", "4"):

return MessageToDict(

cls.pb(instance),

including_default_value_fields=print_fields,

preserving_proto_field_name=preserving_proto_field_name,

use_integers_for_enums=use_integers_for_enums,

float_precision=float_precision,

)

else:

# The `including_default_value_fields` argument was removed from protobuf 5.x

# and replaced with `always_print_fields_with_no_presence` which very similar but has

# handles optional fields consistently by not affecting them.

# The old flag accidentally had inconsistent behavior between proto2

# optional and proto3 optional fields.

return MessageToDict(

cls.pb(instance),

always_print_fields_with_no_presence=print_fields,

preserving_proto_field_name=preserving_proto_field_name,

use_integers_for_enums=use_integers_for_enums,

float_precision=float_precision,

)

return _message_to_map(map_fn=MessageToDict, **locals())

def copy_from(cls, instance, other):

"""Equivalent for protobuf.Message.CopyFrom

return self._pb

def _message_to_map(

cls,

map_fn,

instance,

*,

including_default_value_fields=None,

always_print_fields_with_no_presence=None,

float_precision=None,

**kwargs,

):

"""

Helper for logic for Message.to_dict and Message.to_json

"""

# The `including_default_value_fields` argument was removed from protobuf 5.x

# and replaced with `always_print_fields_with_no_presence` which is similar but

# handles optional fields consistently by not affecting them.

# The old flag accidentally had inconsistent behavior between optional fields

# in proto2 and proto3.

print_fields = cls._normalize_print_fields_without_presence(

always_print_fields_with_no_presence, including_default_value_fields

)

if _PROTOBUF_MAJOR_VERSION in ("3", "4"):

kwargs["including_default_value_fields"] = print_fields

else:

kwargs["always_print_fields_with_no_presence"] = print_fields

if float_precision:

# float_precision removed in protobuf 7

if _PROTOBUF_MAJOR_VERSION in ("3", "4", "5", "6"):

kwargs["float_precision"] = float_precision

warning_msg = "`float_precision` will be removed in Protobuf 7.x."

else: # pragma: NO COVER

warning_msg = (

"`float_precision` was removed in Protobuf 7.x+, and will be ignored."

)

warnings.warn(warning_msg, DeprecationWarning, stacklevel=3)

# suppress similar float_precision warning from protobuf library.

with warnings.catch_warnings():

warnings.filterwarnings("ignore", message=".*float_precision.*")

return map_fn(cls.pb(instance), **kwargs)

__all__ = ("Message",)