File: //opt/alt/python37/lib/python3.7/site-packages/boto3/docs/__pycache__/collection.cpython-37.pyc
B
�P�e�- � @ s� d dl Z d dlmZ d dlmZ d dlmZ d dlmZ d dl m
Z
d dl m Z d dl
mZmZ G d d
� d
e
�Zdd d
�Zddd�Zddd�ZdS )� N)�
xform_name)�DocumentStructure)�get_instance_public_methods)�DocumentedShape)�NestedDocumenter)�%document_model_driven_resource_method)�add_resource_type_overview�get_resource_ignore_paramsc @ s e Zd Zdd� Zdd� ZdS )�CollectionDocumenterc C s� | j jjj}g }t|dddd� || jd< x�|D ]�}|�|j� t|jdd�}|� d�}|j
� | j d � |�
d
|j� �� |�|j� |j |jd | j� d �id
�}| �||� tj�| j| j� | j� �}|�||j� q0W d S )NZ CollectionszUCollections provide an interface to iterate over and manipulate groups of resources. Zguide_collections)�sectionZ
resource_type� descriptionZ
intro_link� collections�html)�targetZ
breadcrumb�indexz / Collection / � qualifier�.)�context)� _resource�metaZresource_modelr
r �
member_map�append�namer �add_new_section�style�refZ_resource_class_name�writeZadd_title_section�
class_name�_document_collection�os�path�joinZ_root_docs_pathZ
_service_nameZ_resource_sub_pathZ
write_to_file) �selfr r
Zcollections_list�
collectionZcollection_docZbreadcrumb_sectionZcollection_sectionZcollections_dir_path� r$ �F/opt/alt/python37/lib/python3.7/site-packages/boto3/docs/collection.py�document_collections s0
z)CollectionDocumenter.document_collectionsc C s� t t| j|j��}t||� i }x|jD ]}|||j< q(W x|t|�D ]p}|�|�}||kr�t|| j | jj
j j
j || || jj
j j
j
d� qDt|| j || jj
j j
j || jj
j j
j
d� qDW d S )N)r �
resource_name�
event_emitter�batch_action_model�collection_model�
service_model)r r' � action_namer( r* r+ )r �getattrr r �document_collection_object�
batch_actions�sortedr �document_batch_actionZ_resource_namer �client�eventsr+ �document_collection_method)r" r r# �methodsr/ Z batch_action�methodZmethod_sectionr$ r$ r% r A s.
z)CollectionDocumenter._document_collectionN)�__name__�
__module__� __qualname__r& r r$ r$ r$ r% r
s $r
Tc C sX |r(| j �dd�� |j� �}| j�|� | �d|jj� d�� | �d|jj� d�� dS )a
Documents a collection resource object
:param section: The section to write to
:param collection_model: The model of the collection
:param include_signature: Whether or not to include the signature.
It is useful for generating docstrings.
r � zA collection of z resources.zA z� Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.N)r �getr r Zstart_sphinx_py_attrZinclude_doc_string�resource�type)r r* �include_signatureZfull_collection_namer$ r$ r% r. ` s r. c C s| |� |jj�}t|jj�}d} |jr0t|jj�} t|�}
|j|krF|}
d� | |
|j
|j
�} t | |j
|||j | |||d� dS )ai Documents a collection's batch action
:param section: The section to write to
:param resource_name: The name of the resource
:param action_name: The name of collection action. Currently only
can be all, filter, limit, or page_size
:param event_emitter: The event emitter to use to emit events
:param batch_action_model: The model of the batch action
:param collection_model: The model of the collection
:param service_model: The model of the service
:param include_signature: Whether or not to include the signature.
It is useful for generating docstrings.
�responsez
{} = {}.{}.{}) r � method_name�operation_modelr( �method_description�example_prefix�
exclude_input�resource_action_modelr> N)
rA �request� operationr �paramsr< r r= � service_name�formatr r �
documentation) r r' r( r) r+ r* r> rA Z
ignore_paramsZexample_return_value�example_resource_namerC r$ r$ r% r1 } s2
r1 c
C sD |� |jj�}g }|jr |jj}t|�} |j|kr6|} d|jj� d�d� t|jj�| |j
�|d�d|jj� d|jj� d�d� t|jj�| |j
�t |jj �d�d|jj� d�d � t|jj�| |j
�t
d
d d d
�g|d�d|jj� d�d� t|jj�| |j
�t
d
d dd
�g|d�d�}
||
k�r@|
| } tf | |||||d�| �� dS )a# Documents a collection method
:param section: The section to write to
:param resource_name: The name of the resource
:param action_name: The name of collection action. Currently only
can be all, filter, limit, or page_size
:param event_emitter: The event emitter to use to emit events
:param collection_model: The model of the collection
:param service_model: The model of the service
:param include_signature: Whether or not to include the signature.
It is useful for generating docstrings.
zCreates an iterable of all z resources in the collection.z{}_iterator = {}.{}.all)rB rC rD zD resources in the collection filtered by kwargs passed to method. A z� collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.z{}_iterator = {}.{}.filterz0Creates an iterable up to a specified amount of z{}_iterator = {}.{}.limit�count�integerz5The limit to the number of resources in the iterable.)r � type_namerK )rB rC Z
include_inputrD zs resources in the collection, but limits the number of items returned by each service call by the specified amount.z {}_iterator = {}.{}.page_sizez1The number of items returned by each service call)�all�filter�limitZ page_size)r r@ rA r( rE r> N)rA rF rG Z input_shape�membersr rI r< r= rJ r r rH r r ) r r' r, r( r* r+ r> rA Z underlying_operation_membersrL Zcustom_action_info_dictZ action_infor$ r$ r% r4 � sf
r4 )T)T)T)r Zbotocorer Zbotocore.docs.bcdoc.restdocr Zbotocore.docs.methodr Zbotocore.docs.utilsr Zboto3.docs.baser Zboto3.docs.methodr Zboto3.docs.utilsr r r
r. r1 r4 r$ r$ r$ r% �<module>
s G
!
>