U
m/e<# @ sl 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 )
PaginatorDocumenterc C s6 || _ | j jj| _| j jjj| _|| _|| _ d| _
d S )NzMhttps://boto3.amazonaws.com/v1/documentation/api/latest/guide/paginators.html) _client __class____name___client_class_namemeta
service_modelZ service_name
_service_name_service_paginator_model_root_docs_path_USER_GUIDE_LINK)selfclientZservice_paginator_modelZroot_docs_path r ;/tmp/pip-unpacked-wheel-3gylhwtm/botocore/docs/paginator.py__init__ s z PaginatorDocumenter.__init__c C s |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
Paginatorsz The available paginators are:z /paginator/html)targetZ paginatorN)styleh2
_add_overviewnew_linewritelnZtoctreesortedr Z_paginator_configZtocitemr r _add_paginatorospathjoinr Z
write_to_file)r sectionZpaginator_namespaginator_nameZpaginator_doc_structureZpaginator_dir_pathr r r document_paginators# s4
z'PaginatorDocumenter.document_paginatorsc C s | d}|j| jd| j |d| || | |}|jj| j d| d |j |j |dt
| d |j |j | j
|}t||| jjj| jjj|d d S ) 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_codeblockr r Z
end_codeblockr Z
get_paginatordocument_paginate_methodr r
eventsr )r r$ r% Zbreadcrumb_sectionZpaginator_sectionr) r r r r E s8
z"PaginatorDocumenter._add_paginatorc C s> |j |d |j jd| jd |d |j d S )NzPaginators 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)titlelink.)r r r+ Z
external_linkr )r r$ r r r r i s
z!PaginatorDocumenter._add_overviewN)r
__module__ __qualname__r r& r r r r r r r s "$r Tc
C s | |}t }tdddd|d< |ddr@tdddd|d< td d
d d|d < td d
d|dg}tdd
ddg} g }
t|d tr|
|d 7 }
n|
|d |ddr|
|d g } t|d tr| |d 7 } n| |d dt|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.
ZMaxItemsintegerzThe total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
)name type_name
documentationZ limit_keyNZPageSizez The size of each page.
Z
StartingTokenstringzq
A token to specify where to start paginating. This is the NextToken from a previous response.
ZPaginationConfigZ structurezCA dictionary that provides parameters to control pagination.
)r4 r5 r6 membersZ NextTokenz$A token to resume pagination.
Z input_tokenZ output_tokenzVCreates an iterator that will paginate through responses from :py:meth:`{}.Client.{}`.Zpaginatez&response_iterator = paginator.paginate)r( Zmethod_descriptionZexample_prefixZ
include_inputZinclude_outputZ
exclude_inputZexclude_outputinclude_signature) operation_modelr r get
isinstancelistappendformatr r r )
r$ r% r( r r) r9 r: Zpagination_config_membersZbotocore_pagination_paramsZ#botocore_pagination_response_paramsZservice_pagination_paramsZ"service_pagination_response_paramsZpaginate_descriptionr r r r, y sz
r, )T)r! Zbotocorer Zbotocore.compatr Zbotocore.docs.bcdoc.restdocr Zbotocore.docs.methodr Zbotocore.docs.utilsr Zbotocore.utilsr r r, r r r r
s h