Skip to content

descriptor

Descriptors essentially contain exactly the information found in a .proto file, in types that make this information accessible in Python.

Descriptor

Bases: _NestedDescriptorBase

Descriptor for a protocol message type.

Attributes:

Name Type Description
name str

Name of this protocol message type.

full_name str

Fully-qualified name of this protocol message type, which will include protocol "package" name and the name of any enclosing types.

containing_type Descriptor

Reference to the descriptor of the type containing us, or None if this is top-level.

fields list[FieldDescriptor]

Field descriptors for all fields in this type.

fields_by_number dict(int, FieldDescriptor

Same :class:FieldDescriptor objects as in :attr:fields, but indexed by "number" attribute in each FieldDescriptor.

fields_by_name dict(str, FieldDescriptor

Same :class:FieldDescriptor objects as in :attr:fields, but indexed by "name" attribute in each :class:FieldDescriptor.

nested_types list[Descriptor]

Descriptor references for all protocol message types nested within this one.

nested_types_by_name dict(str, Descriptor

Same Descriptor objects as in :attr:nested_types, but indexed by "name" attribute in each Descriptor.

enum_types list[EnumDescriptor]

:class:EnumDescriptor references for all enums contained within this type.

enum_types_by_name dict(str, EnumDescriptor

Same :class:EnumDescriptor objects as in :attr:enum_types, but indexed by "name" attribute in each EnumDescriptor.

enum_values_by_name dict(str, EnumValueDescriptor

Dict mapping from enum value name to :class:EnumValueDescriptor for that value.

extensions list[FieldDescriptor]

All extensions defined directly within this message type (NOT within a nested type).

extensions_by_name dict(str, FieldDescriptor

Same FieldDescriptor objects as :attr:extensions, but indexed by "name" attribute of each FieldDescriptor.

is_extendable bool

Does this type define any extension ranges?

oneofs list[OneofDescriptor]

The list of descriptors for oneof fields in this message.

oneofs_by_name dict(str, OneofDescriptor

Same objects as in :attr:oneofs, but indexed by "name" attribute.

file FileDescriptor

Reference to file descriptor.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
class Descriptor(_NestedDescriptorBase):

  """Descriptor for a protocol message type.

  Attributes:
      name (str): Name of this protocol message type.
      full_name (str): Fully-qualified name of this protocol message type,
          which will include protocol "package" name and the name of any
          enclosing types.
      containing_type (Descriptor): Reference to the descriptor of the type
          containing us, or None if this is top-level.
      fields (list[FieldDescriptor]): Field descriptors for all fields in
          this type.
      fields_by_number (dict(int, FieldDescriptor)): Same
          :class:`FieldDescriptor` objects as in :attr:`fields`, but indexed
          by "number" attribute in each FieldDescriptor.
      fields_by_name (dict(str, FieldDescriptor)): Same
          :class:`FieldDescriptor` objects as in :attr:`fields`, but indexed by
          "name" attribute in each :class:`FieldDescriptor`.
      nested_types (list[Descriptor]): Descriptor references
          for all protocol message types nested within this one.
      nested_types_by_name (dict(str, Descriptor)): Same Descriptor
          objects as in :attr:`nested_types`, but indexed by "name" attribute
          in each Descriptor.
      enum_types (list[EnumDescriptor]): :class:`EnumDescriptor` references
          for all enums contained within this type.
      enum_types_by_name (dict(str, EnumDescriptor)): Same
          :class:`EnumDescriptor` objects as in :attr:`enum_types`, but
          indexed by "name" attribute in each EnumDescriptor.
      enum_values_by_name (dict(str, EnumValueDescriptor)): Dict mapping
          from enum value name to :class:`EnumValueDescriptor` for that value.
      extensions (list[FieldDescriptor]): All extensions defined directly
          within this message type (NOT within a nested type).
      extensions_by_name (dict(str, FieldDescriptor)): Same FieldDescriptor
          objects as :attr:`extensions`, but indexed by "name" attribute of each
          FieldDescriptor.
      is_extendable (bool):  Does this type define any extension ranges?
      oneofs (list[OneofDescriptor]): The list of descriptors for oneof fields
          in this message.
      oneofs_by_name (dict(str, OneofDescriptor)): Same objects as in
          :attr:`oneofs`, but indexed by "name" attribute.
      file (FileDescriptor): Reference to file descriptor.

  """

  if _USE_C_DESCRIPTORS:
    _C_DESCRIPTOR_CLASS = _message.Descriptor

    def __new__(
        cls,
        name=None,
        full_name=None,
        filename=None,
        containing_type=None,
        fields=None,
        nested_types=None,
        enum_types=None,
        extensions=None,
        options=None,
        serialized_options=None,
        is_extendable=True,
        extension_ranges=None,
        oneofs=None,
        file=None,  # pylint: disable=redefined-builtin
        serialized_start=None,
        serialized_end=None,
        syntax=None,
        create_key=None):
      _message.Message._CheckCalledFromGeneratedFile()
      return _message.default_pool.FindMessageTypeByName(full_name)

  # NOTE(tmarek): The file argument redefining a builtin is nothing we can
  # fix right now since we don't know how many clients already rely on the
  # name of the argument.
  def __init__(self, name, full_name, filename, containing_type, fields,
               nested_types, enum_types, extensions, options=None,
               serialized_options=None,
               is_extendable=True, extension_ranges=None, oneofs=None,
               file=None, serialized_start=None, serialized_end=None,  # pylint: disable=redefined-builtin
               syntax=None, create_key=None):
    """Arguments to __init__() are as described in the description
    of Descriptor fields above.

    Note that filename is an obsolete argument, that is not used anymore.
    Please use file.name to access this as an attribute.
    """
    if create_key is not _internal_create_key:
      _Deprecated('Descriptor')

    super(Descriptor, self).__init__(
        options, 'MessageOptions', name, full_name, file,
        containing_type, serialized_start=serialized_start,
        serialized_end=serialized_end, serialized_options=serialized_options)

    # We have fields in addition to fields_by_name and fields_by_number,
    # so that:
    #   1. Clients can index fields by "order in which they're listed."
    #   2. Clients can easily iterate over all fields with the terse
    #      syntax: for f in descriptor.fields: ...
    self.fields = fields
    for field in self.fields:
      field.containing_type = self
    self.fields_by_number = dict((f.number, f) for f in fields)
    self.fields_by_name = dict((f.name, f) for f in fields)
    self._fields_by_camelcase_name = None

    self.nested_types = nested_types
    for nested_type in nested_types:
      nested_type.containing_type = self
    self.nested_types_by_name = dict((t.name, t) for t in nested_types)

    self.enum_types = enum_types
    for enum_type in self.enum_types:
      enum_type.containing_type = self
    self.enum_types_by_name = dict((t.name, t) for t in enum_types)
    self.enum_values_by_name = dict(
        (v.name, v) for t in enum_types for v in t.values)

    self.extensions = extensions
    for extension in self.extensions:
      extension.extension_scope = self
    self.extensions_by_name = dict((f.name, f) for f in extensions)
    self.is_extendable = is_extendable
    self.extension_ranges = extension_ranges
    self.oneofs = oneofs if oneofs is not None else []
    self.oneofs_by_name = dict((o.name, o) for o in self.oneofs)
    for oneof in self.oneofs:
      oneof.containing_type = self
    self.syntax = syntax or "proto2"

  @property
  def fields_by_camelcase_name(self):
    """Same FieldDescriptor objects as in :attr:`fields`, but indexed by
    :attr:`FieldDescriptor.camelcase_name`.
    """
    if self._fields_by_camelcase_name is None:
      self._fields_by_camelcase_name = dict(
          (f.camelcase_name, f) for f in self.fields)
    return self._fields_by_camelcase_name

  def EnumValueName(self, enum, value):
    """Returns the string name of an enum value.

    This is just a small helper method to simplify a common operation.

    Args:
      enum: string name of the Enum.
      value: int, value of the enum.

    Returns:
      string name of the enum value.

    Raises:
      KeyError if either the Enum doesn't exist or the value is not a valid
        value for the enum.
    """
    return self.enum_types_by_name[enum].values_by_number[value].name

  def CopyToProto(self, proto):
    """Copies this to a descriptor_pb2.DescriptorProto.

    Args:
      proto: An empty descriptor_pb2.DescriptorProto.
    """
    # This function is overridden to give a better doc comment.
    super(Descriptor, self).CopyToProto(proto)

fields_by_camelcase_name property

Same FieldDescriptor objects as in :attr:fields, but indexed by :attr:FieldDescriptor.camelcase_name.

CopyToProto(proto)

Copies this to a descriptor_pb2.DescriptorProto.

Parameters:

Name Type Description Default
proto

An empty descriptor_pb2.DescriptorProto.

required
Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
399
400
401
402
403
404
405
406
def CopyToProto(self, proto):
  """Copies this to a descriptor_pb2.DescriptorProto.

  Args:
    proto: An empty descriptor_pb2.DescriptorProto.
  """
  # This function is overridden to give a better doc comment.
  super(Descriptor, self).CopyToProto(proto)

EnumValueName(enum, value)

Returns the string name of an enum value.

This is just a small helper method to simplify a common operation.

Parameters:

Name Type Description Default
enum

string name of the Enum.

required
value

int, value of the enum.

required

Returns:

Type Description

string name of the enum value.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
def EnumValueName(self, enum, value):
  """Returns the string name of an enum value.

  This is just a small helper method to simplify a common operation.

  Args:
    enum: string name of the Enum.
    value: int, value of the enum.

  Returns:
    string name of the enum value.

  Raises:
    KeyError if either the Enum doesn't exist or the value is not a valid
      value for the enum.
  """
  return self.enum_types_by_name[enum].values_by_number[value].name

__init__(name, full_name, filename, containing_type, fields, nested_types, enum_types, extensions, options=None, serialized_options=None, is_extendable=True, extension_ranges=None, oneofs=None, file=None, serialized_start=None, serialized_end=None, syntax=None, create_key=None)

Arguments to init() are as described in the description of Descriptor fields above.

Note that filename is an obsolete argument, that is not used anymore. Please use file.name to access this as an attribute.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
def __init__(self, name, full_name, filename, containing_type, fields,
             nested_types, enum_types, extensions, options=None,
             serialized_options=None,
             is_extendable=True, extension_ranges=None, oneofs=None,
             file=None, serialized_start=None, serialized_end=None,  # pylint: disable=redefined-builtin
             syntax=None, create_key=None):
  """Arguments to __init__() are as described in the description
  of Descriptor fields above.

  Note that filename is an obsolete argument, that is not used anymore.
  Please use file.name to access this as an attribute.
  """
  if create_key is not _internal_create_key:
    _Deprecated('Descriptor')

  super(Descriptor, self).__init__(
      options, 'MessageOptions', name, full_name, file,
      containing_type, serialized_start=serialized_start,
      serialized_end=serialized_end, serialized_options=serialized_options)

  # We have fields in addition to fields_by_name and fields_by_number,
  # so that:
  #   1. Clients can index fields by "order in which they're listed."
  #   2. Clients can easily iterate over all fields with the terse
  #      syntax: for f in descriptor.fields: ...
  self.fields = fields
  for field in self.fields:
    field.containing_type = self
  self.fields_by_number = dict((f.number, f) for f in fields)
  self.fields_by_name = dict((f.name, f) for f in fields)
  self._fields_by_camelcase_name = None

  self.nested_types = nested_types
  for nested_type in nested_types:
    nested_type.containing_type = self
  self.nested_types_by_name = dict((t.name, t) for t in nested_types)

  self.enum_types = enum_types
  for enum_type in self.enum_types:
    enum_type.containing_type = self
  self.enum_types_by_name = dict((t.name, t) for t in enum_types)
  self.enum_values_by_name = dict(
      (v.name, v) for t in enum_types for v in t.values)

  self.extensions = extensions
  for extension in self.extensions:
    extension.extension_scope = self
  self.extensions_by_name = dict((f.name, f) for f in extensions)
  self.is_extendable = is_extendable
  self.extension_ranges = extension_ranges
  self.oneofs = oneofs if oneofs is not None else []
  self.oneofs_by_name = dict((o.name, o) for o in self.oneofs)
  for oneof in self.oneofs:
    oneof.containing_type = self
  self.syntax = syntax or "proto2"

DescriptorBase

Descriptors base class.

This class is the base of all descriptor classes. It provides common options related functionality.

Attributes:

Name Type Description
has_options

True if the descriptor has non-default options. Usually it is not necessary to read this -- just call GetOptions() which will happily return the default instance. However, it's sometimes useful for efficiency, and also useful inside the protobuf implementation to avoid some bootstrapping issues.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
class DescriptorBase(metaclass=DescriptorMetaclass):

  """Descriptors base class.

  This class is the base of all descriptor classes. It provides common options
  related functionality.

  Attributes:
    has_options:  True if the descriptor has non-default options.  Usually it
        is not necessary to read this -- just call GetOptions() which will
        happily return the default instance.  However, it's sometimes useful
        for efficiency, and also useful inside the protobuf implementation to
        avoid some bootstrapping issues.
  """

  if _USE_C_DESCRIPTORS:
    # The class, or tuple of classes, that are considered as "virtual
    # subclasses" of this descriptor class.
    _C_DESCRIPTOR_CLASS = ()

  def __init__(self, options, serialized_options, options_class_name):
    """Initialize the descriptor given its options message and the name of the
    class of the options message. The name of the class is required in case
    the options message is None and has to be created.
    """
    self._options = options
    self._options_class_name = options_class_name
    self._serialized_options = serialized_options

    # Does this descriptor have non-default options?
    self.has_options = (options is not None) or (serialized_options is not None)

  def _SetOptions(self, options, options_class_name):
    """Sets the descriptor's options

    This function is used in generated proto2 files to update descriptor
    options. It must not be used outside proto2.
    """
    self._options = options
    self._options_class_name = options_class_name

    # Does this descriptor have non-default options?
    self.has_options = options is not None

  def GetOptions(self):
    """Retrieves descriptor options.

    This method returns the options set or creates the default options for the
    descriptor.
    """
    if self._options:
      return self._options

    from google.protobuf import descriptor_pb2
    try:
      options_class = getattr(descriptor_pb2,
                              self._options_class_name)
    except AttributeError:
      raise RuntimeError('Unknown options class name %s!' %
                         (self._options_class_name))

    with _lock:
      if self._serialized_options is None:
        self._options = options_class()
      else:
        self._options = _ParseOptions(options_class(),
                                      self._serialized_options)

      return self._options

GetOptions()

Retrieves descriptor options.

This method returns the options set or creates the default options for the descriptor.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
def GetOptions(self):
  """Retrieves descriptor options.

  This method returns the options set or creates the default options for the
  descriptor.
  """
  if self._options:
    return self._options

  from google.protobuf import descriptor_pb2
  try:
    options_class = getattr(descriptor_pb2,
                            self._options_class_name)
  except AttributeError:
    raise RuntimeError('Unknown options class name %s!' %
                       (self._options_class_name))

  with _lock:
    if self._serialized_options is None:
      self._options = options_class()
    else:
      self._options = _ParseOptions(options_class(),
                                    self._serialized_options)

    return self._options

__init__(options, serialized_options, options_class_name)

Initialize the descriptor given its options message and the name of the class of the options message. The name of the class is required in case the options message is None and has to be created.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
133
134
135
136
137
138
139
140
141
142
143
def __init__(self, options, serialized_options, options_class_name):
  """Initialize the descriptor given its options message and the name of the
  class of the options message. The name of the class is required in case
  the options message is None and has to be created.
  """
  self._options = options
  self._options_class_name = options_class_name
  self._serialized_options = serialized_options

  # Does this descriptor have non-default options?
  self.has_options = (options is not None) or (serialized_options is not None)

EnumDescriptor

Bases: _NestedDescriptorBase

Descriptor for an enum defined in a .proto file.

Attributes:

Name Type Description
name str

Name of the enum type.

full_name str

Full name of the type, including package name and any enclosing type(s).

values list[EnumValueDescriptor]

List of the values in this enum.

values_by_name dict(str, EnumValueDescriptor

Same as :attr:values, but indexed by the "name" field of each EnumValueDescriptor.

values_by_number dict(int, EnumValueDescriptor

Same as :attr:values, but indexed by the "number" field of each EnumValueDescriptor.

containing_type Descriptor

Descriptor of the immediate containing type of this enum, or None if this is an enum defined at the top level in a .proto file. Set by Descriptor's constructor if we're passed into one.

file FileDescriptor

Reference to file descriptor.

options EnumOptions

Enum options message or None to use default enum options.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
class EnumDescriptor(_NestedDescriptorBase):

  """Descriptor for an enum defined in a .proto file.

  Attributes:
    name (str): Name of the enum type.
    full_name (str): Full name of the type, including package name
      and any enclosing type(s).

    values (list[EnumValueDescriptor]): List of the values
      in this enum.
    values_by_name (dict(str, EnumValueDescriptor)): Same as :attr:`values`,
      but indexed by the "name" field of each EnumValueDescriptor.
    values_by_number (dict(int, EnumValueDescriptor)): Same as :attr:`values`,
      but indexed by the "number" field of each EnumValueDescriptor.
    containing_type (Descriptor): Descriptor of the immediate containing
      type of this enum, or None if this is an enum defined at the
      top level in a .proto file.  Set by Descriptor's constructor
      if we're passed into one.
    file (FileDescriptor): Reference to file descriptor.
    options (descriptor_pb2.EnumOptions): Enum options message or
      None to use default enum options.
  """

  if _USE_C_DESCRIPTORS:
    _C_DESCRIPTOR_CLASS = _message.EnumDescriptor

    def __new__(cls, name, full_name, filename, values,
                containing_type=None, options=None,
                serialized_options=None, file=None,  # pylint: disable=redefined-builtin
                serialized_start=None, serialized_end=None, create_key=None):
      _message.Message._CheckCalledFromGeneratedFile()
      return _message.default_pool.FindEnumTypeByName(full_name)

  def __init__(self, name, full_name, filename, values,
               containing_type=None, options=None,
               serialized_options=None, file=None,  # pylint: disable=redefined-builtin
               serialized_start=None, serialized_end=None, create_key=None):
    """Arguments are as described in the attribute description above.

    Note that filename is an obsolete argument, that is not used anymore.
    Please use file.name to access this as an attribute.
    """
    if create_key is not _internal_create_key:
      _Deprecated('EnumDescriptor')

    super(EnumDescriptor, self).__init__(
        options, 'EnumOptions', name, full_name, file,
        containing_type, serialized_start=serialized_start,
        serialized_end=serialized_end, serialized_options=serialized_options)

    self.values = values
    for value in self.values:
      value.type = self
    self.values_by_name = dict((v.name, v) for v in values)
    # Values are reversed to ensure that the first alias is retained.
    self.values_by_number = dict((v.number, v) for v in reversed(values))

  def CopyToProto(self, proto):
    """Copies this to a descriptor_pb2.EnumDescriptorProto.

    Args:
      proto (descriptor_pb2.EnumDescriptorProto): An empty descriptor proto.
    """
    # This function is overridden to give a better doc comment.
    super(EnumDescriptor, self).CopyToProto(proto)

CopyToProto(proto)

Copies this to a descriptor_pb2.EnumDescriptorProto.

Parameters:

Name Type Description Default
proto EnumDescriptorProto

An empty descriptor proto.

required
Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
719
720
721
722
723
724
725
726
def CopyToProto(self, proto):
  """Copies this to a descriptor_pb2.EnumDescriptorProto.

  Args:
    proto (descriptor_pb2.EnumDescriptorProto): An empty descriptor proto.
  """
  # This function is overridden to give a better doc comment.
  super(EnumDescriptor, self).CopyToProto(proto)

__init__(name, full_name, filename, values, containing_type=None, options=None, serialized_options=None, file=None, serialized_start=None, serialized_end=None, create_key=None)

Arguments are as described in the attribute description above.

Note that filename is an obsolete argument, that is not used anymore. Please use file.name to access this as an attribute.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
def __init__(self, name, full_name, filename, values,
             containing_type=None, options=None,
             serialized_options=None, file=None,  # pylint: disable=redefined-builtin
             serialized_start=None, serialized_end=None, create_key=None):
  """Arguments are as described in the attribute description above.

  Note that filename is an obsolete argument, that is not used anymore.
  Please use file.name to access this as an attribute.
  """
  if create_key is not _internal_create_key:
    _Deprecated('EnumDescriptor')

  super(EnumDescriptor, self).__init__(
      options, 'EnumOptions', name, full_name, file,
      containing_type, serialized_start=serialized_start,
      serialized_end=serialized_end, serialized_options=serialized_options)

  self.values = values
  for value in self.values:
    value.type = self
  self.values_by_name = dict((v.name, v) for v in values)
  # Values are reversed to ensure that the first alias is retained.
  self.values_by_number = dict((v.number, v) for v in reversed(values))

EnumValueDescriptor

Bases: DescriptorBase

Descriptor for a single value within an enum.

Attributes:

Name Type Description
name str

Name of this value.

index int

Dense, 0-indexed index giving the order that this value appears textually within its enum in the .proto file.

number int

Actual number assigned to this enum value.

type EnumDescriptor

:class:EnumDescriptor to which this value belongs. Set by :class:EnumDescriptor's constructor if we're passed into one.

options EnumValueOptions

Enum value options message or None to use default enum value options options.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
class EnumValueDescriptor(DescriptorBase):

  """Descriptor for a single value within an enum.

  Attributes:
    name (str): Name of this value.
    index (int): Dense, 0-indexed index giving the order that this
      value appears textually within its enum in the .proto file.
    number (int): Actual number assigned to this enum value.
    type (EnumDescriptor): :class:`EnumDescriptor` to which this value
      belongs.  Set by :class:`EnumDescriptor`'s constructor if we're
      passed into one.
    options (descriptor_pb2.EnumValueOptions): Enum value options message or
      None to use default enum value options options.
  """

  if _USE_C_DESCRIPTORS:
    _C_DESCRIPTOR_CLASS = _message.EnumValueDescriptor

    def __new__(cls, name, index, number,
                type=None,  # pylint: disable=redefined-builtin
                options=None, serialized_options=None, create_key=None):
      _message.Message._CheckCalledFromGeneratedFile()
      # There is no way we can build a complete EnumValueDescriptor with the
      # given parameters (the name of the Enum is not known, for example).
      # Fortunately generated files just pass it to the EnumDescriptor()
      # constructor, which will ignore it, so returning None is good enough.
      return None

  def __init__(self, name, index, number,
               type=None,  # pylint: disable=redefined-builtin
               options=None, serialized_options=None, create_key=None):
    """Arguments are as described in the attribute description above."""
    if create_key is not _internal_create_key:
      _Deprecated('EnumValueDescriptor')

    super(EnumValueDescriptor, self).__init__(
        options, serialized_options, 'EnumValueOptions')
    self.name = name
    self.index = index
    self.number = number
    self.type = type

__init__(name, index, number, type=None, options=None, serialized_options=None, create_key=None)

Arguments are as described in the attribute description above.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
758
759
760
761
762
763
764
765
766
767
768
769
770
def __init__(self, name, index, number,
             type=None,  # pylint: disable=redefined-builtin
             options=None, serialized_options=None, create_key=None):
  """Arguments are as described in the attribute description above."""
  if create_key is not _internal_create_key:
    _Deprecated('EnumValueDescriptor')

  super(EnumValueDescriptor, self).__init__(
      options, serialized_options, 'EnumValueOptions')
  self.name = name
  self.index = index
  self.number = number
  self.type = type

Error

Bases: Exception

Base error for this module.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
51
52
class Error(Exception):
  """Base error for this module."""

FieldDescriptor

Bases: DescriptorBase

Descriptor for a single field in a .proto file.

Attributes:

Name Type Description
name str

Name of this field, exactly as it appears in .proto.

full_name str

Name of this field, including containing scope. This is particularly relevant for extensions.

index int

Dense, 0-indexed index giving the order that this field textually appears within its message in the .proto file.

number int

Tag number declared for this field in the .proto file.

type int

(One of the TYPE_* constants below) Declared type.

cpp_type int

(One of the CPPTYPE_* constants below) C++ type used to represent this field.

label int

(One of the LABEL_* constants below) Tells whether this field is optional, required, or repeated.

has_default_value bool

True if this field has a default value defined, otherwise false.

default_value Varies

Default value of this field. Only meaningful for non-repeated scalar fields. Repeated fields should always set this to [], and non-repeated composite fields should always set this to None.

containing_type Descriptor

Descriptor of the protocol message type that contains this field. Set by the Descriptor constructor if we're passed into one. Somewhat confusingly, for extension fields, this is the descriptor of the EXTENDED message, not the descriptor of the message containing this field. (See is_extension and extension_scope below).

message_type Descriptor

If a composite field, a descriptor of the message type contained in this field. Otherwise, this is None.

enum_type EnumDescriptor

If this field contains an enum, a descriptor of that enum. Otherwise, this is None.

is_extension

True iff this describes an extension field.

extension_scope Descriptor

Only meaningful if is_extension is True. Gives the message that immediately contains this extension field. Will be None iff we're a top-level (file-level) extension field.

options FieldOptions

Protocol message field options or None to use default field options.

containing_oneof OneofDescriptor

If the field is a member of a oneof union, contains its descriptor. Otherwise, None.

file FileDescriptor

Reference to file descriptor.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
class FieldDescriptor(DescriptorBase):

  """Descriptor for a single field in a .proto file.

  Attributes:
    name (str): Name of this field, exactly as it appears in .proto.
    full_name (str): Name of this field, including containing scope.  This is
      particularly relevant for extensions.
    index (int): Dense, 0-indexed index giving the order that this
      field textually appears within its message in the .proto file.
    number (int): Tag number declared for this field in the .proto file.

    type (int): (One of the TYPE_* constants below) Declared type.
    cpp_type (int): (One of the CPPTYPE_* constants below) C++ type used to
      represent this field.

    label (int): (One of the LABEL_* constants below) Tells whether this
      field is optional, required, or repeated.
    has_default_value (bool): True if this field has a default value defined,
      otherwise false.
    default_value (Varies): Default value of this field.  Only
      meaningful for non-repeated scalar fields.  Repeated fields
      should always set this to [], and non-repeated composite
      fields should always set this to None.

    containing_type (Descriptor): Descriptor of the protocol message
      type that contains this field.  Set by the Descriptor constructor
      if we're passed into one.
      Somewhat confusingly, for extension fields, this is the
      descriptor of the EXTENDED message, not the descriptor
      of the message containing this field.  (See is_extension and
      extension_scope below).
    message_type (Descriptor): If a composite field, a descriptor
      of the message type contained in this field.  Otherwise, this is None.
    enum_type (EnumDescriptor): If this field contains an enum, a
      descriptor of that enum.  Otherwise, this is None.

    is_extension: True iff this describes an extension field.
    extension_scope (Descriptor): Only meaningful if is_extension is True.
      Gives the message that immediately contains this extension field.
      Will be None iff we're a top-level (file-level) extension field.

    options (descriptor_pb2.FieldOptions): Protocol message field options or
      None to use default field options.

    containing_oneof (OneofDescriptor): If the field is a member of a oneof
      union, contains its descriptor. Otherwise, None.

    file (FileDescriptor): Reference to file descriptor.
  """

  # Must be consistent with C++ FieldDescriptor::Type enum in
  # descriptor.h.
  #
  # TODO(robinson): Find a way to eliminate this repetition.
  TYPE_DOUBLE         = 1
  TYPE_FLOAT          = 2
  TYPE_INT64          = 3
  TYPE_UINT64         = 4
  TYPE_INT32          = 5
  TYPE_FIXED64        = 6
  TYPE_FIXED32        = 7
  TYPE_BOOL           = 8
  TYPE_STRING         = 9
  TYPE_GROUP          = 10
  TYPE_MESSAGE        = 11
  TYPE_BYTES          = 12
  TYPE_UINT32         = 13
  TYPE_ENUM           = 14
  TYPE_SFIXED32       = 15
  TYPE_SFIXED64       = 16
  TYPE_SINT32         = 17
  TYPE_SINT64         = 18
  MAX_TYPE            = 18

  # Must be consistent with C++ FieldDescriptor::CppType enum in
  # descriptor.h.
  #
  # TODO(robinson): Find a way to eliminate this repetition.
  CPPTYPE_INT32       = 1
  CPPTYPE_INT64       = 2
  CPPTYPE_UINT32      = 3
  CPPTYPE_UINT64      = 4
  CPPTYPE_DOUBLE      = 5
  CPPTYPE_FLOAT       = 6
  CPPTYPE_BOOL        = 7
  CPPTYPE_ENUM        = 8
  CPPTYPE_STRING      = 9
  CPPTYPE_MESSAGE     = 10
  MAX_CPPTYPE         = 10

  _PYTHON_TO_CPP_PROTO_TYPE_MAP = {
      TYPE_DOUBLE: CPPTYPE_DOUBLE,
      TYPE_FLOAT: CPPTYPE_FLOAT,
      TYPE_ENUM: CPPTYPE_ENUM,
      TYPE_INT64: CPPTYPE_INT64,
      TYPE_SINT64: CPPTYPE_INT64,
      TYPE_SFIXED64: CPPTYPE_INT64,
      TYPE_UINT64: CPPTYPE_UINT64,
      TYPE_FIXED64: CPPTYPE_UINT64,
      TYPE_INT32: CPPTYPE_INT32,
      TYPE_SFIXED32: CPPTYPE_INT32,
      TYPE_SINT32: CPPTYPE_INT32,
      TYPE_UINT32: CPPTYPE_UINT32,
      TYPE_FIXED32: CPPTYPE_UINT32,
      TYPE_BYTES: CPPTYPE_STRING,
      TYPE_STRING: CPPTYPE_STRING,
      TYPE_BOOL: CPPTYPE_BOOL,
      TYPE_MESSAGE: CPPTYPE_MESSAGE,
      TYPE_GROUP: CPPTYPE_MESSAGE
      }

  # Must be consistent with C++ FieldDescriptor::Label enum in
  # descriptor.h.
  #
  # TODO(robinson): Find a way to eliminate this repetition.
  LABEL_OPTIONAL      = 1
  LABEL_REQUIRED      = 2
  LABEL_REPEATED      = 3
  MAX_LABEL           = 3

  # Must be consistent with C++ constants kMaxNumber, kFirstReservedNumber,
  # and kLastReservedNumber in descriptor.h
  MAX_FIELD_NUMBER = (1 << 29) - 1
  FIRST_RESERVED_FIELD_NUMBER = 19000
  LAST_RESERVED_FIELD_NUMBER = 19999

  if _USE_C_DESCRIPTORS:
    _C_DESCRIPTOR_CLASS = _message.FieldDescriptor

    def __new__(cls, name, full_name, index, number, type, cpp_type, label,
                default_value, message_type, enum_type, containing_type,
                is_extension, extension_scope, options=None,
                serialized_options=None,
                has_default_value=True, containing_oneof=None, json_name=None,
                file=None, create_key=None):  # pylint: disable=redefined-builtin
      _message.Message._CheckCalledFromGeneratedFile()
      if is_extension:
        return _message.default_pool.FindExtensionByName(full_name)
      else:
        return _message.default_pool.FindFieldByName(full_name)

  def __init__(self, name, full_name, index, number, type, cpp_type, label,
               default_value, message_type, enum_type, containing_type,
               is_extension, extension_scope, options=None,
               serialized_options=None,
               has_default_value=True, containing_oneof=None, json_name=None,
               file=None, create_key=None):  # pylint: disable=redefined-builtin
    """The arguments are as described in the description of FieldDescriptor
    attributes above.

    Note that containing_type may be None, and may be set later if necessary
    (to deal with circular references between message types, for example).
    Likewise for extension_scope.
    """
    if create_key is not _internal_create_key:
      _Deprecated('FieldDescriptor')

    super(FieldDescriptor, self).__init__(
        options, serialized_options, 'FieldOptions')
    self.name = name
    self.full_name = full_name
    self.file = file
    self._camelcase_name = None
    if json_name is None:
      self.json_name = _ToJsonName(name)
    else:
      self.json_name = json_name
    self.index = index
    self.number = number
    self.type = type
    self.cpp_type = cpp_type
    self.label = label
    self.has_default_value = has_default_value
    self.default_value = default_value
    self.containing_type = containing_type
    self.message_type = message_type
    self.enum_type = enum_type
    self.is_extension = is_extension
    self.extension_scope = extension_scope
    self.containing_oneof = containing_oneof
    if api_implementation.Type() == 'cpp':
      if is_extension:
        self._cdescriptor = _message.default_pool.FindExtensionByName(full_name)
      else:
        self._cdescriptor = _message.default_pool.FindFieldByName(full_name)
    else:
      self._cdescriptor = None

  @property
  def camelcase_name(self):
    """Camelcase name of this field.

    Returns:
      str: the name in CamelCase.
    """
    if self._camelcase_name is None:
      self._camelcase_name = _ToCamelCase(self.name)
    return self._camelcase_name

  @property
  def has_presence(self):
    """Whether the field distinguishes between unpopulated and default values.

    Raises:
      RuntimeError: singular field that is not linked with message nor file.
    """
    if self.label == FieldDescriptor.LABEL_REPEATED:
      return False
    if (self.cpp_type == FieldDescriptor.CPPTYPE_MESSAGE or
        self.containing_oneof):
      return True
    if hasattr(self.file, 'syntax'):
      return self.file.syntax == 'proto2'
    if hasattr(self.message_type, 'syntax'):
      return self.message_type.syntax == 'proto2'
    raise RuntimeError(
        'has_presence is not ready to use because field %s is not'
        ' linked with message type nor file' % self.full_name)

  @staticmethod
  def ProtoTypeToCppProtoType(proto_type):
    """Converts from a Python proto type to a C++ Proto Type.

    The Python ProtocolBuffer classes specify both the 'Python' datatype and the
    'C++' datatype - and they're not the same. This helper method should
    translate from one to another.

    Args:
      proto_type: the Python proto type (descriptor.FieldDescriptor.TYPE_*)
    Returns:
      int: descriptor.FieldDescriptor.CPPTYPE_*, the C++ type.
    Raises:
      TypeTransformationError: when the Python proto type isn't known.
    """
    try:
      return FieldDescriptor._PYTHON_TO_CPP_PROTO_TYPE_MAP[proto_type]
    except KeyError:
      raise TypeTransformationError('Unknown proto_type: %s' % proto_type)

camelcase_name property

Camelcase name of this field.

Returns:

Name Type Description
str

the name in CamelCase.

has_presence property

Whether the field distinguishes between unpopulated and default values.

Raises:

Type Description
RuntimeError

singular field that is not linked with message nor file.

ProtoTypeToCppProtoType(proto_type) staticmethod

Converts from a Python proto type to a C++ Proto Type.

The Python ProtocolBuffer classes specify both the 'Python' datatype and the 'C++' datatype - and they're not the same. This helper method should translate from one to another.

Parameters:

Name Type Description Default
proto_type

the Python proto type (descriptor.FieldDescriptor.TYPE_*)

required

Returns: int: descriptor.FieldDescriptor.CPPTYPE_*, the C++ type. Raises: TypeTransformationError: when the Python proto type isn't known.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
@staticmethod
def ProtoTypeToCppProtoType(proto_type):
  """Converts from a Python proto type to a C++ Proto Type.

  The Python ProtocolBuffer classes specify both the 'Python' datatype and the
  'C++' datatype - and they're not the same. This helper method should
  translate from one to another.

  Args:
    proto_type: the Python proto type (descriptor.FieldDescriptor.TYPE_*)
  Returns:
    int: descriptor.FieldDescriptor.CPPTYPE_*, the C++ type.
  Raises:
    TypeTransformationError: when the Python proto type isn't known.
  """
  try:
    return FieldDescriptor._PYTHON_TO_CPP_PROTO_TYPE_MAP[proto_type]
  except KeyError:
    raise TypeTransformationError('Unknown proto_type: %s' % proto_type)

__init__(name, full_name, index, number, type, cpp_type, label, default_value, message_type, enum_type, containing_type, is_extension, extension_scope, options=None, serialized_options=None, has_default_value=True, containing_oneof=None, json_name=None, file=None, create_key=None)

The arguments are as described in the description of FieldDescriptor attributes above.

Note that containing_type may be None, and may be set later if necessary (to deal with circular references between message types, for example). Likewise for extension_scope.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
def __init__(self, name, full_name, index, number, type, cpp_type, label,
             default_value, message_type, enum_type, containing_type,
             is_extension, extension_scope, options=None,
             serialized_options=None,
             has_default_value=True, containing_oneof=None, json_name=None,
             file=None, create_key=None):  # pylint: disable=redefined-builtin
  """The arguments are as described in the description of FieldDescriptor
  attributes above.

  Note that containing_type may be None, and may be set later if necessary
  (to deal with circular references between message types, for example).
  Likewise for extension_scope.
  """
  if create_key is not _internal_create_key:
    _Deprecated('FieldDescriptor')

  super(FieldDescriptor, self).__init__(
      options, serialized_options, 'FieldOptions')
  self.name = name
  self.full_name = full_name
  self.file = file
  self._camelcase_name = None
  if json_name is None:
    self.json_name = _ToJsonName(name)
  else:
    self.json_name = json_name
  self.index = index
  self.number = number
  self.type = type
  self.cpp_type = cpp_type
  self.label = label
  self.has_default_value = has_default_value
  self.default_value = default_value
  self.containing_type = containing_type
  self.message_type = message_type
  self.enum_type = enum_type
  self.is_extension = is_extension
  self.extension_scope = extension_scope
  self.containing_oneof = containing_oneof
  if api_implementation.Type() == 'cpp':
    if is_extension:
      self._cdescriptor = _message.default_pool.FindExtensionByName(full_name)
    else:
      self._cdescriptor = _message.default_pool.FindFieldByName(full_name)
  else:
    self._cdescriptor = None

FileDescriptor

Bases: DescriptorBase

Descriptor for a file. Mimics the descriptor_pb2.FileDescriptorProto.

Note that :attr:enum_types_by_name, :attr:extensions_by_name, and :attr:dependencies fields are only set by the :py:mod:google.protobuf.message_factory module, and not by the generated proto code.

Attributes:

Name Type Description
name str

Name of file, relative to root of source tree.

package str

Name of the package

syntax str

string indicating syntax of the file (can be "proto2" or "proto3")

serialized_pb bytes

Byte string of serialized :class:descriptor_pb2.FileDescriptorProto.

dependencies list[FileDescriptor]

List of other :class:FileDescriptor objects this :class:FileDescriptor depends on.

public_dependencies list[FileDescriptor]

A product of :attr:dependencies, which were declared as "public".

message_types_by_name dict(str, Descriptor

Mapping from message names to their :class:Descriptor.

enum_types_by_name dict(str, EnumDescriptor

Mapping from enum names to their :class:EnumDescriptor.

extensions_by_name dict(str, FieldDescriptor

Mapping from extension names declared at file scope to their :class:FieldDescriptor.

services_by_name dict(str, ServiceDescriptor

Mapping from services' names to their :class:ServiceDescriptor.

pool DescriptorPool

The pool this descriptor belongs to. When not passed to the constructor, the global default pool is used.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
class FileDescriptor(DescriptorBase):
  """Descriptor for a file. Mimics the descriptor_pb2.FileDescriptorProto.

  Note that :attr:`enum_types_by_name`, :attr:`extensions_by_name`, and
  :attr:`dependencies` fields are only set by the
  :py:mod:`google.protobuf.message_factory` module, and not by the generated
  proto code.

  Attributes:
    name (str): Name of file, relative to root of source tree.
    package (str): Name of the package
    syntax (str): string indicating syntax of the file (can be "proto2" or
      "proto3")
    serialized_pb (bytes): Byte string of serialized
      :class:`descriptor_pb2.FileDescriptorProto`.
    dependencies (list[FileDescriptor]): List of other :class:`FileDescriptor`
      objects this :class:`FileDescriptor` depends on.
    public_dependencies (list[FileDescriptor]): A product of
      :attr:`dependencies`, which were declared as "public".
    message_types_by_name (dict(str, Descriptor)): Mapping from message names
      to their :class:`Descriptor`.
    enum_types_by_name (dict(str, EnumDescriptor)): Mapping from enum names to
      their :class:`EnumDescriptor`.
    extensions_by_name (dict(str, FieldDescriptor)): Mapping from extension
      names declared at file scope to their :class:`FieldDescriptor`.
    services_by_name (dict(str, ServiceDescriptor)): Mapping from services'
      names to their :class:`ServiceDescriptor`.
    pool (DescriptorPool): The pool this descriptor belongs to.  When not
      passed to the constructor, the global default pool is used.
  """

  if _USE_C_DESCRIPTORS:
    _C_DESCRIPTOR_CLASS = _message.FileDescriptor

    def __new__(cls, name, package, options=None,
                serialized_options=None, serialized_pb=None,
                dependencies=None, public_dependencies=None,
                syntax=None, pool=None, create_key=None):
      # FileDescriptor() is called from various places, not only from generated
      # files, to register dynamic proto files and messages.
      # pylint: disable=g-explicit-bool-comparison
      if serialized_pb == b'':
        # Cpp generated code must be linked in if serialized_pb is ''
        try:
          return _message.default_pool.FindFileByName(name)
        except KeyError:
          raise RuntimeError('Please link in cpp generated lib for %s' % (name))
      elif serialized_pb:
        return _message.default_pool.AddSerializedFile(serialized_pb)
      else:
        return super(FileDescriptor, cls).__new__(cls)

  def __init__(self, name, package, options=None,
               serialized_options=None, serialized_pb=None,
               dependencies=None, public_dependencies=None,
               syntax=None, pool=None, create_key=None):
    """Constructor."""
    if create_key is not _internal_create_key:
      _Deprecated('FileDescriptor')

    super(FileDescriptor, self).__init__(
        options, serialized_options, 'FileOptions')

    if pool is None:
      from google.protobuf import descriptor_pool
      pool = descriptor_pool.Default()
    self.pool = pool
    self.message_types_by_name = {}
    self.name = name
    self.package = package
    self.syntax = syntax or "proto2"
    self.serialized_pb = serialized_pb

    self.enum_types_by_name = {}
    self.extensions_by_name = {}
    self.services_by_name = {}
    self.dependencies = (dependencies or [])
    self.public_dependencies = (public_dependencies or [])

  def CopyToProto(self, proto):
    """Copies this to a descriptor_pb2.FileDescriptorProto.

    Args:
      proto: An empty descriptor_pb2.FileDescriptorProto.
    """
    proto.ParseFromString(self.serialized_pb)

CopyToProto(proto)

Copies this to a descriptor_pb2.FileDescriptorProto.

Parameters:

Name Type Description Default
proto

An empty descriptor_pb2.FileDescriptorProto.

required
Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
1055
1056
1057
1058
1059
1060
1061
def CopyToProto(self, proto):
  """Copies this to a descriptor_pb2.FileDescriptorProto.

  Args:
    proto: An empty descriptor_pb2.FileDescriptorProto.
  """
  proto.ParseFromString(self.serialized_pb)

__init__(name, package, options=None, serialized_options=None, serialized_pb=None, dependencies=None, public_dependencies=None, syntax=None, pool=None, create_key=None)

Constructor.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
def __init__(self, name, package, options=None,
             serialized_options=None, serialized_pb=None,
             dependencies=None, public_dependencies=None,
             syntax=None, pool=None, create_key=None):
  """Constructor."""
  if create_key is not _internal_create_key:
    _Deprecated('FileDescriptor')

  super(FileDescriptor, self).__init__(
      options, serialized_options, 'FileOptions')

  if pool is None:
    from google.protobuf import descriptor_pool
    pool = descriptor_pool.Default()
  self.pool = pool
  self.message_types_by_name = {}
  self.name = name
  self.package = package
  self.syntax = syntax or "proto2"
  self.serialized_pb = serialized_pb

  self.enum_types_by_name = {}
  self.extensions_by_name = {}
  self.services_by_name = {}
  self.dependencies = (dependencies or [])
  self.public_dependencies = (public_dependencies or [])

MethodDescriptor

Bases: DescriptorBase

Descriptor for a method in a service.

Attributes:

Name Type Description
name str

Name of the method within the service.

full_name str

Full name of method.

index int

0-indexed index of the method inside the service.

containing_service ServiceDescriptor

The service that contains this method.

input_type Descriptor

The descriptor of the message that this method accepts.

output_type Descriptor

The descriptor of the message that this method returns.

client_streaming bool

Whether this method uses client streaming.

server_streaming bool

Whether this method uses server streaming.

options MethodOptions or None

Method options message, or None to use default method options.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
class MethodDescriptor(DescriptorBase):

  """Descriptor for a method in a service.

  Attributes:
    name (str): Name of the method within the service.
    full_name (str): Full name of method.
    index (int): 0-indexed index of the method inside the service.
    containing_service (ServiceDescriptor): The service that contains this
      method.
    input_type (Descriptor): The descriptor of the message that this method
      accepts.
    output_type (Descriptor): The descriptor of the message that this method
      returns.
    client_streaming (bool): Whether this method uses client streaming.
    server_streaming (bool): Whether this method uses server streaming.
    options (descriptor_pb2.MethodOptions or None): Method options message, or
      None to use default method options.
  """

  if _USE_C_DESCRIPTORS:
    _C_DESCRIPTOR_CLASS = _message.MethodDescriptor

    def __new__(cls,
                name,
                full_name,
                index,
                containing_service,
                input_type,
                output_type,
                client_streaming=False,
                server_streaming=False,
                options=None,
                serialized_options=None,
                create_key=None):
      _message.Message._CheckCalledFromGeneratedFile()  # pylint: disable=protected-access
      return _message.default_pool.FindMethodByName(full_name)

  def __init__(self,
               name,
               full_name,
               index,
               containing_service,
               input_type,
               output_type,
               client_streaming=False,
               server_streaming=False,
               options=None,
               serialized_options=None,
               create_key=None):
    """The arguments are as described in the description of MethodDescriptor
    attributes above.

    Note that containing_service may be None, and may be set later if necessary.
    """
    if create_key is not _internal_create_key:
      _Deprecated('MethodDescriptor')

    super(MethodDescriptor, self).__init__(
        options, serialized_options, 'MethodOptions')
    self.name = name
    self.full_name = full_name
    self.index = index
    self.containing_service = containing_service
    self.input_type = input_type
    self.output_type = output_type
    self.client_streaming = client_streaming
    self.server_streaming = server_streaming

  def CopyToProto(self, proto):
    """Copies this to a descriptor_pb2.MethodDescriptorProto.

    Args:
      proto (descriptor_pb2.MethodDescriptorProto): An empty descriptor proto.

    Raises:
      Error: If self couldn't be serialized, due to too few constructor
        arguments.
    """
    if self.containing_service is not None:
      from google.protobuf import descriptor_pb2
      service_proto = descriptor_pb2.ServiceDescriptorProto()
      self.containing_service.CopyToProto(service_proto)
      proto.CopyFrom(service_proto.method[self.index])
    else:
      raise Error('Descriptor does not contain a service.')

CopyToProto(proto)

Copies this to a descriptor_pb2.MethodDescriptorProto.

Parameters:

Name Type Description Default
proto MethodDescriptorProto

An empty descriptor proto.

required

Raises:

Type Description
Error

If self couldn't be serialized, due to too few constructor arguments.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
def CopyToProto(self, proto):
  """Copies this to a descriptor_pb2.MethodDescriptorProto.

  Args:
    proto (descriptor_pb2.MethodDescriptorProto): An empty descriptor proto.

  Raises:
    Error: If self couldn't be serialized, due to too few constructor
      arguments.
  """
  if self.containing_service is not None:
    from google.protobuf import descriptor_pb2
    service_proto = descriptor_pb2.ServiceDescriptorProto()
    self.containing_service.CopyToProto(service_proto)
    proto.CopyFrom(service_proto.method[self.index])
  else:
    raise Error('Descriptor does not contain a service.')

__init__(name, full_name, index, containing_service, input_type, output_type, client_streaming=False, server_streaming=False, options=None, serialized_options=None, create_key=None)

The arguments are as described in the description of MethodDescriptor attributes above.

Note that containing_service may be None, and may be set later if necessary.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
def __init__(self,
             name,
             full_name,
             index,
             containing_service,
             input_type,
             output_type,
             client_streaming=False,
             server_streaming=False,
             options=None,
             serialized_options=None,
             create_key=None):
  """The arguments are as described in the description of MethodDescriptor
  attributes above.

  Note that containing_service may be None, and may be set later if necessary.
  """
  if create_key is not _internal_create_key:
    _Deprecated('MethodDescriptor')

  super(MethodDescriptor, self).__init__(
      options, serialized_options, 'MethodOptions')
  self.name = name
  self.full_name = full_name
  self.index = index
  self.containing_service = containing_service
  self.input_type = input_type
  self.output_type = output_type
  self.client_streaming = client_streaming
  self.server_streaming = server_streaming

OneofDescriptor

Bases: DescriptorBase

Descriptor for a oneof field.

Attributes:

Name Type Description
name str

Name of the oneof field.

full_name str

Full name of the oneof field, including package name.

index int

0-based index giving the order of the oneof field inside its containing type.

containing_type Descriptor

:class:Descriptor of the protocol message type that contains this field. Set by the :class:Descriptor constructor if we're passed into one.

fields list[FieldDescriptor]

The list of field descriptors this oneof can contain.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
class OneofDescriptor(DescriptorBase):
  """Descriptor for a oneof field.

  Attributes:
    name (str): Name of the oneof field.
    full_name (str): Full name of the oneof field, including package name.
    index (int): 0-based index giving the order of the oneof field inside
      its containing type.
    containing_type (Descriptor): :class:`Descriptor` of the protocol message
      type that contains this field.  Set by the :class:`Descriptor` constructor
      if we're passed into one.
    fields (list[FieldDescriptor]): The list of field descriptors this
      oneof can contain.
  """

  if _USE_C_DESCRIPTORS:
    _C_DESCRIPTOR_CLASS = _message.OneofDescriptor

    def __new__(
        cls, name, full_name, index, containing_type, fields, options=None,
        serialized_options=None, create_key=None):
      _message.Message._CheckCalledFromGeneratedFile()
      return _message.default_pool.FindOneofByName(full_name)

  def __init__(
      self, name, full_name, index, containing_type, fields, options=None,
      serialized_options=None, create_key=None):
    """Arguments are as described in the attribute description above."""
    if create_key is not _internal_create_key:
      _Deprecated('OneofDescriptor')

    super(OneofDescriptor, self).__init__(
        options, serialized_options, 'OneofOptions')
    self.name = name
    self.full_name = full_name
    self.index = index
    self.containing_type = containing_type
    self.fields = fields

__init__(name, full_name, index, containing_type, fields, options=None, serialized_options=None, create_key=None)

Arguments are as described in the attribute description above.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
797
798
799
800
801
802
803
804
805
806
807
808
809
810
def __init__(
    self, name, full_name, index, containing_type, fields, options=None,
    serialized_options=None, create_key=None):
  """Arguments are as described in the attribute description above."""
  if create_key is not _internal_create_key:
    _Deprecated('OneofDescriptor')

  super(OneofDescriptor, self).__init__(
      options, serialized_options, 'OneofOptions')
  self.name = name
  self.full_name = full_name
  self.index = index
  self.containing_type = containing_type
  self.fields = fields

ServiceDescriptor

Bases: _NestedDescriptorBase

Descriptor for a service.

Attributes:

Name Type Description
name str

Name of the service.

full_name str

Full name of the service, including package name.

index int

0-indexed index giving the order that this services definition appears within the .proto file.

methods list[MethodDescriptor]

List of methods provided by this service.

methods_by_name dict(str, MethodDescriptor

Same :class:MethodDescriptor objects as in :attr:methods_by_name, but indexed by "name" attribute in each :class:MethodDescriptor.

options ServiceOptions

Service options message or None to use default service options.

file FileDescriptor

Reference to file info.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
class ServiceDescriptor(_NestedDescriptorBase):

  """Descriptor for a service.

  Attributes:
    name (str): Name of the service.
    full_name (str): Full name of the service, including package name.
    index (int): 0-indexed index giving the order that this services
      definition appears within the .proto file.
    methods (list[MethodDescriptor]): List of methods provided by this
      service.
    methods_by_name (dict(str, MethodDescriptor)): Same
      :class:`MethodDescriptor` objects as in :attr:`methods_by_name`, but
      indexed by "name" attribute in each :class:`MethodDescriptor`.
    options (descriptor_pb2.ServiceOptions): Service options message or
      None to use default service options.
    file (FileDescriptor): Reference to file info.
  """

  if _USE_C_DESCRIPTORS:
    _C_DESCRIPTOR_CLASS = _message.ServiceDescriptor

    def __new__(
        cls,
        name=None,
        full_name=None,
        index=None,
        methods=None,
        options=None,
        serialized_options=None,
        file=None,  # pylint: disable=redefined-builtin
        serialized_start=None,
        serialized_end=None,
        create_key=None):
      _message.Message._CheckCalledFromGeneratedFile()  # pylint: disable=protected-access
      return _message.default_pool.FindServiceByName(full_name)

  def __init__(self, name, full_name, index, methods, options=None,
               serialized_options=None, file=None,  # pylint: disable=redefined-builtin
               serialized_start=None, serialized_end=None, create_key=None):
    if create_key is not _internal_create_key:
      _Deprecated('ServiceDescriptor')

    super(ServiceDescriptor, self).__init__(
        options, 'ServiceOptions', name, full_name, file,
        None, serialized_start=serialized_start,
        serialized_end=serialized_end, serialized_options=serialized_options)
    self.index = index
    self.methods = methods
    self.methods_by_name = dict((m.name, m) for m in methods)
    # Set the containing service for each method in this service.
    for method in self.methods:
      method.containing_service = self

  def FindMethodByName(self, name):
    """Searches for the specified method, and returns its descriptor.

    Args:
      name (str): Name of the method.
    Returns:
      MethodDescriptor or None: the descriptor for the requested method, if
      found.
    """
    return self.methods_by_name.get(name, None)

  def CopyToProto(self, proto):
    """Copies this to a descriptor_pb2.ServiceDescriptorProto.

    Args:
      proto (descriptor_pb2.ServiceDescriptorProto): An empty descriptor proto.
    """
    # This function is overridden to give a better doc comment.
    super(ServiceDescriptor, self).CopyToProto(proto)

CopyToProto(proto)

Copies this to a descriptor_pb2.ServiceDescriptorProto.

Parameters:

Name Type Description Default
proto ServiceDescriptorProto

An empty descriptor proto.

required
Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
878
879
880
881
882
883
884
885
def CopyToProto(self, proto):
  """Copies this to a descriptor_pb2.ServiceDescriptorProto.

  Args:
    proto (descriptor_pb2.ServiceDescriptorProto): An empty descriptor proto.
  """
  # This function is overridden to give a better doc comment.
  super(ServiceDescriptor, self).CopyToProto(proto)

FindMethodByName(name)

Searches for the specified method, and returns its descriptor.

Parameters:

Name Type Description Default
name str

Name of the method.

required

Returns: MethodDescriptor or None: the descriptor for the requested method, if found.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
867
868
869
870
871
872
873
874
875
876
def FindMethodByName(self, name):
  """Searches for the specified method, and returns its descriptor.

  Args:
    name (str): Name of the method.
  Returns:
    MethodDescriptor or None: the descriptor for the requested method, if
    found.
  """
  return self.methods_by_name.get(name, None)

TypeTransformationError

Bases: Error

Error transforming between python proto type and corresponding C++ type.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
55
56
class TypeTransformationError(Error):
  """Error transforming between python proto type and corresponding C++ type."""

MakeDescriptor(desc_proto, package='', build_file_if_cpp=True, syntax=None)

Make a protobuf Descriptor given a DescriptorProto protobuf.

Handles nested descriptors. Note that this is limited to the scope of defining a message inside of another message. Composite fields can currently only be resolved if the message is defined in the same scope as the field.

Parameters:

Name Type Description Default
desc_proto

The descriptor_pb2.DescriptorProto protobuf message.

required
package

Optional package name for the new message Descriptor (string).

''
build_file_if_cpp

Update the C++ descriptor pool if api matches. Set to False on recursion, so no duplicates are created.

True
syntax

The syntax/semantics that should be used. Set to "proto3" to get proto3 field presence semantics.

None

Returns: A Descriptor for protobuf messages.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor.py
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
def MakeDescriptor(desc_proto, package='', build_file_if_cpp=True,
                   syntax=None):
  """Make a protobuf Descriptor given a DescriptorProto protobuf.

  Handles nested descriptors. Note that this is limited to the scope of defining
  a message inside of another message. Composite fields can currently only be
  resolved if the message is defined in the same scope as the field.

  Args:
    desc_proto: The descriptor_pb2.DescriptorProto protobuf message.
    package: Optional package name for the new message Descriptor (string).
    build_file_if_cpp: Update the C++ descriptor pool if api matches.
                       Set to False on recursion, so no duplicates are created.
    syntax: The syntax/semantics that should be used.  Set to "proto3" to get
            proto3 field presence semantics.
  Returns:
    A Descriptor for protobuf messages.
  """
  if api_implementation.Type() == 'cpp' and build_file_if_cpp:
    # The C++ implementation requires all descriptors to be backed by the same
    # definition in the C++ descriptor pool. To do this, we build a
    # FileDescriptorProto with the same definition as this descriptor and build
    # it into the pool.
    from google.protobuf import descriptor_pb2
    file_descriptor_proto = descriptor_pb2.FileDescriptorProto()
    file_descriptor_proto.message_type.add().MergeFrom(desc_proto)

    # Generate a random name for this proto file to prevent conflicts with any
    # imported ones. We need to specify a file name so the descriptor pool
    # accepts our FileDescriptorProto, but it is not important what that file
    # name is actually set to.
    proto_name = binascii.hexlify(os.urandom(16)).decode('ascii')

    if package:
      file_descriptor_proto.name = os.path.join(package.replace('.', '/'),
                                                proto_name + '.proto')
      file_descriptor_proto.package = package
    else:
      file_descriptor_proto.name = proto_name + '.proto'

    _message.default_pool.Add(file_descriptor_proto)
    result = _message.default_pool.FindFileByName(file_descriptor_proto.name)

    if _USE_C_DESCRIPTORS:
      return result.message_types_by_name[desc_proto.name]

  full_message_name = [desc_proto.name]
  if package: full_message_name.insert(0, package)

  # Create Descriptors for enum types
  enum_types = {}
  for enum_proto in desc_proto.enum_type:
    full_name = '.'.join(full_message_name + [enum_proto.name])
    enum_desc = EnumDescriptor(
        enum_proto.name, full_name, None, [
            EnumValueDescriptor(enum_val.name, ii, enum_val.number,
                                create_key=_internal_create_key)
            for ii, enum_val in enumerate(enum_proto.value)],
        create_key=_internal_create_key)
    enum_types[full_name] = enum_desc

  # Create Descriptors for nested types
  nested_types = {}
  for nested_proto in desc_proto.nested_type:
    full_name = '.'.join(full_message_name + [nested_proto.name])
    # Nested types are just those defined inside of the message, not all types
    # used by fields in the message, so no loops are possible here.
    nested_desc = MakeDescriptor(nested_proto,
                                 package='.'.join(full_message_name),
                                 build_file_if_cpp=False,
                                 syntax=syntax)
    nested_types[full_name] = nested_desc

  fields = []
  for field_proto in desc_proto.field:
    full_name = '.'.join(full_message_name + [field_proto.name])
    enum_desc = None
    nested_desc = None
    if field_proto.json_name:
      json_name = field_proto.json_name
    else:
      json_name = None
    if field_proto.HasField('type_name'):
      type_name = field_proto.type_name
      full_type_name = '.'.join(full_message_name +
                                [type_name[type_name.rfind('.')+1:]])
      if full_type_name in nested_types:
        nested_desc = nested_types[full_type_name]
      elif full_type_name in enum_types:
        enum_desc = enum_types[full_type_name]
      # Else type_name references a non-local type, which isn't implemented
    field = FieldDescriptor(
        field_proto.name, full_name, field_proto.number - 1,
        field_proto.number, field_proto.type,
        FieldDescriptor.ProtoTypeToCppProtoType(field_proto.type),
        field_proto.label, None, nested_desc, enum_desc, None, False, None,
        options=_OptionsOrNone(field_proto), has_default_value=False,
        json_name=json_name, create_key=_internal_create_key)
    fields.append(field)

  desc_name = '.'.join(full_message_name)
  return Descriptor(desc_proto.name, desc_name, None, None, fields,
                    list(nested_types.values()), list(enum_types.values()), [],
                    options=_OptionsOrNone(desc_proto),
                    create_key=_internal_create_key)