Skip to content

descriptor_database

Provides a container for DescriptorProtos.

DescriptorDatabase

Bases: object

A container accepting FileDescriptorProtos and maps DescriptorProtos.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor_database.py
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
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
class DescriptorDatabase(object):
  """A container accepting FileDescriptorProtos and maps DescriptorProtos."""

  def __init__(self):
    self._file_desc_protos_by_file = {}
    self._file_desc_protos_by_symbol = {}

  def Add(self, file_desc_proto):
    """Adds the FileDescriptorProto and its types to this database.

    Args:
      file_desc_proto: The FileDescriptorProto to add.
    Raises:
      DescriptorDatabaseConflictingDefinitionError: if an attempt is made to
        add a proto with the same name but different definition than an
        existing proto in the database.
    """
    proto_name = file_desc_proto.name
    if proto_name not in self._file_desc_protos_by_file:
      self._file_desc_protos_by_file[proto_name] = file_desc_proto
    elif self._file_desc_protos_by_file[proto_name] != file_desc_proto:
      raise DescriptorDatabaseConflictingDefinitionError(
          '%s already added, but with different descriptor.' % proto_name)
    else:
      return

    # Add all the top-level descriptors to the index.
    package = file_desc_proto.package
    for message in file_desc_proto.message_type:
      for name in _ExtractSymbols(message, package):
        self._AddSymbol(name, file_desc_proto)
    for enum in file_desc_proto.enum_type:
      self._AddSymbol(('.'.join((package, enum.name))), file_desc_proto)
      for enum_value in enum.value:
        self._file_desc_protos_by_symbol[
            '.'.join((package, enum_value.name))] = file_desc_proto
    for extension in file_desc_proto.extension:
      self._AddSymbol(('.'.join((package, extension.name))), file_desc_proto)
    for service in file_desc_proto.service:
      self._AddSymbol(('.'.join((package, service.name))), file_desc_proto)

  def FindFileByName(self, name):
    """Finds the file descriptor proto by file name.

    Typically the file name is a relative path ending to a .proto file. The
    proto with the given name will have to have been added to this database
    using the Add method or else an error will be raised.

    Args:
      name: The file name to find.

    Returns:
      The file descriptor proto matching the name.

    Raises:
      KeyError if no file by the given name was added.
    """

    return self._file_desc_protos_by_file[name]

  def FindFileContainingSymbol(self, symbol):
    """Finds the file descriptor proto containing the specified symbol.

    The symbol should be a fully qualified name including the file descriptor's
    package and any containing messages. Some examples:

    'some.package.name.Message'
    'some.package.name.Message.NestedEnum'
    'some.package.name.Message.some_field'

    The file descriptor proto containing the specified symbol must be added to
    this database using the Add method or else an error will be raised.

    Args:
      symbol: The fully qualified symbol name.

    Returns:
      The file descriptor proto containing the symbol.

    Raises:
      KeyError if no file contains the specified symbol.
    """
    try:
      return self._file_desc_protos_by_symbol[symbol]
    except KeyError:
      # Fields, enum values, and nested extensions are not in
      # _file_desc_protos_by_symbol. Try to find the top level
      # descriptor. Non-existent nested symbol under a valid top level
      # descriptor can also be found. The behavior is the same with
      # protobuf C++.
      top_level, _, _ = symbol.rpartition('.')
      try:
        return self._file_desc_protos_by_symbol[top_level]
      except KeyError:
        # Raise the original symbol as a KeyError for better diagnostics.
        raise KeyError(symbol)

  def FindFileContainingExtension(self, extendee_name, extension_number):
    # TODO(jieluo): implement this API.
    return None

  def FindAllExtensionNumbers(self, extendee_name):
    # TODO(jieluo): implement this API.
    return []

  def _AddSymbol(self, name, file_desc_proto):
    if name in self._file_desc_protos_by_symbol:
      warn_msg = ('Conflict register for file "' + file_desc_proto.name +
                  '": ' + name +
                  ' is already defined in file "' +
                  self._file_desc_protos_by_symbol[name].name + '"')
      warnings.warn(warn_msg, RuntimeWarning)
    self._file_desc_protos_by_symbol[name] = file_desc_proto

Add(file_desc_proto)

Adds the FileDescriptorProto and its types to this database.

Parameters:

Name Type Description Default
file_desc_proto

The FileDescriptorProto to add.

required

Raises: DescriptorDatabaseConflictingDefinitionError: if an attempt is made to add a proto with the same name but different definition than an existing proto in the database.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor_database.py
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
def Add(self, file_desc_proto):
  """Adds the FileDescriptorProto and its types to this database.

  Args:
    file_desc_proto: The FileDescriptorProto to add.
  Raises:
    DescriptorDatabaseConflictingDefinitionError: if an attempt is made to
      add a proto with the same name but different definition than an
      existing proto in the database.
  """
  proto_name = file_desc_proto.name
  if proto_name not in self._file_desc_protos_by_file:
    self._file_desc_protos_by_file[proto_name] = file_desc_proto
  elif self._file_desc_protos_by_file[proto_name] != file_desc_proto:
    raise DescriptorDatabaseConflictingDefinitionError(
        '%s already added, but with different descriptor.' % proto_name)
  else:
    return

  # Add all the top-level descriptors to the index.
  package = file_desc_proto.package
  for message in file_desc_proto.message_type:
    for name in _ExtractSymbols(message, package):
      self._AddSymbol(name, file_desc_proto)
  for enum in file_desc_proto.enum_type:
    self._AddSymbol(('.'.join((package, enum.name))), file_desc_proto)
    for enum_value in enum.value:
      self._file_desc_protos_by_symbol[
          '.'.join((package, enum_value.name))] = file_desc_proto
  for extension in file_desc_proto.extension:
    self._AddSymbol(('.'.join((package, extension.name))), file_desc_proto)
  for service in file_desc_proto.service:
    self._AddSymbol(('.'.join((package, service.name))), file_desc_proto)

FindFileByName(name)

Finds the file descriptor proto by file name.

Typically the file name is a relative path ending to a .proto file. The proto with the given name will have to have been added to this database using the Add method or else an error will be raised.

Parameters:

Name Type Description Default
name

The file name to find.

required

Returns:

Type Description

The file descriptor proto matching the name.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor_database.py
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def FindFileByName(self, name):
  """Finds the file descriptor proto by file name.

  Typically the file name is a relative path ending to a .proto file. The
  proto with the given name will have to have been added to this database
  using the Add method or else an error will be raised.

  Args:
    name: The file name to find.

  Returns:
    The file descriptor proto matching the name.

  Raises:
    KeyError if no file by the given name was added.
  """

  return self._file_desc_protos_by_file[name]

FindFileContainingSymbol(symbol)

Finds the file descriptor proto containing the specified symbol.

The symbol should be a fully qualified name including the file descriptor's package and any containing messages. Some examples:

'some.package.name.Message' 'some.package.name.Message.NestedEnum' 'some.package.name.Message.some_field'

The file descriptor proto containing the specified symbol must be added to this database using the Add method or else an error will be raised.

Parameters:

Name Type Description Default
symbol

The fully qualified symbol name.

required

Returns:

Type Description

The file descriptor proto containing the symbol.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor_database.py
106
107
108
109
110
111
112
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
def FindFileContainingSymbol(self, symbol):
  """Finds the file descriptor proto containing the specified symbol.

  The symbol should be a fully qualified name including the file descriptor's
  package and any containing messages. Some examples:

  'some.package.name.Message'
  'some.package.name.Message.NestedEnum'
  'some.package.name.Message.some_field'

  The file descriptor proto containing the specified symbol must be added to
  this database using the Add method or else an error will be raised.

  Args:
    symbol: The fully qualified symbol name.

  Returns:
    The file descriptor proto containing the symbol.

  Raises:
    KeyError if no file contains the specified symbol.
  """
  try:
    return self._file_desc_protos_by_symbol[symbol]
  except KeyError:
    # Fields, enum values, and nested extensions are not in
    # _file_desc_protos_by_symbol. Try to find the top level
    # descriptor. Non-existent nested symbol under a valid top level
    # descriptor can also be found. The behavior is the same with
    # protobuf C++.
    top_level, _, _ = symbol.rpartition('.')
    try:
      return self._file_desc_protos_by_symbol[top_level]
    except KeyError:
      # Raise the original symbol as a KeyError for better diagnostics.
      raise KeyError(symbol)

DescriptorDatabaseConflictingDefinitionError

Bases: Error

Raised when a proto is added with the same name & different descriptor.

Source code in client/ayon_hiero/vendor/google/protobuf/descriptor_database.py
42
43
class DescriptorDatabaseConflictingDefinitionError(Error):
  """Raised when a proto is added with the same name & different descriptor."""