o
Vf @ sn 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_namemeta
service_model service_name
_service_name_service_waiter_model_root_docs_path_USER_GUIDE_LINK)selfclientservice_waiter_modelroot_docs_path r U/home/ubuntu/oakencloud.com/venv/lib/python3.10/site-packages/botocore/docs/waiter.py__init__ s zWaiterDocumenter.__init__c C s |j d | | |j |d |j | jjD ]*}|j | j d| t
|dd}| || t j
| j| j d}||| q dS )zgDocuments the various waiters for a service.
:param section: The section to write to.
WaiterszThe available waiters are:z/waiter/html)targetwaiterN)styleh2
_add_overviewnew_linewritelntoctreer waiter_namestocitemr r _add_single_waiterospathjoinr
write_to_file)r section waiter_namewaiter_doc_structurewaiter_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
| d |j |j t ||| j
jj| j
jj| jd d S ) N
breadcrumbz../../z / Waiter / z.Waiter.)
class_namez waiter = client.get_waiter('z'))r, r-
event_emitterr r )add_new_sectionr refr r writeadd_title_sectionstart_sphinx_py_classstart_codeblockr" r
end_codeblockdocument_wait_methodr r
eventsr r )r r, r- breadcrumb_sectionwaiter_sectionr r r r' ; s0
z#WaiterDocumenter._add_single_waiterc C s> |j |d |j jd| jd |d |j d S )NzWaiters 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)titlelink.)r r" r6
external_linkr )r r, r r r r! Y s
z WaiterDocumenter._add_overviewN)r
__module__ __qualname__r r0 r' r! r r r r r s
r Tc C s | |}||j}t }tddd|j dd|d< tddd|j dd|d< tdd d
|d g} d t| d
t|j d|j d|j d }
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.
DelayintegerzDThe amount of time in seconds to wait between attempts. Default: z
)name type_name
documentation MaxAttemptsz7The maximum number of attempts to be made. Default: WaiterConfig structurezI
A dictionary that provides parameters to control waiting behavior.
)rG rH rI memberszPolls :py:meth:`z.Client.z` every zG seconds until a successful state is reached. An error is raised after z failed checks.waitz waiter.waitF)r3 method_descriptionexample_prefix
include_inputdocument_outputinclude_signatureN)
get_waiteroperation_model operationr r delay max_attemptsr r r ) r, r- r3 r r rS waiter_modelrU waiter_config_membersbotocore_waiter_paramswait_descriptionr r r r; i sV
r; )T)r( botocorer botocore.compatr botocore.docs.bcdoc.restdocr botocore.docs.methodr botocore.docs.utilsr botocore.utilsr r r; r r r r s X