HEX
Server: nginx/1.24.0
System: Linux webserver 6.8.0-85-generic #85-Ubuntu SMP PREEMPT_DYNAMIC Thu Sep 18 15:26:59 UTC 2025 x86_64
User: wpuser (1002)
PHP: 8.3.6
Disabled: NONE
Upload Files
File: //lib/python3/dist-packages/botocore/docs/__pycache__/paginator.cpython-312.pyc
�

P��e<#��r�ddlZddlmZddlmZddlmZddlmZddl	m
Z
ddlmZGd�d	�Z
	dd
�Zy)�N)�
xform_name)�OrderedDict)�DocumentStructure)�document_model_driven_method)�DocumentedShape)�get_service_module_namec�$�eZdZd�Zd�Zd�Zd�Zy)�PaginatorDocumenterc���||_|jjj|_|jjj
j|_||_||_	d|_
y)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�client�service_paginator_model�root_docs_paths    �9/usr/lib/python3/dist-packages/botocore/docs/paginator.py�__init__zPaginatorDocumenter.__init__s]�����"&�,�,�"8�"8�"A�"A���!�\�\�.�.�<�<�I�I���(?��%�-���
@�	
��c�R�|jjd�|j|�|jj�|j	d�|jj�t
|jj�}|D]�}|jj|j�d|���t|d��}|j||�tjj|j |jd�}|j#||���y)zhDocuments the various paginators for a service

        param section: The section to write to.
        �
PaginatorszThe available paginators are:z/paginator/�html)�target�	paginatorN)�style�h2�
_add_overview�new_line�writeln�toctree�sortedr�_paginator_config�tocitemrr�_add_paginator�os�path�joinr�
write_to_file)r�section�paginator_names�paginator_name�paginator_doc_structure�paginator_dir_paths      r�document_paginatorsz'PaginatorDocumenter.document_paginators#s��
	�
�
����&����7�#��
�
��� ����7�8��
�
���� ��)�)�;�;�
��
.�	�N��M�M�!�!��%�%�&�k�.�1A�B�
�'8��v�'�#�
��� 7��H�"$������$�$�d�&8�&8�+�"��
$�1�1�"�N�
�	rc�(�|jd�}|jj|jd|j���|jd|���|j
|�|j|�}|jj|j�d|����|jj�|jj�|jdt|��d��|jj�|jj�|jj|�}t|||jj j"|jj j$|��y)	N�
breadcrumbz../../z / Paginator / z.Paginator.)�
class_namez"paginator = client.get_paginator('z'))r1r3�
event_emitterr�paginator_config)�add_new_sectionr#�refrr�write�add_title_section�start_sphinx_py_class�start_codeblockr&r�
end_codeblockr�
get_paginator�document_paginate_methodrr�eventsr)rr1r3�breadcrumb_section�paginator_sectionr;s      rr,z"PaginatorDocumenter._add_paginatorEsi��$�4�4�\�B��� � �$�$��#�#�v�d�.@�.@�-A�%B�	
�	� � �?�>�2B�!C�D��!�!�.�1�$�3�3�N�C�����5�5��*�*�+�;�~�6F�G�	6�	
�
	���/�/�1����(�(�*�	���0��N�1K�0L�B�O�	
�	���-�-�/����(�(�*��8�8�F�F��
��	!�%�)��,�,�+�+�2�2��,�,�+�+�9�9�-�	
rc��|jj�|jd�|jjd|j��|jd�|jj�y)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�.)r#r&r>�
external_linkr)rr1s  rr%z!PaginatorDocumenter._add_overviewisf���
�
��� ��
�
�
�	
�	�
�
�#�#���&�&�	$�	
�	�
�
�c���
�
��� rN)r�
__module__�__qualname__rr6r,r%�rrr
r
s��	
� �D"
�H
!rr
c
��|j|�}t�}tddd��|d<|jdd�rtddd��|d<td	d
d��|d	<tdd
d|��g}tdd
d��g}	g}
t	|dt
�r	|
|dz
}
n|
j
|d�|jdd�r|
j
|d�g}t	|dt
�r	||dz
}n|j
|d�djt|�t|��}t|d|||d||	|
||��y)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>)rSrTrU�members�	NextTokenz$<p>A token to resume pagination.</p>�input_token�output_tokenzVCreates an iterator that will paginate through responses from :py:meth:`{}.Client.{}`.�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)
r1r3r:rr;rgrh�pagination_config_members�botocore_pagination_params�#botocore_pagination_response_params�service_pagination_params�"service_pagination_response_params�paginate_descriptions
             rrDrDys���2$�3�3�N�C�O�
!,�
��,;�
��
%�	
-��j�)����K��.�0?���8�1
�!�*�-�2A�
��
�	2��o�.�	�#�!�"�.�	
�
"��	���A�	
�+�'�!#���"�=�1�4�8�!�%5�m�%D�D�!�!�(�(�)9�-�)H�I����K��.�!�(�(�)9�+�)F�G�*,�&��"�>�2�D�9�*�.>�~�.N�N�*�*�1�1��^�,�	
�
	(�(.��#�M�2�J�~�4N�)
��!����#�/�?�0�:�/�9�+�r)T)r-�botocorer�botocore.compatr�botocore.docs.bcdoc.restdocr�botocore.docs.methodr�botocore.docs.utilsr�botocore.utilsrr
rDrOrr�<module>rzs4��
��'�9�=�/�2�_!�_!�P�
zr