File: //opt/cppython/lib/python3.8/site-packages/botocore/docs/__pycache__/params.cpython-38.pyc
U
KD�g�- � @ sL d dl mZ d dlmZ G dd� de�ZG dd� de�ZG dd� de�Zd S )
� )�ShapeDocumenter)� py_type_namec @ sn e Zd Zddd�Zdd� Zddd�Zddd �Zdd
d �Zd d 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
�A/opt/cppython/lib/python3.8/site-packages/botocore/docs/params.py�document_params s �z$BaseParamsDocumenter.document_paramsc K s | j ||f|� d S �N��_add_member_documentation�r r r �kwargsr
r
r �document_recursive_shape+ s z-BaseParamsDocumenter.document_recursive_shapec K s | j ||f|� d S r r )r r r r r r
r r
r
r �document_shape_default. s z+BaseParamsDocumenter.document_shape_defaultc K sb | j ||f|� |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_list3 s
�
�
z-BaseParamsDocumenter.document_shape_type_listc
K s� | j ||f|� |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 Z key_sectionr � end_sectionr
r
r �document_shape_type_mapE s,
�
�
�
z,BaseParamsDocumenter.document_shape_type_mapc K s� | � |j|�}| j|||d� |D ]J} |r4| |kr4q"|| }
|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_structure` s&
�
�
z2BaseParamsDocumenter.document_shape_type_structurec K s d S r r
r r
r
r r } s z.BaseParamsDocumenter._add_member_documentationc C s$ |r |� � }|D ]}|||j< q|S r )�copyr )r r) r r* r
r
r r( � s
z*BaseParamsDocumenter._add_members_to_shapec C sN | � |�}t|j�}d}|d k r0|�|| � n|j�|| � |�d� d S )Nz(%s) --� )�_get_special_py_type_namer � type_name�writer# Zitalics)r � type_sectionr Zspecial_py_type�py_typeZ type_formatr
r
r �"_document_non_top_level_param_type� s
z7BaseParamsDocumenter._document_non_top_level_param_typec C s |j �� |j �� d S r )r# r$ �new_line�r r r
r
r r � s
z(BaseParamsDocumenter._start_nested_paramc C s |j �� |j �� d S r )r# �dedentr4 r5 r
r
r r � s
z&BaseParamsDocumenter._end_nested_param)NN)NN)NN)NN)NNN)�__name__�
__module__� __qualname__r r r r r& r+ r r( r3 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 k r4|j�|� � |�d� |� d�}| �||� |� d�}|jr�|j�� t|dd�r�|� d�}d } d
�d d � |j �
� D ��}
d
} |�| |
� |� d�} | j� | � |� |j� |j�
� d S )N�
param-name�- r- �
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 s g | ]}d |� d ��qS �z``r
��.0r! r
r
r �
<listcomp>� s zFResponseParamsDocumenter._add_member_documentation.<locals>.<listcomp>z3'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}zparam-unknown-example)r r0 r# �boldr3 �
documentationr$ �getattr�joinr) �keysZ codeblock�include_doc_string�
new_paragraph)
r r r r r � name_sectionr1 �documentation_section�tagged_union_docs�note�tagged_union_members_strZunknown_code_example�exampler
r
r r � s4
��
��
z2ResponseParamsDocumenter._add_member_documentationc K s | j |||f|� d S r )r+ )r r r r r r
r
r � document_shape_type_event_stream� s z9ResponseParamsDocumenter.document_shape_type_event_stream)N)r7 r8 r9 �__doc__�
EVENT_NAMEr rS r
r
r
r r: � s
'r: c @ s8 e Zd ZdZdZd
dd�Zddd�Zd d
� Zd d � ZdS )�RequestParamsDocumenterz4Generates the description for the request parameterszrequest-paramsNc
K s� t |�dkr&| j||f|� |j�� | �|j|�}t|�D ]Z\}} |rR| |krRq<|| }
|j| d|
jid�} | j� � | |j
k} | 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 r4 Zrequired_membersr r6 )
r r r r r r
r r) �ir* r r rX r
r
r r+ � s2
�
�
z5RequestParamsDocumenter.document_shape_type_structureFc K sz | � |�}|d kr t|j�}|rr|�d�}|�d|� d|� �� |�d�} | j�� |�d�}
|
�d|� d�� nJ|�d�}
|
�d� |d k r�|
j�|� � |
�d� |�d�}| �||� |r�|�d �} | j� � | j�d
� | �d� |j
�rb|�d �} | j� � t |d d
��rJ|�d�}
d}d� dd� |j
�� D ��}|
�|| � | �|j
� | �| |� |�d�}|j�� d S )Nr= z:type z: zend-param-typer; z:param r< r- z is-requiredz
[REQUIRED]r> r? Fr@ zl.. note:: This is a Tagged Union structure. Only one of the following top level keys can be set: %s. rA c S s g | ]}d |� d ��qS rB r
rC r
r
r rE ! s zERequestParamsDocumenter._add_member_documentation.<locals>.<listcomp>z end-param)r. r r/ r r0 r# r4 rF r3 r$ rG rH rI r) rJ rK � _add_special_trait_documentationrL )r r r r Zis_top_level_paramrX r r2 r1 Zend_type_sectionrM Zis_required_sectionrN rO rP rQ Zend_param_sectionr
r
r r � sR
�
���
z1RequestParamsDocumenter._add_member_documentationc C s d|j kr| �|� d S )NZidempotencyToken)�metadata�!_append_idempotency_documentation)r r r r
r
r r\ ) s
z8RequestParamsDocumenter._add_special_trait_documentationc C s d}|� |� d S )Nz,This field is autopopulated if not provided.)r0 )r r Z docstringr
r
r r^ - s z9RequestParamsDocumenter._append_idempotency_documentation)NN)NFF) r7 r8 r9 rT rU r+ r r\ r^ r
r
r
r rV � s �
�
9rV N)Zbotocore.docs.shaper Zbotocore.docs.utilsr r r: rV r
r
r
r �<module>
s
2