Classes
class	_Parser

class	_Printer

class	Error

class	ParseError

class	SerializeToJsonError

Functions
def	_ConvertBool (value, require_str)

def	_ConvertFloat (value)

def	_ConvertInteger (value)

def	_ConvertScalarFieldValue (value, field, require_str=False)

def	_CreateMessageFromTypeUrl (type_url, descriptor_pool)

def	_DuplicateChecker (js)

def	_IsMapEntry (field)

def	_IsWrapperMessage (message_descriptor)

def	MessageToDict (message, including_default_value_fields=False, preserving_proto_field_name=False, use_integers_for_enums=False, descriptor_pool=None)

def	MessageToJson (message, including_default_value_fields=False, preserving_proto_field_name=False, indent=2, sort_keys=False, use_integers_for_enums=False, descriptor_pool=None)

def	Parse (text, message, ignore_unknown_fields=False, descriptor_pool=None)

def	ParseDict (js_dict, message, ignore_unknown_fields=False, descriptor_pool=None)

Variables
string	__author__ = 'jieluo@google.com (Jie Luo)'

	_FLOAT_TYPES

string	_INFINITY = 'Infinity'

	_INT64_TYPES

	_INT_OR_FLOAT = six.integer_types + (float,)

	_INT_TYPES

string	_NAN = 'NaN'

string	_NEG_INFINITY = '-Infinity'

string	_TIMESTAMPFOMAT = '%Y-%m-%dT%H:%M:%S'

	_UNPAIRED_SURROGATE_PATTERN

	_VALID_EXTENSION_NAME = re.compile(r'\[[a-zA-Z0-9\._]*\]$')

dictionary	_WKTJSONMETHODS

Function Documentation

◆ _ConvertBool()

def google.protobuf.json_format._ConvertBool	(	value,
		require_str
	)

private

Convert a boolean value.

Args:
  value: A scalar value to convert.
  require_str: If True, value must be a str.

Returns:
  The bool parsed.

Raises:
  ParseError: If a boolean value couldn't be consumed.

Definition at line 775 of file json_format.py.

◆ _ConvertFloat()

def google.protobuf.json_format._ConvertFloat ( value )

private

Convert an floating point number.

Definition at line 756 of file json_format.py.

◆ _ConvertInteger()

def google.protobuf.json_format._ConvertInteger ( value )

private

Convert an integer.

Args:
  value: A scalar value to convert.

Returns:
  The integer value.

Raises:
  ParseError: If an integer couldn't be consumed.

Definition at line 735 of file json_format.py.

◆ _ConvertScalarFieldValue()

def google.protobuf.json_format._ConvertScalarFieldValue	(	value,
		field,
		require_str = `False`
	)

private

Convert a single scalar field value.

Args:
  value: A scalar value to convert the scalar field value.
  field: The descriptor of the field to convert.
  require_str: If True, the field value must be a str.

Returns:
  The converted scalar field value

Raises:
  ParseError: In case of convert problems.

Definition at line 687 of file json_format.py.

◆ _CreateMessageFromTypeUrl()

def google.protobuf.json_format._CreateMessageFromTypeUrl	(	type_url,
		descriptor_pool
	)

private

Creates a message from a type URL.

Definition at line 380 of file json_format.py.

◆ _DuplicateChecker()

def google.protobuf.json_format._DuplicateChecker ( js )

private

Definition at line 371 of file json_format.py.

◆ _IsMapEntry()

def google.protobuf.json_format._IsMapEntry ( field )

private

Definition at line 171 of file json_format.py.

◆ _IsWrapperMessage()

def google.protobuf.json_format._IsWrapperMessage ( message_descriptor )

private

Definition at line 367 of file json_format.py.

◆ MessageToDict()

def google.protobuf.json_format.MessageToDict	(	message,
		including_default_value_fields = `False`,
		preserving_proto_field_name = `False`,
		use_integers_for_enums = `False`,
		descriptor_pool = `None`
	)

Converts protobuf message to a dictionary.

When the dictionary is encoded to JSON, it conforms to proto3 JSON spec.

Args:
  message: The protocol buffers message instance to serialize.
  including_default_value_fields: If True, singular primitive fields,
      repeated fields, and map fields will always be serialized.  If
      False, only serialize non-empty fields.  Singular message fields
      and oneof fields are not affected by this option.
  preserving_proto_field_name: If True, use the original proto field
      names as defined in the .proto file. If False, convert the field
      names to lowerCamelCase.
  use_integers_for_enums: If true, print integers instead of enum names.
  descriptor_pool: A Descriptor Pool for resolving types. If None use the
      default.

Returns:
  A dict representation of the protocol buffer message.

Definition at line 136 of file json_format.py.

◆ MessageToJson()

def google.protobuf.json_format.MessageToJson	(	message,
		including_default_value_fields = `False`,
		preserving_proto_field_name = `False`,
		indent = `2`,
		sort_keys = `False`,
		use_integers_for_enums = `False`,
		descriptor_pool = `None`
	)

Converts protobuf message to JSON format.

Args:
  message: The protocol buffers message instance to serialize.
  including_default_value_fields: If True, singular primitive fields,
      repeated fields, and map fields will always be serialized.  If
      False, only serialize non-empty fields.  Singular message fields
      and oneof fields are not affected by this option.
  preserving_proto_field_name: If True, use the original proto field
      names as defined in the .proto file. If False, convert the field
      names to lowerCamelCase.
  indent: The JSON object will be pretty-printed with this indent level.
      An indent level of 0 or negative will only insert newlines.
  sort_keys: If True, then the output will be sorted by field names.
  use_integers_for_enums: If true, print integers instead of enum names.
  descriptor_pool: A Descriptor Pool for resolving types. If None use the
      default.

Returns:
  A string containing the JSON formatted protocol buffer message.

Definition at line 99 of file json_format.py.

◆ Parse()

def google.protobuf.json_format.Parse	(	text,
		message,
		ignore_unknown_fields = `False`,
		descriptor_pool = `None`
	)

Parses a JSON representation of a protocol message into a message.

Args:
  text: Message JSON representation.
  message: A protocol buffer message to merge into.
  ignore_unknown_fields: If True, do not raise errors for unknown fields.
  descriptor_pool: A Descriptor Pool for resolving types. If None use the
      default.

Returns:
  The same message passed as argument.

Raises::
  ParseError: On JSON parsing problems.

Definition at line 394 of file json_format.py.

◆ ParseDict()

def google.protobuf.json_format.ParseDict	(	js_dict,
		message,
		ignore_unknown_fields = `False`,
		descriptor_pool = `None`
	)

Parses a JSON dictionary representation into a message.

Args:
  js_dict: Dict representation of a JSON message.
  message: A protocol buffer message to merge into.
  ignore_unknown_fields: If True, do not raise errors for unknown fields.
  descriptor_pool: A Descriptor Pool for resolving types. If None use the
    default.

Returns:
  The same message passed as argument.

Definition at line 418 of file json_format.py.

Variable Documentation

◆ author

string google.protobuf.json_format.__author__ = 'jieluo@google.com (Jie Luo)'

private

Definition at line 43 of file json_format.py.

◆ _FLOAT_TYPES

google.protobuf.json_format._FLOAT_TYPES

private

Initial value:

1 = frozenset([descriptor.FieldDescriptor.CPPTYPE_FLOAT,

2 descriptor.FieldDescriptor.CPPTYPE_DOUBLE])

Definition at line 74 of file json_format.py.

◆ _INFINITY

string google.protobuf.json_format._INFINITY = 'Infinity'

private

Definition at line 76 of file json_format.py.

◆ _INT64_TYPES

google.protobuf.json_format._INT64_TYPES

private

Initial value:

1 = frozenset([descriptor.FieldDescriptor.CPPTYPE_INT64,

2 descriptor.FieldDescriptor.CPPTYPE_UINT64])

Definition at line 72 of file json_format.py.

◆ _INT_OR_FLOAT

google.protobuf.json_format._INT_OR_FLOAT = six.integer_types + (float,)

private

Definition at line 439 of file json_format.py.

◆ _INT_TYPES

google.protobuf.json_format._INT_TYPES

private

Initial value:

 =  frozenset([descriptor.FieldDescriptor.CPPTYPE_INT32,
                         descriptor.FieldDescriptor.CPPTYPE_UINT32,
                         descriptor.FieldDescriptor.CPPTYPE_INT64,
                         descriptor.FieldDescriptor.CPPTYPE_UINT64])

Definition at line 68 of file json_format.py.

◆ _NAN

string google.protobuf.json_format._NAN = 'NaN'

private

Definition at line 78 of file json_format.py.

◆ _NEG_INFINITY

string google.protobuf.json_format._NEG_INFINITY = '-Infinity'

private

Definition at line 77 of file json_format.py.

◆ _TIMESTAMPFOMAT

string google.protobuf.json_format._TIMESTAMPFOMAT = '%Y-%m-%dT%H:%M:%S'

private

Definition at line 67 of file json_format.py.

◆ _UNPAIRED_SURROGATE_PATTERN

google.protobuf.json_format._UNPAIRED_SURROGATE_PATTERN

private

Initial value:

 =  re.compile(six.u(
     r'[\ud800-\udbff](?![\udc00-\udfff])|(?<![\ud800-\udbff])[\udc00-\udfff]'
 ))

Definition at line 80 of file json_format.py.

◆ _VALID_EXTENSION_NAME

google.protobuf.json_format._VALID_EXTENSION_NAME = re.compile(r'\[[a-zA-Z0-9\._]*\]$')

private

Definition at line 84 of file json_format.py.

◆ _WKTJSONMETHODS

dictionary google.protobuf.json_format._WKTJSONMETHODS

private

Initial value:

 =  {
     'google.protobuf.Any': ['_AnyMessageToJsonObject',
                             '_ConvertAnyMessage'],
     'google.protobuf.Duration': ['_GenericMessageToJsonObject',
                                  '_ConvertGenericMessage'],
     'google.protobuf.FieldMask': ['_GenericMessageToJsonObject',
                                   '_ConvertGenericMessage'],
     'google.protobuf.ListValue': ['_ListValueMessageToJsonObject',
                                   '_ConvertListValueMessage'],
     'google.protobuf.Struct': ['_StructMessageToJsonObject',
                                '_ConvertStructMessage'],
     'google.protobuf.Timestamp': ['_GenericMessageToJsonObject',
                                   '_ConvertGenericMessage'],
     'google.protobuf.Value': ['_ValueMessageToJsonObject',
                               '_ConvertValueMessage']
 }

Definition at line 800 of file json_format.py.

Classes

Functions

Variables

Function Documentation

◆ _ConvertBool()

◆ _ConvertFloat()

◆ _ConvertInteger()

◆ _ConvertScalarFieldValue()

◆ _CreateMessageFromTypeUrl()

◆ _DuplicateChecker()

◆ _IsMapEntry()

◆ _IsWrapperMessage()

◆ MessageToDict()

◆ MessageToJson()

◆ Parse()

◆ ParseDict()

Variable Documentation

◆ __author__

◆ _FLOAT_TYPES

◆ _INFINITY

◆ _INT64_TYPES

◆ _INT_OR_FLOAT

◆ _INT_TYPES

◆ _NAN

◆ _NEG_INFINITY

◆ _TIMESTAMPFOMAT

◆ _UNPAIRED_SURROGATE_PATTERN

◆ _VALID_EXTENSION_NAME

◆ _WKTJSONMETHODS

◆ author