extension_dict.py 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  1. # Protocol Buffers - Google's data interchange format
  2. # Copyright 2008 Google Inc. All rights reserved.
  3. #
  4. # Use of this source code is governed by a BSD-style
  5. # license that can be found in the LICENSE file or at
  6. # https://developers.google.com/open-source/licenses/bsd
  7. """Contains _ExtensionDict class to represent extensions.
  8. """
  9. from google.protobuf.internal import type_checkers
  10. from google.protobuf.descriptor import FieldDescriptor
  11. def _VerifyExtensionHandle(message, extension_handle):
  12. """Verify that the given extension handle is valid."""
  13. if not isinstance(extension_handle, FieldDescriptor):
  14. raise KeyError('HasExtension() expects an extension handle, got: %s' %
  15. extension_handle)
  16. if not extension_handle.is_extension:
  17. raise KeyError('"%s" is not an extension.' % extension_handle.full_name)
  18. if not extension_handle.containing_type:
  19. raise KeyError('"%s" is missing a containing_type.'
  20. % extension_handle.full_name)
  21. if extension_handle.containing_type is not message.DESCRIPTOR:
  22. raise KeyError('Extension "%s" extends message type "%s", but this '
  23. 'message is of type "%s".' %
  24. (extension_handle.full_name,
  25. extension_handle.containing_type.full_name,
  26. message.DESCRIPTOR.full_name))
  27. # TODO: Unify error handling of "unknown extension" crap.
  28. # TODO: Support iteritems()-style iteration over all
  29. # extensions with the "has" bits turned on?
  30. class _ExtensionDict(object):
  31. """Dict-like container for Extension fields on proto instances.
  32. Note that in all cases we expect extension handles to be
  33. FieldDescriptors.
  34. """
  35. def __init__(self, extended_message):
  36. """
  37. Args:
  38. extended_message: Message instance for which we are the Extensions dict.
  39. """
  40. self._extended_message = extended_message
  41. def __getitem__(self, extension_handle):
  42. """Returns the current value of the given extension handle."""
  43. _VerifyExtensionHandle(self._extended_message, extension_handle)
  44. result = self._extended_message._fields.get(extension_handle)
  45. if result is not None:
  46. return result
  47. if extension_handle.label == FieldDescriptor.LABEL_REPEATED:
  48. result = extension_handle._default_constructor(self._extended_message)
  49. elif extension_handle.cpp_type == FieldDescriptor.CPPTYPE_MESSAGE:
  50. message_type = extension_handle.message_type
  51. if not hasattr(message_type, '_concrete_class'):
  52. # pylint: disable=g-import-not-at-top
  53. from google.protobuf import message_factory
  54. message_factory.GetMessageClass(message_type)
  55. if not hasattr(extension_handle.message_type, '_concrete_class'):
  56. from google.protobuf import message_factory
  57. message_factory.GetMessageClass(extension_handle.message_type)
  58. result = extension_handle.message_type._concrete_class()
  59. try:
  60. result._SetListener(self._extended_message._listener_for_children)
  61. except ReferenceError:
  62. pass
  63. else:
  64. # Singular scalar -- just return the default without inserting into the
  65. # dict.
  66. return extension_handle.default_value
  67. # Atomically check if another thread has preempted us and, if not, swap
  68. # in the new object we just created. If someone has preempted us, we
  69. # take that object and discard ours.
  70. # WARNING: We are relying on setdefault() being atomic. This is true
  71. # in CPython but we haven't investigated others. This warning appears
  72. # in several other locations in this file.
  73. result = self._extended_message._fields.setdefault(
  74. extension_handle, result)
  75. return result
  76. def __eq__(self, other):
  77. if not isinstance(other, self.__class__):
  78. return False
  79. my_fields = self._extended_message.ListFields()
  80. other_fields = other._extended_message.ListFields()
  81. # Get rid of non-extension fields.
  82. my_fields = [field for field in my_fields if field.is_extension]
  83. other_fields = [field for field in other_fields if field.is_extension]
  84. return my_fields == other_fields
  85. def __ne__(self, other):
  86. return not self == other
  87. def __len__(self):
  88. fields = self._extended_message.ListFields()
  89. # Get rid of non-extension fields.
  90. extension_fields = [field for field in fields if field[0].is_extension]
  91. return len(extension_fields)
  92. def __hash__(self):
  93. raise TypeError('unhashable object')
  94. # Note that this is only meaningful for non-repeated, scalar extension
  95. # fields. Note also that we may have to call _Modified() when we do
  96. # successfully set a field this way, to set any necessary "has" bits in the
  97. # ancestors of the extended message.
  98. def __setitem__(self, extension_handle, value):
  99. """If extension_handle specifies a non-repeated, scalar extension
  100. field, sets the value of that field.
  101. """
  102. _VerifyExtensionHandle(self._extended_message, extension_handle)
  103. if (extension_handle.label == FieldDescriptor.LABEL_REPEATED or
  104. extension_handle.cpp_type == FieldDescriptor.CPPTYPE_MESSAGE):
  105. raise TypeError(
  106. 'Cannot assign to extension "%s" because it is a repeated or '
  107. 'composite type.' % extension_handle.full_name)
  108. # It's slightly wasteful to lookup the type checker each time,
  109. # but we expect this to be a vanishingly uncommon case anyway.
  110. type_checker = type_checkers.GetTypeChecker(extension_handle)
  111. # pylint: disable=protected-access
  112. self._extended_message._fields[extension_handle] = (
  113. type_checker.CheckValue(value))
  114. self._extended_message._Modified()
  115. def __delitem__(self, extension_handle):
  116. self._extended_message.ClearExtension(extension_handle)
  117. def _FindExtensionByName(self, name):
  118. """Tries to find a known extension with the specified name.
  119. Args:
  120. name: Extension full name.
  121. Returns:
  122. Extension field descriptor.
  123. """
  124. descriptor = self._extended_message.DESCRIPTOR
  125. extensions = descriptor.file.pool._extensions_by_name[descriptor]
  126. return extensions.get(name, None)
  127. def _FindExtensionByNumber(self, number):
  128. """Tries to find a known extension with the field number.
  129. Args:
  130. number: Extension field number.
  131. Returns:
  132. Extension field descriptor.
  133. """
  134. descriptor = self._extended_message.DESCRIPTOR
  135. extensions = descriptor.file.pool._extensions_by_number[descriptor]
  136. return extensions.get(number, None)
  137. def __iter__(self):
  138. # Return a generator over the populated extension fields
  139. return (f[0] for f in self._extended_message.ListFields()
  140. if f[0].is_extension)
  141. def __contains__(self, extension_handle):
  142. _VerifyExtensionHandle(self._extended_message, extension_handle)
  143. if extension_handle not in self._extended_message._fields:
  144. return False
  145. if extension_handle.label == FieldDescriptor.LABEL_REPEATED:
  146. return bool(self._extended_message._fields.get(extension_handle))
  147. if extension_handle.cpp_type == FieldDescriptor.CPPTYPE_MESSAGE:
  148. value = self._extended_message._fields.get(extension_handle)
  149. # pylint: disable=protected-access
  150. return value is not None and value._is_present_in_parent
  151. return True