← Back
Editing: descriptor_pool.cpython-36.pyc
3 ���h�� � @ s� d Z dZddlZddlmZ ddlmZ ddlmZ ejZdd� Zd d � Z d d � Z G d d� de �Z dd� Z erxejjZne � Zdd� ZdS )aJ Provides DescriptorPool to use as a container for proto2 descriptors. The DescriptorPool is used in conjection with a DescriptorDatabase to maintain a collection of protocol buffer descriptors for use when dynamically creating message types at runtime. For most applications protocol buffers should be used via modules generated by the protocol buffer compiler tool. This should only be used when the type of protocol buffers used in an application or library cannot be predetermined. Below is a straightforward example on how to use this class: pool = DescriptorPool() file_descriptor_protos = [ ... ] for file_descriptor_proto in file_descriptor_protos: pool.Add(file_descriptor_proto) my_message_descriptor = pool.FindMessageTypeByName('some.package.MessageType') The message descriptor can be used in conjunction with the message_factory module in order to create a protocol buffer class that can be encoded and decoded. If you want to get a Python class for the specified proto, use the helper functions inside google.protobuf.message_factory directly instead of this class. z"matthewtoia@google.com (Matt Toia)� N)� descriptor)�descriptor_database)� text_encodingc C s | j d�S )aL Remove leading period from fully-qualified type name. Due to b/13860351 in descriptor_database.py, types in the root namespace are generated with a leading period. This function removes that prefix. Args: name: A str, the fully-qualified symbol name. Returns: A str, the normalized fully-qualified symbol name. �.)�lstrip)�name� r �%/usr/lib/python3.6/descriptor_pool.py� _NormalizeFullyQualifiedNameF s r c C s | j d�r| jS dS dS )zCReturns the value of the field `options`, or None if it is not set.�optionsN)�HasFieldr )Zdescriptor_protor r r �_OptionsOrNoneU s r c C s6 | j o4| jjo4| jj� jo4| jtjjko4| j tjj kS )N) � is_extension�containing_typeZ has_optionsZ GetOptionsZmessage_set_wire_format�typer �FieldDescriptor� TYPE_MESSAGE�labelZLABEL_OPTIONAL)�fieldr r r �_IsMessageSetExtension] s r c @ s& e Zd ZdZerdFdd�ZdGdd�Zdd� Zd d � Zd d � Z d d� Z dd� Z dd� Z dd� Z dd� Zdd� Zdd� Zdd � Zd d � Zd d � Zd!d"� Zd#d$� Zd%d&� Zd'd(� Zd)d*� Zd+d,� Zd-d.� ZdHd/d0�ZdId1d2�Z dJd4d5�Z d6d7� Z d8d9� Z d:d;� Z d<d=� Z!d>d?� Z"d@dA� Z#dBdC� Z$dDdE� Z%dS )K�DescriptorPoolzGA collection of protobufs dynamically constructed by descriptor protos.Nc C s t jj|�S )N)r �_messager )�cls� descriptor_dbr r r �__new__j s zDescriptorPool.__new__c C sJ t j� | _|| _i | _i | _i | _i | _i | _t j t �| _ t j t �| _ dS )a� Initializes a Pool of proto buffs. The descriptor_db argument to the constructor is provided to allow specialized file descriptor proto lookup code to be triggered on demand. An example would be an implementation which will read and compile a file specified in a call to FindFileByName() and not require the call to Add() at all. Results from this database will be cached internally here as well. Args: descriptor_db: A secondary source of file descriptors. N)r ZDescriptorDatabase� _internal_db�_descriptor_db� _descriptors�_enum_descriptors�_service_descriptors�_file_descriptors�_toplevel_extensions� collections� defaultdict�dict�_extensions_by_name�_extensions_by_number)�selfr r r r �__init__n s zDescriptorPool.__init__c C s | j j|� dS )zAdds the FileDescriptorProto and its types to this pool. Args: file_desc_proto: The FileDescriptorProto to add. N)r �Add)r' �file_desc_protor r r r) � s zDescriptorPool.Addc C s& ddl m} |jj|�}| j|� dS )z�Adds the FileDescriptorProto and its types to this pool. Args: serialized_file_desc_proto: A bytes string, serialization of the FileDescriptorProto to add. r )�descriptor_pb2N)�google.protobufr+ ZFileDescriptorProtoZ FromStringr) )r' Zserialized_file_desc_protor+ r* r r r �AddSerializedFile� s z DescriptorPool.AddSerializedFilec C s0 t |tj�std��|| j|j< | j|j� dS )a Adds a Descriptor to the pool, non-recursively. If the Descriptor contains nested messages or enums, the caller must explicitly register them. This method also registers the FileDescriptor associated with the message. Args: desc: A Descriptor. z+Expected instance of descriptor.Descriptor.N)� isinstancer � Descriptor� TypeErrorr � full_name�_AddFileDescriptor�file)r' �descr r r � AddDescriptor� s z DescriptorPool.AddDescriptorc C s0 t |tj�std��|| j|j< | j|j� dS )z�Adds an EnumDescriptor to the pool. This method also registers the FileDescriptor associated with the enum. Args: enum_desc: An EnumDescriptor. z/Expected instance of descriptor.EnumDescriptor.N)r. r �EnumDescriptorr0 r r1 r2 r3 )r' Z enum_descr r r �AddEnumDescriptor� s z DescriptorPool.AddEnumDescriptorc C s$ t |tj�std��|| j|j< dS )z^Adds a ServiceDescriptor to the pool. Args: service_desc: A ServiceDescriptor. z2Expected instance of descriptor.ServiceDescriptor.N)r. r �ServiceDescriptorr0 r r1 )r' Z service_descr r r �AddServiceDescriptor� s z#DescriptorPool.AddServiceDescriptorc C s� t |tj�o|jstd��|jdkr0|| j|j< y| j|j |j }W n t k rZ Y n(X ||k r�t d|j|j|j j|j f ��|| j|j |j < || j |j |j< t|�r�|| j |j |jj< dS )a; Adds a FieldDescriptor describing an extension to the pool. Args: extension: A FieldDescriptor. Raises: AssertionError: when another extension with the same number extends the same message. TypeError: when the specified extension is not a descriptor.FieldDescriptor. z!Expected an extension descriptor.NzSExtensions "%s" and "%s" both try to extend message type "%s" with field number %d.)r. r r r r0 �extension_scoper! r1 r& r �number�KeyError�AssertionErrorr% r � message_type)r' � extensionZ existing_descr r r �AddExtensionDescriptor� s& z%DescriptorPool.AddExtensionDescriptorc C s | j |� dS )z�Adds a FileDescriptor to the pool, non-recursively. If the FileDescriptor contains messages or enums, the caller must explicitly register them. Args: file_desc: A FileDescriptor. N)r2 )r' � file_descr r r �AddFileDescriptor� s z DescriptorPool.AddFileDescriptorc C s$ t |tj�std��|| j|j< dS )z�Adds a FileDescriptor to the pool, non-recursively. If the FileDescriptor contains messages or enums, the caller must explicitly register them. Args: file_desc: A FileDescriptor. z/Expected instance of descriptor.FileDescriptor.N)r. r �FileDescriptorr0 r r )r' rA r r r r2 s z!DescriptorPool._AddFileDescriptorc C s� y | j | S tk r Y nX y| jj|�}W n: tk rj } z | jrV| jj|�}n|�W Y dd}~X nX |s|td| ��| j|�S )z�Gets a FileDescriptor by file name. Args: file_name: The path to the file to get a descriptor for. Returns: A FileDescriptor for the named file. Raises: KeyError: if the file cannot be found in the pool. NzCannot find a file named %s)r r< r �FindFileByNamer �!_ConvertFileProtoToFileDescriptor)r' � file_name� file_proto�errorr r r rD s z DescriptorPool.FindFileByNamec 3 C s t |�}y | j| jS tk r( Y nX y | j| jS tk rJ Y nX y | j| jS tk rl Y nX y | j|�S tk r� Y nX y | j| jS tk r� Y nX |jd�\}}}y | j |�}|j | s�t �|jS tk �r td| ��Y nX dS )a Gets the FileDescriptor for the file containing the specified symbol. Args: symbol: The name of the symbol to search for. Returns: A FileDescriptor that contains the specified symbol. Raises: KeyError: if the file cannot be found in the pool. r z Cannot find a file containing %sN) r r r3 r< r r � _FindFileContainingSymbolInDbr! � rpartition�FindMessageTypeByName�extensions_by_namer= )r' �symbol� message_name�_�extension_name�messager r r �FindFileContainingSymbol+ s8 z'DescriptorPool.FindFileContainingSymbolc C s& t |�}|| jkr | j|� | j| S )z�Loads the named descriptor from the pool. Args: full_name: The full name of the descriptor to load. Returns: The descriptor for the named type. Raises: KeyError: if the message cannot be found in the pool. )r r rI )r' r1 r r r rK [ s z$DescriptorPool.FindMessageTypeByNamec C s& t |�}|| jkr | j|� | j| S )z�Loads the named enum descriptor from the pool. Args: full_name: The full name of the enum descriptor to load. Returns: The enum descriptor for the named type. Raises: KeyError: if the enum cannot be found in the pool. )r r rI )r' r1 r r r �FindEnumTypeByNamem s z!DescriptorPool.FindEnumTypeByNamec C s, t |�}|jd�\}}}| j|�}|j| S )a Loads the named field descriptor from the pool. Args: full_name: The full name of the field descriptor to load. Returns: The field descriptor for the named field. Raises: KeyError: if the field cannot be found in the pool. r )r rJ rK Zfields_by_name)r' r1 rN rO Z field_name�message_descriptorr r r �FindFieldByName s z DescriptorPool.FindFieldByNamec C s, t |�}|jd�\}}}| j|�}|j| S )a Loads the named oneof descriptor from the pool. Args: full_name: The full name of the oneof descriptor to load. Returns: The oneof descriptor for the named oneof. Raises: KeyError: if the oneof cannot be found in the pool. r )r rJ rK Zoneofs_by_name)r' r1 rN rO Z oneof_namerT r r r �FindOneofByName� s z DescriptorPool.FindOneofByNamec C sp t |�}y | j| S tk r& Y nX |jd�\}}}y| j|�}W n tk rd | j|�}Y nX |j| S )a Loads the named extension descriptor from the pool. Args: full_name: The full name of the extension descriptor to load. Returns: A FieldDescriptor, describing the named extension. Raises: KeyError: if the extension cannot be found in the pool. r )r r! r< rJ rK rI rL )r' r1 rN rO rP �scoper r r �FindExtensionByName� s z"DescriptorPool.FindExtensionByNamec C s | j | | S )a� Gets the extension of the specified message with the specified number. Extensions have to be registered to this pool by calling AddExtensionDescriptor. Args: message_descriptor: descriptor of the extended message. number: integer, number of the extension field. Returns: A FieldDescriptor describing the extension. Raises: KeyError: when no extension with the given number is known for the specified message. )r& )r' rT r; r r r �FindExtensionByNumber� s z$DescriptorPool.FindExtensionByNumberc C s t | j| j� �S )a! Gets all the known extension of a given message. Extensions have to be registered to this pool by calling AddExtensionDescriptor. Args: message_descriptor: descriptor of the extended message. Returns: A list of FieldDescriptor describing the extensions. )�listr& �values)r' rT r r r �FindAllExtensions� s z DescriptorPool.FindAllExtensionsc C s& t |�}|| jkr | j|� | j| S )a Loads the named service descriptor from the pool. Args: full_name: The full name of the service descriptor to load. Returns: The service descriptor for the named service. Raises: KeyError: if the service cannot be found in the pool. )r r rI )r' r1 r r r �FindServiceByName� s z DescriptorPool.FindServiceByNamec C sf y| j j|�}W n: tk rJ } z | jr6| jj|�}n|�W Y dd}~X nX |s\td| ��| j|�S )a" Finds the file in descriptor DB containing the specified symbol. Args: symbol: The name of the symbol to search for. Returns: A FileDescriptor that contains the specified symbol. Raises: KeyError: if the file cannot be found in the descriptor database. Nz Cannot find a file containing %s)r rR r< r rE )r' rM rG rH r r r rI � s z,DescriptorPool._FindFileContainingSymbolInDbc s8 |j �jk�r,t�j|j��}�fdd�|jD �� � fdd�|jD �}tj�|j |j|j t |�|j � � |d�}i }xD|D ]<}|j �j t|jj� ��� |j dd� t|jj� �D �� qxW x0|jD ]&}�j||j|||j �}||j|j < q�W x*|jD ] } �j| |j|d|�|j| j < q�W x`t|j�D ]R\} } �j| |j| |dd �} �j|j| j|�| _�j| | |j|� | |j | j < �q"W x |jD ]} �j |j| |� �q�W |j�r�t |j�}nd }x,|jD ]"} �j|| j |�}||j| j < �q�W x4t|j �D ]&\} }�j || ||j|�|j!|j < �q�W �j"|� |�j|j < �j|j S ) aD Creates a FileDescriptor from a proto or returns a cached copy. This method also has the side effect of loading all the symbols found in the file into the appropriate dictionaries in the pool. Args: file_proto: The proto to convert. Returns: A FileDescriptor matching the passed in proto. c s g | ]}� j |��qS r )rD )�.0�n)r' r r � <listcomp> s zDDescriptorPool._ConvertFileProtoToFileDescriptor.<locals>.<listcomp>c s g | ] }� | �qS r r )r^ �i)� direct_depsr r r` s )Zpoolr �package�syntaxr Z serialized_pb� dependenciesZpublic_dependenciesc s s | ]}t |j�|fV qd S )N)�_PrefixWithDotr1 )r^ �enumr r r � <genexpr>, s zCDescriptorPool._ConvertFileProtoToFileDescriptor.<locals>.<genexpr>NT)r � )#r r rZ �_GetDeps� dependencyZpublic_dependencyr rC rc rd r ZSerializeToString�update�_ExtractSymbolsZmessage_types_by_namer[ Zenum_types_by_namer> �_ConvertMessageDescriptor� enum_type�_ConvertEnumDescriptor� enumerater? �_MakeFieldDescriptor�_GetTypeFromScope�extendeer � _SetFieldTyperL �_SetAllFieldTypesrf Zservice�_MakeServiceDescriptorZservices_by_namer) )r' rG Z built_depsZ public_depsZfile_descriptorrW rk r> Z message_descro �index�extension_proto�extension_desc� desc_protoZdesc_proto_prefixr4 � service_protor )rb r' r rE sf z0DescriptorPool._ConvertFileProtoToFileDescriptorc s� |rdj ||jf�� n|j� �dkr*d}n�j}�dkr<i �� ����fdd�|jD �}� ���fdd�|jD �}� ��fdd�t|j�D �} � ��fdd�t|j�D �} � fdd�t|j�D �} d d� |jD �} | r�d } nd } t j |j� |d| | ||| t |�| | �dd�d �}x|j D ] }||_ �qW x|jD ] }||_ �q0W xLt|j�D ]>\}}|jd ��rL|j}| | jj| | � | | | | _�qLW |�t� �< |�j� < |S )a� Adds the proto to the pool in the specified package. Args: desc_proto: The descriptor_pb2.DescriptorProto protobuf message. package: The package the proto should be located in. file_desc: The file containing this message. scope: Dict mapping short and full symbols to message and enum types. syntax: string indicating syntax of the file ("proto2" or "proto3") Returns: The added descriptor. r Nc s g | ]}�j |� �����qS r )rn )r^ �nested)� desc_namerA rW r' rd r r r` z s z<DescriptorPool._ConvertMessageDescriptor.<locals>.<listcomp>c s g | ]}�j |� �d ���qS )N)rp )r^ rg )r~ rA rW r' r r r` ~ s c s g | ]\}}�j |� |���qS r )rr )r^ rx r )r~ rA r' r r r` � s c s$ g | ] \}}�j |� |�d d��qS )T)r )rr )r^ rx r? )r~ rA r' r r r` � s c s4 g | ],\}}t j|jd j� |jf�|dg |j��qS )r N)r ZOneofDescriptorr �joinr )r^ rx r4 )r~ r r r` � s c S s g | ]}|j |jf�qS r )�start�end)r^ �rr r r r` � s TF)r r1 �filenamer �fields�oneofs� nested_types� enum_types� extensionsr � is_extendable�extension_rangesr3 Zserialized_startZserialized_endrd � oneof_index)r r � nested_typero rq r r? Z oneof_declZextension_ranger r/ r r� r r� r r� r� �appendZcontaining_oneofrf r )r' r{ rc rA rW rd rF r} Zenumsr� r� r� r� r� r4 rg Z field_index� field_descr� r )r~ rA rW r' rd r rn ] sf z(DescriptorPool._ConvertMessageDescriptorc s� |rdj ||jf�}n|j}|dkr*d}n|j}� fdd�t|j�D �}tj|j|||||t|�d�} | |d| < | � j|< | S )a� Make a protobuf EnumDescriptor given an EnumDescriptorProto protobuf. Args: enum_proto: The descriptor_pb2.EnumDescriptorProto protobuf message. package: Optional package name for the new message EnumDescriptor. file_desc: The file containing the enum descriptor. containing_type: The type containing this enum. scope: Scope containing available types. Returns: The added descriptor r Nc s g | ]\}}� j ||��qS r )�_MakeEnumValueDescriptor)r^ rx �value)r' r r r` � s z9DescriptorPool._ConvertEnumDescriptor.<locals>.<listcomp>)r r1 r� r3 r[ r r z.%s)r r rq r� r r6 r r ) r' Z enum_protorc rA r rW Z enum_namerF r[ r4 r )r' r rp � s$ z%DescriptorPool._ConvertEnumDescriptorFc C sR |rdj ||jf�}n|j}tj|j|||j|jdddd|jdd|dt|�|d�S )a� Creates a field descriptor from a FieldDescriptorProto. For message and enum type fields, this method will do a look up in the pool for the appropriate descriptor for that type. If it is unavailable, it will fall back to the _source function to create it. If this type is still unavailable, construction will fail. Args: field_proto: The proto describing the field. message_name: The name of the containing message. index: Index of the field file_desc: The file containing the field descriptor. is_extension: Indication that this field is for an extension. Returns: An initialized FieldDescriptor object r NF)r r1 rx r; r �cpp_typer> ro r r �has_default_value� default_valuer r: r r3 )r r r r r; r r r )r' � field_protorN rx rA r r1 r r r rr � s( z#DescriptorPool._MakeFieldDescriptorc C s� t |�}| j||j|�}|dkr,t |j�}ndj||jg�}x*t|j|j�D ]\}}| j||||� qLW x@tt|j |j ��D ]*\}} | j||j |�| _ | j|| ||� q|W x |j D ]} | j|| |� q�W dS )a Sets all the descriptor's fields's types. This method also sets the containing types on any extensions. Args: package: The current package of desc_proto. desc_proto: The message descriptor to update. scope: Enclosing scope of available types. r N)rf rs r r �zipr r� ru rZ r? r� rt r r� rv ) r' rc r{ rW Z main_descZnested_packager� r� ry rz r� r r r rv s z DescriptorPool._SetAllFieldTypesc C s |j r| j||j |�}nd}|jd�sHt|tj�r>tjj|_n tjj |_tjj |j�|_ |jtjjkst|jtjj krz||_ |jtjj kr�||_|jtjjkr�d|_g |_�nh|jd��rvd|_|jtjjks�|jtjjkr�t|j�|_n�|jtjjk�r|j|_nr|jtjjk�r$|jj� dk|_nP|jtjj k�rH|jj|j j|_n,|jtjjk�rht j |j�|_n t |j�|_n�d|_|jtjjk�s�|jtjjk�r�d|_np|jtjjk�r�d|_nX|jtjjk�r�d|_n@|jtjj k�r�|jj d j|_n |jtjjk�rd |_nd |_|j|_dS ) a Sets the field's type, cpp_type, message_type and enum_type. Args: field_proto: Data about the field in proto format. field_desc: The descriptor to modiy. package: The package the field's container is in. scope: Enclosing scope of available types. Nr Fr� T�trueg ri r � ) � type_namers r r. r r/ r r r Z TYPE_ENUMZProtoTypeToCppProtoTyper� Z TYPE_GROUPr> ro r ZLABEL_REPEATEDr� r� Z TYPE_DOUBLEZ TYPE_FLOAT�floatZ TYPE_STRINGZ TYPE_BOOL�lowerZvalues_by_namer; Z TYPE_BYTESr Z CUnescape�intr[ )r' r� r� rc rW r4 r r r ru s^ z DescriptorPool._SetFieldTypec C s t j|j||jt|�dd�S )z�Creates a enum value descriptor object from a enum value proto. Args: value_proto: The proto describing the enum value. index: The index of the enum value. Returns: An initialized EnumValueDescriptor object. N)r rx r; r r )r ZEnumValueDescriptorr r; r )r' Z value_protorx r r r r� f s z'DescriptorPool._MakeEnumValueDescriptorc sd � rdj � |jf��n|j�� ���fdd�t|j�D �}tj|j�||t|�|d�}|�j�< |S )a� Make a protobuf ServiceDescriptor given a ServiceDescriptorProto. Args: service_proto: The descriptor_pb2.ServiceDescriptorProto protobuf message. service_index: The index of the service in the File. scope: Dict mapping short and full symbols to message and enum types. package: Optional package name for the new message EnumDescriptor. file_desc: The file containing the service descriptor. Returns: The added descriptor. r c s" g | ]\}}�j |�� �|��qS r )�_MakeMethodDescriptor)r^ rx � method_proto)rc rW r' � service_namer r r` � s z9DescriptorPool._MakeServiceDescriptor.<locals>.<listcomp>)r r1 rx �methodsr r3 )r r rq �methodr r8 r r )r' r| Z service_indexrW rc rA r� r4 r )rc rW r' r� r rw x s z%DescriptorPool._MakeServiceDescriptorc C sN dj ||jf�}| j||j|�}| j||j|�}tj|j||d||t|�d�S )a� Creates a method descriptor from a MethodDescriptorProto. Args: method_proto: The proto describing the method. service_name: The name of the containing service. package: Optional package name to look up for types. scope: Scope containing available types. index: Index of the method in the service. Returns: An initialized MethodDescriptor object. r N)r r1 rx Zcontaining_service� input_type� output_typer )r r rs r� r� r ZMethodDescriptorr ) r' r� r� rc rW rx r1 r� r� r r r r� � s z$DescriptorPool._MakeMethodDescriptorc c s^ xX|D ]P}t |j�|fV x| j|j�D ] }|V q(W x |jD ]}t |j�|fV q>W qW dS )z�Pulls out all the symbols from descriptor protos. Args: descriptors: The messages to extract descriptors from. Yields: A two element tuple of the type name and descriptor object. N)rf r1 rm r� r� )r' Z descriptorsr4 rM rg r r r rm � s z DescriptorPool._ExtractSymbolsc c s8 x2|D ]*}| j |�}|V x|jD ] }|V q"W qW dS )z�Recursively finds dependencies for file protos. Args: dependencies: The names of the files being depended on. Yields: Each direct and indirect dependency. N)rD re )r' re rk Zdep_descZ parent_depr r r rj � s zDescriptorPool._GetDepsc C sR ||krJt |�jd�}x2|rHdj||g �}||kr<|}P q|jd� qW || S )a? Finds a given type name in the current scope. Args: package: The package the proto should be located in. type_name: The name of the type to be found in the scope. scope: Dict mapping short and full symbols to message and enum types. Returns: The descriptor for the requested type. r � ���)rf �splitr �pop)r' rc r� rW Z componentsZpossible_matchr r r rs � s z DescriptorPool._GetTypeFromScope)N)N)NNNN)NNNN)F)&�__name__� __module__� __qualname__�__doc__�_USE_C_DESCRIPTORSr r( r) r- r5 r7 r9 r@ rB r2 rD rR rK rS rU rV rX rY r\ r] rI rE rn rp rr rv ru r� rw r� rm rj rs r r r r r e sJ * 0 U P & + F r c C s | j d�r| S d| S )Nr z.%s)� startswith)r r r r rf � s rf c C s t S )N)�_DEFAULTr r r r �Default� s r� )r� � __author__r" r, r r r r� r r r �objectr rf r Z default_poolr� r� r r r r �<module>8 s,
Save File
Cancel