7xjN~dZddlmZddlmZddlmZddlmZddl m Z m Z m Z ddl mZmZmZmZeZGdd eZGd d eZGd d eZGddeZGddeZGddZGddeZGddeZGddeZGddeZGddeZ GddeZ!Gd d!eZ"Gd"d#Z#Gd$d%Z$Gd&d'Z%Gd(d)Z&Gd*d+Z'Gd,d-Z(d.S)/z-Abstractions to interact with service models.) defaultdict) NamedTuple)resolve_auth_type) OrderedDict)MissingServiceIdErrorUndefinedModelAttributeError UnsupportedServiceProtocolsError)$PRIORITY_ORDERED_SUPPORTED_PROTOCOLSCachedPropertyhyphenize_service_idinstance_cacheceZdZdS)NoShapeFoundErrorN__name__ __module__ __qualname__?C:\Projects\Historical\venv\Lib\site-packages\botocore/model.pyrr#DrrceZdZdS)InvalidShapeErrorNrrrrrr'rrrceZdZdS)OperationNotFoundErrorNrrrrrr+rrrceZdZdS)InvalidShapeReferenceErrorNrrrrrr/rrrceZdZdZdS) ServiceIdc t|SN)r selfs r hyphenizezServiceId.hyphenize4s#D)))rN)rrrr$rrrrr3s#*****rrceZdZdZgdZgdZeZd dZe dZ e dZ e dZ d Z d Zed ZdS) 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|_|dd|_||_|t }||_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_namegetrI _shape_modelUnresolvableShapeMap_shape_resolver_cache)r# shape_name shape_modelshape_resolvers r__init__zShape.__init__fs[( $V,(___bAA'  ! 233N- rc|j}i}|jD]}||jvr ||||<d|vr|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. r'rK)rNSERIALIZED_ATTRSpop)r#model serializationattrs rrZzShape.serializationsi.! ) 2 2Dt(((&+Dk d# ] * *$1$5$5n$E$EM& !rcT|j}i}|jD]}||jvr ||||<|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. )rNMETADATA_ATTRS)r#rYmetadatar[s rr^zShape.metadatasD.!' - -Dt(((!&trc8|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. r7r^rMr"s rrequired_memberszShape.required_memberss}  R000rc6|j|Sr!rPresolve_shape_refr# shape_refs r_resolve_shape_refzShape._resolve_shape_ref#55i@@@rc2d|jjd|jdS)N<(z)> __class__rrKr"s r__repr__zShape.__repr__s":4>*::TY::::rcdSr!rr"s revent_stream_namezShape.event_stream_namestrr!)rrr__doc__rWr]rMAP_TYPErUr rZr^rargrnpropertyrprrrr&r&8s== &N$H    D^@^:11^1AAA;;;Xrr&c|eZdZedZedZedZedZedZdS)StructureShapec|jd|}|}|D]\}}||||<|S)Nmembers)rNrMrritemsrg)r#rw shape_membersrKrfs rrwzStructureShape.membersso#'' 4==??CC  &}} E EOD)"&"9"9)"D"DM$  rc|jD]#\}}|jdr|cS$dS)Nr1)rwrxrZrM)r# member_namemembers rrpz StructureShape.event_stream_namesS#'<#5#5#7#7 # # K#'' 66 #"""" #trc|jddsdS|jdi}|d}|r|S|jS)Nr?Fr>code)r^rMrK)r#error_metadatar~s r error_codezStructureShape.error_codes`}  e44 4**7B77!!&))  Kyrc8|jddS)NrBFr`r"s ris_document_typezStructureShape.is_document_types}  U333rc8|jddS)NrCFr`r"s ris_tagged_unionzStructureShape.is_tagged_unions}  %000rN) rrrr rwrprrrrrrrurus  ^ ^ ^44^411^111rruc$eZdZedZdS) ListShapecB||jdS)Nr|rgrNr"s rr|zListShape.members&&t'8'BCCCrN)rrrr r|rrrrrs2DD^DDDrrc:eZdZedZedZdS)MapShapecB||jdS)Nkeyrr"s rrz MapShape.keys&&t'8'?@@@rcB||jdS)Nvaluerr"s rrzMapShape.values&&t'8'ABBBrN)rrrr rrrrrrr sPAA^ACC^CCCrrc$eZdZedZdS) StringShapec8|jdgS)Nr<r`r"s rr<zStringShape.enums}  ,,,rN)rrrr r<rrrrrs---^---rrc*eZdZUeed<eezed<dS)StaticContextParameterrKrN)rrrstr__annotations__boolrrrrrs+ III #:rrc$eZdZUeed<eed<dS)ContextParameterrKr{Nrrrrrrrrrr"s' IIIrrc.eZdZUeed<eed<eed<dS)ClientContextParameterrKrHrINrrrrrr's0 III IIIrrceZdZdZddZddZdZedZdZ edZ ed Z e d Z ed Zed Zed ZedZedZedZedZedZedZedZedZedZedZdZedZejdZedZdZ dS) ServiceModelzQ :ivar service_description: The parsed service description dictionary. Nc||_|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_descriptionrMr^ ShapeResolverrPNOT_SET_signature_version _service_name_instance_cache)r#service_description service_names rrUzServiceModel.__init__4sh*%8!+// B?? ,  # #Hb 1 1  #*)!rc8|j||Sr!)rPget_shape_by_namer#rR member_traitss r shape_forzServiceModel.shape_forSs"#55     rc8|j|dSr!)_error_code_cacherM)r#rs rshape_for_error_codez!ServiceModel.shape_for_error_codeXs%))*d;;;rc6i}|jD]}|j}|||<|Sr!) error_shapesr)r#error_code_cache error_shaper~s rrzServiceModel._error_code_cache[s6, 1 1K)D%0 T " "rc6|j|Sr!rcres rrdzServiceModel.resolve_shape_refcrhrcRt|jdiS)NrlistrrMr"s r shape_nameszServiceModel.shape_namesfs#D-11(B??@@@rcg}|jD]G}||}|jddr||H|S)Nr?F)rrr^rMappend)r#rrRrs rrzServiceModel.error_shapesjs` * 1 1J..44K#'' U;; 1##K000rc |jd|}n#t$rt|wxYwt|||SN operations)rKeyErrorrOperationModel)r#operation_namerYs roperation_modelzServiceModel.operation_modelssV 9-l;NKEE 9 9 9(88 8 9eT>:::s0c8|jddSNrIrJ)rrMr"s rrIzServiceModel.documentation{s(,,_bAAArcRt|jdgSrrr"s roperation_nameszServiceModel.operation_namess#D-11,CCDDDrc,|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_names   )% %' 'rc t|dS#t$rt|jwxYw)N serviceId)r)r_get_metadata_propertyrrrr"s r service_idzServiceModel.service_idsW IT88EEFF F+ I I I'T5GHHH H Is !$ AcL|jd}||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^rMr)r# signing_names rrzServiceModel.signing_names-}((77  /Lrc,|dS)N apiVersionrr"s r api_versionzServiceModel.api_versions**<888rc,|dS)Nprotocolrr"s rrzServiceModel.protocols**:666rc,|dS)N protocolsrr"s rrzServiceModel.protocolss**;777rc|jdr8tD]}||jvr|cSt t|j|j|jS)Nr)botocore_supported_protocolsservice_supported_protocolsservice)r^rMr rr rr)r#rs rresolved_protocolzServiceModel.resolved_protocolsu =  [ ) ) @ $ $t~--#OOO.2-Q,0N) }rc,|dS)NendpointPrefixrr"s rrzServiceModel.endpoint_prefixs**+;<<z:ServiceModel.client_context_parameters..sP   & I #v&'8      r)rrMrxr#paramss rclient_context_parametersz&ServiceModel.client_context_parameterssF*../DbII  *0     rcd |j|S#t$rtd|d|wxYw)N"z," not defined in the metadata of the model: )r^rrr#rKs rrz#ServiceModel._get_metadata_propertysT =& &   .LDLLdLL  s  /cn|jtur!|jd}||_|jS)NsignatureVersion)rrr^rM)r#signature_versions rrzServiceModel.signature_versions8  "g - - $ 1 12D E E &7D #&&rc||_dSr!)r)r#rs rrzServiceModel.signature_versions"'rcd|jvS)NawsQueryCompatibler^r"s ris_query_compatiblez ServiceModel.is_query_compatibles#t}44rc0|jjd|jdS)Nrk))rmrrr"s rrnzServiceModel.__repr__s!.)@@D,=@@@@rr!)!rrrrqrUrrr rrdrrr rrIrrrrrrrrrrrrrrsrsetterrrnrrrrr-s """">    <<<  ^ AAAAA^A^;;^;BB^BEE^E((^( II^I   ^ 99^977^788^8^"==^=^ ^   ^  ''X' (((55^5AAAAArrc|eZdZd$dZedZedZedZedZ edZ edZ ed Z ed Z ed Zed Zed ZedZedZedZedZedZedZedZedZedZedZedZedZedZdZdZdZ edZ!edZ"d Z#d!Z$d"Z%d#Z&dS)%rNc||_||_||_|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. rKhttpN)_operation_model_service_model _api_namerM _wire_namer^r)r#r service_modelrKs rrUzOperationModel.__init__sW8!0+*--f55%. #''33 rc,|j|jS|jSr!)r wire_namer"s rrKzOperationModel.name+s > %> !> !rc6|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``. rKrrMr"s rrzOperationModel.wire_name2s$((000rc|jSr!)rr"s rrzOperationModel.service_model@s ""rc8|jddSrrr"s rrIzOperationModel.documentationDs$(("===rc8|jddS)N deprecatedFrr"s rr zOperationModel.deprecatedHs$((u===rc8|jddS)Nendpointdiscoveryrr"s rrz!OperationModel.endpoint_discoveryLs$(().qsC   u!U^33124 333rrrwrx)r#rs ridempotent_membersz!OperationModel.idempotent_membersksG&  I  !,!4!:!:!.{sE   e #EIIg4F4F G G G   r)rrMrxrs rstatic_context_parametersz(OperationModel.static_context_parametersxsD&**+@"EE  %||~~    rcd|jsgSd|jjDS)Ncg|]?\}}d|jvr1d|jdvt|jdd|@S)rDrK)rKr{)r^rrs rrz5OperationModel.context_parameters..sj   e//%.888 ^N3F;     988rrr"s rcontext_parametersz!OperationModel.context_parameterssG I  $/7==??     rc8|jdgS)NoperationContextParamsrr"s roperation_context_parametersz+OperationModel.operation_context_parameterss$(()A2FFFrc6|jdS)Nrequestcompressionrr"s rrequest_compressionz"OperationModel.request_compressions$(()=>>>rc6|jdS)Nauthrr"s rr-zOperationModel.auths$((000rc6|jdS)Nauthtyperr"s r auth_typezOperationModel.auth_type$((444rcF|jrt|jS|jSr!)r-rr0r"s rresolved_auth_typez!OperationModel.resolved_auth_types$ 9 0$TY// /~rc6|jdS)NunsignedPayloadrr"s runsigned_payloadzOperationModel.unsigned_payloads$(():;;;rcpjdg}tfd|DS)Nerrorsc3LK|]}j|VdSr!)rrd)rsr#s r z.OperationModel.error_shapes..s4MMD'99!<<MMMMMMr)rrMr)r#rs` rrzOperationModel.error_shapess>&**8R88MMMMfMMMMMMrc6|jdS)Nendpointrr"s rr=zOperationModel.endpointr1rc8|jddS)NhttpChecksumRequiredFrr"s rhttp_checksum_requiredz%OperationModel.http_checksum_requireds$(()?GGGrc8|jdiS)N httpChecksumrr"s r http_checksumzOperationModel.http_checksums$((<<>^>>>^>DD^D EE^E  ^   ^    ^    ^    ^  GG^G??^?11^155^5^ <<^<NN^N55^5HH^H==^=99^9::^:88899966^677^7:::;;;   >>>>>rrc4eZdZdZeeeedZdZ ddZ dZ dS)rzResolves shape references.) structurermapstringc"||_i|_dSr!) _shape_map _shape_cache)r# shape_maps rrUzShapeResolver.__init__s#rNc^ |j|}n#t$rt|wxYw |j|dt }n #t$rt d|wxYw|r)|}||||||}|S)NrHz&Shape is missing required key 'type': ) rarr SHAPE_CLASSESrMr&rcopyupdate)r#rRrrS shape_clsresults rrzShapeResolver.get_shape_by_names 0/*5KK 0 0 0#J// / 0 *..{6/BEJJII   #FFF    .%**,,K   } - - -:{D99 s *&AA2c(t|dkrd|vr||dS|} |d}n #t$rt d|wxYw|||S)Nrz(Invalid model, missing shape reference: )lenrrfrXrr)r#rfrrRs rrdzShapeResolver.resolve_shape_refs y>>Q  7i#7#7)))G*<== =%NN,,M *..w77    0JyJJ ))*mDD Ds AA;r!) rrrrqrurrrrerUrrdrrrrrsk$$$ M"EEEEErrc eZdZdZddZdZdS)rOzEA 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_name's" W* W W W   rc(td|d)NzAttempted to resolve shape 'rorpres rrdz&UnresolvableShapeMap.resolve_shape_ref,s* !9 ! ! !   rr!)rrrrqrrdrrrrOrO$s=OO         rrOcTeZdZdZdZddZdZdZdZdZ d Z d Z d Z d Z d ZdS)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_integerbooleanrYfloat timestamplongdoublecharNct|_t|_|!|jd|_dSdS)Nr])rrwShapeNameGenerator_name_generatornew_shape_namerKrs rrUz%DenormalizedStructureBuilder.__init__dsC"}} 133 <,;;KHHDIII >> 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 rkType)r capitalize)r#rL current_indexs rrz!ShapeNameGenerator.new_shape_namesP4 ###q(###(3 &&((==m===rN)rrrrqrUrrrrr}r}s<,,,>>>>>rr}N))rq collectionsrtypingr botocore.authrbotocore.compatrbotocore.exceptionsrrr botocore.utilsr r r r objectr Exceptionrrrrrrr&rurrrrrrrrrrOrtr}rrrrs843######++++++''''''  &((                     Y           ******** bbbbbbbbJ'1'1'1'1'1U'1'1'1TDDDDDDDD CCCCCuCCC-----%--- Z z Z UAUAUAUAUAUAUAUApf>f>f>f>f>f>f>f>R3E3E3E3E3E3E3E3El         QFQFQFQFQFQFQFQFh'>'>'>'>'>'>'>'>'>'>r