HEX
Server: Apache
System: Linux pdx1-shared-a1-38 6.6.104-grsec-jammy+ #3 SMP Tue Sep 16 00:28:11 UTC 2025 x86_64
User: mmickelson (3396398)
PHP: 8.1.31
Disabled: NONE
Upload Files
File: //usr/lib/python3/dist-packages/botocore/docs/__pycache__/method.cpython-310.pyc
o

.&�a@-�@s|ddlZddlmZddlmZddlmZddlmZdZdd�Z	dd	d
�Z		ddd�Z
d
d�Z					ddd�ZdS)�N)�RequestParamsDocumenter)�ResponseParamsDocumenter)�ResponseExampleDocumenter)�RequestExampleDocumenterz'https://docs.aws.amazon.com/goto/WebAPIcCs<t�|�}i}|D]\}}|�d�st�|�r|||<q	|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)�instance�instance_members�instance_methods�name�member�r�6/usr/lib/python3/dist-packages/botocore/docs/method.py�get_instance_public_methodss
	

�rc	Cs~i}|jr	|jj}t|���}|dur|D]}|�|j�q|dur0|D]}||vr/|�|�q$d}|r6d}|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�params�parameter_namesr�signature_paramsrrr�document_model_driven_signature*s 
�r#cCsRt�|�}tj|jdd�|j|j|jd�}|�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.
    �N)�args�varargs�varkw�defaults�(�))r�getfullargspec�
formatargspecr%r&r'r(�lstrip�rstriprr)rr�methodrr�argspecr"rrr�document_custom_signatureQs
�

r1cCsFt|||�|�d�}|�d�t�|�}|dur!|j�|�dSdS)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
    �method-introrN)r1�add_new_section�writelnr�getdocr�write_py_doc_string)r�method_namer/�method_intro_section�
doc_stringrrr�document_custom_methodos	�


�r:TcCs�|rt|||||d�|�d�}|�|�|jr'|j��|�d�|j��|jj	�
d�}
|
durQ|j��|�d�dt
|
|jf}|jjd|d	�|�d
�|�d�}|j��|j�d�d
|��|��|��d�i}|jr�t|jj|j||d�j||j|||d�n|j��|j��|�|d�|�d�}|jr�t|jj|j||d�j||j||d�|�d�}|j��|jdu�rK|
�rK|�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�dS|�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.
    )rrr2z�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: z%s/%s/%szAWS API Documentation)�title�linkr�examplezRequest Syntax�special_shape_types)�streaming_input_shape�streaming_output_shape�eventstream_output_shape)�service_name�operation_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) r#r3�include_doc_string�
deprecatedr�start_dangerr4�
end_danger�
service_model�metadata�get�
new_paragraph�write�AWS_DOC_BASEr�
external_link�bold�get_streaming_input�get_streaming_output�get_event_stream_outputrrrC�document_example�start_codeblockr�document_params�new_line�output_shape�indentrr)rr7rrE�method_description�example_prefix�
include_input�include_output�
exclude_input�exclude_output�document_output�include_signaturer8�service_uidr=�example_sectionrF�request_params_section�return_section�event_stream_output�
event_section�return_example_section�return_description_sectionrrr�document_model_driven_method�s�+�


�


��


����


��








�



��	�

�
�ro)NN)NNNNNNTT)
r�botocore.docs.paramsrr�botocore.docs.examplerrrSrr#r1r:rorrrr�<module>s$
�(
��