File: //opt/alt/python37/lib/python3.7/site-packages/botocore/docs/__pycache__/params.cpython-37.pyc
B
�P�e�- � @ 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
�E/opt/alt/python37/lib/python3.7/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 )N)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 r 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� xR|D ]J} |r6| |kr6q$|| }
|j| d|
jid�} | �| � | j| |
|| d� q$W |�d�}| �|� d S )N)r r )r )r r r r z
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 )Nr
)r r r r r
r
r r } s z.BaseParamsDocumenter._add_member_documentationc C s( |r$|� � }x|D ]}|||j< qW |S )N)�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 )N)r r �new_line)r r r
r
r r � s
z(BaseParamsDocumenter._start_nested_paramc C s |j �� |j �� d S )N)r �dedentr. )r r 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" r- 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 r6|j�d| � |�d� |� d�}| �||� |� d�}|jr�|j�� t|dd�r�|� d �}d
} d �d d
� |j �
� D ��}
d} |�| |
� |� d�} | j� | � |� |j� |j�
� d S )Nz
param-namez- z%sr' z
param-typezparam-documentation�is_tagged_unionFzparam-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 followsz, c S s g | ] }d | �qS )z``%s``r
)�.0r r
r
r �
<listcomp>� s zFResponseParamsDocumenter._add_member_documentation.<locals>.<listcomp>z3'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}zparam-unknown-example)r r* r �boldr- �
documentationr �getattr�joinr# �keysZ codeblock�include_doc_string�
new_paragraph)
r r r r r � name_sectionr+ �documentation_section�tagged_union_docs�note�tagged_union_members_strZunknown_code_example�exampler
r
r r � s,
z2ResponseParamsDocumenter._add_member_documentationc K s | j |||f|� d S )N)r% )r r r r r r
r
r � document_shape_type_event_stream� s z9ResponseParamsDocumenter.document_shape_type_event_stream)N)r0 r1 r2 �__doc__�
EVENT_NAMEr rD r
r
r
r r3 � s
'r3 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|�}xft|�D ]Z\}} |rT| |krTq>|| }
|j| d|
jid�} | j� � | |j
k} | j | |
|| | d� q>W |�d�}t |�dkr�|j� � |j� � d S )N� r )r )r r r r � is_requiredz
end-structure)
�lenr r r r" r# � enumerater r r. Zrequired_membersr r/ )
r r r r r r
r r# �ir$ r r rI r
r
r r% � s,
z5RequestParamsDocumenter.document_shape_type_structureFc K sx | � |�}|d kr t|j�}|rn|�d�}|�d|� d|� �� |�d�} | j�� |�d�}
|
�d| � nL|�d�}
|
�d� |d k r�|
j�d| � |
�d � |�d�}| �||� |r�|�d
�} | j� � | j�d � | �d � |j
�r`|�d �} | j� � t |d
d��rH|�d�}
d}d� dd� |j
�� D ��}|
�|| � | �|j
� | �| |� |�d�}|j�� d S )Nz
param-typez:type z: zend-param-typez
param-namez :param %s: z- z%sr' z is-requiredz
[REQUIRED]zparam-documentationr4 Fzparam-tagged-union-docszl.. note:: This is a Tagged Union structure. Only one of the following top level keys can be set: %s. z, c S s g | ] }d | �qS )z``%s``r
)r5 r r
r
r r6 ! s zERequestParamsDocumenter._add_member_documentation.<locals>.<listcomp>z end-param)r( r r) r r* r r. r7 r- r r8 r9 r: r# r; r< � _add_special_trait_documentationr= )r r r r Zis_top_level_paramrI r r, r+ Zend_type_sectionr> Zis_required_sectionr? r@ rA rB Zend_param_sectionr
r
r r � sJ
z1RequestParamsDocumenter._add_member_documentationc C s d|j kr| �|� d S )NZidempotencyToken)�metadata�!_append_idempotency_documentation)r r r r
r
r rM ) s
z8RequestParamsDocumenter._add_special_trait_documentationc C s d}|� |� d S )Nz,This field is autopopulated if not provided.)r* )r r Z docstringr
r
r rO - s z9RequestParamsDocumenter._append_idempotency_documentation)NN)NFF) r0 r1 r2 rE rF r% r rM rO r
r
r
r rG � s
3rG N)Zbotocore.docs.shaper Zbotocore.docs.utilsr r r3 rG r
r
r
r �<module>
s
2