3
SLj @ 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 dS )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 dr| 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_extensioncontaining_typeZ has_optionsZ
GetOptionsZmessage_set_wire_formattyper FieldDescriptor TYPE_MESSAGElabelZLABEL_OPTIONAL)fieldr r r _IsMessageSetExtension] s
r c @ s& e Zd ZdZerdFddZdGddZdd 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/d0ZdId1d2Z dJd4d5Z d6d7 Z d8d9 Z d:d; Z dd? Z"d@dA Z#dBdC Z$dDdE Z%dS )KDescriptorPoolzGA 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 defaultdictdict_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 )zAdds 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 |tjstd|| 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_AddFileDescriptorfile)r' descr r r
AddDescriptor s
z DescriptorPool.AddDescriptorc C s0 t |tjstd|| j|j< | j|j dS )zAdds 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 |tjstd|| 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 |tjo|jstd|jdkr0|| j|j< y| j|j |j
}W n t k
rZ Y n(X ||k rt 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 numberKeyErrorAssertionErrorr% r message_type)r' extensionZ
existing_descr r r AddExtensionDescriptor s&
z%DescriptorPool.AddExtensionDescriptorc C s | j | dS )zAdds 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 |tjstd|| j|j< dS )zAdds 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 )zGets 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_protoerrorr 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
| st |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!
rpartitionFindMessageTypeByNameextensions_by_namer= )r' symbol message_name_extension_namemessager r r FindFileContainingSymbol+ s8
z'DescriptorPool.FindFileContainingSymbolc C s& t |}|| jkr | j| | j| S )zLoads 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 )zLoads 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_namemessage_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
s0 |j jkr$tj|j}fdd|jD fdd|jD }tj|j |j|j t
||j |d}i }x<|D ]4}|j j
|jj |j dd |jj D qxW x0|jD ]&}j||j|||j }||j|j < qW x*|jD ] } j| |j|d||j| j < qW x`t|jD ]R\}
} j| |j|
|dd } j|j| j|| _j| | |j| | |j | j < qW x |jD ]}
j |j|
| qxW |jrt |j}nd
}x,|jD ]"}
j||
j |}||j|
j < qW x4t|j D ]&\}
}j ||
||j||j!|j < qW 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 ).0n)r' r r
s zDDescriptorPool._ConvertFileProtoToFileDescriptor..c s g | ] } | qS r r )r^ i) direct_depsr r r` s )Zpoolr packagesyntaxr Z
serialized_pb dependenciesZpublic_dependenciesc s s | ]}t |j|fV qd S )N)_PrefixWithDotr1 )r^ enumr r r , s zCDescriptorPool._ConvertFileProtoToFileDescriptor..NT)r )#r r rZ _GetDeps
dependencyZpublic_dependencyr rC rc rd r
ZSerializeToStringupdate_ExtractSymbolsZmessage_types_by_namer[ Zenum_types_by_namer> _ConvertMessageDescriptor enum_type_ConvertEnumDescriptor enumerater? _MakeFieldDescriptor_GetTypeFromScopeextendeer
_SetFieldTyperL _SetAllFieldTypesrf Zservice_MakeServiceDescriptorZservices_by_namer) )r' rG Z
built_depsZ public_depsZfile_descriptorrW rk r> Z message_descro indexextension_protoextension_desc
desc_protoZdesc_proto_prefixr4
service_protor )rb r' r rE sf
z0DescriptorPool._ConvertFileProtoToFileDescriptorc s |rdj ||jf n|j dkr*d}nj}dkr\}}|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.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 dqS )T)r )rr )r^ rx r? )r~ rA r' r r r` s c s4 g | ],\}}t j|jd j |jf|dg |jqS )r N)r ZOneofDescriptorr joinr )r^ rx r4 )r~ r r r` s c S s g | ]}|j |jfqS r )startend)r^ rr r r r` s TF)r r1 filenamer fieldsoneofs nested_types
enum_types
extensionsr
is_extendableextension_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} fddt|jD }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..)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||dS )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|jD ]\}}| j|||| qLW xtjj|_n
tjj |_tjj
|j|_ |jtjjkst|jtjj krz||_
|jtjj kr||_|jtjjkrd|_g |_nh|jdrvd|_|jtjjks|jtjjkrt|j|_n|jtjjkr|j|_nr|jtjjkr$|jj dk|_nP|jtjj krH|jj|j j|_n,|jtjjkrht j |j|_n t |j|_nd|_|jtjjks|jtjjkrd|_np|jtjjkrd|_nX|jtjjkrd|_n@|jtjj kr|jj d j|_n |jtjjkrd
|_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 Ttrueg 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_FLOATfloatZ TYPE_STRINGZ TYPE_BOOLlowerZvalues_by_namer; Z
TYPE_BYTESr Z CUnescapeintr[ )r' r r rc rW r4 r r r ru s^
z DescriptorPool._SetFieldTypec C s t j|j||jt|ddS )zCreates 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 |jfn|j fddt|jD }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..)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|dS )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|jD ]
}|V q(W x |jD ]}t |j|fV q>W qW dS )zPulls 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 )zRecursively 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 dr| 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 8 s,