File: //lib/python3.6/site-packages/awscli/customizations/__pycache__/paginate.cpython-36.opt-1.pyc
3
�T_�. � @ s� d Z ddlZddlmZ ddlmZ ddlmZmZ ddlm Z ddl
m Z ej 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 | j dt� | jdt� d S )Nzbuilding-argument-tablezdoc-description)�register�unify_paging_paramsZ
register_last�add_paging_description)Zevent_handlers� r � /usr/lib/python3.6/paginate.py�register_paginationL s r
c C sL y| j |�}W n tk
r" d S X y|j|�}W n tk
rF 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 � | j j d| j � |j
d�r�|d }t|�tk rx|g}djdd� |D ��}| j 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_keyz, 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
^ s&
r
c K s� t ||jj|j�}|d kr d S tjd|j� t| |� |jdd�}i }t| dt dt
ddd�|� |j j }d} d |kr�||d }
|
j
} | t jkr�td
j| |j|d ���t| d t d t| d d�|� t| d
t d
t| dd�|� |j|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 )Nr )r5 Zarg_nameZargumentr6 r r r r) � s r) c K sz ddg}x>| D ]6}|j dd�}t||�d k r||krtjd� d|_qW |jsvt||� x |j� D ]\} }
|
|| < qbW 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_tokensr6 r5 � parsed_argsZparsed_globalsr Znormalized_paging_args�token�py_name�key�valuer r r r3 � s
r3 c sb dddg}dd� |j � D ��� �fdd�|D �}t|�dkr^djd d� |D ��}td
| d ��d S ) NZstarting_tokenZ page_sizer7 c S s g | ]}|j d d��qS )r8 r9 )r( )r �pr r r r � s z0ensure_paging_params_not_set.<locals>.<listcomp>c s$ g | ] }|�krt � |d �r|�qS )N)r: )r rB )r= �shadowed_paramsr r r � s r z, c S s g | ]}d |j dd� �qS )z--r9 r8 )r( )r rB r r r r � s z@Cannot specify --no-paginate along with pagination arguments: %s)�message)�keys�lenr r )r= r6 Z
paging_paramsZ params_usedZconverted_paramsr )r= rC r r; � s
r; c C s xt |�D ]}d| | _q
W d S )NT)r4 Z
_UNDOCUMENTED)r5 �pagination_config�cli_namer r r r' � s r' c c sJ t | �}x |D ]}t|d�}|V qW d| krF| d }t|d�}|V d S )Nr8 r$ )�_get_input_tokensr )rG �tokens�
token_namerH Zkey_namer r r r4 � s
r4 c C s | d }t |t�s|gS |S )NZ input_token)r r )rG rJ r r r rI � s
rI c C s( x"| D ]}|j |kr|jjd�S qW d S )Nr8 )r rH �lstrip)Z
param_objectsrK Zparamr r r �
_get_cli_name� s
rM 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 jdddi�| _|| _|| _|| _|| _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 )Nz--)rN )rS r r r rH
s zPageArgument.cli_namec C s | j S )N)rQ )rS r r r �
cli_type_name s zPageArgument.cli_type_namec C s | j S )N)rR )rS r r r �required s zPageArgument.requiredc C s
|| _ d S )N)rR )rS rA r r r rW s c C s | j S )N)rP )rS r r r rT s zPageArgument.documentationc C s |j | j| j| j| j d� d S )N)�destr )� add_argumentrH r? r. rQ )rS �parserr r r �
add_to_parser! s zPageArgument.add_to_parserc C s* |d k r&|j di �}||| j< ||d< d S )NZPaginationConfig)r rO )rS Z
parametersrA rG r r r �
add_to_params% s
zPageArgument.add_to_paramsN)�__name__�
__module__� __qualname__�str�intr. rU �propertyrH rV rW �setterrT r[ r\ r r r r r* � s r* ) �__doc__Zlogging� functoolsr Zbotocorer Zbotocore.exceptionsr r r Zawscli.argumentsr Z getLoggerr] r% r+ r2 r1 r
r r
r r) r3 r; r' r4 rI rM r* r r r r �<module> s,
0