]jN~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(y.)/z-Abstractions to interact with service models.) defaultdict) NamedTuple)resolve_auth_type) OrderedDict)MissingServiceIdErrorUndefinedModelAttributeError UnsupportedServiceProtocolsError)$PRIORITY_ORDERED_SUPPORTED_PROTOCOLSCachedPropertyhyphenize_service_idinstance_cachec eZdZy)NoShapeFoundErrorN__name__ __module__ __qualname__8/root/env/lib/python3.12/site-packages/botocore/model.pyrr#rrc eZdZy)InvalidShapeErrorNrrrrrr'rrrc eZdZy)OperationNotFoundErrorNrrrrrr+rrrc eZdZy)InvalidShapeReferenceErrorNrrrrrr/rrrceZdZdZy) ServiceIdct|SN)r selfs r hyphenizezServiceId.hyphenize4s #D))rN)rrrr$rrrrr3s*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_namegetrI _shape_modelUnresolvableShapeMap_shape_resolver_cache)r# shape_name shape_modelshape_resolvers r__init__zShape.__init__fsQ( $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'rK)rNSERIALIZED_ATTRSpop)r#model serializationattrs rrZzShape.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. )rNMETADATA_ATTRS)r#rYmetadatar[s 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. r7r^rMr"s rrequired_memberszShape.required_memberss}}  R00rc8|jj|Sr!rPresolve_shape_refr# shape_refs r_resolve_shape_refzShape._resolve_shape_ref##55i@@rcPd|jjd|jdS)N<(z)> __class__rrKr"s r__repr__zShape.__repr__s&4>>**+1TYYKr::rcyr!rr"s revent_stream_namezShape.event_stream_namesrr!)rrr__doc__rWr]rMAP_TYPErUr rZr^rargrnpropertyrprrrr&r&8s}= &N$H D@:11A;rr&c\eZdZedZedZedZedZedZy)StructureShapec|jjd|j}|j}|jD]\}}|j |||<|S)Nmembers)rNrMrritemsrg)r#rw shape_membersrKrfs rrwzStructureShape.memberssc##'' 4==?C  &}} EOD)"&"9"9)"DM$  Erc|jjD]$\}}|jjds"|cSy)Nr1)rwrxrZrM)r# member_namemembers rrpz StructureShape.event_stream_namesB#'<<#5#5#7 # K##'' 6"" #rc|jjddsy|jjdi}|jd}|r|S|jS)Nr?Fr>code)r^rMrK)r#error_metadatar~s r error_codezStructureShape.error_codesQ}}  e4**7B7!!&) Kyyrc:|jjddS)NrBFr`r"s ris_document_typezStructureShape.is_document_types}}  U33rc:|jjddS)NrCFr`r"s ris_tagged_unionzStructureShape.is_tagged_unions}}  %00rN) rrrr rwrprrrrrrrurusd   4411rruceZdZedZy) ListShapec>|j|jdS)Nr|rgrNr"s rr|zListShape.members&&t'8'8'BCCrN)rrrr r|rrrrrsDDrrc,eZdZedZedZy)MapShapec>|j|jdS)Nkeyrr"s rrz MapShape.keys&&t'8'8'?@@rc>|j|jdS)Nvaluerr"s rrzMapShape.values&&t'8'8'ABBrN)rrrr rrrrrrr s,AACCrrceZdZedZy) StringShapec:|jjdgS)Nr<r`r"s rr<zStringShape.enums}}  ,,rN)rrrr r<rrrrrs--rrc(eZdZUeed<eezed<y)StaticContextParameterrKrN)rrrstr__annotations__boolrrrrrs I #:rrc"eZdZUeed<eed<y)ContextParameterrKr{Nrrrrrrrrrr"s Irrc,eZdZUeed<eed<eed<y)ClientContextParameterrKrHrINrrrrrr's I IrrceZdZdZddZddZdZedZdZ edZ ed Z e d Z ed Zed Zed ZedZedZedZedZedZedZedZedZedZedZdZedZej<dZedZdZ y) 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_descriptionrMr^ ShapeResolverrPNOT_SET_signature_version _service_name_instance_cache)r#service_description service_names rrUzServiceModel.__init__4sW*%8!+// B? ,  # #Hb 1 #*)!rc:|jj||Sr!)rPget_shape_by_namer#rR member_traitss r shape_forzServiceModel.shape_forSs ##55    rc:|jj|dSr!)_error_code_cacherM)r#rs rshape_for_error_codez!ServiceModel.shape_for_error_codeXs%%))*d;;rcNi}|jD]}|j}|||<|Sr!) error_shapesr)r#error_code_cache error_shaper~s rrzServiceModel._error_code_cache[s;,, 1K))D%0 T " 1 rc8|jj|Sr!rcres rrdzServiceModel.resolve_shape_refcrhrcLt|jjdiS)NrlistrrMr"s r shape_nameszServiceModel.shape_namesfs D--11(B?@@rcg}|jD]A}|j|}|jjdds1|j |C|S)Nr?F)rrr^rMappend)r#rrRrs rrzServiceModel.error_shapesjsV ** 1J..4K##'' U;##K0 1rcr |jd|}t|||S#t$r t|wxYwN operations)rKeyErrorrOperationModel)r#operation_namerYs roperation_modelzServiceModel.operation_modelssI 9--l;NKEeT>:: 9(8 8 9s!6c:|jjddSNrIrJ)rrMr"s rrIzServiceModel.documentation{s((,,_bAArcLt|jjdgSrrr"s roperation_nameszServiceModel.operation_namess 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_names(    )%% %'' '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^rMr)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)N protocolsrr"s rrzServiceModel.protocolss**;77rc|jjdrCtD]}||jvs|cSt t|j|j |j S)Nr)botocore_supported_protocolsservice_supported_protocolsservice)r^rMr rr rr)r#rs rresolved_protocolzServiceModel.resolved_protocolsd ==  [ )@ $t~~-#O $3-Q,0NN)) }}rc$|jdS)NendpointPrefixrr"s rrzServiceModel.endpoint_prefixs**+;<a@@rr!)!rrrrqrUrrr rrdrrr rrIrrrrrrrrrrrrrrsrsetterrrnrrrrr-s "> <  AAA;;BBEE(( II   997788"==     '' ((55ArrceZdZd$dZedZedZedZedZ edZ edZ ed Z ed Z ed Zed Zed ZedZedZedZedZedZedZedZedZedZedZedZedZedZdZdZdZ edZ!edZ"d Z#d!Z$d"Z%d#Z&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. rKhttpN)_operation_model_service_model _api_namerM _wire_namer^r)r#r service_modelrKs rrUzOperationModel.__init__sP8!0+*--f5%.. #''3 rcJ|j |jS|jSr!)r wire_namer"s rrKzOperationModel.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``. rKrrMr"s rrzOperationModel.wire_name2s$$((00rc|jSr!)rr"s rrzOperationModel.service_model@s"""rc:|jjddSrrr"s rrIzOperationModel.documentationDs$$(("==rc:|jjddS)N deprecatedFrr"s rrzOperationModel.deprecatedHs$$((u==rc:|jjddS)Nendpointdiscoveryrr"s rrz!OperationModel.endpoint_discoveryLs$$(()>rc8|jjdS)Nauthrr"s rr#zOperationModel.auths$$((00rc8|jjdS)Nauthtyperr"s r auth_typezOperationModel.auth_type$$((44rc\|jrt|jS|jSr!)r#rr&r"s rresolved_auth_typez!OperationModel.resolved_auth_types" 99$TYY/ /~~rc8|jjdS)NunsignedPayloadrr"s runsigned_payloadzOperationModel.unsigned_payloads$$(():;;rcdjjdg}tfd|DS)Nerrorsc3TK|]}jj|!ywr!)rrd).0sr#s r z.OperationModel.error_shapes..s"MD''99!<Ms%()rrMr)r#rs` rrzOperationModel.error_shapess,&&**8R8MfMMMrc8|jjdS)Nendpointrr"s rr4zOperationModel.endpointr'rc:|jjddS)NhttpChecksumRequiredFrr"s rhttp_checksum_requiredz%OperationModel.http_checksum_requireds$$(()?GGrc:|jjdiS)N httpChecksumrr"s r http_checksumzOperationModel.http_checksums$$((<>>>DD EE              GG??1155 <<NN55HH==99::896677:; >rrc2eZdZdZeeeedZdZ ddZ dZ y)rzResolves shape references.) structurermapstringc ||_i|_yr!) _shape_map _shape_cache)r# shape_maps rrUzShapeResolver.__init__s#rNc. |j|} |jj |dt }|r!|j}|j|||||}|S#t$r t|wxYw#t$rt d|wxYw)NrHz&Shape is missing required key 'type': ) rXrr SHAPE_CLASSESrMr&rcopyupdate)r#rRrrS 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: )lenrr]rXrr)r#rfrrRs rrdzShapeResolver.resolve_shape_refs y>Q 7i#7)))G*<= =%NN,M *..w7 ))*mD D  0>ykJ s AA3r!) rrrrqrurrrr\rUrrdrrrrrs*$$ M"ErrceZdZdZddZdZy)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)*5V W  rc td|d)NzAttempted to resolve shape 'rfrgres rrdz&UnresolvableShapeMap.resolve_shape_ref,s *9+6  !  rr!)rrrrqrrdrrrrOrO$sO  rrOcReZdZdZdZddZdZdZdZdZ 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. ) rVintegerbooleanrPfloat timestamplongdoublecharNct|_t|_|!|jj d|_yy)NrT)rrwShapeNameGenerator_name_generatornew_shape_namerKrs rrUz%DenormalizedStructureBuilder.__init__ds8"} 13 <,,;;KHDI rc||_|S)zp :type members: dict :param members: The denormalized members. :return: self )_members)r#rws r with_membersz)DenormalizedStructureBuilder.with_membersjs   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. rT)rHrw)rZ)rRrSrT)rrx _build_modelrKrru)r#r denormalizedresolvers r build_modelz(DenormalizedStructureBuilder.build_modelvsa}}  , : 62yytyy)#  rc$|ddk(r|j||||<y|ddk(r|j||||<y|ddk(r|j||||<y|d|jvr|j |||<yt d|d)NrHrTrrUzUnknown shape type: )_build_structure _build_list _build_map SCALAR_TYPES _build_scalarr)r#rYrrRs rr{z)DenormalizedStructureBuilder._build_models =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)Nrwr)r_build_initial_shaperMrx_get_shape_namer{)r#rYrrwrrK member_modelmember_shape_names rrz-DenormalizedStructureBuilder._build_structures-))%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)Nrr|rrr{)r#rYrrrs rrz(DenormalizedStructureBuilder._build_listsN 007))%0"$56h %/63DE rc|j|d}|j|d}|j|}d|i|d<d|i|d<|j|d|||j|d|||S)Nrrrr)r#rYrkey_shape_namevalue_shape_namers rrz'DenormalizedStructureBuilder._build_maps--eEl;//g?))%00e !#34g %,? %.&2BC rcpd|di}d|vr|d|d<tjD]}||vs||||<|S)NrHrI)r&r])r#rYrr[s rrz1DenormalizedStructureBuilder._build_initial_shapes[ E&M  e #%*?%;E/ "(( *Du}#Dkd  * rc$|j|Sr!)rr#rYs rrz*DenormalizedStructureBuilder._build_scalars((//rcPd|vr|dS|jj|dS)NrRrH)rurvrs rrz,DenormalizedStructureBuilder._get_shape_names0 5 & &''66uV}E Err!)rrrrqrrUryr~r{rrrrrrrrrrkrk3sD"H LI  ( L  0FrrkceZdZdZdZdZy)rtzGenerate 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 rrUzShapeNameGenerator.__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 rbType)r capitalize)r#rL current_indexs rrvz!ShapeNameGenerator.new_shape_namesE4 #q(#((3 &&()m_==rN)rrrrqrUrvrrrrtrts,>rrtN))rq collectionsrtypingr botocore.authrbotocore.compatrbotocore.exceptionsrrr botocore.utilsr r r r objectr Exceptionrrrrrrr&rurrrrrrrrrrOrkrtrrrrs!4#+'  (     Y   ** bbJ'1U'1TDD CuC-%- Z z Z UAUApf>f>R3E3El   QFQFh'>'>r