o
.&a @ s\ 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)_clientmeta
service_model service_name
_service_name_service_paginator_model)selfclientservice_paginator_model r 9/usr/lib/python3/dist-packages/botocore/docs/paginator.py__init__ s
z PaginatorDocumenter.__init__c C s` |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.
Paginatorsz The available paginators are:z:py:class:`%s.Paginator.%s`N) styleh2new_linewritelnsortedr
_paginator_configlir __class____name___add_paginator)r sectionpaginator_namespaginator_namer r r document_paginators s
z'PaginatorDocumenter.document_paginatorsc C s | |}|jjd| jjj|f d |j |j |dt | |j
|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)add_new_sectionr start_sphinx_py_classr r r start_codeblockr writer
end_codeblockr
get_paginatordocument_paginate_methodr eventsr
)r r r! r% r r r r - s2
z"PaginatorDocumenter._add_paginatorN)r
__module__ __qualname__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 trJ|
|d 7 }
n|
|d |ddr^|
|d g } t|d trn| |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.
MaxItemsintegerzThe 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
documentation limit_keyNPageSizez The size of each page.
StartingTokenstringzq
A token to specify where to start paginating. This is the NextToken from a previous response.
PaginationConfig structurezCA dictionary that provides parameters to control pagination.
)r2 r3 r4 members NextTokenz$A token to resume pagination.
input_token output_tokenzXCreates an iterator that will paginate through responses from :py:meth:`{0}.Client.{1}`.paginatez&response_iterator = paginator.paginate)r$ method_descriptionexample_prefix
include_inputinclude_output
exclude_inputexclude_outputinclude_signature) operation_modelr r get
isinstancelistappendformatr r r )
r r! r$ r
r% rF rG pagination_config_membersbotocore_pagination_params#botocore_pagination_response_paramsservice_pagination_params"service_pagination_response_paramspaginate_descriptionr r r r, J st
r, N)T)
botocorer botocore.compatr botocore.docs.utilsr botocore.utilsr botocore.docs.methodr objectr r, r r r r s 8