File: //opt/alt/python37/lib/python3.7/site-packages/botocore/docs/__pycache__/example.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_defaultc @ st e Zd Zddd�Zdd� Zddd�Zddd �Zdd
d �Zd d d
�Zd dd�Z dd� Z
d dd�Z d dd�Z dd� Z
dS ) �BaseExampleDocumenterNc C sV g }|j �� |j �� |dk r*|�|� | j|||||d� |�d�}|j �� dS )a] Generates an example based on a shape
:param section: The section to write the documentation to.
:param shape: The shape of the operation.
:param prefix: Anything to be included before the example
: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�include�excludezfinal-blank-line)�style�new_lineZstart_codeblock�write�traverse_and_document_shape�add_new_section)�selfr r �prefixr r r Zfinal_blank_line_section� r �F/opt/alt/python37/lib/python3.7/site-packages/botocore/docs/example.py�document_example s
z&BaseExampleDocumenter.document_examplec K s |� d� d S )Nz{'... recursive ...'})r )r r r �kwargsr r r �document_recursive_shape4 s z.BaseExampleDocumenter.document_recursive_shapec K s> | � |�}|d kr t|j�}| j�d�|kr0d}|�|� d S )NZstreaming_shapezStreamingBody())Z_get_special_py_defaultr � type_name�_context�getr )r r r r r r r Zpy_typer r r �document_shape_default7 s
z,BaseExampleDocumenter.document_shape_defaultc K sh d|j krVxXt|j d �D ]6\}}|�d| � |t|j d �d k r|�d� qW n| �|||� d S )N�enumz'%s'� �|)�metadata� enumerater �lenr ) r r r r r r r �ir r r r �document_shape_type_stringB s
z0BaseExampleDocumenter.document_shape_type_stringc K sn |j }|�d�}| �|d� |jdd|jid�} | j| ||d� |�d�}
|
�d� |�d �} | �| d
� d S ) Nz
list-value�[�memberr )�context)r r r z ending-comma�,zending-bracket�])r# r �_start_nested_param�namer
r �_end_nested_param) r r r r r r r � param_shapeZ list_section�
param_section�ending_comma_sectionZending_bracket_sectionr r r �document_shape_type_listM s
z.BaseExampleDocumenter.document_shape_type_listc K s� |j s|�d� d S |�d�}| �|d� | �|j |�}x�t|�D ]�\}} |rX| |krXqB|�| �}
|
�d| � || } |
jdd| jid�} | j| | || d� |t|�d k rB|
�d
�}
|
�d � |
j �
� qBW | � |dd � d S )
Nz{}zstructure-value�{z'%s': z member-valuer )r$ )r r r r( r z ending-commar% �}) �membersr r r' �_add_members_to_shaper r( r
r r
r �_end_structure)r r r r r r r �
input_membersr �paramr+ r* �param_value_sectionr, r r r � document_shape_type_structure^ s2
z3BaseExampleDocumenter.document_shape_type_structurec K sz |� d�}| �|d� |j}|j dd|jjid�} | �d� |j dd|jid�}
| j|
||d� |� d �} | �| d
� d S ) Nz map-valuer. �keyr )r$ z
'string': �value)r r r zending-bracketr/ )r r' r8 r7 r( r r
r) ) r r r r r r r Z map_sectionZ value_shapeZ key_sectionZ
value_section�end_bracket_sectionr r r �document_shape_type_map� s
z-BaseExampleDocumenter.document_shape_type_mapc C s( |r$|� � }x|D ]}|||j< qW |S )N)�copyr( )r r0 r r4 r r r r1 � s
z+BaseExampleDocumenter._add_members_to_shapec C s4 |d k r|� |� |j�� |j�� |j�� d S )N)r r
�indentr )r r �startr r r r' � s
z)BaseExampleDocumenter._start_nested_paramc C s4 |j �� |j �� |j �� |d k r0|�|� d S )N)r
�dedentr r )r r �endr r r r) � s
z'BaseExampleDocumenter._end_nested_paramc C sB |j s(|�� |�|| � | �|� n|�d�}| �||� d S )Nzending-bracket)Zavailable_sectionsZ
clear_textr r) r )r r r= r? r9 r r r r2 � s
z$BaseExampleDocumenter._end_structure)NNN)NN)NN)NN)NN)NN)N)N)�__name__�
__module__� __qualname__r r r r! r- r6 r: r1 r' r) r2 r r r r r s
!
#
r c @ s e Zd ZdZdd� ZdS )�ResponseExampleDocumenterzresponse-examplec K s4 |� d� | j|||f|� |�d�}|� d� d S )Nz EventStream(zevent-stream-end�))r r6 r )r r r r r � end_sectionr r r � document_shape_type_event_stream� s
z:ResponseExampleDocumenter.document_shape_type_event_streamN)r@ rA rB �
EVENT_NAMErF r r r r rC � s rC c @ s e Zd ZdZddd�ZdS )�RequestExampleDocumenterzrequest-exampleNc K s d}d}d} d}
t |�dkr,d}d} d}
d }|�d
�}| �|| � | �|j|�} x�t| �D ]�\} }
|rp|
|krpqZ|�|
�}|�||
� |�|� | |
}|jd d |jid
�}| j||||
d� | t | �d k rZ|�d�}|�d� |j �
� qZW | � || |
� d S )Nz'%s'z: r. r/ r �=�(rD z%szstructure-valuez member-valuer )r$ )r r r r( z ending-commar% ) r r r' r1 r0 r r r( r
r
r r2 )r r r r r r r Z param_format�operatorr= r? r3 r r4 r+ r* r5 r, r r r r6 � s@
z6RequestExampleDocumenter.document_shape_type_structure)NN)r@ rA rB rG r6 r r r r rH � s rH N)Zbotocore.docs.shaper Zbotocore.docs.utilsr r rC rH r r r r �<module>
s
&