h r d dl Z d dlmZ d dlmZ d dlmZ d dlmZ d dl m
Z
d dl m Z G d d Z
d d
Zy) N)
xform_name) OrderedDict)DocumentStructure) document_model_driven_method)DocumentedShape)get_service_module_namec $ e Zd Zd Zd Zd Zd Zy)WaiterDocumenterc || _ | j j j | _ | j j j
j | _ || _ || _ d| _
y )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_paths p/home/developers/rajanand/mypropertyqr-fmb-refixing-v2/venv/lib/python3.12/site-packages/botocore/docs/waiter.py__init__zWaiterDocumenter.__init__ s] "&,,"8"8"A"A !\\ . . < < I I%9" -
E
c < |j j d | j | |j j |j d |j j | j j D ] }|j j | j d| t |d }| j || t j j | j | j d }|j! || y)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_paths r document_waitersz!WaiterDocumenter.document_waiters# s
# 7#
45
55BB MK MM ! !T%7%7$8
"N O#4F$
# #$8+ F !ggll$$d&8&8( O
! . . L Mr c |j d }|j j | j d| j |j d| |j
| |j | }|j j | j d| |j j |j j |j dt | d |j j |j j t ||| j j j | j j j | j" y ) N
breadcrumbz../../z / Waiter / z.Waiter.)
class_namez waiter = client.get_waiter('z'))r0 r1
event_emitterr r )add_new_sectionr# refr r writeadd_title_sectionstart_sphinx_py_classstart_codeblockr& r
end_codeblockdocument_wait_methodr r eventsr r )r r0 r1 breadcrumb_sectionwaiter_sections r r+ z#WaiterDocumenter._add_single_waiter; sN $ 4 4\ B $$ # #vd.@.@-A%B
< }!=>!!+. 00= 22 112(;-H 3
,,. %%' +J{,C+DC H
**, %%' "# ,,++22 ,,++99!%!;!;
r c |j j |j d |j j d| j |j d |j j y )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& r;
external_linkr )r r0 s r r% z WaiterDocumenter._add_overviewY sf
## && $
c
r N)r
__module__ __qualname__r r4 r+ r% r r r
r
s
M0
<
!r r
c |j | }|j |j }t }t ddd|j
d |d< t ddd|j d |d< t dd d
| g} d t | d
t |j d|j
d|j d }
t | d|||
d| d| y)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.
)rO rP rQ 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)r8 method_descriptionexample_prefix
include_inputdocument_outputinclude_signatureN)
get_waiteroperation_model operationr r delay max_attemptsr r r ) r0 r1 r8 r r r[ waiter_modelr] waiter_config_membersbotocore_waiter_paramswait_descriptions r r@ r@ i s& . (22;?L#33L4J4JKO 'M%4
""."4"4!5T
; &'" ,;
$112$
8 ,-( !( *
2=AB( l,, -
.h|7I7I6J K$112/ C !#+$, +
r )T)r, botocorer botocore.compatr botocore.docs.bcdoc.restdocr botocore.docs.methodr botocore.docs.utilsr botocore.utilsr r
r@ rK r r rk s4
' 9 = / 2O! O!p
Kr