PewdZddlmZddlmZmZddlmZddlm Z m Z ddl m Z m Z mZeZGddeZGd d eZGd d eZGd deZGddeZGddZGddeZGddeZGddeZGddeZGddeZGddeZGdd eZGd!d"Z Gd#d$Z!Gd%d&Z"Gd'd(Z#Gd)d*Z$Gd+d,Z%y-).z-Abstractions to interact with service models.) defaultdict) NamedTupleUnion) OrderedDict)MissingServiceIdErrorUndefinedModelAttributeError)CachedPropertyhyphenize_service_idinstance_cachec eZdZy)NoShapeFoundErrorN__name__ __module__ __qualname__0/usr/lib/python3/dist-packages/botocore/model.pyr r rr c eZdZy)InvalidShapeErrorNrrrrrrrrrc eZdZy)OperationNotFoundErrorNrrrrrr#rrrc eZdZy)InvalidShapeReferenceErrorNrrrrrr'rrrceZdZdZy) ServiceIdct|SN)r selfs r hyphenizezServiceId.hyphenize,s #D))rN)rrrr"rrrrr+s*rrcxeZdZdZgdZgdZeZd dZe dZ e dZ e dZ d Z d Zed Zy) Shapez3Object representing a shape from the service model.) locationName queryName flattenedlocationpayload streamingtimestampFormat xmlNamespace resultWrapper xmlAttribute eventstreamevent eventheader eventpayload jsonvaluer+ hostLabel)requiredminmaxpattern sensitiveenumidempotencyTokenerror exceptionendpointdiscoveryid retryabledocumentunion contextParamclientContextParamsrequiresLengthNc||_|d|_|jdd|_||_| t }||_i|_y)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_namegetrG _shape_modelUnresolvableShapeMap_shape_resolver_cache)r! shape_name shape_modelshape_resolvers r__init__zShape.__init__^sQ( $V,(___bA'  ! 23N- rc|j}i}|jD]}||jvs||||<d|vr|jd|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. r%rI)rLSERIALIZED_ATTRSpop)r!model serializationattrs rrXzShape.serializationsj.!! )) 2Dt(((&+Dk d# 2 ] *$1$5$5n$EM& !rcr|j}i}|jD]}||jvs||||<|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. )rLMETADATA_ATTRS)r!rWmetadatarYs rr\zShape.metadatasK.!!'' -Dt(((!&t -rc:|jjdgS)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. r5r\rKr s rrequired_memberszShape.required_memberss}}  R00rc8|jj|SrrNresolve_shape_refr! shape_refs r_resolve_shape_refzShape._resolve_shape_ref##55i@@rcPd|jjd|jdS)N<(z)> __class__rrIr s r__repr__zShape.__repr__s&4>>**+1TYYKr::rcyrrr s revent_stream_namezShape.event_stream_namesrr)rrr__doc__rUr[rMAP_TYPErSr rXr\r_rerlpropertyrnrrrr$r$0s}= &N$H D@:11A;rr$c\eZdZedZedZedZedZedZy)StructureShapec|jjd|j}|j}|jD]\}}|j |||<|S)Nmembers)rLrKrpitemsre)r!ru shape_membersrIrds rruzStructureShape.memberssc##'' 4==?C  &}} EOD)"&"9"9)"DM$  Erc|jjD]$\}}|jjds"|cSy)Nr/)rurvrXrK)r! member_namemembers rrnz StructureShape.event_stream_namesB#'<<#5#5#7 # K##'' 6"" #rc|jjddsy|jjdi}|jd}|r|S|jS)Nr=Fr<code)r\rKrI)r!error_metadatar|s r error_codezStructureShape.error_codesQ}}  e4**7B7!!&) Kyyrc:|jjddS)Nr@Fr^r s ris_document_typezStructureShape.is_document_types}}  U33rc:|jjddS)NrAFr^r s ris_tagged_unionzStructureShape.is_tagged_unions}}  %00rN) rrrr rurnr~rrrrrrsrssd   4411rrsceZdZedZy) ListShapec>|j|jdS)NrzrerLr s rrzzListShape.members&&t'8'8'BCCrN)rrrr rzrrrrrsDDrrc,eZdZedZedZy)MapShapec>|j|jdS)Nkeyrr s rrz MapShape.keys&&t'8'8'?@@rc>|j|jdS)Nvaluerr s rrzMapShape.value s&&t'8'8'ABBrN)rrrr rrrrrrrs,AACCrrceZdZedZy) StringShapec:|jjdgS)Nr:r^r s rr:zStringShape.enums}}  ,,rN)rrrr r:rrrrrs--rrc,eZdZUeed<eeefed<y)StaticContextParameterrIrN)rrrstr__annotations__rboolrrrrrs I s rrc"eZdZUeed<eed<y)ContextParameterrIryNrrrrrrrrrrs Irrc,eZdZUeed<eed<eed<y)ClientContextParameterrIrFrGNrrrrrrs I Irrc\eZdZdZddZddZdZedZdZ edZ ed Z e d Z ed Zed Zed ZedZedZedZedZedZedZedZedZdZedZej8dZdZy) ServiceModelzQ :ivar service_description: The parsed service description dictionary. Nc||_|jdi|_t|jdi|_t |_||_i|_y)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_descriptionrKr\ ShapeResolverrNNOT_SET_signature_version _service_name_instance_cache)r!service_description service_names rrSzServiceModel.__init__,sW*%8!+// B? ,  # #Hb 1 #*)!rc:|jj||Sr)rNget_shape_by_namer!rP member_traitss r shape_forzServiceModel.shape_forKs ##55    rc:|jj|dSr)_error_code_cacherK)r!r~s rshape_for_error_codez!ServiceModel.shape_for_error_codePs%%))*d;;rcNi}|jD]}|j}|||<|Sr) error_shapesr~)r!error_code_cache error_shaper|s rrzServiceModel._error_code_cacheSs;,, 1K))D%0 T " 1 rc8|jj|Srrarcs rrbzServiceModel.resolve_shape_ref[rfrcLt|jjdiS)NrlistrrKr s r shape_nameszServiceModel.shape_names^s D--11(B?@@rcg}|jD]A}|j|}|jjdds1|j |C|S)Nr=F)rrr\rKappend)r!rrPrs rrzServiceModel.error_shapesbsV ** 1J..4K##'' U;##K0 1rcr |jd|}t|||S#t$r t|wxYwN operations)rKeyErrorrOperationModel)r!operation_namerWs roperation_modelzServiceModel.operation_modelksI 9--l;NKEeT>:: 9(8 8 9s!6c:|jjddSNrGrH)rrKr s rrGzServiceModel.documentationss((,,_bAArcLt|jjdgSrrr s roperation_nameszServiceModel.operation_namesws D--11,CDDrcJ|j |jS|jS)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. )rendpoint_prefixr s rrzServiceModel.service_name{s(    )%% %'' 'rc~ t|jdS#t$rt|jwxYw)N serviceId)r)r_get_metadata_propertyrrrr s r service_idzServiceModel.service_ids@ IT88EF F+ I'T5G5GH H Is <cX|jjd}| |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. signingName)r\rKr)r! signing_names rrzServiceModel.signing_names/}}((7  //Lrc$|jdS)N apiVersionrr s r api_versionzServiceModel.api_versions**<88rc$|jdS)Nprotocolrr s rrzServiceModel.protocols**:66rc$|jdS)NendpointPrefixrr s rrzServiceModel.endpoint_prefixs**+;<a@@rr)rrrrorSrrr rrbrrr rrGrrrrrrrrrrrrqrsetterrlrrrrr%s "> <  AAA;;BBEE(( II   9977==     '' ((ArrceZdZd dZedZedZedZedZ edZ edZ ed Z ed Z ed Zed Zed ZedZedZedZedZedZedZedZedZedZdZdZdZedZedZdZdZ dZ!dZ"y)!rNc||_||_||_|jd|_|j |_|jdi|_y)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. rIhttpN)_operation_model_service_model _api_namerK _wire_namer\r)r!r service_modelrIs rrSzOperationModel.__init__sP8!0+*--f5%.. #''3 rcJ|j |jS|jSr)r wire_namer s rrIzOperationModel.name s >> %>> !>> !rc8|jjdS)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``. rIrrKr s rrzOperationModel.wire_names$$((00rc|jSr)rr s rrzOperationModel.service_models"""rc:|jjddSrrr s rrGzOperationModel.documentation"s$$(("==rc:|jjddS)N deprecatedFrr s rrzOperationModel.deprecated&s$$((u==rc:|jjddS)Nendpointdiscoveryrr s rrz!OperationModel.endpoint_discovery*s$$(()s< 400 0""44  ! !( +  rc|j}|sgS|jjDcgc]$\}}d|jvr|jdr|&c}}Scc}}w)Nr;)rrurvr\)r!rrIshapes ridempotent_membersz!OperationModel.idempotent_membersIsc&& I"-!4!4!:!:!< u!U^^312    s)Ac |jjdi}|jDcgc]!\}}t||jd#c}}Scc}}w)NstaticContextParamsr)rIr)rrKrvr)r!rrIpropss rstatic_context_parametersz(OperationModel.static_context_parametersVsW&&**+@"E &||~ e #EIIg4F G   s&Ac |jsgS|jjjDcgc]A\}}d|jvr.d|jdvrt |jdd|Cc}}Scc}}w)NrBrI)rIry)rrurvr\r)r!rIrs rcontext_parametersz!OperationModel.context_parameters^sI $//77==?  e/%..88 ^^N3F;     sABc8|jjdS)Nrequestcompressionrr s rrequest_compressionz"OperationModel.request_compressionms$$(()=>>rc8|jjdS)Nauthtyperr s r auth_typezOperationModel.auth_typeq$$((44rcdjjdg}tfd|DS)Nerrorsc3TK|]}jj|!ywr)rrb).0sr!s r z.OperationModel.error_shapes..xs"MD''99!<Ms%()rrKr)r!rs` rrzOperationModel.error_shapesus,&&**8R8MfMMMrc8|jjdS)Nendpointrr s rrzOperationModel.endpointzrrc:|jjddS)NhttpChecksumRequiredFrr s rhttp_checksum_requiredz%OperationModel.http_checksum_required~s$$(()?GGrc:|jjdiS)N httpChecksumrr s r http_checksumzOperationModel.http_checksums$$((<>>>DD EE              ??55NN55HH==99::896677:; >rrc2eZdZdZeeeedZdZ ddZ dZ y)rzResolves shape references.) structurermapstringc ||_i|_yr) _shape_map _shape_cache)r! shape_maps rrSzShapeResolver.__init__s#rNc. |j|} |jj |dt }|r!|j}|j|||||}|S#t$r t|wxYw#t$rt d|wxYw)NrFz&Shape is missing required key 'type': ) rBrr SHAPE_CLASSESrKr$rcopyupdate)r!rPrrQ shape_clsresults rrzShapeResolver.get_shape_by_names 0//*5K **..{6/BEJI %**,K   } -:{D9  0#J/ / 0 #8 F  sA$#A<$A9<Bct|dk(rd|vr|j|dS|j} |jd}|j||S#t$rt d|wxYw)Nrz(Invalid model, missing shape reference: )lenrrGrVrr)r!rdrrPs rrbzShapeResolver.resolve_shape_refs y>Q 7i#7)))G*<= =%NN,M *..w7 ))*mD D  0>ykJ s AA3r) rrrrorsrrrrFrSrrbrrrrrs*$$ M"ErrceZdZdZddZdZy)rMzEA ShapeResolver that will throw ValueErrors when shapes are resolved.Nc td|d)NzAttempted to lookup shape '!', but no shape map was provided. ValueErrorrs rrz&UnresolvableShapeMap.get_shape_by_names)*5V W  rc td|d)NzAttempted to resolve shape 'rPrQrcs rrbz&UnresolvableShapeMap.resolve_shape_refs *9+6  !  rr)rrrrorrbrrrrMrMsO  rrMcReZdZdZdZddZdZdZdZdZ d Z d Z d Z d Z d Zy)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. ) r@integerbooleanr:float timestamplongdoublecharNct|_t|_|!|jj d|_yy)Nr>)rruShapeNameGenerator_name_generatornew_shape_namerIrs rrSz%DenormalizedStructureBuilder.__init__0s8"} 13 <,,;;KHDI rc||_|S)zp :type members: dict :param members: The denormalized members. :return: self )_members)r!rus r with_membersz)DenormalizedStructureBuilder.with_members6s   rct}d|jd}|j|||jt |}t |j||j|S)zBuild the model based on the provided members. :rtype: botocore.model.StructureShape :return: The built StructureShape object. r>)rFru)rD)rPrQrR)rrb _build_modelrIrrs)r!r denormalizedresolvers r build_modelz(DenormalizedStructureBuilder.build_modelBsa}}  , : 62yytyy)#  rc$|ddk(r|j||||<y|ddk(r|j||||<y|ddk(r|j||||<y|d|jvr|j |||<yt d|d)NrFr>rr?zUnknown shape type: )_build_structure _build_list _build_map SCALAR_TYPES _build_scalarr)r!rWrrPs rrez)DenormalizedStructureBuilder._build_modelVs =K '!%!6!6uf!EF:  6]f $!%!1!1%!@F:  6]e #!%!?F:  6]d// /!%!3!3E!:F: #&:5=/$JK Krct}|j|}||d<|jdtjD]0\}}|j |}d|i||<|j |||2|S)Nrur)r_build_initial_shaperKrv_get_shape_namere)r!rWrrurrI member_modelmember_shape_names rrjz-DenormalizedStructureBuilder._build_structurebs-))%0"i"'))I{}"E"K"K"M G D, $ 4 4\ B $&78GDM   lF4E F G rc|j|}|j|}d|i|d<|j|d|||S)Nrrzrqrpre)r!rWrrsrs rrkz(DenormalizedStructureBuilder._build_listmsN 007))%0"$56h %/63DE rc|j|d}|j|d}|j|}d|i|d<d|i|d<|j|d|||j|d|||S)Nrrrru)r!rWrkey_shape_namevalue_shape_namers rrlz'DenormalizedStructureBuilder._build_mapts--eEl;//g?))%00e !#34g %,? %.&2BC rcpd|di}d|vr|d|d<tjD]}||vs||||<|S)NrFrG)r$r[)r!rWrrYs rrpz1DenormalizedStructureBuilder._build_initial_shape~s[ E&M  e #%*?%;E/ "(( *Du}#Dkd  * rc$|j|Sr)rpr!rWs rrnz*DenormalizedStructureBuilder._build_scalars((//rcPd|vr|dS|jj|dS)NrPrF)r_r`r{s rrqz,DenormalizedStructureBuilder._get_shape_names0 5 & &''66uV}E Err)rrrrormrSrcrhrerjrkrlrprnrqrrrrUrUsD"H LI  ( L  0FrrUceZdZdZdZdZy)r^zGenerate 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. c,tt|_yr)rint _name_cacher s rrSzShapeNameGenerator.__init__s&s+rcx|j|xxdz cc<|j|}|jd|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 rLType)r capitalize)r!rJ current_indexs rr`z!ShapeNameGenerator.new_shape_namesE4 #q(#((3 &&()m_==rN)rrrrorSr`rrrr^r^s,>rr^N)&ro collectionsrtypingrrbotocore.compatrbotocore.exceptionsrrbotocore.utilsr r r objectr Exceptionr rrrrrr$rsrrrrrrrrrrMrUr^rrrrs4#$'PO (     Y   ** bbJ'1U'1TDD CuC-%- Z z Z {A{A|T>T>n3E3El   QFQFh'>'>r