Inheritance diagram for google.protobuf.symbol_database.SymbolDatabase:

Public Member Functions
def	GetMessages (self, files)

def	GetSymbol (self, symbol)

def	RegisterEnumDescriptor (self, enum_descriptor)

def	RegisterFileDescriptor (self, file_descriptor)

def	RegisterMessage (self, message)

def	RegisterMessageDescriptor (self, message_descriptor)

def	RegisterServiceDescriptor (self, service_descriptor)

Public Member Functions inherited from google.protobuf.message_factory.MessageFactory
def	__init__ (self, pool=None)

def	GetPrototype (self, descriptor)

Additional Inherited Members
Public Attributes inherited from google.protobuf.message_factory.MessageFactory
	pool

Detailed Description

A database of Python generated symbols.

Definition at line 65 of file symbol_database.py.

Member Function Documentation

◆ GetMessages()

def google.protobuf.symbol_database.SymbolDatabase.GetMessages	(	self,
		files
	)

Gets all registered messages from a specified file.

Only messages already created and registered will be returned; (this is the
case for imported _pb2 modules)
But unlike MessageFactory, this version also returns already defined nested
messages, but does not register any message extensions.

Args:
  files: The file names to extract messages from.

Returns:
  A dictionary mapping proto names to the message classes.

Raises:
  KeyError: if a file could not be found.

Reimplemented from google.protobuf.message_factory.MessageFactory.

Definition at line 145 of file symbol_database.py.

◆ GetSymbol()

def google.protobuf.symbol_database.SymbolDatabase.GetSymbol	(	self,
		symbol
	)

Tries to find a symbol in the local database.

Currently, this method only returns message.Message instances, however, if
may be extended in future to support other symbol types.

Args:
  symbol: A str, a protocol buffer symbol.

Returns:
  A Python class corresponding to the symbol.

Raises:
  KeyError: if the symbol could not be found.

Definition at line 127 of file symbol_database.py.

◆ RegisterEnumDescriptor()

def google.protobuf.symbol_database.SymbolDatabase.RegisterEnumDescriptor	(	self,
		enum_descriptor
	)

Registers the given enum descriptor in the local database.

Args:
  enum_descriptor: a descriptor.EnumDescriptor.

Returns:
  The provided descriptor.

Definition at line 93 of file symbol_database.py.

◆ RegisterFileDescriptor()

def google.protobuf.symbol_database.SymbolDatabase.RegisterFileDescriptor	(	self,
		file_descriptor
	)

Registers the given file descriptor in the local database.

Args:
  file_descriptor: a descriptor.FileDescriptor.

Returns:
  The provided descriptor.

Definition at line 116 of file symbol_database.py.

◆ RegisterMessage()

def google.protobuf.symbol_database.SymbolDatabase.RegisterMessage	(	self,
		message
	)

Registers the given message type in the local database.

Calls to GetSymbol() and GetMessages() will return messages registered here.

Args:
  message: a message.Message, to be registered.

Returns:
  The provided message.

Definition at line 68 of file symbol_database.py.

◆ RegisterMessageDescriptor()

def google.protobuf.symbol_database.SymbolDatabase.RegisterMessageDescriptor	(	self,
		message_descriptor
	)

Registers the given message descriptor in the local database.

Args:
  message_descriptor: a descriptor.MessageDescriptor.

Definition at line 85 of file symbol_database.py.

◆ RegisterServiceDescriptor()

def google.protobuf.symbol_database.SymbolDatabase.RegisterServiceDescriptor	(	self,
		service_descriptor
	)

Registers the given service descriptor in the local database.

Args:
  service_descriptor: a descriptor.ServiceDescriptor.

Returns:
  The provided descriptor.

Definition at line 105 of file symbol_database.py.

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

symbol_database.py

Public Member Functions

Additional Inherited Members