File: //usr/lib/python3/dist-packages/botocore/docs/__pycache__/params.cpython-310.pyc
o
.&�a�, � @ sL d dl mZ d dlmZ G dd� de�ZG dd� de�ZG dd� de�Zd S )
� )�ShapeDocumenter)� py_type_namec @ s~ e Zd Zddd�Zdd� Z ddd�Z ddd �Z dd
d �Z dd d
�Zdd� Z dd� Z
dd� Z dd� Z dd� Z
dS )�BaseParamsDocumenterNc C s g }| j |||d||d� dS )a3 Fills out the documentation for a section given a model shape.
:param section: The section to write the documentation to.
:param shape: The shape of the operation.
: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)�section�shape�history�name�include�exclude)�traverse_and_document_shape)�selfr r r r
r � r
�6/usr/lib/python3/dist-packages/botocore/docs/params.py�document_params s
�z$BaseParamsDocumenter.document_paramsc K s | j ||fi |�� d S �N��_add_member_documentation�r r r �kwargsr
r
r �document_recursive_shape& s z-BaseParamsDocumenter.document_recursive_shapec K s | j ||fi |�� d S r r )r r r r r r
r r
r
r �document_shape_default) s z+BaseParamsDocumenter.document_shape_defaultc K sf | j ||fi |�� |j}|j|jd|jjid�}| �|� | j|||d d� |�d�}| �|� d S )Nr ��context�r r r r zend-list)r �member�add_new_sectionr �_start_nested_paramr �_end_nested_param) r r r r r r
r � param_shape�
param_sectionr
r
r �document_shape_type_list- s �
�
z-BaseParamsDocumenter.document_shape_type_listc
K s� | j ||fi |�� |jdd|jjid�}| �|� | � ||j� |j|jjd|jjid�}|j�� | �|� | j||j|d d� |�d�} | � | � | � | � d S )N�keyr r r zend-map)
r r r! r r �value�style�indentr r )
r r r r r r
r � key_sectionr � end_sectionr
r
r �document_shape_type_map: s$ �
�
�
z,BaseParamsDocumenter.document_shape_type_mapc K s� | � |j|�}| j|||d� |D ]%} |r| |v rq|| }
|j| d|
jid�} | �| � | j| |
|| d� q|�d�}| �|� d S )N)r r r r �
end-structure)�_add_members_to_shape�membersr r r r r r ) r r r r r r
r r r* �paramr r r
r
r � document_shape_type_structureO s
�
�
z2BaseParamsDocumenter.document_shape_type_structurec K s d S r r
r r
r
r r a s z.BaseParamsDocumenter._add_member_documentationc C s$ |r|� � }|D ]}|||j< q|S r )�copyr )r r* r r+ r
r
r r) d s
z*BaseParamsDocumenter._add_members_to_shapec C sF | � |�}t|j�}d}|d ur|�|| � d S |j�|| � d S )Nz(%s) -- )�_get_special_py_type_namer � type_name�writer# �italics)r � type_sectionr �special_py_type�py_type� type_formatr
r
r �"_document_non_top_level_param_typek s
z7BaseParamsDocumenter._document_non_top_level_param_typec C � |j �� |j �� d S r )r# r$ �new_line�r r r
r
r r w �
z(BaseParamsDocumenter._start_nested_paramc C r7 r )r# �dedentr8 r9 r
r
r r { r: z&BaseParamsDocumenter._end_nested_param�NN)NNN)�__name__�
__module__� __qualname__r r r r r' r, r r) r6 r r r
r
r
r r s(
�
�
�
� r c @ s& e Zd ZdZdZddd�Zdd� ZdS ) �ResponseParamsDocumenterz5Generates the description for the response parameterszresponse-paramsNc
K s� |� d�}|�d� |d ur|j�d| � |� d�}| �||� |� d�}|jrb|j�� t|dd�r\|� d�}d } d
�d d � |j �
� D ��}
d
} |�| |
� |� d�} | j� | � |� |j� |j�
� d S )N�
param-name�- �%s �
param-type�param-documentation�is_tagged_unionF�param-tagged-union-docsaK .. note:: This is a Tagged Union structure. Only one of the following top level keys will be set: %s. If a client receives an unknown member it will set ``SDK_UNKNOWN_MEMBER`` as the top level key, which maps to the name or tag of the unknown member. The structure of ``SDK_UNKNOWN_MEMBER`` is as follows�, c S � g | ]}d | �qS �z``%s``r
��.0r! r
r
r �
<listcomp>� � zFResponseParamsDocumenter._add_member_documentation.<locals>.<listcomp>z3'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}zparam-unknown-example)r r0 r# �boldr6 �
documentationr$ �getattr�joinr* �keys� codeblock�include_doc_string�
new_paragraph)
r r r r r � name_sectionr2 �documentation_section�tagged_union_docs�note�tagged_union_members_str�unknown_code_example�exampler
r
r r � s0
��
�
z2ResponseParamsDocumenter._add_member_documentationc K s | j |||fi |�� d S r )r, )r r r r r r
r
r � document_shape_type_event_stream� s z9ResponseParamsDocumenter.document_shape_type_event_streamr )r= r> r? �__doc__�
EVENT_NAMEr r^ r
r
r
r r@ � s
$r@ c @ s> e Zd ZdZdZ d
dd�Z ddd�Zd d
� Zd d � ZdS )�RequestParamsDocumenterz4Generates the description for the request parameterszrequest-paramsNc
K s� t |�dkr| j||fi |�� |j�� | �|j|�}t|�D ]-\}} |r+| |v r+q || }
|j| d|
jid�} | j� � | |j
v } | j | |
|| | d� q |�d�}t |�dkr^|j� � |j� � d S )N� r r )r r r r � is_requiredr( )
�lenr r# r$ r) r* � enumerater r r8 �required_membersr r; )
r r r r r r
r r* �ir+ r r rc r
r
r r, � s*
�
�
z5RequestParamsDocumenter.document_shape_type_structureFc K s\ | � |�}|d u rt|j�}|r5|�d�}|�d||f � |�d�} | j�� |�d�}
|
�d| � n!|�d�}
|
�d� |d urK|
j�d| � |�d�}| �||� |rh|�d�} | j� � | j�d � |j
r�|�d
�} | j� � t |d d �r�|�d
�}
d}d� dd� |j
�� D ��}|
�|| � | �|j
� | �| |� |�d�}|j�� d S )NrD z :type %s: %szend-param-typerA z :param %s: rB rC z is-requiredz [REQUIRED] rE rF FrG zl.. note:: This is a Tagged Union structure. Only one of the following top level keys can be set: %s. rH c S rI rJ r
rK r
r
r rM � rN zERequestParamsDocumenter._add_member_documentation.<locals>.<listcomp>z end-param)r. r r/ r r0 r# r8 rO r6 r$ rP rQ rR r* rS rU � _add_special_trait_documentationrV )r r r r �is_top_level_paramrc r r4 r2 �end_type_sectionrW �is_required_sectionrX rY rZ r[ �end_param_sectionr
r
r r � sN
�
���
z1RequestParamsDocumenter._add_member_documentationc C s d|j v r | �|� d S d S )N�idempotencyToken)�metadata�!_append_idempotency_documentation)r r r r
r
r rh � s
�z8RequestParamsDocumenter._add_special_trait_documentationc C s d}|� |� d S )Nz,This field is autopopulated if not provided.)r0 )r r � docstringr
r
r ro � s z9RequestParamsDocumenter._append_idempotency_documentationr< )NFF) r= r> r? r_ r` r, r rh ro r
r
r
r ra � s
�
�0 ra N)�botocore.docs.shaper �botocore.docs.utilsr r r@ ra r
r
r
r �<module> s
o.