File: //lib/python3/dist-packages/awscli/customizations/__pycache__/paginate.cpython-310.pyc
o
.&�a�. � @ s� d Z ddlZddlmZ ddlmZ ddlmZmZ ddlm Z ddl
m Z e� e
�ZdZd Zd
Zd d � Zd
d� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd � Zd d � Zd d � Z G d!d"� d"e �Z dS )#a' This module has customizations to unify paging paramters.
For any operation that can be paginated, we will:
* Hide the service specific pagination params. This can vary across
services and we're going to replace them with a consistent set of
arguments. The arguments will still work, but they are not
documented. This allows us to add a pagination config after
the fact and still remain backwards compatible with users that
were manually doing pagination.
* Add a ``--starting-token`` and a ``--max-items`` argument.
� N)�partial)�
xform_name)�DataNotFoundError�PaginationError)�model)�BaseCLIArgumenta/
<p>A token to specify where to start paginating. This is the
<code>NextToken</code> from a previously truncated response.</p>
<p>For usage examples, see <a
href="https://docs.aws.amazon.com/cli/latest/userguide/pagination.html"
>Pagination</a> in the <i>AWS Command Line Interface User
Guide</i>.</p>
a`
<p>The total number of items to return in the command's output.
If the total number of items available is more than the value
specified, a <code>NextToken</code> is provided in the command's
output. To resume pagination, provide the
<code>NextToken</code> value in the <code>starting-token</code>
argument of a subsequent command. <b>Do not</b> use the
<code>NextToken</code> response element directly outside of the
AWS CLI.</p>
<p>For usage examples, see <a
href="https://docs.aws.amazon.com/cli/latest/userguide/pagination.html"
>Pagination</a> in the <i>AWS Command Line Interface User
Guide</i>.</p>
a�
<p>The size of each page to get in the AWS service call. This
does not affect the number of items returned in the command's
output. Setting a smaller page size results in more calls to
the AWS service, retrieving fewer items in each call. This can
help prevent the AWS service calls from timing out.</p>
<p>For usage examples, see <a
href="https://docs.aws.amazon.com/cli/latest/userguide/pagination.html"
>Pagination</a> in the <i>AWS Command Line Interface User
Guide</i>.</p>
c C s | � dt� | �dt� d S )Nzbuilding-argument-tablezdoc-description)�register�unify_paging_params�
register_last�add_paging_description)�event_handlers� r
�@/usr/lib/python3/dist-packages/awscli/customizations/paginate.py�register_paginationL s r c C sJ z| � |�}W n
ty Y d S w z|�|�}W |S ty$ Y d S w �N)�get_paginator_modelr �
get_paginator�
ValueError)�session� service_name�operation_name�paginator_model�operation_paginator_configr
r
r �get_paginator_configQ s �� ��r c K s� t | jtj�s d S | jjj}t| j|| jj�}|sd S | j j
� � | j � d| j � |�
d�rP|d }t|�tur<|g}d�dd� |D ��}| j � d| � d S d S )Nz�``%s`` is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the ``--no-paginate`` argument.�
result_key�, c S s g | ]}d | �qS )z``%s``r
)�.0�sr
r
r �
<listcomp>s s z*add_paging_description.<locals>.<listcomp>z�When using ``--output text`` and the ``--query`` argument on a paginated response, the ``--query`` argument must extract data from the results of the following query expressions: %s)�
isinstance�objr �OperationModel�
service_modelr r r �name�doc�style�
new_paragraph�writeln�get�type�list�join)� help_command�kwargsr �paginator_config�queriesr
r
r r ^ s2
� ��
���r c K s� t ||jj|j�}|d u rd S t�d|j� t| |� |�dd�}i }t| dt dt
ddd�|� |j j }d} d |v ra||d }
|
j
} | t jvrTtd
�| |j|d ���t| d t d t| d d�|� t| d
t d
t| dd�|� |�|tttt|��|| �� d S )Nz-Modifying paging parameters for operation: %szbuilding-argument-table.zoperation-args-parsed.zstarting-token�string�
StartingToken)�
parse_type�serialized_name�integer� limit_keyzCUnsupported pagination type {0} for operation {1} and parameter {2}z page-size�PageSizez max-items�MaxItems)r r" r r# �logger�debug�!_remove_existing_paging_arguments�replace�add_paging_argument� PageArgument�STARTING_TOKEN_HELP� input_shape�members� type_name�type_map� TypeError�format�PAGE_SIZE_HELP�MAX_ITEMS_HELPr r � check_should_enable_paginationr* �_get_all_cli_input_tokens) �argument_table�operation_model�
event_namer r- r. �parsed_args_event�
shadowed_args�
input_membersrA �limit_key_shaper
r
r r { sn ��
���
������
��r c C s || v r
| | ||< || |< d S r r
)rI �arg_name�argumentrM r
r
r r< � s r< c K sv ddg}| D ]}|� dd�}t||�d ur!||vr!t�d� d|_q|js7t||� |�� D ]
\} }
|
|| < q.d S d S )N� start_token� max_items�-�_zPUser has specified a manual pagination arg. Automatically setting --no-paginate.F)r; �getattrr8 r9 �paginate� ensure_paging_params_not_set�items) � input_tokensrM rI � parsed_args�parsed_globalsr- �normalized_paging_args�token�py_name�key�valuer
r
r rG � s
�
�
rG c s` g d�}dd� |� � D ��� �fdd�|D �}t|�dkr.d�dd� |D ��}td| d ��d S )
N)�starting_token� page_sizerS c S s g | ]}|� d d��qS )rT rU �r; �r �pr
r
r r � s z0ensure_paging_params_not_set.<locals>.<listcomp>c s$ g | ]}|�vrt � |d �r|�qS r )rV re �r[ �shadowed_paramsr
r r � s �r r c S s g | ]
}d |� dd� �qS )�--rU rT rd re r
r
r r � s z@Cannot specify --no-paginate along with pagination arguments: %s)�message)�keys�lenr+ r )r[ rM �
paging_params� params_used�converted_paramsr
rg r rX � s ����rX c C s t |�D ]}d| | _qd S )NT)rH �
_UNDOCUMENTED)rI �pagination_config�cli_namer
r
r r: � s �r: c c sL � t | �}|D ]
}t|d�}|V qd| v r$| d }t|d�}|V d S d S )NrT r5 )�_get_input_tokensr )rq �tokens�
token_namerr �key_namer
r
r rH � s �
�rH c C s | d }t |t�s |gS |S )N� input_token)r r* )rq rt r
r
r rs � s
rs c C s( | D ]}|j |kr|j�d� S qd S )NrT )r# rr �lstrip)�
param_objectsru �paramr
r
r �
_get_cli_name� s
��r{ c @ sn e Zd Zeeed�Zdd� Zedd� �Zedd� �Z edd � �Z
e
j d
d � �Z
ed d � �Z d
d� Z
dd� ZdS )r= )r0 r4 �longc C s4 t �dddi�| _|| _|| _|| _|| _d| _d S )Nr= r) r0 F)r �Shape�argument_model�_name�_serialized_name�_documentation� _parse_type� _required)�selfr# �
documentationr2 r3 r
r
r �__init__ s
zPageArgument.__init__c C s
d| j S )Nri )r �r� r
r
r rr
�
zPageArgument.cli_namec C � | j S r )r� r� r
r
r �
cli_type_name � zPageArgument.cli_type_namec C r� r �r� r� r
r
r �required r� zPageArgument.requiredc C s
|| _ d S r r� )r� ra r
r
r r� r� c C r� r )r� r� r
r
r r� r� zPageArgument.documentationc C s |j | j| j| j| j d� d S )N)�destr) )� add_argumentrr r_ rB r� )r� �parserr
r
r �
add_to_parser! s
�zPageArgument.add_to_parserc C s. |d ur|� di �}||| j< ||d< d S d S )N�PaginationConfig)r( r� )r� �
parametersra rq r
r
r �
add_to_params% s
�zPageArgument.add_to_paramsN)�__name__�
__module__� __qualname__�str�intrB r� �propertyrr r� r� �setterr� r� r� r
r
r
r r= � s$ �
r= ) �__doc__�logging� functoolsr �botocorer �botocore.exceptionsr r r �awscli.argumentsr � getLoggerr� r8 r> rF rE r r r r r< rG rX r: rH rs r{ r= r
r
r
r �<module> s.
0