o

.&�a��@s\dd
lm
Z

ddlmZ
ddlmZ
ddlmZ
ddlm	Z	
Gdd�de
�Z	dd	d
�
ZdS)
�)
�
xform_name)
�OrderedDict)
�DocumentedShape)
�get_service_module_name)
�document_model_driven_methodc@s$eZ
dZd
d�Zdd�Zdd�ZdS)�PaginatorDocumentercCs|
|_|jj
jj|_||_dS)
N)�_client�meta�
service_model�service_name�
_service_name�_service_paginator_model)�self�client�service_paginator_model�r�9/usr/lib/python3/dist-packages/botocore/docs/paginator.py�__init__s



zPaginatorDocumenter.__init__cCs`|
j�
d
�

|
j��
|
�d�

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

|�|
|�
qdS)zhDocuments the various paginators for a service

        param section: The section to write to.
        �
PaginatorszThe available paginators are:z:py:class:`%s.Paginator.%s`N)�style�h2�new_line�writeln�sortedr
�_paginator_config�lir�	__class__�__name__�_add_paginator)r�section�paginator_names�paginator_namerrr�document_paginatorss




�



���z'PaginatorDocumenter.document_paginatorscCs�|
�|�
}
|
j
jd
|jjj|fd�

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

|
j
�
�
|
j
��
|j�|�
}t
|
||jjj|jjj|d�
dS)Nz%s.Paginator.%s)
�
class_namez&paginator = client.get_paginator('%s'))rr!�
event_emitterr
�paginator_config)�add_new_sectionr�start_sphinx_py_classrrr�start_codeblockr�writer�
end_codeblockr
�
get_paginator�document_paginate_methodr	�eventsr
)rrr!r%rrrr-s2




��




��



�





�z"PaginatorDocumenter._add_paginatorN)r�
__module__�__qualname__rr"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�rJ|
|d7}
n|
�|d�

|�dd�r^|
�|d�

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

d�t|�
t	|
�
�}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.
    �MaxItems�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�
documentation�	limit_keyN�PageSizez<p>The size of each page.<p>�
StartingToken�stringzq<p>A token to specify where to start paginating. This is the <code>NextToken</code> from a previous response.</p>�PaginationConfig�	structurezC<p>A dictionary that provides parameters to control pagination.</p>)r2r3r4�members�	NextTokenz$<p>A token to resume pagination.</p>�input_token�output_tokenzXCreates an iterator that will paginate through responses from :py:meth:`{0}.Client.{1}`.�paginatez&response_iterator = paginator.paginate)r$�method_description�example_prefix�
include_input�include_output�
exclude_input�exclude_output�include_signature)�operation_modelrr�get�
isinstance�list�append�formatrrr)
rr!r$r
r%rFrG�pagination_config_members�botocore_pagination_params�#botocore_pagination_response_params�service_pagination_params�"service_pagination_response_params�paginate_descriptionrrrr,Jst
�

�	



�

�
��

��




�
�

��









�r,N)
T)
�botocorer�botocore.compatr�botocore.docs.utilsr�botocore.utilsr�botocore.docs.methodr�objectrr,rrrr�<module>
s



8�