|
Server : Apache System : Linux iad1-shared-b8-43 6.6.49-grsec-jammy+ #10 SMP Thu Sep 12 23:23:08 UTC 2024 x86_64 User : dh_edsupp ( 6597262) PHP Version : 8.2.26 Disable Function : NONE Directory : /lib/python3/dist-packages/awscli/__pycache__/ |
Upload File : |
o
.&�a<r � @ s� d dl Z d dlZd dlmZ d dlmZ d dlmZ d dlm Z d dl
m Z d dl m
Z
d dlmZ d d lmZmZmZ e �e�ZG d
d � d e�ZG d d
� d
e�ZG dd� de�ZG dd� de�ZG dd� de�Z G dd� de �Z dS )� N)�
xform_name)� StringShape)�is_json_value_header)� SCALAR_TYPES)�ParamShorthandDocGen)�
DOC_EVENTS)�
TopicTagDB)�%find_service_and_method_in_event_name�is_document_type� operation_uses_document_typesc @ s� e Zd Zdd� Zdd� Zdd� Zdd� Zd d
� Zd d � Zd
d� Z dd� Z
dd� Z dd� Z dd� Z
dd� Zdd� Zdd � Zd d � Zd d � Zd!d"� Zd#d$� Zd%d&� Zd'd(� Zd)S )*�CLIDocumentEventHandlerc C s, || _ | �|j|j� | �|�| _g | _d S �N)� help_command�register�session� event_class�_build_arg_table_groups� _arg_groups�_documented_arg_groups��selfr � r �0/usr/lib/python3/dist-packages/awscli/clidocs.py�__init__! s
z CLIDocumentEventHandler.__init__c C s: i }|j �� D ]\}}|jd ur|�|jg ��|� q|S r
)� arg_table�items�
group_name�
setdefault�append)r r �
arg_groups�name�argr r r r ' s
�z/CLIDocumentEventHandler._build_arg_table_groupsc C s t |�rdS t|�r dS |S )N�JSON�document)r r
)r �shape�defaultr r r �_get_argument_type_name. s
z/CLIDocumentEventHandler._get_argument_type_namec C sv t D ]6}|�dd�}t| |�r8t| |�}t | }t|�d��d }|fd| } ||| }
|| } ||
|| � qd S )N�-�_�.� )�*)r �replace�hasattr�getattr�len�split) r r r �mapfn�event�event_handler_name�
event_handler�
format_string�num_args� format_args� event_string� unique_idr r r �
_map_handlers5 s
��z%CLIDocumentEventHandler._map_handlersc C s | � |||j� dS )a:
The default register iterates through all of the
available document events and looks for a corresponding
handler method defined in the object. If it's there, that
handler method will be registered for the all events of
that type for the specified ``event_class``.
N)r: r )r r r r r r r A s z CLIDocumentEventHandler.registerc C s | � | jj| jj| jjj� dS )a>
The default unregister iterates through all of the
available document events and looks for a corresponding
handler method defined in the object. If it's there, that
handler method will be unregistered for the all events of
that type for the specified ``event_class``.
N)r: r r r �
unregister)r r r r r; K s
�z"CLIDocumentEventHandler.unregisterc K s� |j }|jdkrC|j�d�}|�d� |�d� dg}|d d� D ]}|�d� |�|� d�|�}|�d ||f � q!|�d
� d S d S ) N�manr) �[ z:ref:`aws <cli:aws>`�aws���� . � z:ref:`%s <cli:%s>`� ])�doc�targetr r0 �writer �join)r r �kwargsrC � cmd_names�
full_cmd_list�cmd�
full_cmd_namer r r �doc_breadcrumbsY s
�z'CLIDocumentEventHandler.doc_breadcrumbsc K sN |j }|j�� |j�dd�}|dkrd| }|�d| � |j�|j� d S )Nr) rA r> zaws z .. _cli:%s:)rC �style�
new_paragraphr r, �writeln�h1r )r r rG rC � referencer r r � doc_titleg s
z!CLIDocumentEventHandler.doc_titlec K s, |j }|j�d� |�|j� |j�� d S �N� Description)rC rM �h2�include_doc_string� descriptionrN �r r rG rC r r r �doc_descriptionp � z'CLIDocumentEventHandler.doc_descriptionc K s6 g | _ |j}|j�d� |j�� |�d|j � d S )N�Synopsis�%s)r rC rM rU �start_codeblockrO r rX r r r �doc_synopsis_startv s
z*CLIDocumentEventHandler.doc_synopsis_startc K s� |j }|j| }|j| jv r,|j| jv rd S d�dd� | j|j D ��}| j�|j� n|j�d�r8d|j }nd|j }|j sJt
|dd�sJd | }|� d
| � d S ) N� | c S s g | ]}|j �qS r ��cli_name��.0�ar r r �
<listcomp>� s z?CLIDocumentEventHandler.doc_synopsis_option.<locals>.<listcomp>z--z
%s <value>z<%s>�_DOCUMENT_AS_REQUIREDFz[%s]r\ ) rC r r r r rF r ra �
startswith�requiredr. rO )r �arg_namer rG rC �argument�
option_strr r r �doc_synopsis_option} s&
��
�z+CLIDocumentEventHandler.doc_synopsis_optionc K s |j }|j�� g | _d S r
)rC rM �
end_codeblockr rX r r r �doc_synopsis_end� s
z(CLIDocumentEventHandler.doc_synopsis_endc K s* |j }|j�d� |js|�d� d S d S )N�Optionsz*None*
)rC rM rU r rE rX r r r �doc_options_start� s
�z)CLIDocumentEventHandler.doc_options_startc K s� |j }|j| }|j| jv r,|j| jv rd S d�dd� | j|j D ��}| j�|j� nd|j }|�d|| � |j
|j �f � |j �
� |�|j� t|d�r^| �|j
|� | �|j
|� |j �� |j �� d S )Nr_ c S s g | ]}d |j �qS )�``%s``r` rb r r r re � s z6CLIDocumentEventHandler.doc_option.<locals>.<listcomp>rq z%s (%s)
�argument_model)rC r r r r rF r ra rE r& rr �
cli_type_namerM �indentrV �
documentationr- �_document_enums�_document_nested_structure�dedentrN )r ri r rG rC rj r r r r �
doc_option� s,
��
�
z"CLIDocumentEventHandler.doc_optionc K s |j r|j}|j�d� d S d S )NzSee Also)�
related_itemsrC rM rU rX r r r �doc_relateditems_start� s �z.CLIDocumentEventHandler.doc_relateditems_startc K s2 |j }|�d� |jjd| |d� |�d� d S )N�* zcli:%s��label�text�
)rC rE rM �sphinx_reference_label)r r � related_itemrG rC r r r �doc_relateditem� s
�z'CLIDocumentEventHandler.doc_relateditemc C s` t |t�r,|jr.|j�� |�d� |j�� |jD ]
}|j�d| � q|j�� dS dS dS )z#Documents top-level parameter enumszPossible values:rq N) �
isinstancer �enumrM rN rE �start_ul�li�end_ul)r �modelrC r� r r r rv � s
�z'CLIDocumentEventHandler._document_enumsc
C s� t |dd�}|dkr!|j�� D ]\}}| j||||jgd� qdS |dkr3| j|d|j|jgd� dS |dkrc|j}|j�dd �}| j||||jgd� |j }|j�dd
�} | j|| ||jgd� dS dS ) z5Recursively documents parameters in nested structures� type_nameN� structure��stack�list� �mapr �key�value)
r. �membersr � _doc_memberr �memberr� �
serialization�getr� )
r r� rC �member_type_name� member_name� member_shape� key_shape�key_name� value_shape�
value_namer r r rw � s"
�� �z2CLIDocumentEventHandler._document_nested_structurec C sh |j |v r|�|j �dkr|jdkr|�d� d S |�|j � z| �||||� W |�� d S |�� w )N� r� z( ... recursive ... ))r �countr� rE r �_do_doc_member�pop)r rC r� r� r� r r r r� � s
�z#CLIDocumentEventHandler._doc_memberc C s |j }| �||j�}|r|�d||f � n|�d| � |j�� |j�� |�|� |j�� |j}|dkrK|j� � D ] \}} | �
||| |� q=n6|dkrt|j }
|
j �
dd�} | �
|| |
|� |j} | j �
dd�}
| �
||
| |� n
|dkr�| �
|d |j|� |j�� |j�� d S )
Nz
%s -> (%s)z(%s)r� r� r r� r� r� r� )ru r& r� rE rM rt rN rV r� r r� r� r� r� r� r� rx )r rC r� r� r� �docsr� r� �sub_name� sub_shaper� r� r� r� r r r r� � s6 �
�
z&CLIDocumentEventHandler._do_doc_memberN)�__name__�
__module__� __qualname__r r r& r: r r; rL rR rY r^ rl rn rp ry r{ r� rv rw r� r� r r r r r s*
r c @ sL e Zd Zdd� Zdd� Zdd� Zdd� Zd d
� Zd d � Zd
d� Z dd� Z
dS )� ProviderDocumentEventHandlerc K � d S r
r )r r �
event_namerG r r r rL � z,ProviderDocumentEventHandler.doc_breadcrumbsc K s0 |j }|j�d� |j�|j� |�|j� d S )Nr[ )rC rM rU � codeblock�synopsisrV �
help_usagerX r r r r^ s z/ProviderDocumentEventHandler.doc_synopsis_startc K r� r
r �r ri r rG r r r rl r� z0ProviderDocumentEventHandler.doc_synopsis_optionc K s |j }|j�� d S r
)rC rM rN rX r r r rn s z-ProviderDocumentEventHandler.doc_synopsis_endc K s |j }|j�d� d S )Nro )rC rM rU rX r r r rp s z.ProviderDocumentEventHandler.doc_options_startc K sl |j }|j| }|�d|j|jf � |�|j� |jr4|j� � |jD ]}|j�
|� q$|j� � d S d S )Nz ``%s`` (%s)) rC r rO ra rs rV ru �choicesrM r� r� r� )r ri r rG rC rj �choicer r r ry " s
�
�z'ProviderDocumentEventHandler.doc_optionc K � |j }|j�d� |j�� d S )NzAvailable Services�rC rM rU �toctreerX r r r �doc_subitems_start. � z/ProviderDocumentEventHandler.doc_subitems_startc K s" |j }d| }|jj||d� d S )N�%s/index�� file_name)rC rM �tocitem)r � command_namer rG rC r� r r r � doc_subitem3 s z(ProviderDocumentEventHandler.doc_subitemN) r� r� r� rL r^ rl rn rp ry r� r� r r r r r� s r� c @ s\ e Zd Zdd� Zdd� Zdd� Zdd� Zd d
� Zd d � Zd
d� Z dd� Z
dd� Z dd� Z dS )�ServiceDocumentEventHandlerc K r� r
r �r r rG r r r r^ < r� z.ServiceDocumentEventHandler.doc_synopsis_startc K r� r
r r� r r r rl ? r� z/ServiceDocumentEventHandler.doc_synopsis_optionc K r� r
r r� r r r rn B r� z,ServiceDocumentEventHandler.doc_synopsis_endc K r� r
r r� r r r rp F r� z-ServiceDocumentEventHandler.doc_options_startc K r� r
r r� r r r ry I r� z&ServiceDocumentEventHandler.doc_optionc K r� r
r r� r r r �doc_option_exampleL r� z.ServiceDocumentEventHandler.doc_option_examplec K r� r
r r� r r r �doc_options_endO r� z+ServiceDocumentEventHandler.doc_options_endc K s( |j }|j}|j�d� |�|j� d S rS )rC �objrM rU rV ru )r r rG rC �
service_modelr r r rY R s z+ServiceDocumentEventHandler.doc_descriptionc K r� )NzAvailable Commandsr� rX r r r r� Y r� z.ServiceDocumentEventHandler.doc_subitems_startc K sT |j }|j| }t|di �}t|�dkr"d| }|jj||d� d S |j�|� d S )N�subcommand_tabler r� r� )rC �
command_tabler. r/ rM r� )r r� r rG rC �
subcommandr� r� r r r r� ^ s
z'ServiceDocumentEventHandler.doc_subitemN)
r� r� r� r^ rl rn rp ry r� r� rY r� r� r r r r r� 9 s r� c @ sz e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d d �Zd
d� Z dd� Z
dd� Z dd� Z dd� Z
dd� Zdd� Zdd � Zd S ) � OperationDocumentEventHandlerz'https://docs.aws.amazon.com/goto/WebAPIc K sF |j }|j}|j�d� |�|j� | �|� | �|� | �|� d S rS ) rC r� rM rU rV ru �_add_webapi_crosslink� _add_top_level_args_reference�$_add_note_for_document_types_if_used)r r rG rC �operation_modelr r r rY p s
z-OperationDocumentEventHandler.doc_descriptionc C s: |j �d� |j �d� |j jjddd� |j �d� d S )Nr� zSee z
'aws help'z/reference/index)�title�pagez' for descriptions of global parameters.)rC rO rE rM �
internal_linkr r r r r� y s �z;OperationDocumentEventHandler._add_top_level_args_referencec C sn |j }|j}|j}|j�d�}|d u rd S |j�� |�d� d| j||j f }|jj
d|d� |� d� d S )N�uidz
See also: z%s/%s/%szAWS API Documentation)r� �linkr� ) rC r� r� �metadatar� rM rN rE � AWS_DOC_BASEr �
external_linkrO )r r rC r� r� � service_uidr� r r r r� � s
�z3OperationDocumentEventHandler._add_webapi_crosslinkc C s0 t |j�r|jj�� |j�d|j � d S d S )NaC ``%s`` uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type ``document`` must be provided as JSON. Shorthand syntax does not support document types.)r r� rC rM rN rO r r r r r r� � s
���zBOperationDocumentEventHandler._add_note_for_document_types_if_usedTc C sJ t |t�r|jr|r|j}d�dd� |D ��S dS |jdkr dS d|j S )N�|c S s g | ]}d | �qS )z"%s"r )rc �cr r r re � s zJOperationDocumentEventHandler._json_example_value_name.<locals>.<listcomp>z"string"�booleanz
true|falser\ )r� r r� rF r� )r rr �include_enum_valuesr� r r r �_json_example_value_name� s
z6OperationDocumentEventHandler._json_example_value_namec C sf |j |v r|�|j �dkr|jdkr|�d� d S |�|j � z| �|||� W |�� d S |�� w )Nr� r� z{ ... recursive ... })r r� r� rE r �_do_json_exampler� )r rC rr r� r r r �
_json_example� s
z+OperationDocumentEventHandler._json_examplec C sn |j dkrI|�d� |jj tv r |�d| �|j� � n&|j�� |j�� | �||j|� |j�� |�d� |j� � |j�� |�d� d S |j dkr�|�d� |j�� | �|j
�}|�d| � |j j tv ru|�| �|j �� n|j�� | �||j |� |j� � |j�� |�d� |j� � |�d � d S |j d
kr�|j r�| �
|� d S | �|||� d S d S ) Nr� �[z%s, ...z...�]r� �{z%s: �}r� )r� rE r� r r� rM rt �new_liner� rx r� r� r
�_doc_document_member� _doc_input_structure_members)r rC rr r� �
key_stringr r r r� � s>
�z.OperationDocumentEventHandler._do_json_examplec C s |� d� d S )Nz{...})rE )r rC r r r r� � � z2OperationDocumentEventHandler._doc_document_memberc C s |� d� |j�� |j�� |j}t|�D ]f\}}|| }|j}|tv r2|� d|| �|�f � n8|dkrE|� d| � | � |||� n%|dkrX|� d| � | � |||� n|dkrj|� d| � | � |||� |t
|�d k r||� d� |j�� q|j� � |j�� |� d � d S )
Nr� z"%s": %sr� z"%s": r� r� r� �,r� ) rE rM rt r� r� � enumerater� r r� r� r/ rx ) r rC rr r� r� �ir� � member_modelr� r r r r� � s6
�
�
z:OperationDocumentEventHandler._doc_input_structure_membersc K s� t |�\}}|j}|j| }|j| jv r |j| jv r d S |j} t� }
|
�|j�rW|
� |||�} | d u r5d S | rW|j
� � |� d� |j
�
� | �� D ]} |�| � qJ|j
�� | d ur�| jdkr�| jjtv r�| j}
|j
� � |� d� |j
�
� | j|
dd�}|� d||f � t|
t�r�|
jr�| �||
j� |j
�� |j
� � d S |jtvr�|j
� � |� d� |j
�
� | j|| g d� |j
�� |j
� � d S d S ) NzShorthand Syntaxr� �SyntaxF)r� z %s %s ...z JSON Syntaxr� )r rC r r r r rr r �supports_shorthand�generate_shorthand_examplerM rN rE r] �
splitlinesrO rm r� r� r r� r� r r� �_write_valid_enumsrs r� )r ri r r� rG �
service_id�operation_namerC � cli_argumentrr �docgen�example_shorthand_syntax� example_liner� � example_typer r r r� � sX �
�
�
�z0OperationDocumentEventHandler.doc_option_examplec C s: |j �� |�d� |D ] }|�d| � q |�d� d S )NzWhere valid values are:
z %s
r� )rM rN rE )r rC � enum_valuesr� r r r r� 4 s
z0OperationDocumentEventHandler._write_valid_enumsc K sd |j }|j�d� |j}|j}|d u s|js |�d� d S |j�� D ]
\}}| j|||g d� q"d S )N�Output�Noner� ) rC rM rU r� � output_shaper� rE r r� ) r r r� rG rC r� r� r� r� r r r �
doc_output; s �z(OperationDocumentEventHandler.doc_outputc K s | � |� d S r
)r� r� r r r r� F r� z-OperationDocumentEventHandler.doc_options_endN)T)r� r� r� r� rY r� r� r� r� r� r� r� r� r� r� r� r� r r r r r� l s
#8 r� c @ sX e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd d
� Z dd� Z
dd� Z dd� Z dS )� TopicListerDocumentEventHandleras This is the AWS CLI Topic Guide. It gives access to a set of topics that provide a deeper understanding of the CLI. To access the list of topics from the command line, run ``aws help topics``. To access a specific topic from the command line, run ``aws help [topicname]``, where ``topicname`` is the name of the topic as it appears in the output from ``aws help topics``.c C s, || _ | �|j|j� t� | _| j�� d S r
)r r r r r �
_topic_tag_db�load_json_indexr r r r r S s z(TopicListerDocumentEventHandler.__init__c K s< |j }|jdkr |�d� |jjddd� |�d� d S d S )Nr< r= �cli:awsr> r} rB �rC rD rE rM r� rX r r r rL Y s
�z/TopicListerDocumentEventHandler.doc_breadcrumbsc K s8 |j }|j�� |jjd| jj dd� |j�d� d S )N�cli:aws help %sr� ��refnamer� zAWS CLI Topic Guide)rC rM rN �link_target_definitionr r rP rX r r r rR ` s
�z)TopicListerDocumentEventHandler.doc_titlec K s, |j }|j�d� |�| j� |j�� d S rS )rC rM rU rV � DESCRIPTIONrN rX r r r rY h rZ z/TopicListerDocumentEventHandler.doc_descriptionc K r� r
r r� r r r r^ n r� z2TopicListerDocumentEventHandler.doc_synopsis_startc K r� r
r r� r r r rn q r� z0TopicListerDocumentEventHandler.doc_synopsis_endc K r� r
r r� r r r rp t r� z1TopicListerDocumentEventHandler.doc_options_startc K r� r
r r� r r r r� w r� z/TopicListerDocumentEventHandler.doc_options_endc
K s� |j }|j�d� | j�d�}| j�� }t|�� �}|D ]3}|j�|� |j� � t|| �D ] }| j�
|d�} |� d� |jj d| |d� |� d| � q/q |j�
� |D ]}|j�|� qWd S )NzAvailable Topics�categoryrW r| r� r} z: %s
)rC rM rU r� �query�get_all_topic_names�sorted�keys�h3rN �get_tag_single_valuerE r� �hidden_toctree�hidden_tocitem)
r r rG rC �
categories� topic_names�category_names�
category_name�
topic_namerW r r r r� z s.
�
��
�z2TopicListerDocumentEventHandler.doc_subitems_startN)
r� r� r� r r rL rR rY r^ rn rp r� r� r r r r r� J s � r� c @ s< e Zd Zdd� Zdd� Zdd� Zdd� Zd d
� Zd d � Zd
S )�TopicDocumentEventHandlerc K sV |j }|jdkr)|�d� |jjddd� |�d� |jjddd� |�d � d S d S )
Nr< r= r� r> r} r@ zcli:aws help topics�topicsrB r� rX r r r rL � s
��z)TopicDocumentEventHandler.doc_breadcrumbsc K sH |j }|j�� |jjd| jj dd� | j�|jd�}|j�|� d S )Nr� r� r r� ) rC rM rN r r r r� r
rP )r r rG rC r� r r r rR � s
��z#TopicDocumentEventHandler.doc_titlec K s@ |j }tj�| jj|jd �}| �|�}|�|� |j �
� d S )Nz.rst) rC �os�pathrF r� � topic_dirr �_remove_tags_from_contentrO rM rN )r r rG rC �topic_filename�contentsr r r rY � s �
z)TopicDocumentEventHandler.doc_descriptionc C sl t |d�� }|�� }W d � n1 sw Y d}t|�D ]
\}}| �|�s,|} nq d�||d � �S )N�rr r� )�open� readlinesr� �
_line_has_tagrF )r �filename�f�lines�content_begin_indexr� �liner r r r � s
�
�z3TopicDocumentEventHandler._remove_tags_from_contentc C s* | j jD ]}|�d| d �r dS qdS )N�:TF)r� �
valid_tagsrg )r r" �tagr r r r � s
�z'TopicDocumentEventHandler._line_has_tagc K r� r
r r� r r r r� � r� z,TopicDocumentEventHandler.doc_subitems_startN) r� r� r� rL rR rY r r r� r r r r r � s
r ) �loggingr �botocorer �botocore.modelr �botocore.utilsr �awsclir �awscli.argprocessr �awscli.bcdoc.doceventsr �awscli.topictagsr � awscli.utilsr r
r � getLoggerr� �LOG�objectr r� r� r� r� r r r r r �<module> s&
n-3 _N