File: //proc/self/root/lib/python3.6/site-packages/botocore/docs/__pycache__/params.cpython-36.pyc
3
�T_Y% � @ 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
� /usr/lib/python3.6/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|� | j|||d d� |jd�}| j|� 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 ||f|� |jdd|jjid�}| j|� | j ||j� |j|jjd|jjid�}|jj� | j|� | j||j|d d� |jd�} | j | � | j | � 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 Z end_sectionr
r
r �document_shape_type_map: s
z,BaseParamsDocumenter.document_shape_type_mapc K s� | j |j|�}| j|||d� xR|D ]J} |r6| |kr6q$|| }
|j| d|
jid�} | j| � | j| |
|| d� q$W |jd�}| j|� 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_structureO s
z2BaseParamsDocumenter.document_shape_type_structurec K s d S )Nr
)r r r r r
r
r r a s z.BaseParamsDocumenter._add_member_documentationc C s( |r$|j � }x|D ]}|||j< qW |S )N)�copyr )r r" r r# r
r
r r! d s
z*BaseParamsDocumenter._add_members_to_shapec C sD | j |�}t|j�}d}|d k r0|j|| � n|jj|| � 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_typek s
z7BaseParamsDocumenter._document_non_top_level_param_typec C s |j j� |j j� d S )N)r r �new_line)r r r
r
r r w s
z(BaseParamsDocumenter._start_nested_paramc C s |j j� |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 sv |j d�}|jd� |d k r,|jjd| � |j d�}| j||� |j d�}|jrh|jj� |j|j� |jj� d S )Nz
param-namez- z%s z
param-typezparam-documentation) r r( r �boldr+ �
documentationr �include_doc_string�
new_paragraph)r r r r r � name_sectionr) �documentation_sectionr
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)r. r/ r0 �__doc__�
EVENT_NAMEr r8 r
r
r
r r1 � s
r1 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|� |jj� | j|j|�}xft|�D ]Z\}} |rT| |krTq>|| }
|j| d|
jid�} | jj � | |j
k} | j | |
|| | d� q>W |jd�}t |�dkr�|jj � |jj � 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 r= r
r
r r$ � s&
z5RequestParamsDocumenter.document_shape_type_structureFc K s | j |�}|d kr t|j�}|rj|jd�}|jd||f � |jd�} | jj� |jd�}
|
jd| � nB|jd�}
|
jd� |d k r�|
jjd| � |jd�}| j||� |r�|jd�} | jj � | jjd � |j
�r|jd
�} | jj � | j |j
� | j | |� |jd �}
|
jj
� d S ) Nz
param-typez :type %s: %szend-param-typez
param-namez :param %s: z- z%s z is-requiredz [REQUIRED] zparam-documentationz end-param)r& r r' r r( r r, r2 r+ r r3 r4 � _add_special_trait_documentationr5 )r r r r Zis_top_level_paramr= r r* r) Zend_type_sectionr6 Zis_required_sectionr7 Zend_param_sectionr
r
r r � s8
z1RequestParamsDocumenter._add_member_documentationc C s d|j kr| j|� d S )NZidempotencyToken)Zmetadata�!_append_idempotency_documentation)r r r r
r
r rA � s
z8RequestParamsDocumenter._add_special_trait_documentationc C s d}|j |� d S )Nz,This field is autopopulated if not provided.)r( )r r Z docstringr
r
r rB � s z9RequestParamsDocumenter._append_idempotency_documentation)NN)NFF) r. r/ r0 r9 r: r$ r rA rB r
r
r
r r; � s
"r; N)Zbotocore.docs.shaper Zbotocore.docs.utilsr r r1 r; r
r
r
r �<module>
s o