U .bp@s<dZddlmZddlmZddlmZmZddlm Z m Z m Z e Z GdddeZGdd d eZGd d d eZGd d d eZGdddeZGdddZGdddeZGdddeZGdddeZGdddeZGdddZGdddZGdddZGd d!d!ZGd"d#d#ZGd$d%d%Zd&S)'z-Abstractions to interact with service models.) defaultdict) OrderedDict)MissingServiceIdErrorUndefinedModelAttributeError)CachedPropertyhyphenize_service_idinstance_cachec@s eZdZdS)NoShapeFoundErrorN__name__ __module__ __qualname__rr2/tmp/pip-unpacked-wheel-7df6wvge/botocore/model.pyr sr c@s eZdZdS)InvalidShapeErrorNr rrrrrsrc@s eZdZdS)OperationNotFoundErrorNr rrrrr"src@s eZdZdS)InvalidShapeReferenceErrorNr rrrrr&src@seZdZddZdS) ServiceIdcCst|SN)rselfrrr hyphenize+szServiceId.hyphenizeN)r r r rrrrrr*src@seZdZdZdddddddd d d d d dddddgZdddddddddddddg ZeZd.d d!Ze d"d#Z e d$d%Z e d&d'Z d(d)Z d*d+Zed,d-ZdS)/Shapez3Object representing a shape from the service model. locationNameZ queryNameZ flattenedlocationpayloadZ streamingZtimestampFormatZ xmlNamespaceZ resultWrapperZ xmlAttribute eventstreameventZ eventheaderZ eventpayloadZ jsonvalueZ hostLabelrequiredminmaxpatternZ sensitiveenumidempotencyTokenerror exceptionZendpointdiscoveryidZ retryabledocumentunionNcCsB||_|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__Zs 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. rr+)r.SERIALIZED_ATTRSpop)rmodel serializationattrrrrr9|s  zShape.serializationcCs0|j}i}|jD]}||jkr||||<q|S)asMetadata about the shape. This requires optional information about the shape, including: * min * max * pattern * enum * sensitive * required * idempotencyToken * document * union :rtype: dict :return: Metadata about the shape. )r.METADATA_ATTRS)rr8metadatar:rrrr<s   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. rr<r-rrrrrequired_memberss zShape.required_memberscCs |j|Srr0resolve_shape_refr shape_refrrr_resolve_shape_refszShape._resolve_shape_refcCsd|jjd|jdS)N<(z)> __class__r r+rrrr__repr__szShape.__repr__cCsdSrrrrrrevent_stream_nameszShape.event_stream_name)N)r r r __doc__r6r;rMAP_TYPEr5rr9r<r>rCrHpropertyrIrrrrr/sZ "   rc@sHeZdZeddZeddZeddZeddZed d Zd S) StructureShapecCs>|jd|}|}|D]\}}||||<q"|S)Nmembers)r.r-rKitemsrC)rrNZ shape_membersr+rBrrrrNs zStructureShape.memberscCs,|jD]\}}|jdr |Sq dS)Nr)rNrOr9r-)r member_namememberrrrrIs  z StructureShape.event_stream_namecCs8|jddsdS|jdi}|d}|r2|S|jS)Nr%Fr$code)r<r-r+)rZerror_metadatarRrrr error_codes zStructureShape.error_codecCs|jddS)Nr&Fr=rrrris_document_typeszStructureShape.is_document_typecCs|jddS)Nr'Fr=rrrris_tagged_unionszStructureShape.is_tagged_unionN) r r r rrNrIrSrTrUrrrrrMs    rMc@seZdZeddZdS) ListShapecCs||jdS)NrQrCr.rrrrrQszListShape.memberN)r r r rrQrrrrrVsrVc@s$eZdZeddZeddZdS)MapShapecCs||jdS)NkeyrWrrrrrYsz MapShape.keycCs||jdS)NvaluerWrrrrrZszMapShape.valueN)r r r rrYrZrrrrrXs rXc@seZdZeddZdS) StringShapecCs|jdgS)Nr"r=rrrrr" szStringShape.enumN)r r r rr"rrrrr[sr[c@seZdZdZd.ddZd/ddZddZed d Zd d Z ed dZ eddZ e ddZ eddZeddZeddZeddZeddZeddZedd Zed!d"Zed#d$Zed%d&Zd'd(Zed)d*Zejd+d*Zd,d-ZdS)0 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. r<shapesN) _service_descriptionr-r< ShapeResolverr0NOT_SET_signature_version _service_nameZ_instance_cache)rZservice_description service_namerrrr5s zServiceModel.__init__cCs|j||Sr)r0get_shape_by_namerr2 member_traitsrrr shape_for4szServiceModel.shape_forcCs|j|dSr)_error_code_cacher-)rrSrrrshape_for_error_code9sz!ServiceModel.shape_for_error_codecCs"i}|jD]}|j}|||<q |Sr) error_shapesrS)rZerror_code_cache error_shaperRrrrrh<s   zServiceModel._error_code_cachecCs |j|Srr?rArrrr@DszServiceModel.resolve_shape_refcCst|jdiS)Nr]listr^r-rrrr shape_namesGszServiceModel.shape_namescCs6g}|jD]&}||}|jddr ||q |S)Nr%F)rnrgr<r-append)rrjr2rkrrrrjKs    zServiceModel.error_shapescCs<z|jd|}Wntk r.t|YnXt|||SN operations)r^KeyErrorrOperationModel)rZoperation_namer8rrroperation_modelTs zServiceModel.operation_modelcCs|jddSNr)r*)r^r-rrrrr)\szServiceModel.documentationcCst|jdgSrprlrrrroperation_names`szServiceModel.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)rbendpoint_prefixrrrrrcds zServiceModel.service_namecCs6zt|dWStk r0t|jdYnXdS)NZ serviceId)rc)r_get_metadata_propertyrrrbrrrr service_iduszServiceModel.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)r<r-rw)r signing_namerrrrz|s zServiceModel.signing_namecCs |dS)NZ apiVersionrxrrrr api_versionszServiceModel.api_versioncCs |dS)Nprotocolr{rrrrr}szServiceModel.protocolcCs |dS)NZendpointPrefixr{rrrrrwszServiceModel.endpoint_prefixcCs(|jD]}||}|jr|SqdSr)rvrtis_endpoint_discovery_operationrZ operationr8rrrendpoint_discovery_operations  z)ServiceModel.endpoint_discovery_operationcCs6|jD]*}||}|jdk r|jdrdSqdS)NrTF)rvrtendpoint_discoveryr-rrrrendpoint_discovery_requireds   z(ServiceModel.endpoint_discovery_requiredcCs:z |j|WStk r4td|d|YnXdS)N"z," not defined in the metadata of the model: )r<rrrrr+rrrrxs  z#ServiceModel._get_metadata_propertycCs"|jtkr|jd}||_|jS)NZsignatureVersion)rar`r<r-)rsignature_versionrrrrs  zServiceModel.signature_versioncCs ||_dSr)ra)rrZrrrrscCs|jjd|jdS)NrE))rGr rcrrrrrHszServiceModel.__repr__)N)N)r r r rJr5rgrirrhr@rnrjrrtr)rvrcryrzr|r}rwrrrxrLrsetterrHrrrrr\sN                   r\c@s2eZdZd8ddZeddZeddZedd Zed d Z ed d Z eddZ eddZ eddZ eddZeddZeddZeddZeddZeddZed d!Zed"d#Zed$d%Zd&d'Zd(d)Zd*d+Zed,d-Zed.d/Zd0d1Zd2d3Zd4d5Zd6d7ZdS)9rsNcCs8||_||_||_|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. r+httpN)_operation_model_service_model _api_namer-Z _wire_namer<r)rrt service_modelr+rrrr5s  zOperationModel.__init__cCs|jdk r|jS|jSdSr)r wire_namerrrrr+s 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 operaiton name we send across the wire (e.g cloudfront). Any serialization code should use ``wire_name``. r+rr-rrrrrs zOperationModel.wire_namecCs|jSr)rrrrrrszOperationModel.service_modelcCs|jddSrurrrrrr)szOperationModel.documentationcCs|jddS)N deprecatedFrrrrrrszOperationModel.deprecatedcCs|jddS)NZendpointdiscoveryrrrrrrsz!OperationModel.endpoint_discoverycCs|jddS)NZendpointoperationFrrrrrr~ sz.OperationModel.is_endpoint_discovery_operationcCs d|jkrdS|j|jdS)Ninputrrr@rrrr input_shapes  zOperationModel.input_shapecCs d|jkrdS|j|jdS)Noutputrrrrr output_shapes  zOperationModel.output_shapecCs"|j}|sgSdd|jDS)NcSs(g|] \}}d|jkr|jdr|qS)r#)r<).0r+shaperrr ,s  z5OperationModel.idempotent_members..)rrNrO)rrrrridempotent_members&s z!OperationModel.idempotent_memberscCs |jdS)NZauthtyperrrrr auth_type3szOperationModel.auth_typecs$jdg}tfdd|DS)Nerrorsc3s|]}j|VqdSr)rr@)rsrrr :sz.OperationModel.error_shapes..)rr-rm)rr]rrrrj7szOperationModel.error_shapescCs |jdS)Nendpointrrrrrr<szOperationModel.endpointcCs|jddS)NZhttpChecksumRequiredFrrrrrhttp_checksum_required@sz%OperationModel.http_checksum_requiredcCs|jdiS)NZ httpChecksumrrrrr http_checksumDszOperationModel.http_checksumcCs |dk Sr)get_event_stream_inputrrrrhas_event_stream_inputHsz%OperationModel.has_event_stream_inputcCs |dk Sr)get_event_stream_outputrrrrhas_event_stream_outputLsz&OperationModel.has_event_stream_outputcCs ||jSr)_get_event_streamrrrrrrPsz%OperationModel.get_event_stream_inputcCs ||jSr)rrrrrrrSsz&OperationModel.get_event_stream_outputcCs$|dkr dS|j}|r |j|SdS)zAReturns the event stream member's shape if any or None otherwise.N)rIrN)rrZ event_namerrrrVs  z OperationModel._get_event_streamcCs |dk Sr)get_streaming_inputrrrrhas_streaming_input_sz"OperationModel.has_streaming_inputcCs |dk Sr)get_streaming_outputrrrrhas_streaming_outputcsz#OperationModel.has_streaming_outputcCs ||jSr)_get_streaming_bodyrrrrrrgsz"OperationModel.get_streaming_inputcCs ||jSr)rrrrrrrjsz#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)r9r-rNr,)rrrZ payload_shaperrrrms   z"OperationModel._get_streaming_bodycCs|jjd|jdS)Nz(name=rrFrrrrrHxszOperationModel.__repr__)N) r r r r5rr+rLrrr)rrr~rrrrrjrrrrrrrrrrrrrrHrrrrrss\ %                     rsc@s8eZdZdZeeeedZddZ d ddZ dd Z dS) r_zResolves shape references.) structurermmapstringcCs||_i|_dSr) _shape_mapZ _shape_cache)r shape_maprrrr5szShapeResolver.__init__NcCsz|j|}Wntk r*t|YnXz|j|dt}Wn"tk rdtd|YnX|r||}||||||}|S)Nr(z&Shape is missing required key 'type': ) rrrr SHAPE_CLASSESr-rrcopyupdate)rr2rfr3Z shape_clsresultrrrrds   zShapeResolver.get_shape_by_namecCslt|dkr"d|kr"||dS|}z|d}Wn"tk rZtd|YnX|||SdS)Nrz(Invalid model, missing shape reference: )lenrdrr7rrr)rrBrfr2rrrr@s zShapeResolver.resolve_shape_ref)N) r r r rJrMrVrXr[rr5rdr@rrrrr_|s r_c@s"eZdZdZdddZddZdS)r/zEA ShapeResolver that will throw ValueErrors when shapes are resolved.NcCstd|ddS)NzAttempted to lookup shape '!', but no shape map was provided. ValueErrorrerrrrds z&UnresolvableShapeMap.get_shape_by_namecCstd|ddS)NzAttempted to resolve shape 'rrrArrrr@s z&UnresolvableShapeMap.resolve_shape_ref)N)r r r rJrdr@rrrrr/s r/c@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)rrNShapeNameGenerator_name_generatornew_shape_namer+rrrrr5sz%DenormalizedStructureBuilder.__init__cCs ||_|S)zp :type members: dict :param members: The denormalized members. :return: self )_members)rrNrrr with_memberss 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(rN)r)r2r3r4)rr _build_modelr+r_rM)rr]Z denormalizedresolverrrr build_models z(DenormalizedStructureBuilder.build_modelcCs|ddkr|||||<nl|ddkr<|||||<nN|ddkrZ|||||<n0|d|jkrx||||<ntd|ddS)Nr(rrmrzUnknown shape type: )_build_structure _build_list _build_map SCALAR_TYPES _build_scalarr)rr8r]r2rrrrs   z)DenormalizedStructureBuilder._build_modelcCs\t}||}||d<|dtD],\}}||}d|i||<||||q*|S)NrNr)r_build_initial_shaper-rO_get_shape_namer)rr8r]rNrr+Z member_modelmember_shape_namerrrr$s   z-DenormalizedStructureBuilder._build_structurecCs6||}||}d|i|d<||d|||S)NrrQrrr)rr8r]rrrrrr/s    z(DenormalizedStructureBuilder._build_listcCsf||d}||d}||}d|i|d<d|i|d<||d||||d|||S)NrYrZrr)rr8r]Zkey_shape_nameZvalue_shape_namerrrrr6s   z'DenormalizedStructureBuilder._build_mapcCsDd|di}d|kr |d|d<tjD]}||kr&||||<q&|S)Nr(r))rr;)rr8rr:rrrr@s  z1DenormalizedStructureBuilder._build_initial_shapecCs ||Sr)rrr8rrrrKsz*DenormalizedStructureBuilder._build_scalarcCs$d|kr|dS|j|dSdS)Nr2r()rrrrrrrNsz,DenormalizedStructureBuilder._get_shape_name)N)r r r rJrr5rrrrrrrrrrrrrrs$      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_cacherrrrr5]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)rr,Z current_indexrrrr`s z!ShapeNameGenerator.new_shape_nameN)r r r rJr5rrrrrrUsrN) rJ collectionsrZbotocore.compatrZbotocore.exceptionsrrZbotocore.utilsrrrobjectr` Exceptionr rrrstrrrrMrVrXr[r\rsr_r/rrrrrr s2   * 3=6