File: //proc/self/root/lib/python3.6/site-packages/botocore/docs/__pycache__/paginator.cpython-36.pyc
3
�T_� � @ sZ 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 )�PaginatorDocumenterc C s || _ | j jjj| _|| _d S )N)�_client�meta�
service_modelZ service_nameZ
_service_name�_service_paginator_model)�selfZclientZservice_paginator_model� r
� /usr/lib/python3.6/paginator.py�__init__ s z PaginatorDocumenter.__init__c C sd |j jd� |j j� |jd� t| jj�}x2|D ]*}|j jd| jj j
|f � | j ||� q2W dS )zhDocuments the various paginators for a service
param section: The section to write to.
Z
Paginatorsz The available paginators are:z:py:class:`%s.Paginator.%s`N) �styleZh2�new_lineZwriteln�sortedr Z_paginator_configZlir � __class__�__name__�_add_paginator)r �sectionZpaginator_names�paginator_namer
r
r �document_paginators s
z'PaginatorDocumenter.document_paginatorsc C s� |j |�}|jjd| jjj|f d� |jj� |jj� |jdt |� � |jj
� |jj� | j j |�}t
||| jjj| jjj|d� d S )Nz%s.Paginator.%s)�
class_namez&paginator = client.get_paginator('%s'))r r �
event_emitterr
�paginator_config)Zadd_new_sectionr Zstart_sphinx_py_classr r r Zstart_codeblockr �writer Z
end_codeblockr Z
get_paginator�document_paginate_methodr Zeventsr
)r r r r r
r
r r - s&
z"PaginatorDocumenter._add_paginatorN)r �
__module__� __qualname__r r r r
r
r
r r s r Tc
C s |j |�}t� }tdddd�|d< |jdd�r@tdddd�|d< td d
d d�|d < td d
d|d�g}tdd
dd�g} g }
t|d t�r�|
|d 7 }
n|
j|d � |jdd�r�|
j|d � g } t|d t�r�| |d 7 } n| j|d � djt|�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.
ZMaxItemsZintegerz�<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>)r r! r" �membersZ NextTokenz$<p>A token to resume pagination.</p>Z input_tokenZ output_tokenzXCreates an iterator that will paginate through responses from :py:meth:`{0}.Client.{1}`.Zpaginatez&response_iterator = paginator.paginate)r Zmethod_descriptionZexample_prefixZ
include_inputZinclude_outputZ
exclude_inputZexclude_output�include_signature) �operation_modelr r �get�
isinstance�list�append�formatr r r )
r r r r
r r% r& Zpagination_config_membersZbotocore_pagination_paramsZ#botocore_pagination_response_paramsZservice_pagination_paramsZ"service_pagination_response_paramsZpaginate_descriptionr
r
r r J sX
r N)T)
Zbotocorer Zbotocore.compatr Zbotocore.docs.utilsr Zbotocore.utilsr Zbotocore.docs.methodr �objectr r r
r
r
r �<module>
s 8