o
!d. @ 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 parameters.
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)DataNotFoundErrorPaginationError)model)BaseCLIArgumenta/
A token to specify where to start paginating. This is the
NextToken from a previously truncated response.
For usage examples, see Pagination in the AWS Command Line Interface User
Guide.
a`
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 NextToken is provided in the command's
output. To resume pagination, provide the
NextToken value in the starting-token
argument of a subsequent command. Do not use the
NextToken response element directly outside of the
AWS CLI.
For usage examples, see Pagination in the AWS Command Line Interface User
Guide.
a
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.
For usage examples, see Pagination in the AWS Command Line Interface User
Guide.
c C s | dt | dt d S )Nzbuilding-argument-tablezdoc-description)registerunify_paging_paramsZ
register_lastadd_paging_description)Zevent_handlers r Busr/lib/python3.10/site-packages/awscli/customizations/paginate.pyregister_paginationL s r
c C sJ z| |}W n
ty Y d S w z||}W |S ty$ Y d S w 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 | jtjs d S | jjj}t| j|| jj}|sd S | j j
| j d| j |
drP|d }t|tur<|g}ddd |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.Z
result_key, c S s g | ]}d | qS )z``%s``r ).0sr r r
s s z*add_paging_description..zWhen 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)
isinstanceobjr ZOperationModel
service_modelr r r namedocstyleZ
new_paragraphwritelngettypelistjoin)Z help_commandkwargsr paginator_configZqueriesr r r r
^ s2
r
c K s t ||jj|j}|d u rd S td|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-tokenstringZ
StartingToken)
parse_typeserialized_nameinteger limit_keyzCUnsupported pagination type {0} for operation {1} and parameter {2}z page-sizeZPageSizez max-itemsZMaxItems)r r r r loggerdebug!_remove_existing_paging_argumentsreplaceadd_paging_argument PageArgumentSTARTING_TOKEN_HELPZ input_shapemembers type_nametype_map TypeErrorformatPAGE_SIZE_HELPMAX_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_membersr1 Zlimit_key_shaper r r r { sn
r c C s || v r
| | ||< || |< d S r r )r9 Zarg_nameZargumentr: r r r r- s r- c K sv ddg}| D ]}| dd}t||d ur!||vr!td d|_q|js7t|| | D ]
\} }
|
|| < q.d S 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_setitems) Z input_tokensr: r9 parsed_argsZparsed_globalsr" Znormalized_paging_argstokenpy_namekeyvaluer r r r7 s
r7 c s` g d}dd | D fdd|D }t|dkr.ddd |D }td| d d S )
N)Zstarting_tokenZ page_sizer; c S s g | ]}| d dqS )r< r= r, r pr r r r s z0ensure_paging_params_not_set..c s$ g | ]}|vrt |d r|qS r )r> rG rA Zshadowed_paramsr r r s r r c S s g | ]
}d | dd qS )--r= r< rF rG r r r r s z@Cannot specify --no-paginate along with pagination arguments: %s)message)keyslenr! r )rA r: Z
paging_paramsZ params_usedZconverted_paramsr rI r r? s r? c C s t |D ]}d| | _qd S )NT)r8 Z
_UNDOCUMENTED)r9 pagination_configcli_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 )Nr< r( )_get_input_tokensr )rN tokens
token_namerO Zkey_namer r r r8 s
r8 c C s | d }t |ts |gS |S )NZ input_token)r r )rN rQ r r r rP s
rP c C s( | D ]}|j |kr|jd S qd S )Nr< )r rO lstrip)Z
param_objectsrR paramr r r
_get_cli_name s
rU c @ sn e Zd ZeeedZdd Zedd Zedd Z edd Z
e
j d
d Z
ed d Z d
d Z
dd ZdS )r. )r$ r' longc 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 )NrJ )rW r\ r r r rO
zPageArgument.cli_namec C | j S r )rZ r_ r r r
cli_type_name zPageArgument.cli_type_namec C ra r r[ r_ r r r required rc zPageArgument.requiredc C s
|| _ d S r rd )r\ rE r r r re r` c C ra r )rY r_ r r r r] rc zPageArgument.documentationc C s |j | j| j| j| j d d S )N)destr ) add_argumentrO rC r2 rZ )r\ parserr r r
add_to_parser! s
zPageArgument.add_to_parserc C s. |d ur| di }||| j< ||d< d S d S )NZPaginationConfig)r rX )r\
parametersrE rN r r r
add_to_params% s
zPageArgument.add_to_paramsN)__name__
__module__ __qualname__strintr2 r^ propertyrO rb re setterr] ri rk r r r r r. s$
r. ) __doc__logging functoolsr Zbotocorer Zbotocore.exceptionsr r r Zawscli.argumentsr getLoggerrl r) r/ r6 r5 r
r r
r r- r7 r? r+ r8 rP rU r. r r r r s.
0