U EZhz@sdZddlmZddlmZmZddlmZddlm Z ddl m Z m Z ddl mZmZmZeZGdd d eZGd d d eZGd d d eZGdddeZGdddeZGdddZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZ Gd d!d!eZ!Gd"d#d#Z"Gd$d%d%Z#Gd&d'd'Z$Gd(d)d)Z%Gd*d+d+Z&Gd,d-d-Z'd.S)/z-Abstractions to interact with service models.) defaultdict) NamedTupleUnion)resolve_auth_type) OrderedDict)MissingServiceIdErrorUndefinedModelAttributeError)CachedPropertyhyphenize_service_idinstance_cachec@s eZdZdS)NoShapeFoundErrorN__name__ __module__ __qualname__rrU/home/aprabhat/apps/x.techxrdev.in/venv/lib/python3.8/site-packages/botocore/model.pyr sr c@s eZdZdS)InvalidShapeErrorNr rrrrr!src@s eZdZdS)OperationNotFoundErrorNr rrrrr%src@s eZdZdS)InvalidShapeReferenceErrorNr rrrrr)src@seZdZddZdS) ServiceIdcCst|SN)r selfrrr hyphenize.szServiceId.hyphenizeN)rrrrrrrrr-src@seZdZdZdddddddd d d d d dddddgZddddddddddddddd d!gZeZd1d#d$Ze d%d&Z e d'd(Z e d)d*Z d+d,Z d-d.Zed/d0Zd"S)2Shapez3Object representing a shape from the service model. locationNameZ queryNameZ flattenedlocationpayloadZ streamingZtimestampFormatZ xmlNamespaceZ resultWrapperZ xmlAttribute eventstreameventZ eventheaderZ eventpayloadZ jsonvalueZ hostLabelrequiredminmaxpatternZ sensitiveenumidempotencyTokenerror exceptionZendpointdiscoveryidZ retryabledocumentunion contextParamclientContextParamsZrequiresLengthNcCsB||_|d|_|dd|_||_|dkr2t}||_i|_dS)a  :type shape_name: string :param shape_name: The name of the shape. :type shape_model: dict :param shape_model: The shape model. This would be the value associated with the key in the "shapes" dict of the service model (i.e ``model['shapes'][shape_name]``) :type shape_resolver: botocore.model.ShapeResolver :param shape_resolver: A shape resolver object. This is used to resolve references to other shapes. For scalar shape types (string, integer, boolean, etc.), this argument is not required. If a shape_resolver is not provided for a complex type, then a ``ValueError`` will be raised when an attempt to resolve a shape is made. type documentationN)name type_namegetr. _shape_modelUnresolvableShapeMap_shape_resolver_cache)r shape_name shape_modelshape_resolverrrr__init__`s zShape.__init__cCsF|j}i}|jD]}||jkr||||<qd|krB|d|d<|S)aSerialization information about the shape. This contains information that may be needed for input serialization or response parsing. This can include: * name * queryName * flattened * location * payload * streaming * xmlNamespace * resultWrapper * xmlAttribute * jsonvalue * timestampFormat :rtype: dict :return: Serialization information about the shape. rr0)r3SERIALIZED_ATTRSpop)rmodel serializationattrrrrr>s  zShape.serializationcCs0|j}i}|jD]}||jkr||||<q|S)aMetadata about the shape. This requires optional information about the shape, including: * min * max * pattern * enum * sensitive * required * idempotencyToken * document * union * contextParam * clientContextParams * requiresLength :rtype: dict :return: Metadata about the shape. )r3METADATA_ATTRS)rr=metadatar?rrrrAs   zShape.metadatacCs|jdgS)zA list of members that are required. A structure shape can define members that are required. This value will return a list of required members. If there are no required members an empty list is returned. r!rAr2rrrrrequired_memberss zShape.required_memberscCs |j|Srr5resolve_shape_refr shape_refrrr_resolve_shape_refszShape._resolve_shape_refcCsd|jjd|jdS)N<(z)> __class__rr0rrrr__repr__szShape.__repr__cCsdSrrrrrrevent_stream_nameszShape.event_stream_name)N)rrr__doc__r;r@rMAP_TYPEr:r r>rArCrHrMpropertyrNrrrrr2s` "   rc@sHeZdZeddZeddZeddZeddZed d Zd S) StructureShapecCs>|jd|}|}|D]\}}||||<q"|S)Nmembers)r3r2rPitemsrH)rrSZ shape_membersr0rGrrrrSs zStructureShape.memberscCs,|jD]\}}|jdr |Sq dS)Nr)rSrTr>r2)r member_namememberrrrrNs  z StructureShape.event_stream_namecCs8|jddsdS|jdi}|d}|r2|S|jS)Nr(Fr'code)rAr2r0)rZerror_metadatarWrrr error_codes zStructureShape.error_codecCs|jddS)Nr)FrBrrrris_document_typeszStructureShape.is_document_typecCs|jddS)Nr*FrBrrrris_tagged_unionszStructureShape.is_tagged_unionN) rrrr rSrNrXrYrZrrrrrRs    rRc@seZdZeddZdS) ListShapecCs||jdS)NrVrHr3rrrrrVszListShape.memberN)rrrr rVrrrrr[sr[c@s$eZdZeddZeddZdS)MapShapecCs||jdS)Nkeyr\rrrrr^sz MapShape.keycCs||jdS)Nvaluer\rrrrr_ szMapShape.valueN)rrrr r^r_rrrrr]s r]c@seZdZeddZdS) StringShapecCs|jdgS)Nr%rBrrrrr%szStringShape.enumN)rrrr r%rrrrr`sr`c@s&eZdZUeed<eeefed<dS)StaticContextParameterr0r_N)rrrstr__annotations__rboolrrrrras rac@seZdZUeed<eed<dS)ContextParameterr0rUNrrrrbrcrrrrres rec@s&eZdZUeed<eed<eed<dS)ClientContextParameterr0r-r.Nrfrrrrrg!s rgc@s*eZdZdZd4ddZd5ddZddZed d Zd d Z ed dZ eddZ e ddZ eddZeddZeddZeddZeddZeddZedd Zed!d"Zed#d$Zed%d&Zed'd(Zed)d*Zd+d,Zed-d.Zejd/d.Zed0d1Zd2d3ZdS)6 ServiceModelzQ :ivar service_description: The parsed service description dictionary. NcCs<||_|di|_t|di|_t|_||_i|_dS)a :type service_description: dict :param service_description: The service description model. This value is obtained from a botocore.loader.Loader, or from directly loading the file yourself:: service_description = json.load( open('/path/to/service-description-model.json')) model = ServiceModel(service_description) :type service_name: str :param service_name: The name of the service. Normally this is the endpoint prefix defined in the service_description. However, you can override this value to provide a more convenient name. This is done in a few places in botocore (ses instead of email, emr instead of elasticmapreduce). If this value is not provided, it will default to the endpointPrefix defined in the model. rAshapesN) _service_descriptionr2rA ShapeResolverr5NOT_SET_signature_version _service_nameZ_instance_cache)rZservice_description service_namerrrr:.s zServiceModel.__init__cCs|j||Sr)r5get_shape_by_namerr7 member_traitsrrr shape_forMszServiceModel.shape_forcCs|j|dSr)_error_code_cacher2)rrXrrrshape_for_error_codeRsz!ServiceModel.shape_for_error_codecCs"i}|jD]}|j}|||<q |Sr) error_shapesrX)rZerror_code_cache error_shaperWrrrrtUs   zServiceModel._error_code_cachecCs |j|SrrDrFrrrrE]szServiceModel.resolve_shape_refcCst|jdiS)Nrilistrjr2rrrr shape_names`szServiceModel.shape_namescCs6g}|jD]&}||}|jddr ||q |S)Nr(F)rzrsrAr2append)rrvr7rwrrrrvds    zServiceModel.error_shapescCs<z|jd|}Wntk r.t|YnXt|||SN operations)rjKeyErrorrOperationModel)rZoperation_namer=rrroperation_modelms zServiceModel.operation_modelcCs|jddSNr.r/)rjr2rrrrr.uszServiceModel.documentationcCst|jdgSr|rxrrrroperation_namesyszServiceModel.operation_namescCs|jdk r|jS|jSdS)aThe name of the service. This defaults to the endpointPrefix defined in the service model. However, this value can be overriden when a ``ServiceModel`` is created. If a service_name was not provided when the ``ServiceModel`` was created and if there is no endpointPrefix defined in the service model, then an ``UndefinedModelAttributeError`` exception will be raised. N)rnendpoint_prefixrrrrro}s zServiceModel.service_namecCs6zt|dWStk r0t|jdYnXdS)NZ serviceId)ro)r_get_metadata_propertyrrrnrrrr service_idszServiceModel.service_idcCs|jd}|dkr|j}|S)zThe name to use when computing signatures. If the model does not define a signing name, this value will be the endpoint prefix defined in the model. Z signingNameN)rAr2r)r signing_namerrrrs zServiceModel.signing_namecCs |dS)NZ apiVersionrrrrr api_versionszServiceModel.api_versioncCs |dS)NprotocolrrrrrrszServiceModel.protocolcCs |dS)N protocolsrrrrrrszServiceModel.protocolscCs |dS)NZendpointPrefixrrrrrrszServiceModel.endpoint_prefixcCs(|jD]}||}|jr|SqdSr)rris_endpoint_discovery_operationrZ operationr=rrrendpoint_discovery_operations  z)ServiceModel.endpoint_discovery_operationcCs6|jD]*}||}|jdk r|jdrdSqdS)Nr!TF)rrendpoint_discoveryr2rrrrendpoint_discovery_requireds   z(ServiceModel.endpoint_discovery_requiredcCs |jdi}dd|DS)Nr,cSs&g|]\}}t||d|ddqS)r-r.)r0r-r.)rg).0 param_nameZ param_valrrr s z:ServiceModel.client_context_parameters..)rjr2rTrparamsrrrclient_context_parameterssz&ServiceModel.client_context_parameterscCs:z |j|WStk r4td|d|YnXdS)N"z," not defined in the metadata of the model: )rAr~rrr0rrrrs  z#ServiceModel._get_metadata_propertycCs"|jtkr|jd}||_|jS)NZsignatureVersion)rmrlrAr2)rsignature_versionrrrrs  zServiceModel.signature_versioncCs ||_dSr)rm)rr_rrrrscCs d|jkS)NZawsQueryCompatiblerArrrris_query_compatiblesz ServiceModel.is_query_compatiblecCs|jjd|jdS)NrJ))rLrrorrrrrMszServiceModel.__repr__)N)N) rrrrOr:rsrur rtrErzrvr rr.rrorrrrrrrrrrrQrsetterrrMrrrrrh'sZ                      rhc@seZdZdFddZeddZeddZedd Zed d Z ed d Z eddZ eddZ eddZ eddZeddZeddZeddZeddZeddZed d!Zed"d#Zed$d%Zed&d'Zed(d)Zed*d+Zed,d-Zed.d/Zed0d1Zed2d3Zd4d5Zd6d7Zd8d9Z ed:d;Z!edd?Z#d@dAZ$dBdCZ%dDdEZ&dS)GrNcCs8||_||_||_|d|_|j|_|di|_dS)a :type operation_model: dict :param operation_model: The operation model. This comes from the service model, and is the value associated with the operation name in the service model (i.e ``model['operations'][op_name]``). :type service_model: botocore.model.ServiceModel :param service_model: The service model associated with the operation. :type name: string :param name: The operation name. This is the operation name exposed to the users of this model. This can potentially be different from the "wire_name", which is the operation name that *must* by provided over the wire. For example, given:: "CreateCloudFrontOriginAccessIdentity":{ "name":"CreateCloudFrontOriginAccessIdentity2014_11_06", ... } The ``name`` would be ``CreateCloudFrontOriginAccessIdentity``, but the ``self.wire_name`` would be ``CreateCloudFrontOriginAccessIdentity2014_11_06``, which is the value we must send in the corresponding HTTP request. r0httpN)_operation_model_service_model _api_namer2Z _wire_namerAr)rr service_modelr0rrrr:s  zOperationModel.__init__cCs|jdk r|jS|jSdSr)r wire_namerrrrr0s zOperationModel.namecCs |jdS)aRThe wire name of the operation. In many situations this is the same value as the ``name``, value, but in some services, the operation name exposed to the user is different from the operation name we send across the wire (e.g cloudfront). Any serialization code should use ``wire_name``. r0rr2rrrrrs zOperationModel.wire_namecCs|jSr)rrrrrr(szOperationModel.service_modelcCs|jddSrrrrrrr.,szOperationModel.documentationcCs|jddS)N deprecatedFrrrrrr0szOperationModel.deprecatedcCs|jddS)NZendpointdiscoveryrrrrrr4sz!OperationModel.endpoint_discoverycCs|jddS)NZendpointoperationFrrrrrr:sz.OperationModel.is_endpoint_discovery_operationcCs d|jkrdS|j|jdS)NinputrrrErrrr input_shape>s  zOperationModel.input_shapecCs d|jkrdS|j|jdS)Noutputrrrrr output_shapeHs  zOperationModel.output_shapecCs"|j}|sgSdd|jDS)NcSs(g|] \}}d|jkr|jdr|qS)r&rrr0shaperrrrYs  z5OperationModel.idempotent_members..rrSrT)rrrrridempotent_membersSs z!OperationModel.idempotent_memberscCs |jdi}dd|DS)NZstaticContextParamscSs"g|]\}}t||ddqS)r_)r0r_)rar2)rr0propsrrrrcsz.)rr2rTrrrrstatic_context_parameters`sz(OperationModel.static_context_parameterscCs |js gSdd|jjDS)NcSs>g|]6\}}d|jkrd|jdkrt|jdd|dqS)r+r0)r0rU)rArerrrrrms  z5OperationModel.context_parameters..rrrrrcontext_parametershs  z!OperationModel.context_parameterscCs|jdgS)NZoperationContextParamsrrrrroperation_context_parameterswsz+OperationModel.operation_context_parameterscCs |jdS)NZrequestcompressionrrrrrrequest_compression{sz"OperationModel.request_compressioncCs |jdS)NauthrrrrrrszOperationModel.authcCs |jdS)NZauthtyperrrrr auth_typeszOperationModel.auth_typecCs|jrt|jS|jSr)rrrrrrrresolved_auth_types z!OperationModel.resolved_auth_typecCs |jdS)NZunsignedPayloadrrrrrunsigned_payloadszOperationModel.unsigned_payloadcs$jdg}tfdd|DS)Nerrorsc3s|]}j|VqdSr)rrE)rsrrr sz.OperationModel.error_shapes..)rr2ry)rrirrrrvszOperationModel.error_shapescCs |jdS)NendpointrrrrrrszOperationModel.endpointcCs|jddS)NZhttpChecksumRequiredFrrrrrhttp_checksum_requiredsz%OperationModel.http_checksum_requiredcCs|jdiS)NZ httpChecksumrrrrr http_checksumszOperationModel.http_checksumcCs |dk Sr)get_event_stream_inputrrrrhas_event_stream_inputsz%OperationModel.has_event_stream_inputcCs |dk Sr)get_event_stream_outputrrrrhas_event_stream_outputsz&OperationModel.has_event_stream_outputcCs ||jSr)_get_event_streamrrrrrrsz%OperationModel.get_event_stream_inputcCs ||jSr)rrrrrrrsz&OperationModel.get_event_stream_outputcCs$|dkr dS|j}|r |j|SdS)zAReturns the event stream member's shape if any or None otherwise.N)rNrS)rrZ event_namerrrrs  z OperationModel._get_event_streamcCs |dk Sr)get_streaming_inputrrrrhas_streaming_inputsz"OperationModel.has_streaming_inputcCs |dk Sr)get_streaming_outputrrrrhas_streaming_outputsz#OperationModel.has_streaming_outputcCs ||jSr)_get_streaming_bodyrrrrrrsz"OperationModel.get_streaming_inputcCs ||jSr)rrrrrrrsz#OperationModel.get_streaming_outputcCs<|dkr dS|jd}|dk r8|j|}|jdkr8|SdS)z?Returns the streaming member's shape if any; or None otherwise.Nrblob)r>r2rSr1)rrrZ payload_shaperrrrs   z"OperationModel._get_streaming_bodycCs|jjd|jdS)Nz(name=rrKrrrrrMszOperationModel.__repr__)N)'rrrr:r r0rQrrr.rrrrrrrrrrrrrrrvrrrrrrrrrrrrrrMrrrrrsx %                            rc@s8eZdZdZeeeedZddZ d ddZ dd Z dS) rkzResolves shape references.) structurerymapstringcCs||_i|_dSr) _shape_mapZ _shape_cache)r shape_maprrrr:szShapeResolver.__init__NcCsz|j|}Wntk r*t|YnXz|j|dt}Wn"tk rdtd|YnX|r||}||||||}|S)Nr-z&Shape is missing required key 'type': ) rr~r SHAPE_CLASSESr2rrcopyupdate)rr7rrr8Z shape_clsresultrrrrps   zShapeResolver.get_shape_by_namecCslt|dkr"d|kr"||dS|}z|d}Wn"tk rZtd|YnX|||SdS)Nrz(Invalid model, missing shape reference: )lenrprr<r~r)rrGrrr7rrrrEs zShapeResolver.resolve_shape_ref)N) rrrrOrRr[r]r`rr:rprErrrrrks rkc@s"eZdZdZdddZddZdS)r4zEA ShapeResolver that will throw ValueErrors when shapes are resolved.NcCstd|ddS)NzAttempted to lookup shape '!', but no shape map was provided. ValueErrorrqrrrrps z&UnresolvableShapeMap.get_shape_by_namecCstd|ddS)NzAttempted to resolve shape 'rrrFrrrrEs z&UnresolvableShapeMap.resolve_shape_ref)N)rrrrOrprErrrrr4 s r4c@sfeZdZdZdZdddZddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ ddZdS)DenormalizedStructureBuilderaBuild a StructureShape from a denormalized model. This is a convenience builder class that makes it easy to construct ``StructureShape``s based on a denormalized model. It will handle the details of creating unique shape names and creating the appropriate shape map needed by the ``StructureShape`` class. Example usage:: builder = DenormalizedStructureBuilder() shape = builder.with_members({ 'A': { 'type': 'structure', 'members': { 'B': { 'type': 'structure', 'members': { 'C': { 'type': 'string', } } } } } }).build_model() # ``shape`` is now an instance of botocore.model.StructureShape :type dict_type: class :param dict_type: The dictionary type to use, allowing you to opt-in to using OrderedDict or another dict type. This can be particularly useful for testing when order matters, such as for documentation. ) rintegerbooleanrfloat timestamplongdoublecharNcCs*t|_t|_|dkr&|jd|_dS)Nr)rrSShapeNameGenerator_name_generatornew_shape_namer0rrrrr:Lsz%DenormalizedStructureBuilder.__init__cCs ||_|S)zp :type members: dict :param members: The denormalized members. :return: self )_members)rrSrrr with_membersRs z)DenormalizedStructureBuilder.with_memberscCsBt}d|jd}||||jt|d}t|j||j|dS)zBuild the model based on the provided members. :rtype: botocore.model.StructureShape :return: The built StructureShape object. r)r-rS)r)r7r8r9)rr _build_modelr0rkrR)rriZ denormalizedresolverrrr build_model^s z(DenormalizedStructureBuilder.build_modelcCs|ddkr|||||<nl|ddkr<|||||<nN|ddkrZ|||||<n0|d|jkrx||||<ntd|ddS)Nr-rryrzUnknown shape type: )_build_structure _build_list _build_map SCALAR_TYPES _build_scalarr)rr=rir7rrrrrs   z)DenormalizedStructureBuilder._build_modelcCs\t}||}||d<|dtD],\}}||}d|i||<||||q*|S)NrSr)r_build_initial_shaper2rT_get_shape_namer)rr=rirSrr0Z member_modelmember_shape_namerrrr~s   z-DenormalizedStructureBuilder._build_structurecCs6||}||}d|i|d<||d|||S)NrrVrrr)rr=rirrrrrrs    z(DenormalizedStructureBuilder._build_listcCsf||d}||d}||}d|i|d<d|i|d<||d||||d|||S)Nr^r_rr)rr=riZkey_shape_nameZvalue_shape_namerrrrrs   z'DenormalizedStructureBuilder._build_mapcCsDd|di}d|kr |d|d<tjD]}||kr&||||<q&|S)Nr-r.)rr@)rr=rr?rrrrs  z1DenormalizedStructureBuilder._build_initial_shapecCs ||Sr)rrr=rrrrsz*DenormalizedStructureBuilder._build_scalarcCs$d|kr|dS|j|dSdS)Nr7r-)rrrrrrrsz,DenormalizedStructureBuilder._get_shape_name)N)rrrrOrr:rrrrrrrrrrrrrrs$      rc@s eZdZdZddZddZdS)rzGenerate unique shape names for a type. This class can be used in conjunction with the DenormalizedStructureBuilder to generate unique shape names for a given type. cCstt|_dSr)rint _name_cacherrrrr:szShapeNameGenerator.__init__cCs.|j|d7<|j|}|d|S)aGenerate a unique shape name. This method will guarantee a unique shape name each time it is called with the same type. :: >>> s = ShapeNameGenerator() >>> s.new_shape_name('structure') 'StructureType1' >>> s.new_shape_name('structure') 'StructureType2' >>> s.new_shape_name('list') 'ListType1' >>> s.new_shape_name('list') 'ListType2' :type type_name: string :param type_name: The type name (structure, list, map, string, etc.) :rtype: string :return: A unique shape name for the given type rType)r capitalize)rr1Z current_indexrrrrs z!ShapeNameGenerator.new_shape_nameN)rrrrOr:rrrrrrsrN)(rO collectionsrtypingrrZ botocore.authrZbotocore.compatrZbotocore.exceptionsrrZbotocore.utilsr r r objectrl Exceptionr rrrrbrrrRr[r]r`rarergrhrrkr4rrrrrr s<   &* Gj6