U

KD�g#�@sldd
lZddl
mZ
ddlmZ
ddlmZ
ddlmZ
ddl	m
Z

ddlmZ
Gdd	�d	�Z
d
dd�
Zd
S)�N)
�
xform_name)
�OrderedDict)
�DocumentStructure)
�document_model_driven_method)
�DocumentedShape)
�get_service_module_namec@s,eZ
dZd
d�Zdd�Zdd�Zdd�Zd	S)
�PaginatorDocumentercCs6|
|_|jj
j|_|jjjj|_||_||_	d
|_
dS)NzMhttps://boto3.amazonaws.com/v1/documentation/api/latest/guide/paginators.html)�_client�	__class__�__name__�_client_class_name�meta�
service_model�service_name�
_service_name�_service_paginator_model�_root_docs_path�_USER_GUIDE_LINK)�self�clientZservice_paginator_modelZroot_docs_path�r�D/opt/cppython/lib/python3.8/site-packages/botocore/docs/paginator.py�__init__s




�zPaginatorDocumenter.__init__cCs�|
j�
d
�

|�|
�

|
j��
|
�d�

|
j��
t|jj�
}|D]T}|
j�	|j
�d|���

t|dd�}|�||�
t
j�|j|j
d�}|�||�
qDdS)zhDocuments the various paginators for a service

        param section: The section to write to.
        Z
PaginatorszThe available paginators are:z/paginator/�html)
�targetZ	paginatorN)�styleZh2�
_add_overview�new_line�writelnZtoctree�sortedrZ_paginator_configZtocitemrr�_add_paginator�os�path�joinrZ
write_to_file)r�sectionZpaginator_names�paginator_nameZpaginator_doc_structureZpaginator_dir_pathrrr�document_paginators#s4








�

�
�
�
�z'PaginatorDocumenter.document_paginatorscCs�|
�d
�
}|j
�|jd|j���
|�d|���

|
�|�

|
�|�
}|j
j|j�d|��d�

|j
��
|j
�	�
|�dt
|�
�d��

|j
��
|j
�	�
|j�
|�
}t|||jjj|jjj|d�
dS)	NZ
breadcrumbz../../z / Paginator / z.Paginator.)
�
class_namez"paginator = client.get_paginator('z'))r$r%�
event_emitterr�paginator_config)Zadd_new_sectionr�refrr�writeZadd_title_sectionZstart_sphinx_py_classZstart_codeblockrrZ
end_codeblockrZ
get_paginator�document_paginate_methodr	r
�eventsr)rr$r%Zbreadcrumb_sectionZpaginator_sectionr)rrrr Es8




�



�



�



�




�z"PaginatorDocumenter._add_paginatorcCs>|
j�
�
|
�d
�

|
jjd|jd�
|
�d�

|
j�
�
dS)Nz�Paginators are available on a client instance via the ``get_paginator`` method. For more detailed instructions and examples on the usage of paginators, see the paginators z
user guide)�title�link�
.)rrr+Z
external_linkr)rr$rrrris



�

�

z!PaginatorDocumenter._add_overviewN)r�
__module__�__qualname__rr&r rrrrrrs
"$rTc

Cs&
|�|
�
}t
�}td
ddd�|d
<|�dd�r@tdddd�|d<td	d
dd�|d	<tdd
d|d�g
}tdd
dd�g
}	g}
t|dt�r�|
|d7}
n|
�|d�

|�dd�r�|
�|d�

g}t|dt�r�||d7}n|�|d�

dt|�
�dt|
�
�d�}t	|d|||d||	|
||d�
dS)a�
Documents the paginate method of a paginator

    :param section: The section to write to

    :param paginator_name: The name of the paginator. It is snake cased.

    :param event_emitter: The event emitter to use to emit events

    :param service_model: The service model

    :param paginator_config: The paginator config associated to a particular
        paginator.

    :param include_signature: Whether or not to include the signature.
        It is useful for generating docstrings.
    ZMaxItems�integerz�<p>The total number of items to return. If the total number of items available is more than the value specified in max-items then a <code>NextToken</code> will be provided in the output that you can use to resume pagination.</p>)�name�	type_name�
documentationZ	limit_keyNZPageSizez<p>The size of each page.<p>Z
StartingToken�stringzq<p>A token to specify where to start paginating. This is the <code>NextToken</code> from a previous response.</p>ZPaginationConfigZ	structurezC<p>A dictionary that provides parameters to control pagination.</p>)r4r5r6�membersZ	NextTokenz$<p>A token to resume pagination.</p>Zinput_tokenZoutput_tokenzHCreates an iterator that will paginate through responses from :py:meth:`z.Client.z`.Zpaginatez&response_iterator = paginator.paginate)r(Zmethod_descriptionZexample_prefixZ
include_inputZinclude_outputZ
exclude_inputZexclude_output�include_signature)
�operation_modelrr�get�
isinstance�list�appendrrr)
r$r%r(rr)r9r:Zpagination_config_membersZbotocore_pagination_paramsZ#botocore_pagination_response_paramsZservice_pagination_paramsZ"service_pagination_response_paramsZpaginate_descriptionrrrr,yst


�




�


�


��



��




��










�r,)
T)r!ZbotocorerZbotocore.compatrZbotocore.docs.bcdoc.restdocrZbotocore.docs.methodrZbotocore.docs.utilsrZbotocore.utilsrrr,rrrr�<module>
s




h�