3
SLj @ sH d Z ddlmZ ddlmZ G dd dejZeej dZdd Zd S )
aR A database of Python protocol buffer generated symbols.
SymbolDatabase is the MessageFactory for messages generated at compile time,
and makes it easy to create new instances of a registered type, given only the
type's protocol buffer symbol name.
Example usage:
db = symbol_database.SymbolDatabase()
# Register symbols of interest, from one or multiple files.
db.RegisterFileDescriptor(my_proto_pb2.DESCRIPTOR)
db.RegisterMessage(my_proto_pb2.MyMessage)
db.RegisterEnumDescriptor(my_proto_pb2.MyEnum.DESCRIPTOR)
# The database can be used as a MessageFactory, to generate types based on
# their name:
types = db.GetMessages(['my_proto.proto'])
my_message_instance = types['MyMessage']()
# The database's underlying descriptor pool can be queried, so it's not
# necessary to know a type's filename to be able to generate it:
filename = db.pool.FindFileContainingSymbol('MyMessage')
my_message_instance = db.GetMessages([filename])['MyMessage']()
# This functionality is also provided directly via a convenience method:
my_message_instance = db.GetSymbol('MyMessage')()
)descriptor_pool)message_factoryc @ sH e Zd ZdZdd Zdd Zdd Zdd Zd
d Zd d
Z dd Z
dS )SymbolDatabasez'A database of Python generated symbols.c C s |j }|| j|< | j| |S )zRegisters 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.
)Z
DESCRIPTOR_classesRegisterMessageDescriptor)selfmessagedesc r
%/usr/lib/python3.6/symbol_database.pyRegisterMessageD s
z SymbolDatabase.RegisterMessagec C s | j j| dS )zRegisters the given message descriptor in the local database.
Args:
message_descriptor: a descriptor.MessageDescriptor.
N)poolZ
AddDescriptor)r Zmessage_descriptorr
r
r r U s z(SymbolDatabase.RegisterMessageDescriptorc C s | j j| |S )zRegisters the given enum descriptor in the local database.
Args:
enum_descriptor: a descriptor.EnumDescriptor.
Returns:
The provided descriptor.
)r
ZAddEnumDescriptor)r Zenum_descriptorr
r
r RegisterEnumDescriptor] s z%SymbolDatabase.RegisterEnumDescriptorc C s | j j| dS )zRegisters the given service descriptor in the local database.
Args:
service_descriptor: a descriptor.ServiceDescriptor.
Returns:
The provided descriptor.
N)r
ZAddServiceDescriptor)r Zservice_descriptorr
r
r RegisterServiceDescriptori s z(SymbolDatabase.RegisterServiceDescriptorc C s | j j| dS )zRegisters the given file descriptor in the local database.
Args:
file_descriptor: a descriptor.FileDescriptor.
Returns:
The provided descriptor.
N)r
ZAddFileDescriptor)r Zfile_descriptorr
r
r RegisterFileDescriptort s z%SymbolDatabase.RegisterFileDescriptorc C s | j | jj| S )ax 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.
)r r
ZFindMessageTypeByName)r Zsymbolr
r
r GetSymbol s zSymbolDatabase.GetSymbolc s~ fdd i }xh|D ]`}| j j|}xN|jj D ]@}x: |D ].}y| j| ||j< W q@ tk
rl Y q@X q@W q2W qW |S )a 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.
c 3 s2 | V x&| j D ] }x |D ]
}|V q W qW dS )zCWalk a message Descriptor and recursively yields all message names.N)Z nested_types)r msg_descZ nested_desc)_GetAllMessagesr
r r s z3SymbolDatabase.GetMessages.._GetAllMessages)r
ZFindFileByNameZmessage_types_by_namevaluesr Z full_nameKeyError)r filesresult file_nameZ file_descr r r
)r r GetMessages s
zSymbolDatabase.GetMessagesN) __name__
__module__ __qualname____doc__r r r r r r r r
r
r
r r A s r )r
c C s t S )z#Returns the default SymbolDatabase.)_DEFAULTr
r
r
r Default s r N)r Zgoogle.protobufr r ZMessageFactoryr r r r
r
r
r : s
w