o <&ßa¦2ã@s˜ddlmZddlmZddlmZddlmZddlmZddlm Z ddl m Z ddlm Z dd l mZd d „ZGd d „d eƒZGdd„deƒZdS)é)Úget_official_service_name©Údocument_custom_method)Údocument_model_driven_method)Úget_instance_public_methods)Údocument_shared_examples)ÚResponseExampleDocumenter)ÚResponseParamsDocumenter)ÚDocumentedShape)Ú OrderedDictcKs|dkrdS|dvS)NÚgenerate_presigned_url)Ús3©)Ú method_nameÚ service_nameÚkwargsrrú6/usr/lib/python3/dist-packages/botocore/docs/client.pyÚ!_allowlist_generate_presigned_urlsrc@sŒeZdZegZd dd„Zdd„Zdd„Zdd „Zd d „Z d d „Z dd„Z dd„Z dd„Z dd„Zdd„Zdd„Zdd„Zdd„Zdd„ZdS)!ÚClientDocumenterNcCs.||_||_|jduri|_|jjjj|_dS©N)Ú_clientÚ_shared_examplesÚmetaÚ service_modelrÚ _service_name)ÚselfÚclientÚshared_examplesrrrÚ__init__#s  zClientDocumenter.__init__cCs8| |¡| |¡| ¡}| ||¡| ||¡dS)z]Documents a client and its methods :param section: The section to write to. N)Ú _add_titleÚ_add_class_signatureÚ_get_client_methodsÚ_add_client_introÚ_add_client_methods)rÚsectionÚclient_methodsrrrÚdocument_client*s   z ClientDocumenter.document_clientcCst|jƒ}| |¡Sr)rrÚ_filter_client_methods)rr%rrrr!5s  z$ClientDocumenter._get_client_methodscCs8i}| ¡D]\}}|j|||jd}|r|||<q|S)N)Úmethodrr)ÚitemsÚ_filter_client_methodr)rr%Úfiltered_methodsrr(Úincluderrrr'9sý€z'ClientDocumenter._filter_client_methodscKs.|jD]}|di|¤Ž}|dur|SqdS)NTr)Ú_CLIENT_METHODS_FILTERS)rrÚfilterÚfilter_includerrrr*Es ÿz&ClientDocumenter._filter_client_methodcCó|j d¡dS)NÚClient©ÚstyleÚh2©rr$rrrrOózClientDocumenter._add_titlecCsš| d¡}t|jjjƒ}| d|¡|j ¡| |jjjj ¡|  |¡|j ¡| d¡|j ¡|jj j }t |ƒD] }|j d||f¡q>dS)NÚintroz"A low-level client representing %sz These are the available methods:z:py:meth:`~%s.Client.%s`)Úadd_new_sectionrrrrÚwriter3Únew_lineÚinclude_doc_stringÚ documentationÚ_add_client_creation_exampleÚ __class__Ú__name__ÚsortedÚli)rr$r%Úofficial_service_nameÚ class_namerrrrr"Rs& ÿÿ        ÿÿz"ClientDocumenter._add_client_introcCs|jjd|jjjddS)Nz %s.Client©rC)r3Ústart_sphinx_py_classrr>r?r5rrrr hs  ÿz%ClientDocumenter._add_class_signaturecCs6|j ¡|j ¡| dj|jd¡|j ¡dS)Nz+client = session.create_client('{service}'))Úservice)r3Ústart_codeblockr:r9ÚformatrÚ end_codeblockr5rrrr=ls  ÿÿz-ClientDocumenter._add_client_creation_examplecCs.| d¡}t|ƒD] }| ||||¡q dS)NÚmethods)r8r@Ú_add_client_method)rr$r%rrrrr#us   ÿÿz$ClientDocumenter._add_client_methodscCs6| |¡}| |¡r| |||¡dS| ||¡dSr)r8Ú_is_custom_methodÚ_add_custom_methodÚ_add_model_driven_method©rr$rr(rrrrK{s  z#ClientDocumenter._add_client_methodcCs||jjjvSr)rrÚmethod_to_api_mapping)rrrrrrL‚sz"ClientDocumenter._is_custom_methodcCst|||ƒdSrrrOrrrrM…r6z#ClientDocumenter._add_custom_methodcCsb| d¡}|j ¡|j d¡|j ¡|jjj}|jD]}d||jf}|j  d|¡qdS)NÚ exceptionsÚ Exceptionsú%s.Client.exceptions.%sú:py:class:`%s`) r8r3r:Úboldrr>r?Ú error_shapesÚnamerA)rr$Úoperation_modelÚ error_sectionÚ client_nameÚerrorrCrrrÚ_add_method_exceptions_listˆs      þz,ClientDocumenter._add_method_exceptions_listcCs~|jjj}|jjj|}| |¡}d|}t||||jjj|j|d|jr,|  ||¡|j   |¡}|r=t ||||ƒdSdS)Nzresponse = client.%s)Ú event_emitterÚmethod_descriptionÚexample_prefix) rrrrPrXrÚeventsr<rVr\rÚgetr)rr$rrÚoperation_namerXr_rrrrrN’s$  ü  ÿÿz)ClientDocumenter._add_model_driven_methodr)r?Ú __module__Ú __qualname__rr-rr&r!r'r*rr"r r=r#rKrLrMr\rNrrrrrs$ÿ      rc @s´eZdZdZedddededdddfd ed dd dfgƒd Zd d „Zdd„Zdd„Z dd„Z dd„Z dd„Z dd„Z dd„Zdd„Zdd„Zd d!„Zd"d#„Zd$d%„Zd&d'„Zd(S))ÚClientExceptionsDocumenterzQhttps://boto3.amazonaws.com/v1/documentation/api/latest/guide/error-handling.htmlÚErrorÚ structurez1Normalized access to common exception attributes.ÚCodeÚstringz,An identifier specifying the exception type.)rWÚ type_namer<ÚMessagez;A descriptive message explaining why the exception occured.)rWrjr<ÚmemberscCs||_|jjjj|_dSr)rrrrr)rrrrrrÈsz#ClientExceptionsDocumenter.__init__cCs,| |¡| |¡| |¡| |¡dSr)rÚ _add_overviewÚ_add_exceptions_listÚ_add_exception_classesr5rrrÚdocument_exceptionsÌs   z.ClientExceptionsDocumenter.document_exceptionscCr0)NzClient Exceptionsr2r5rrrrÒr6z%ClientExceptionsDocumenter._add_titlecCs>|j ¡| d¡|jjd|jd| d¡|j ¡dS)NzÂClient exceptions are available on a client instance via the ``exceptions`` property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling z user guide)ÚtitleÚlinkÚ.)r3r:r9Ú external_linkÚ_USER_GUIDE_LINKr5rrrrmÕs ÿþ z(ClientExceptionsDocumenter._add_overviewcCs|jjj}d||jfS)NrS)rr>r?rW)rÚshapeÚcls_namerrrÚ_exception_class_nameäs z0ClientExceptionsDocumenter._exception_class_namecCsx|jjjj}|s|j ¡| d¡|j ¡dS|j ¡| d¡|j ¡|D]}| |¡}|j d|¡q*dS)Nz-This client has no modeled exception classes.z$The available client exceptions are:rT) rrrrVr3r:r9rxrA)rr$rVrvrCrrrrnès        þz/ClientExceptionsDocumenter._add_exceptions_listcCs"|jjjjD]}| ||¡qdSr)rrrrVÚ_add_exception_class©rr$rvrrrroösÿz1ClientExceptionsDocumenter._add_exception_classescCsV| |j¡}| |¡}|jj|d| ||¡| ||¡| ||¡|j ¡dS)NrD) r8rWrxr3rEÚ_add_top_level_documentationÚ_add_exception_catch_exampleÚ_add_response_attrÚend_sphinx_py_class)rr$rvÚ class_sectionrCrrrryús     z/ClientExceptionsDocumenter._add_exception_classcCs.|jr|j ¡| |j¡|j ¡dSdSr)r<r3r:r;rzrrrr{s   ýz7ClientExceptionsDocumenter._add_top_level_documentationcCs¢|j ¡|j d¡|j ¡| d¡|j ¡|j ¡| d¡|j ¡|j ¡| d|j¡|j ¡|j ¡| d¡|j ¡|j ¡dS)NÚExampleztry:z...z!except client.exceptions.%s as e:zprint(e.response)) r3r:rUrGr9ÚindentÚdedentrWrIrzrrrr| s             z7ClientExceptionsDocumenter._add_exception_catch_examplecCsF| d¡}|j d¡| |¡| ||¡| ||¡|j ¡dS)NÚresponse)r8r3Ústart_sphinx_py_attrÚ_add_response_attr_descriptionÚ_add_response_exampleÚ_add_response_paramsÚend_sphinx_py_attr)rr$rvÚresponse_sectionrrrr}s     z-ClientExceptionsDocumenter._add_response_attrcCs"|j ¡| d¡|j ¡dS)NzÈThe parsed error response. All exceptions have a top level ``Error`` key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.)r3r:r;r5rrrr…"s ÿz9ClientExceptionsDocumenter._add_response_attr_descriptioncCsX| d¡}|j ¡|j d¡|j ¡t|jd|jjj d}|j |||j gddS)NÚsyntaxÚSyntax©rrbr]©r,) r8r3r:rUÚ new_paragraphrrrrr`Údocument_exampleÚ_GENERIC_ERROR_SHAPE)rr$rvÚexample_sectionÚ documenterrrrr†,ó    ý  ÿz0ClientExceptionsDocumenter._add_response_examplecCsX| d¡}|j ¡|j d¡|j ¡t|jd|jjj d}|j |||j gddS)NÚ StructurerŒr) r8r3r:rUrŽr rrrr`Údocument_paramsr)rr$rvÚparams_sectionr’rrrr‡:r“z/ClientExceptionsDocumenter._add_response_paramsN)r?rcrdrur r rrrprrmrxrnroryr{r|r}r…r†r‡rrrrreªsDÿüüøú  reN)Úbotocore.docs.utilsrÚbotocore.docs.methodrrrÚbotocore.docs.sharedexamplerÚbotocore.docs.examplerÚbotocore.docs.paramsr r Úbotocore.compatr rÚobjectrrerrrrÚs