U S³dŽã@sXdZddlZddlmZddlmZddlmZGdd„dƒZee ¡dZ d d „ZdS) aSA 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')() éN)Úapi_implementation)Údescriptor_pool)Úmessage_factoryc@sneZdZdZiZddd„Zdd„Zdd„Zd d „Zd d „Z d d„Z dd„Z dd„Z dd„Z dd„Zdd „ZdS)ÚSymbolDatabasez'A database of Python generated symbols.NcCs|p t ¡|_dS)z!Initializes a new SymbolDatabase.N)rZDescriptorPoolÚpool)Úselfr©rúC/tmp/pip-unpacked-wheel-1ori_g8k/google/protobuf/symbol_database.pyÚ__init__IszSymbolDatabase.__init__cCst d¡t |¡S)Nz–SymbolDatabase.GetPrototype() is deprecated. Please use message_factory.GetMessageClass() instead. SymbolDatabase.GetPrototype() will be removed soon.)ÚwarningsÚwarnrZGetMessageClass©rZ descriptorrrr Ú GetPrototypeMs zSymbolDatabase.GetPrototypecCst d¡t |¡S)Nz–Directly call CreatePrototype() is wrong. Please use message_factory.GetMessageClass() instead. SymbolDatabase.CreatePrototype() will be removed soon.)r r rZ_InternalCreateMessageClassr rrr ÚCreatePrototypeSs zSymbolDatabase.CreatePrototypecCst d¡t ||j¡S)NzžSymbolDatabase.GetMessages() is deprecated. Please use message_factory.GetMessageClassedForFiles() instead. SymbolDatabase.GetMessages() will be removed soon.)r r rZGetMessageClassedForFilesr)rÚfilesrrr Ú GetMessagesYs zSymbolDatabase.GetMessagescCs|j}||j|<| |¡|S)a@Registers the given message type in the local database. Calls to GetSymbol() and GetMessages() will return messages registered here. Args: message: A :class:`google.protobuf.message.Message` subclass (or instance); its descriptor will be registered. Returns: The provided message. )Z DESCRIPTORÚ_classesÚRegisterMessageDescriptor)rÚmessageÚdescrrr ÚRegisterMessage_s   zSymbolDatabase.RegisterMessagecCst ¡dkr|j |¡dS)z“Registers the given message descriptor in the local database. Args: message_descriptor (Descriptor): the message descriptor to add. ÚpythonN)rÚTyperZ_AddDescriptor)rZmessage_descriptorrrr rqs z(SymbolDatabase.RegisterMessageDescriptorcCst ¡dkr|j |¡|S)zÐRegisters the given enum descriptor in the local database. Args: enum_descriptor (EnumDescriptor): The enum descriptor to register. Returns: EnumDescriptor: The provided descriptor. r)rrrZ_AddEnumDescriptor)rZenum_descriptorrrr ÚRegisterEnumDescriptor{s  z%SymbolDatabase.RegisterEnumDescriptorcCst ¡dkr|j |¡dS)z§Registers the given service descriptor in the local database. Args: service_descriptor (ServiceDescriptor): the service descriptor to register. rN)rrrZ_AddServiceDescriptor)rZservice_descriptorrrr ÚRegisterServiceDescriptor‰s z(SymbolDatabase.RegisterServiceDescriptorcCst ¡dkr|j |¡dS)z“Registers the given file descriptor in the local database. Args: file_descriptor (FileDescriptor): The file descriptor to register. rN)rrrZ_InternalAddFileDescriptor)rZfile_descriptorrrr ÚRegisterFileDescriptor”s z%SymbolDatabase.RegisterFileDescriptorcCs|j|j |¡S)awTries 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 (str): a protocol buffer symbol. Returns: A Python class corresponding to the symbol. Raises: KeyError: if the symbol could not be found. )rrZFindMessageTypeByName)rÚsymbolrrr Ú GetSymbolžszSymbolDatabase.GetSymbolc sr‡fdd„‰i}|D]X}|j |¡}|j ¡D]<}ˆ|ƒD].}z|j|||j<Wq:tk rfYq:Xq:q.q|S)aGets 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 (list[str]): 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. c3s*|V|jD]}ˆ|ƒD] }|Vqq dS)zCWalk a message Descriptor and recursively yields all message names.N)Z nested_types)rÚmsg_descZ nested_desc©Ú_GetAllMessagesrr r Ãs  z3SymbolDatabase.GetMessages.._GetAllMessages)rZFindFileByNameZmessage_types_by_nameÚvaluesrZ full_nameÚKeyError)rrÚresultÚ file_nameZ file_descrrrrr r°s    )N)Ú__name__Ú __module__Ú __qualname__Ú__doc__rr rrrrrrrrrrrrr rCs    r)rcCstS)z#Returns the default SymbolDatabase.)Ú_DEFAULTrrrr ÚDefaultÚsr*) r(r Zgoogle.protobuf.internalrZgoogle.protobufrrrr*r)rrrr Ús