File: //lib/python3.6/site-packages/botocore/docs/__pycache__/waiter.cpython-36.pyc
3
�T_� � @ sZ d dl mZ d dlmZ d dlmZ d dlmZ d dlm Z G dd� de
�Z d d d
�Z d S )
� )�
xform_name)� OrderedDict)�DocumentedShape)�get_service_module_name)� document_model_driven_methodc @ s$ e Zd Zdd� Zdd� Zdd� ZdS )�WaiterDocumenterc C s || _ | j jjj| _|| _d S )N)�_client�meta�
service_modelZ service_nameZ
_service_name�_service_waiter_model)�selfZclient�service_waiter_model� r � /usr/lib/python3.6/waiter.py�__init__ s zWaiterDocumenter.__init__c C s\ |j jd� |j j� |jd� x6| jjD ]*}|j jd| jjj |f � | j
||� q*W dS )zgDocuments the various waiters for a service.
:param section: The section to write to.
ZWaiterszThe available waiters are:z:py:class:`%s.Waiter.%s`N) �styleZh2�new_lineZwritelnr Z waiter_namesZlir � __class__�__name__�_add_single_waiter)r �section� waiter_namer r r �document_waiters s
z!WaiterDocumenter.document_waitersc C s� |j |�}|jjd| jjj|f d� |jj� |jj� |jdt |� � |jj
� |jj� t ||| jj j
| jj j| jd� d S )Nz %s.Waiter.%s)�
class_namez waiter = client.get_waiter('%s'))r r �
event_emitterr
r
)Zadd_new_sectionr Zstart_sphinx_py_classr r r Zstart_codeblockr �writer Z
end_codeblock�document_wait_methodr Zeventsr
r )r r r r r r r ( s
z#WaiterDocumenter._add_single_waiterN)r �
__module__� __qualname__r r r r r r r r s r Tc C s� |j |�}|j|j�}t� }tdddj|j�d�|d< tdddj|j�d�|d< tddd |d
�g} d jt|�t |j�|j|j�}
t
| d |||
d
| d|d� dS )a� Documents a the wait method of a waiter
:param section: The section to write to
:param waiter_name: The name of the waiter
:param event_emitter: The event emitter to use to emit events
:param service_model: The service model
:param service_waiter_model: The waiter model associated to the service
:param include_signature: Whether or not to include the signature.
It is useful for generating docstrings.
ZDelayZintegerzK<p>The amount of time in seconds to wait between attempts. Default: {0}</p>)�name� type_name�
documentationZ MaxAttemptsz><p>The maximum number of attempts to be made. Default: {0}</p>Z WaiterConfigZ structurezI<p>A dictionary that provides parameters to control waiting behavior.</p>)r r r! �membersz�Polls :py:meth:`{0}.Client.{1}` every {2} seconds until a successful state is reached. An error is returned after {3} failed checks.�waitz waiter.waitF)r Zmethod_descriptionZexample_prefixZ
include_inputZdocument_output�include_signatureN) Z
get_waiter�operation_modelZ operationr r �formatZdelayZ max_attemptsr r r ) r r r r
r
r$ Z waiter_modelr% Zwaiter_config_membersZbotocore_waiter_paramsZwait_descriptionr r r r A s8
r N)T)
Zbotocorer Zbotocore.compatr Zbotocore.docs.utilsr Zbotocore.utilsr Zbotocore.docs.methodr �objectr r r r r r �<module>
s /