HEX
Server: LiteSpeed
System: Linux s1299.sgp1.mysecurecloudhost.com 4.18.0-553.52.1.lve.el8.x86_64 #1 SMP Wed May 21 15:31:29 UTC 2025 x86_64
User: everest2 (1878)
PHP: 8.2.31
Disabled: NONE
Upload Files
File: //lib/python3.6/site-packages/botocore/docs/__pycache__/method.cpython-36.pyc
3

�T_-�@snddlZddlmZddlmZddlmZddlmZdZdd�Zdd	d
�Z	ddd�Z
d
d�Zddd�ZdS)�N)�RequestParamsDocumenter)�ResponseParamsDocumenter)�ResponseExampleDocumenter)�RequestExampleDocumenterz'https://docs.aws.amazon.com/goto/WebAPIcCs@tj|�}i}x,|D]$\}}|jd�stj|�r|||<qW|S)aRetrieves an objects public methods

    :param instance: The instance of the class to inspect
    :rtype: dict
    :returns: A dictionary that represents an instance's methods where
        the keys are the name of the methods and the
        values are the handler to the method.
    �_)�inspectZ
getmembers�
startswithZismethod)�instanceZinstance_membersZinstance_methods�name�member�r�/usr/lib/python3.6/method.py�get_instance_public_methodss	


rc	Cs�i}|jr|jj}t|j��}|dk	r@x|D]}|j|j�q,W|dk	rhx|D]}||krN|j|�qNWd}|rtd}|jj||�dS)a;Documents the signature of a model-driven method

    :param section: The section to write the documentation to.

    :param name: The name of the method

    :param operation_model: The operation model for the method

    :type include: Dictionary where keys are parameter names and
        values are the shapes of the parameter names.
    :param include: The parameter shapes to include in the documentation.

    :type exclude: List of the names of the parameters to exclude.
    :param exclude: The names of the parameters to exclude from
        documentation.
    N�z**kwargs)	�input_shape�members�list�keys�appendr
�remove�style�start_sphinx_py_method)	�sectionr
�operation_model�include�excludeZparamsZparameter_namesr�signature_paramsrrr
�document_model_driven_signature*s

rc
CsTtj|�\}}}}|dd�}tj||||�}	|	jd�}	|	jd�}	|jj||	�dS)a3Documents the signature of a custom method

    :param section: The section to write the documentation to.

    :param name: The name of the method

    :param method: The handle to the method being documented

    :type include: Dictionary where keys are parameter names and
        values are the shapes of the parameter names.
    :param include: The parameter shapes to include in the documentation.

    :type exclude: List of the names of the parameters to exclude.
    :param exclude: The names of the parameters to exclude from
        documentation.
    �N�(�))rZ
getargspecZ
formatargspec�lstrip�rstriprr)
rr
�methodrr�argsZvarargs�keywordsZdefaultsrrrr
�document_custom_signatureQs

r&cCsBt|||�|jd�}|jd�tj|�}|dk	r>|jj|�dS)z�Documents a non-data driven method

    :param section: The section to write the documentation to.

    :param method_name: The name of the method

    :param method: The handle to the method being documented
    zmethod-introrN)r&�add_new_section�writelnrZgetdocrZwrite_py_doc_string)r�method_namer#�method_intro_sectionZ
doc_stringrrr
�document_custom_methodls	



r+TcCs�|rt|||||d�|jd�}|j|�|jrN|jj�|jd�|jj�|jj	j
d�}
|
dk	r�|jj�|jd�dt
|
|jf}|jjd|d	�|jd
�|jd�}|jj�|jjd�d
|j�|j�|j�d�i}|j�rt|jj|j||d�j||j|||d�n"|jj�|jj�|j|d�|jd�}|j�rjt|jj|j||d�j||j||d�|jd�}|jj�|jdk	�r�|
�r�|jd�|jj�|jd�|jj�|jj�|j�}|�r�|jd�}|jj�|jd�|jj�|jd�}|jj�|jjd�|jj�t|jj|j||d�j||j||	d�|jd�}|jj�|jjd�|jj�t|jj|j||d�j||j||	d�n
|jd�dS)a.Documents an individual method

    :param section: The section to write to

    :param method_name: The name of the method

    :param operation_model: The model of the operation

    :param event_emitter: The event emitter to use to emit events

    :param example_prefix: The prefix to use in the method example.

    :type include_input: Dictionary where keys are parameter names and
        values are the shapes of the parameter names.
    :param include_input: The parameter shapes to include in the
        input documentation.

    :type include_output: Dictionary where keys are parameter names and
        values are the shapes of the parameter names.
    :param include_input: The parameter shapes to include in the
        output documentation.

    :type exclude_input: List of the names of the parameters to exclude.
    :param exclude_input: The names of the parameters to exclude from
        input documentation.

    :type exclude_output: List of the names of the parameters to exclude.
    :param exclude_input: The names of the parameters to exclude from
        output documentation.

    :param document_output: A boolean flag to indicate whether to
        document the output.

    :param include_signature: Whether or not to include the signature.
        It is useful for generating docstrings.
    )rrzmethod-introz�This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.ZuidNz
See also: z%s/%s/%szAWS API Documentation)�title�linkrZexamplezRequest SyntaxZspecial_shape_types)Zstreaming_input_shapeZstreaming_output_shapeZeventstream_output_shape)�service_nameZoperation_name�
event_emitter�context)�prefixrrz()zrequest-params�returnz:rtype: dictz
:returns: zevent-streamz�The response of this operation contains an :class:`.EventStream` member. When iterated the :class:`.EventStream` will yield events based on the structure below, where only one of the top level keys will be present for any given event.zResponse Syntax�descriptionzResponse Structurez:returns: None) rr'Zinclude_doc_stringZ
deprecatedrZstart_dangerr(Z
end_dangerZ
service_modelZmetadata�getZ
new_paragraph�write�AWS_DOC_BASEr
Z
external_linkZboldZget_streaming_inputZget_streaming_outputZget_event_stream_outputrrr.Zdocument_exampleZstart_codeblockrZdocument_paramsZnew_lineZoutput_shape�indentrr)rr)rr/Zmethod_descriptionZexample_prefixZ
include_inputZinclude_outputZ
exclude_inputZexclude_outputZdocument_outputZinclude_signaturer*Zservice_uidr-Zexample_sectionr0Zrequest_params_sectionZreturn_sectionZevent_stream_outputZ
event_sectionZreturn_example_sectionZreturn_description_sectionrrr
�document_model_driven_method~s�+
































r8)NN)NN)NNNNNNTT)
rZbotocore.docs.paramsrrZbotocore.docs.examplerrr6rrr&r+r8rrrr
�<module>
s
'