o
.&a @ s\ 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)_clientmeta
service_model service_name
_service_name_service_waiter_model)selfclientservice_waiter_model r 6/usr/lib/python3/dist-packages/botocore/docs/waiter.py__init__ s
zWaiterDocumenter.__init__c C sX |j d |j |d | jjD ]}|j d| jjj |f |
|| qdS )zgDocuments the various waiters for a service.
:param section: The section to write to.
WaiterszThe available waiters are:z:py:class:`%s.Waiter.%s`N) styleh2new_linewritelnr
waiter_nameslir __class____name___add_single_waiterr section waiter_namer r r document_waiters s
z!WaiterDocumenter.document_waitersc C s | |}|jjd| jjj|f d |j |j |dt | |j
|j t ||| jj j
| jj j| jd d S )Nz %s.Waiter.%s)
class_namez waiter = client.get_waiter('%s'))r r
event_emitterr
r )add_new_sectionr start_sphinx_py_classr r r start_codeblockr writer
end_codeblockdocument_wait_methodr eventsr
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.
DelayintegerzKThe amount of time in seconds to wait between attempts. Default: {0}
)name type_name
documentation MaxAttemptsz>The maximum number of attempts to be made. Default: {0}
WaiterConfig structurezIA dictionary that provides parameters to control waiting behavior.
)r/ r0 r1 memberszPolls :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# method_descriptionexample_prefix
include_inputdocument_outputinclude_signatureN)
get_waiteroperation_model operationr r formatdelay max_attemptsr r r ) r r r# r
r r; waiter_modelr= waiter_config_membersbotocore_waiter_paramswait_descriptionr r r r) A sJ
r) N)T)
botocorer botocore.compatr botocore.docs.utilsr botocore.utilsr botocore.docs.methodr objectr r) r r r r s /