File: //lib/python3/dist-packages/awscli/customizations/__pycache__/paginate.cpython-38.pyc
U
<�^�. � @ 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_paramsZ
register_last�add_paging_description)Zevent_handlers� r �@/usr/lib/python3/dist-packages/awscli/customizations/paginate.py�register_paginationL s r
c C sP z| � |�}W n tk
r$ Y d S X z|�|�}W n tk
rJ Y d S X |S �N)Zget_paginator_modelr Z
get_paginator�
ValueError)�session� service_nameZoperation_nameZpaginator_modelZoperation_paginator_configr r r �get_paginator_configQ s �r c K s� t | jtj�sd S | jjj}t| j|| jj�}|s6d S | j j
� � | j � d| j � |�
d�r�|d }t|�tk rx|g}d�dd� |D ��}| j � d| � 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.Z
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 ZOperationModel�
service_modelr r r �name�docZstyleZ
new_paragraphZwriteln�get�type�list�join)Z help_command�kwargsr �paginator_configZqueriesr r r r
^ s4
� ��
��r
c K s� t ||jj|j�}|d kr d S t�d|j� t| |� |�dd�}i }t| dt dt
ddd�|� |j j }d} d |kr�||d }
|
j
} | t jkr�td
�| |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�stringZ
StartingToken)�
parse_type�serialized_name�integer� limit_keyzCUnsupported pagination type {0} for operation {1} and parameter {2}z page-sizeZPageSizez max-itemsZMaxItems)r r r r �logger�debug�!_remove_existing_paging_arguments�replace�add_paging_argument� PageArgument�STARTING_TOKEN_HELPZ 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_tableZoperation_modelZ
event_namer r r! Zparsed_args_event�
shadowed_argsZ
input_membersr/ Zlimit_key_shaper r r r { sr ��
���
������
��r c C s || kr| | ||< || |< d S r r )r7 Zarg_nameZargumentr8 r r r r+ � s r+ c K sr ddg}| D ]6}|� dd�}t||�d k r ||kr t�d� d|_q |jsnt||� |�� D ]\} }
|
|| < q\d S )NZ start_token� max_items�-�_zPUser has specified a manual pagination arg. Automatically setting --no-paginate.F)r* �getattrr' r( Zpaginate� ensure_paging_params_not_set�items) Z input_tokensr8 r7 � parsed_argsZparsed_globalsr Znormalized_paging_args�token�py_name�key�valuer r r r5 � s �
r5 c sb dddg}dd� |� � D ��� �fdd�|D �}t|�dkr^d�d d� |D ��}td
| d ��d S ) NZstarting_tokenZ page_sizer9 c S s g | ]}|� d d��qS )r: r; �r* �r �pr r r r � s z0ensure_paging_params_not_set.<locals>.<listcomp>c s$ g | ] }|�krt � |d �r|�qS r )r< rE �r? Zshadowed_paramsr r r � s �r r c S s g | ]}d |� dd� �qS )�--r; r: rD rE r r r r � s z@Cannot specify --no-paginate along with pagination arguments: %s)�message)�keys�lenr r )r? r8 Z
paging_paramsZ params_usedZconverted_paramsr rG r r= � s
���r= c C s t |�D ]}d| | _qd S )NT)r6 Z
_UNDOCUMENTED)r7 �pagination_config�cli_namer r r r) � s r) c c sF t | �}|D ]}t|d�}|V q d| krB| d }t|d�}|V d S )Nr: r& )�_get_input_tokensr )rL �tokens�
token_namerM Zkey_namer r r r6 � s
r6 c C s | d }t |t�s|gS |S )NZ input_token)r r )rL rO r r r rN � s
rN c C s( | D ] }|j |kr|j�d� S qd S )Nr: )r rM �lstrip)Z
param_objectsrP Zparamr r r �
_get_cli_name� s
rR 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, )r" r% Zlongc C s4 t �dddi�| _|| _|| _|| _|| _d| _d S )Nr, r r" F)r ZShapeZargument_model�_name�_serialized_name�_documentation� _parse_type� _required)�selfr �
documentationr# r$ r r r �__init__ s zPageArgument.__init__c C s
d| j S )NrH )rS �rX r r r rM
s zPageArgument.cli_namec C s | j S r )rV r[ r r r �
cli_type_name s zPageArgument.cli_type_namec C s | j S r �rW r[ r r r �required s zPageArgument.requiredc C s
|| _ d S r r] )rX rC r r r r^ s c C s | j S r )rU r[ r r r rY s zPageArgument.documentationc C s |j | j| j| j| j d� d S )N)�destr )� add_argumentrM rA r0 rV )rX �parserr r r �
add_to_parser! s
�zPageArgument.add_to_parserc C s* |d k r&|� di �}||| j< ||d< d S )NZPaginationConfig)r rT )rX Z
parametersrC rL r r r �
add_to_params% s
zPageArgument.add_to_paramsN)�__name__�
__module__� __qualname__�str�intr0 rZ �propertyrM r\ r^ �setterrY rb rc r r r r r, � s" �
r, ) �__doc__Zlogging� functoolsr Zbotocorer Zbotocore.exceptionsr r r Zawscli.argumentsr Z getLoggerrd r' r- r4 r3 r
r r
r r+ r5 r= r) r6 rN rR r, r r r r �<module>
s,
0