Functions | Variables
google.protobuf.internal.decoder Namespace Reference

Functions

def _DecodeFixed32 (buffer, pos)
 
def _DecodeFixed64 (buffer, pos)
 
def _DecodeUnknownField (buffer, pos, wire_type)
 
def _DecodeUnknownFieldSet (buffer, pos, end_pos=None)
 
def _DoubleDecoder ()
 
def _EndGroup (buffer, pos, end)
 
def _FieldSkipper ()
 
def _FloatDecoder ()
 
def _ModifiedDecoder (wire_type, decode_value, modify_value)
 
def _RaiseInvalidWireType (buffer, pos, end)
 
def _SignedVarintDecoder (bits, result_type)
 
def _SimpleDecoder (wire_type, decode_value)
 
def _SkipFixed32 (buffer, pos, end)
 
def _SkipFixed64 (buffer, pos, end)
 
def _SkipGroup (buffer, pos, end)
 
def _SkipLengthDelimited (buffer, pos, end)
 
def _SkipVarint (buffer, pos, end)
 
def _StructPackDecoder (wire_type, format)
 
def _VarintDecoder (mask, result_type)
 
def BytesDecoder (field_number, is_repeated, is_packed, key, new_default)
 
def BytesDecoder (field_number, is_repeated, is_packed, key, new_default, clear_if_default=False)
 
def EnumDecoder (field_number, is_repeated, is_packed, key, new_default)
 
def EnumDecoder (field_number, is_repeated, is_packed, key, new_default, clear_if_default=False)
 
def GroupDecoder (field_number, is_repeated, is_packed, key, new_default)
 
def MapDecoder (field_descriptor, new_default, is_message_map)
 
def MessageDecoder (field_number, is_repeated, is_packed, key, new_default)
 
def MessageSetItemDecoder (descriptor)
 
def ReadTag (buffer, pos)
 
def StringDecoder (field_number, is_repeated, is_packed, key, new_default, is_strict_utf8=False)
 

Variables

string __author__ = 'kenton@google.com (Kenton Varda)'
 
 _DecodeError = message.DecodeError
 
def _DecodeSignedVarint = _SignedVarintDecoder(64, long)
 
def _DecodeSignedVarint32 = _SignedVarintDecoder(32, int)
 
def _DecodeVarint = _VarintDecoder((1 << 64) - 1, long)
 
def _DecodeVarint32 = _VarintDecoder((1 << 32) - 1, int)
 
int _NAN = _POS_INF * 0
 
int _NEG_INF = -_POS_INF
 
int _POS_INF = 1e10000
 
 _SURROGATE_PATTERN = re.compile(six.u(r'[\ud800-\udfff]'))
 
int _UCS2_MAXUNICODE = 65535
 
def BoolDecoder
 
def DoubleDecoder = _DoubleDecoder()
 
def Fixed32Decoder = _StructPackDecoder(wire_format.WIRETYPE_FIXED32, '<I')
 
def Fixed64Decoder = _StructPackDecoder(wire_format.WIRETYPE_FIXED64, '<Q')
 
def FloatDecoder = _FloatDecoder()
 
def Int32Decoder
 
def Int64Decoder
 
 long = int
 
 MESSAGE_SET_ITEM_TAG = encoder.TagBytes(1, wire_format.WIRETYPE_START_GROUP)
 
def SFixed32Decoder = _StructPackDecoder(wire_format.WIRETYPE_FIXED32, '<i')
 
def SFixed64Decoder = _StructPackDecoder(wire_format.WIRETYPE_FIXED64, '<q')
 
def SInt32Decoder
 
def SInt64Decoder
 
def SkipField = _FieldSkipper()
 
def UInt32Decoder = _SimpleDecoder(wire_format.WIRETYPE_VARINT, _DecodeVarint32)
 
def UInt64Decoder = _SimpleDecoder(wire_format.WIRETYPE_VARINT, _DecodeVarint)
 

Function Documentation

◆ _DecodeFixed32()

def google.protobuf.internal.decoder._DecodeFixed32 (   buffer,
  pos 
)
private
Decode a fixed32.

Definition at line 992 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ _DecodeFixed64()

def google.protobuf.internal.decoder._DecodeFixed64 (   buffer,
  pos 
)
private
Decode a fixed64.

Definition at line 910 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ _DecodeUnknownField()

def google.protobuf.internal.decoder._DecodeUnknownField (   buffer,
  pos,
  wire_type 
)
private
Decode a unknown field.  Returns the UnknownField and new position.

Definition at line 954 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ _DecodeUnknownFieldSet()

def google.protobuf.internal.decoder._DecodeUnknownFieldSet (   buffer,
  pos,
  end_pos = None 
)
private
Decode UnknownFieldSet.  Returns the UnknownFieldSet and new position.

Definition at line 937 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ _DoubleDecoder()

def google.protobuf.internal.decoder._DoubleDecoder ( )
private
Returns a decoder for a double field.

This code works around a bug in struct.unpack for not-a-number.

Definition at line 346 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ _EndGroup()

def google.protobuf.internal.decoder._EndGroup (   buffer,
  pos,
  end 
)
private
Skipping an END_GROUP tag returns -1 to tell the parent loop to break.

Definition at line 977 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ _FieldSkipper()

def google.protobuf.internal.decoder._FieldSkipper ( )
private
Constructs the SkipField function.

Definition at line 1004 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ _FloatDecoder()

def google.protobuf.internal.decoder._FloatDecoder ( )
private
Returns a decoder for a float field.

This code works around a bug in struct.unpack for non-finite 32-bit
floating-point values.

Definition at line 301 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ _ModifiedDecoder()

def google.protobuf.internal.decoder._ModifiedDecoder (   wire_type,
  decode_value,
  modify_value 
)
private
Like SimpleDecoder but additionally invokes modify_value on every value
before storing it.  Usually modify_value is ZigZagDecode.

Definition at line 262 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ _RaiseInvalidWireType()

def google.protobuf.internal.decoder._RaiseInvalidWireType (   buffer,
  pos,
  end 
)
private
Skip function for unknown wire types.  Raises an exception.

Definition at line 999 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ _SignedVarintDecoder()

def google.protobuf.internal.decoder._SignedVarintDecoder (   bits,
  result_type 
)
private
Like _VarintDecoder() but decodes signed values.

Definition at line 139 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ _SimpleDecoder()

def google.protobuf.internal.decoder._SimpleDecoder (   wire_type,
  decode_value 
)
private
Return a constructor for a decoder for fields of a particular type.

Args:
    wire_type:  The field's wire type.
    decode_value:  A function which decodes an individual value, e.g.
      _DecodeVarint()

Definition at line 203 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ _SkipFixed32()

def google.protobuf.internal.decoder._SkipFixed32 (   buffer,
  pos,
  end 
)
private
Skip a fixed32 value.  Returns the new position.

Definition at line 983 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ _SkipFixed64()

def google.protobuf.internal.decoder._SkipFixed64 (   buffer,
  pos,
  end 
)
private
Skip a fixed64 value.  Returns the new position.

Definition at line 901 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ _SkipGroup()

def google.protobuf.internal.decoder._SkipGroup (   buffer,
  pos,
  end 
)
private
Skip sub-group.  Returns the new position.

Definition at line 926 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ _SkipLengthDelimited()

def google.protobuf.internal.decoder._SkipLengthDelimited (   buffer,
  pos,
  end 
)
private
Skip a length-delimited value.  Returns the new position.

Definition at line 916 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ _SkipVarint()

def google.protobuf.internal.decoder._SkipVarint (   buffer,
  pos,
  end 
)
private
Skip a varint value.  Returns the new position.

Definition at line 889 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ _StructPackDecoder()

def google.protobuf.internal.decoder._StructPackDecoder (   wire_type,
  format 
)
private
Return a constructor for a decoder for a fixed-width field.

Args:
    wire_type:  The field's wire type.
    format:  The format string to pass to struct.unpack().

Definition at line 276 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ _VarintDecoder()

def google.protobuf.internal.decoder._VarintDecoder (   mask,
  result_type 
)
private
Return an encoder for a basic varint value (does not include tag).

Decoded values will be bitwise-anded with the given mask before being
returned, e.g. to limit them to 32 bits.  The returned decoder does not
take the usual "end" parameter -- the caller is expected to do bounds checking
after the fact (often the caller can defer such checking until later).  The
decoder returns a (value, new_pos) pair.

Definition at line 112 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ BytesDecoder() [1/2]

def google.protobuf.internal.decoder.BytesDecoder (   field_number,
  is_repeated,
  is_packed,
  key,
  new_default 
)
Returns a decoder for a bytes field.

Definition at line 612 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ BytesDecoder() [2/2]

def google.protobuf.internal.decoder.BytesDecoder (   field_number,
  is_repeated,
  is_packed,
  key,
  new_default,
  clear_if_default = False 
)
Returns a decoder for a bytes field.

Definition at line 596 of file protobuf/python/google/protobuf/internal/decoder.py.

◆ EnumDecoder() [1/2]

def google.protobuf.internal.decoder.EnumDecoder (   field_number,
  is_repeated,
  is_packed,
  key,
  new_default 
)

◆ EnumDecoder() [2/2]

def google.protobuf.internal.decoder.EnumDecoder (   field_number,
  is_repeated,
  is_packed,
  key,
  new_default,
  clear_if_default = False 
)
Returns a decoder for enum field.

Definition at line 372 of file protobuf/python/google/protobuf/internal/decoder.py.

◆ GroupDecoder()

def google.protobuf.internal.decoder.GroupDecoder (   field_number,
  is_repeated,
  is_packed,
  key,
  new_default 
)
Returns a decoder for a group field.

Definition at line 649 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ MapDecoder()

def google.protobuf.internal.decoder.MapDecoder (   field_descriptor,
  new_default,
  is_message_map 
)
Returns a decoder for a map field.

Definition at line 843 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ MessageDecoder()

def google.protobuf.internal.decoder.MessageDecoder (   field_number,
  is_repeated,
  is_packed,
  key,
  new_default 
)
Returns a decoder for a message field.

Definition at line 696 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ MessageSetItemDecoder()

def google.protobuf.internal.decoder.MessageSetItemDecoder (   descriptor)
Returns a decoder for a MessageSet item.

The parameter is the message Descriptor.

The message set message looks like this:
  message MessageSet {
    repeated group Item = 1 {
      required int32 type_id = 2;
      required string message = 3;
    }
  }

Definition at line 750 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ ReadTag()

def google.protobuf.internal.decoder.ReadTag (   buffer,
  pos 
)
Read a tag from the memoryview, and return a (tag_bytes, new_pos) tuple.

We return the raw bytes of the tag rather than decoding them.  The raw
bytes can then be used to look up the proper decoder.  This effectively allows
us to trade some work that would be done in pure-python (decoding a varint)
for work that is done in C (searching for a byte string in a hash table).
In a low-level language it would be much cheaper to decode the varint and
use that, but not in Python.

Args:
  buffer: memoryview object of the encoded bytes
  pos: int of the current position to start from

Returns:
  Tuple[bytes, int] of the tag data and new position.

Definition at line 174 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ StringDecoder()

def google.protobuf.internal.decoder.StringDecoder (   field_number,
  is_repeated,
  is_packed,
  key,
  new_default,
  clear_if_default = False 
)
Returns a decoder for a string field.

Definition at line 552 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

Variable Documentation

◆ __author__

string google.protobuf.internal.decoder.__author__ = 'kenton@google.com (Kenton Varda)'
private

◆ _DecodeError

google.protobuf.internal.decoder._DecodeError = message.DecodeError
private

◆ _DecodeSignedVarint

def google.protobuf.internal.decoder._DecodeSignedVarint = _SignedVarintDecoder(64, long)
private

◆ _DecodeSignedVarint32

def google.protobuf.internal.decoder._DecodeSignedVarint32 = _SignedVarintDecoder(32, int)
private

◆ _DecodeVarint

def google.protobuf.internal.decoder._DecodeVarint = _VarintDecoder((1 << 64) - 1, long)
private

◆ _DecodeVarint32

def google.protobuf.internal.decoder._DecodeVarint32 = _VarintDecoder((1 << 32) - 1, int)
private

◆ _NAN

int google.protobuf.internal.decoder._NAN = _POS_INF * 0
private

◆ _NEG_INF

int google.protobuf.internal.decoder._NEG_INF = -_POS_INF
private

◆ _POS_INF

int google.protobuf.internal.decoder._POS_INF = 1e10000
private

◆ _SURROGATE_PATTERN

google.protobuf.internal.decoder._SURROGATE_PATTERN = re.compile(six.u(r'[\ud800-\udfff]'))
private

◆ _UCS2_MAXUNICODE

int google.protobuf.internal.decoder._UCS2_MAXUNICODE = 65535
private

◆ BoolDecoder

def google.protobuf.internal.decoder.BoolDecoder
Initial value:
2  wire_format.WIRETYPE_VARINT, _DecodeVarint, bool)

Definition at line 548 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ DoubleDecoder

def google.protobuf.internal.decoder.DoubleDecoder = _DoubleDecoder()

◆ Fixed32Decoder

def google.protobuf.internal.decoder.Fixed32Decoder = _StructPackDecoder(wire_format.WIRETYPE_FIXED32, '<I')

◆ Fixed64Decoder

def google.protobuf.internal.decoder.Fixed64Decoder = _StructPackDecoder(wire_format.WIRETYPE_FIXED64, '<Q')

◆ FloatDecoder

def google.protobuf.internal.decoder.FloatDecoder = _FloatDecoder()

◆ Int32Decoder

def google.protobuf.internal.decoder.Int32Decoder
Initial value:
2  wire_format.WIRETYPE_VARINT, _DecodeSignedVarint32)

Definition at line 523 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ Int64Decoder

def google.protobuf.internal.decoder.Int64Decoder
Initial value:
2  wire_format.WIRETYPE_VARINT, _DecodeSignedVarint)

Definition at line 526 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ long

google.protobuf.internal.decoder.long = int

◆ MESSAGE_SET_ITEM_TAG

google.protobuf.internal.decoder.MESSAGE_SET_ITEM_TAG = encoder.TagBytes(1, wire_format.WIRETYPE_START_GROUP)

◆ SFixed32Decoder

def google.protobuf.internal.decoder.SFixed32Decoder = _StructPackDecoder(wire_format.WIRETYPE_FIXED32, '<i')

◆ SFixed64Decoder

def google.protobuf.internal.decoder.SFixed64Decoder = _StructPackDecoder(wire_format.WIRETYPE_FIXED64, '<q')

◆ SInt32Decoder

def google.protobuf.internal.decoder.SInt32Decoder
Initial value:
2  wire_format.WIRETYPE_VARINT, _DecodeVarint32, wire_format.ZigZagDecode)

Definition at line 532 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ SInt64Decoder

def google.protobuf.internal.decoder.SInt64Decoder
Initial value:
2  wire_format.WIRETYPE_VARINT, _DecodeVarint, wire_format.ZigZagDecode)

Definition at line 534 of file bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py.

◆ SkipField

def google.protobuf.internal.decoder.SkipField = _FieldSkipper()

◆ UInt32Decoder

def google.protobuf.internal.decoder.UInt32Decoder = _SimpleDecoder(wire_format.WIRETYPE_VARINT, _DecodeVarint32)

◆ UInt64Decoder

def google.protobuf.internal.decoder.UInt64Decoder = _SimpleDecoder(wire_format.WIRETYPE_VARINT, _DecodeVarint)
google::protobuf.internal.decoder._ModifiedDecoder
def _ModifiedDecoder(wire_type, decode_value, modify_value)
Definition: bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py:262
google::protobuf.internal.decoder._SimpleDecoder
def _SimpleDecoder(wire_type, decode_value)
Definition: bloaty/third_party/protobuf/python/google/protobuf/internal/decoder.py:203


grpc
Author(s):
autogenerated on Fri May 16 2025 03:03:27