google.protobuf.internal.containers.MessageMap Class Reference

Inheritance diagram for google.protobuf.internal.containers.MessageMap:

Public Member Functions
def	__contains__ (self, item)
def	__delitem__ (self, key)
def	__getitem__ (self, key)
def	__init__ (self, message_listener, message_descriptor, key_checker, entry_descriptor)
def	__iter__ (self)
def	__len__ (self)
def	__repr__ (self)
def	__setitem__ (self, key, value)
def	clear (self)
def	get (self, key, default=None)
def	get_or_create (self, key)
def	GetEntryClass (self)
def	InvalidateIterators (self)
def	MergeFrom (self, other)
Public Member Functions inherited from google.protobuf.internal.containers.MutableMapping
def	pop (self, key, default=__marker)
def	popitem (self)
def	setdefault (self, key, default=None)
def	update (*args, **kwds)
Public Member Functions inherited from google.protobuf.internal.containers.Mapping
def	__eq__ (self, other)
def	__ne__ (self, other)
def	items (self)
def	iteritems (self)
def	iterkeys (self)
def	itervalues (self)
def	keys (self)
def	values (self)

Private Attributes
	_entry_descriptor
	_key_checker
	_message_descriptor
	_message_listener
	_values

Static Private Attributes
list	__slots__

Detailed Description

Simple, type-checked, dict-like container for with submessage values.

Definition at line 546 of file containers.py.

Constructor & Destructor Documentation

__init__()

def google.protobuf.internal.containers.MessageMap.__init__	(		self,
			message_listener,
			message_descriptor,
			key_checker,
			entry_descriptor
	)

Args:
  message_listener: A MessageListener implementation.
The ScalarMap will call this object's Modified() method when it
is modified.
  key_checker: A type_checkers.ValueChecker instance to run on keys
inserted into this container.
  value_checker: A type_checkers.ValueChecker instance to run on values
inserted into this container.
  entry_descriptor: The MessageDescriptor of a map entry: key and value.

Definition at line 554 of file containers.py.

Member Function Documentation

__contains__()

def google.protobuf.internal.containers.MessageMap.__contains__	(		self,
			item
	)

Reimplemented from google.protobuf.internal.containers.Mapping.

Definition at line 608 of file containers.py.

__delitem__()

def google.protobuf.internal.containers.MessageMap.__delitem__	(		self,
			key
	)

Definition at line 615 of file containers.py.

__getitem__()

def google.protobuf.internal.containers.MessageMap.__getitem__	(		self,
			key
	)

Definition at line 573 of file containers.py.

__iter__()

def google.protobuf.internal.containers.MessageMap.__iter__

(

self

)

Definition at line 623 of file containers.py.

__len__()

def google.protobuf.internal.containers.MessageMap.__len__

(

self

)

Definition at line 620 of file containers.py.

__repr__()

def google.protobuf.internal.containers.MessageMap.__repr__

(

self

)

Definition at line 626 of file containers.py.

__setitem__()

def google.protobuf.internal.containers.MessageMap.__setitem__	(		self,
			key,
			value
	)

Definition at line 612 of file containers.py.

clear()

def google.protobuf.internal.containers.MessageMap.clear

(

self

)

Reimplemented from google.protobuf.internal.containers.MutableMapping.

Definition at line 647 of file containers.py.

get()

def google.protobuf.internal.containers.MessageMap.get	(		self,
			key,
			default = None
	)

Reimplemented from google.protobuf.internal.containers.Mapping.

Definition at line 602 of file containers.py.

get_or_create()

def google.protobuf.internal.containers.MessageMap.get_or_create	(		self,
			key
	)

get_or_create() is an alias for getitem (ie. map[key]).

Args:
  key: The key to get or create in the map.

This is useful in cases where you want to be explicit that the call is
mutating the map.  This can avoid lint errors for statements like this
that otherwise would appear to be pointless statements:

  msg.my_map[key]

Definition at line 585 of file containers.py.

GetEntryClass()

def google.protobuf.internal.containers.MessageMap.GetEntryClass

(

self

)

Definition at line 651 of file containers.py.

InvalidateIterators()

def google.protobuf.internal.containers.MessageMap.InvalidateIterators

(

self

)

Definition at line 639 of file containers.py.

MergeFrom()

def google.protobuf.internal.containers.MessageMap.MergeFrom	(		self,
			other
	)

Definition at line 629 of file containers.py.

Member Data Documentation

__slots__

list google.protobuf.internal.containers.MessageMap.__slots__

staticprivate

Initial value:

=  ['_key_checker', '_values', '_message_listener',
               '_message_descriptor', '_entry_descriptor']

Definition at line 551 of file containers.py.

_entry_descriptor

google.protobuf.internal.containers.MessageMap._entry_descriptor

private

Definition at line 569 of file containers.py.

_key_checker

google.protobuf.internal.containers.MessageMap._key_checker

private

Definition at line 568 of file containers.py.

_message_descriptor

google.protobuf.internal.containers.MessageMap._message_descriptor

private

Definition at line 567 of file containers.py.

_message_listener

google.protobuf.internal.containers.MessageMap._message_listener

private

Definition at line 566 of file containers.py.

_values

google.protobuf.internal.containers.MessageMap._values

private

Definition at line 570 of file containers.py.

---

The documentation for this class was generated from the following file:

• containers.py