B
䊇c @ sX d dl mZ d dlmZ d dlmZ d dlmZ d dlm Z G dd dZ
d d d
Z d S )
)
xform_name) OrderedDict) document_model_driven_method)DocumentedShape)get_service_module_namec @ s$ e Zd Zdd Zdd Zdd ZdS )WaiterDocumenterc C s || _ | j jjj| _|| _d S )N)_clientmeta
service_model service_nameZ
_service_name_service_waiter_model)selfclientservice_waiter_model r o/private/var/folders/8c/hx9_v10d5x38qmnzt13b7b8j1k3n5b/T/pip-target-x6xd5gna/lib/python/botocore/docs/waiter.py__init__ s zWaiterDocumenter.__init__c C sb |j d |j |d x<| jjD ]0}|j d| jjj d| d |
|| q*W dS )zgDocuments the various waiters for a service.
:param section: The section to write to.
ZWaiterszThe available waiters are:z :py:class:`z.Waiter.`N) styleZh2new_linewritelnr Z waiter_namesZlir __class____name___add_single_waiter)r
section waiter_namer r r document_waiters s
z!WaiterDocumenter.document_waitersc C s | |}|jj| jjj d| d |j |j |dt | |j
|j t ||| jj j
| jj j| jd d S )Nz.Waiter.)
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_codeblockdocument_wait_methodr eventsr
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}t }tddd|jd|d< tddd|jd|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.
ZDelayintegerzJThe amount of time in seconds to wait between attempts. Default: {}
)name type_name
documentationZ MaxAttemptsz=The maximum number of attempts to be made. Default: {}
Z WaiterConfigZ structurezIA dictionary that provides parameters to control waiting behavior.
)r% r& r' memberszPolls :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_outputinclude_signatureN) Z
get_waiteroperation_modelZ operationr r formatdelayZ max_attemptsr r r ) r r r r
r r* Z waiter_modelr+ Zwaiter_config_membersZbotocore_waiter_paramsZwait_descriptionr r r r A sB
r N)T) Zbotocorer Zbotocore.compatr Zbotocore.docs.methodr Zbotocore.docs.utilsr Zbotocore.utilsr r r r r r r
s 3