File: //opt/alt/python37/lib/python3.7/site-packages/botocore/docs/__pycache__/waiter.cpython-37.pyc
B
�P�e� � @ sl d dl Z d dlmZ d dlmZ d dlmZ d dlmZ d dl m
Z
d dl m Z G dd � d �Z
d
d d �ZdS )� N)�
xform_name)� OrderedDict)�DocumentStructure)� document_model_driven_method)�DocumentedShape)�get_service_module_namec @ s, e Zd Zdd� Zdd� Zdd� Zdd� Zd S )
�WaiterDocumenterc C s6 || _ | j jj| _| j jjj| _|| _|| _ d| _
d S )NzRhttps://boto3.amazonaws.com/v1/documentation/api/latest/guide/clients.html#waiters) �_client� __class__�__name__�_client_class_name�meta�
service_model� service_name�
_service_name�_service_waiter_model�_root_docs_path�_USER_GUIDE_LINK)�self�client�service_waiter_modelZroot_docs_path� r �E/opt/alt/python37/lib/python3.7/site-packages/botocore/docs/waiter.py�__init__ s zWaiterDocumenter.__init__c C s� |j �d� | �|� |j �� |�d� |j �� x`| jjD ]T}|j �| j � d|� �� t
|dd�}| � ||� t j
�| j| j d�}|�||� q>W dS )zgDocuments the various waiters for a service.
:param section: The section to write to.
ZWaiterszThe available waiters are:z/waiter/�html)�target�waiterN)�styleZh2�
_add_overview�new_line�writelnZtoctreer Z waiter_namesZtocitemr r �_add_single_waiter�os�path�joinr Z
write_to_file)r �section� waiter_nameZwaiter_doc_structureZwaiter_dir_pathr r r �document_waiters# s
z!WaiterDocumenter.document_waitersc C s� |� d�}|j�| jd| j� �� |�d|� �� |�|� |� |�}|jj| j� d|� �d� |j�� |j� � |�dt
|� � |j� � |j� � t ||| j
jj| j
jj| jd� d S )NZ
breadcrumbz../../z / Waiter / z.Waiter.)�
class_namez waiter = client.get_waiter('%s'))r% r& �
event_emitterr r )Zadd_new_sectionr �refr r �writeZadd_title_sectionZstart_sphinx_py_classZstart_codeblockr r Z
end_codeblock�document_wait_methodr r
�eventsr r )r r% r& Zbreadcrumb_sectionZwaiter_sectionr r r r! ; s(
z#WaiterDocumenter._add_single_waiterc C s> |j �� |�d� |j jd| jd� |�d� |j �� d S )Nz�Waiters are available on a client instance via the ``get_waiter`` method. For more detailed instructions and examples on the usage or waiters, see the waiters z
user guide)�title�link�.)r r r+ Z
external_linkr )r r% r r r r Y s
z WaiterDocumenter._add_overviewN)r �
__module__� __qualname__r r' r! r r r r r r s r Tc C s� |� |�}|�|j�}t� }tddd�|j�d�|d< tddd�|j�d�|d< tddd |d
�g} d �t|�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.
ZDelay�integerzJ<p>The amount of time in seconds to wait between attempts. Default: {}</p>)�name� type_name�
documentationZ MaxAttemptsz=<p>The maximum number of attempts to be made. Default: {}</p>Z WaiterConfigZ structurezI<p>A dictionary that provides parameters to control waiting behavior.</p>)r4 r5 r6 �membersz�Polls :py:meth:`{}.Client.{}` every {} seconds until a successful state is reached. An error is returned after {} failed checks.�waitz waiter.waitF)r) Zmethod_descriptionZexample_prefixZ
include_inputZdocument_output�include_signatureN) Z
get_waiter�operation_modelZ operationr r �format�delayZ max_attemptsr r r ) r% r& r) r r r9 Z waiter_modelr: Zwaiter_config_membersZbotocore_waiter_paramsZwait_descriptionr r r r, i sB
r, )T)r" Zbotocorer Zbotocore.compatr Zbotocore.docs.bcdoc.restdocr Zbotocore.docs.methodr Zbotocore.docs.utilsr Zbotocore.utilsr r r, r r r r �<module>
s X