HEX
Server: LiteSpeed
System: Linux us-phx-web1284.main-hosting.eu 4.18.0-553.109.1.lve.el8.x86_64 #1 SMP Thu Mar 5 20:23:46 UTC 2026 x86_64
User: u300739242 (300739242)
PHP: 8.2.30
Disabled: system, shell_exec, passthru, mysql_list_dbs, ini_alter, dl, symlink, link, chgrp, leak, popen, apache_child_terminate, virtual, mb_send_mail
Upload Files
File: //opt/alt/python37/lib/python3.7/site-packages/botocore/docs/__pycache__/method.cpython-37.pyc
B

�P�e/�@sfddlZddlZddlmZmZddlmZmZdZdd�Z	ddd�Z
dd	d
�Zdd�Zddd�Z
dS)�N)�RequestExampleDocumenter�ResponseExampleDocumenter)�RequestParamsDocumenter�ResponseParamsDocumenterz'https://docs.aws.amazon.com/goto/WebAPIcCs@t�|�}i}x,|D]$\}}|�d�st�|�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.
    �_)�inspect�
getmembers�
startswith�ismethod)�instanceZinstance_membersZinstance_methods�name�member�r�E/opt/alt/python37/lib/python3.7/site-packages/botocore/docs/method.py�get_instance_public_methodss	


rc	Cs�i}|jr|jj}t|���}|dk	r@x|D]}|�|j�q,W|dk	rhx|D]}||krN|�|�qNWd}|rtd}|j�||�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�exclude�paramsZparameter_namesr
�signature_paramsrrr�document_model_driven_signature.s

r c
Cs�t�|�}t|tj�r`tt|j��}|j|j}|tj	j
ks@t�|j��}||=|j
|��d�}t|��d�}	|	�d�}	|j�||	�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.
    )�
parameters�(�)N)r�	signature�
isinstance�types�FunctionType�next�iterr!�kind�	Parameter�POSITIONAL_OR_KEYWORD�AssertionError�copy�replace�values�str�lstrip�rstriprr)
rr�methodrrr$Z
self_paramZ	self_kind�
new_paramsrrrr�document_custom_signatureVs


r6cCsX|j�dd��|��}t|||�|�d�}|�d�t�|�}|dk	rT|j�|�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	qualifierrzmethod-introN)	�context�getr6�add_new_section�writelnr�getdocrZwrite_py_doc_string)r�method_namer4Zfull_method_name�method_intro_sectionZ
doc_stringrrr�document_custom_methodys	


r>TcCs�|rt|||||d�|�d�}|�|�|jrN|j��|�d�|j��|jj	�
d�}
|
dk	r�|j��|�d�t
�d|
�d|j��}|jjd|d	�|�d
�|�d�}|j��|j�d�d
|��|��|��d�i}|j�rt|jj|j||d�j||j|||d�n"|j��|j��|�|d�|�d�}|j�rpt|jj|j||d�j||j||d�|�d�}|j��|jdk	�r�|
�r�|�d�|j��|�d�|j��|j��|��}|�r�|�d�}|j��|�d�|j��|�d�}|j��|j�d�|j��t|jj|j||d�j||j||	d�|�d�}|j��|j�d�|j��t|jj|j||d�j||j||	d�n
|�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.�uidNz
See also: �/zAWS API Documentation)�title�linkrzrequest-examplezRequest SyntaxZspecial_shape_types)Zstreaming_input_shapeZstreaming_output_shapeZeventstream_output_shape)�service_nameZoperation_name�
event_emitterr7)�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-examplezResponse Syntax�descriptionzResponse Structurez:returns: None) r r9Zinclude_doc_string�
deprecatedrZstart_dangerr:Z
end_dangerZ
service_model�metadatar8Z
new_paragraph�write�AWS_DOC_BASErZ
external_link�boldZget_streaming_inputZget_streaming_outputZget_event_stream_outputrrrCZdocument_exampleZstart_codeblockrZdocument_params�new_lineZoutput_shape�indentrr)rr<rrDZmethod_descriptionZexample_prefixZ
include_inputZinclude_outputZ
exclude_inputZexclude_outputZdocument_outputZinclude_signaturer=Zservice_uidrBZexample_sectionr7Zrequest_params_sectionZreturn_sectionZevent_stream_outputZ
event_sectionZreturn_example_sectionZreturn_description_sectionrrr�document_model_driven_method�s�3




























rO)NN)NN)NNNNNNTT)rr&Zbotocore.docs.examplerrZbotocore.docs.paramsrrrKrr r6r>rOrrrr�<module>
s 
(
"