File: //lib/python3/dist-packages/awscli/__pycache__/clidocs.cpython-38.pyc
U
<�^qj � @ 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 lmZ e �e�ZG d
d � d e�ZG d d
� d
e�ZG dd� de�ZG dd� de�ZG dd� de�ZG dd� de�ZdS )� N)�
xform_name)�
DOC_EVENTS)� StringShape��is_json_value_header)� SCALAR_TYPES)�ParamShorthandDocGen)�
TopicTagDB)�%find_service_and_method_in_event_namec @ 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#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 k r|�|jg ��|� q|S r )� arg_table�items�
group_name�
setdefault�append)r r
Z
arg_groups�name�argr r r r $ s
z/CLIDocumentEventHandler._build_arg_table_groupsc C s t |�r dS |S )NZJSONr )r �shape�defaultr r r �_get_argument_type_name+ s z/CLIDocumentEventHandler._get_argument_type_namec C sv t D ]l}|�dd�}t| |�rt| |�}t | }t|�d��d }|fd| } ||| }
|| } ||
|| � qd S )N�-�_�.� )�*)r �replace�hasattr�getattr�len�split) r r r ZmapfnZeventZevent_handler_nameZ
event_handler�
format_stringZnum_argsZ format_argsZ event_stringZ unique_idr r r �
_map_handlers0 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 < 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/ F s
�z"CLIDocumentEventHandler.unregisterc K s� |j }|jdkr�|j�d�}|�d� |�d� dg}|d d� D ]4}|�d� |�|� d�|�}|�d ||f � qB|�d
� d S ) N�manr% �[ z:ref:`aws <cli:aws>`�aws���� . � z:ref:`%s <cli:%s>`� ])�doc�targetr r, �writer �join)r r
�kwargsr7 Z cmd_namesZ
full_cmd_list�cmdZ
full_cmd_namer r r �doc_breadcrumbsT s
z'CLIDocumentEventHandler.doc_breadcrumbsc K sN |j }|j�� |j�dd�}|dkr.d| }|�d| � |j�|j� d S )Nr% r5 r2 zaws z .. _cli:%s:)r7 �style�
new_paragraphr r( �writeln�h1r )r r
r; r7 Z referencer r r � doc_titleb s
z!CLIDocumentEventHandler.doc_titlec K s, |j }|j�d� |�|j� |j�� d S �NZ Description)r7 r> �h2�include_doc_string� descriptionr? �r r
r; r7 r r r �doc_descriptionk s z'CLIDocumentEventHandler.doc_descriptionc K s6 g | _ |j}|j�d� |j�� |�d|j � d S )N�Synopsis�%s)r r7 r> rD �start_codeblockr@ r rG r r r �doc_synopsis_startq s
z*CLIDocumentEventHandler.doc_synopsis_startc K s� |j }|j| }|j| jkrX|j| jkr,d S d�dd� | j|j D ��}| j�|j� n
d|j }|js|t |dd�s|d| }|�
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
%s <value>Z_DOCUMENT_AS_REQUIREDFz[%s]rJ ) r7 r r r r r: r rO Zrequiredr* r@ )r �arg_namer
r; r7 �argumentZ
option_strr r r �doc_synopsis_optionx s"
��
�z+CLIDocumentEventHandler.doc_synopsis_optionc K s |j }|j�� g | _d S r )r7 r> �
end_codeblockr rG r r r �doc_synopsis_end� s
z(CLIDocumentEventHandler.doc_synopsis_endc K s& |j }|j�d� |js"|�d� d S )N�Optionsz*None*
)r7 r> rD r r9 rG r r r �doc_options_start� s z)CLIDocumentEventHandler.doc_options_startc K s� |j }|j| }|j| jkrX|j| jkr,d S d�dd� | j|j D ��}| j�|j� n
d|j }|�d|| � |j
|j �f � |j �
� |�|j� | �||� |j �� |j �� d S )NrM c S s g | ]}d |j �qS )�``%s``rN rP r r r rS � s z6CLIDocumentEventHandler.doc_option.<locals>.<listcomp>r[ z%s (%s)
)r7 r r r r r: r rO r9 r" �argument_model�
cli_type_namer> �indentrE �
documentation�_document_enums�dedentr? )r rT r
r; r7 rU r r r r �
doc_option� s*
��
�
z"CLIDocumentEventHandler.doc_optionc K s |j r|j}|j�d� d S )NzSee Also)Z
related_itemsr7 r> rD rG r r r �doc_relateditems_start� s z.CLIDocumentEventHandler.doc_relateditems_startc K s2 |j }|�d� |jjd| |d� |�d� d S )N�* zcli:%s�Zlabel�text�
)r7 r9 r> �sphinx_reference_label)r r
Z related_itemr; r7 r r r �doc_relateditem� s
�z'CLIDocumentEventHandler.doc_relateditemc C sh t |d�rd|j}t|t�rd|jrd|j�� |�d� |j�� |jD ]}|j� d| � qD|j�
� dS )z#Documents top-level parameter enumsr\ zPossible values:r[ N) r) r\ �
isinstancer �enumr> r? r9 �start_ul�li�end_ul)r rU r7 Zmodelrk r r r r` � s
z'CLIDocumentEventHandler._document_enumsN)�__name__�
__module__� __qualname__r r r" r. r r/ r= rB rH rL rV rX rZ rb rc ri 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 s d S r r )r r
�
event_namer; r r r r= � s z,ProviderDocumentEventHandler.doc_breadcrumbsc K s0 |j }|j�d� |j�|j� |�|j� d S )NrI )r7 r> rD Z codeblockZsynopsisrE Z
help_usagerG r r r rL � s z/ProviderDocumentEventHandler.doc_synopsis_startc K s d S r r �r rT r
r; r r r rV � s z0ProviderDocumentEventHandler.doc_synopsis_optionc K s |j }|j�� d S r )r7 r> r? rG r r r rX � s z-ProviderDocumentEventHandler.doc_synopsis_endc K s |j }|j�d� d S )NrY )r7 r> rD rG r r r rZ � s z.ProviderDocumentEventHandler.doc_options_startc K sh |j }|j| }|�d|j|jf � |�|j� |jrd|j� � |jD ]}|j�
|� qH|j� � d S )Nz ``%s`` (%s)) r7 r r@ rO r] rE r_ �choicesr> rl rm rn )r rT r
r; r7 rU Zchoicer r r rb � s
�
z'ProviderDocumentEventHandler.doc_optionc K s |j }|j�d� |j�� d S )NzAvailable Services�r7 r> rD ZtoctreerG r r r �doc_subitems_start� s z/ProviderDocumentEventHandler.doc_subitems_startc K s" |j }d| }|jj||d� d S )N�%s/index�� file_name)r7 r> �tocitem)r � command_namer
r; r7 rz r r r � doc_subitem� s z(ProviderDocumentEventHandler.doc_subitemN) ro rp rq r= rL rV rX rZ rb rw r} r r r r rr � s rr c @ s\ e Zd Zdd� Zdd� Zdd� Zdd� Zd d
� Zd d � Zd
d� Z dd� Z
dd� Z dd� Z dS )�ServiceDocumentEventHandlerc K s d S r r �r r
r; r r r rL � s z.ServiceDocumentEventHandler.doc_synopsis_startc K s d S r r rt r r r rV � s z/ServiceDocumentEventHandler.doc_synopsis_optionc K s d S r r r r r r rX � s z,ServiceDocumentEventHandler.doc_synopsis_endc K s d S r r r r r r rZ s z-ServiceDocumentEventHandler.doc_options_startc K s d S r r rt r r r rb s z&ServiceDocumentEventHandler.doc_optionc K s d S r r rt r r r �doc_option_example s z.ServiceDocumentEventHandler.doc_option_examplec K s d S r r r r r r �doc_options_end s z+ServiceDocumentEventHandler.doc_options_endc K s( |j }|j}|j�d� |�|j� d S rC )r7 �objr> rD rE r_ )r r
r; r7 �
service_modelr r r rH s z+ServiceDocumentEventHandler.doc_descriptionc K s |j }|j�d� |j�� d S )NzAvailable Commandsrv rG r r r rw s z.ServiceDocumentEventHandler.doc_subitems_startc K sR |j }|j| }t|di �}t|�dkrBd| }|jj||d� n |j�|� d S )N�subcommand_tabler rx ry )r7 Z
command_tabler* r+ r> r{ )r r| r
r; r7 Z
subcommandr� rz r r r r} s
z'ServiceDocumentEventHandler.doc_subitemN)
ro rp rq rL rV rX rZ rb r� r� rH rw r} r r r r r~ � s r~ c @ sz e Zd ZdZdd� Zdd� Zdd� Zd d d
�Zd 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 s< |j }|j}|j�d� |�|j� | �|� | �|� d S rC )r7 r� r> rD rE r_ �_add_webapi_crosslink� _add_top_level_args_reference)r r
r; r7 �operation_modelr r r rH - s
z-OperationDocumentEventHandler.doc_descriptionc C s: |j �d� |j �d� |j jjddd� |j �d� d S )N� zSee z
'aws help'z/reference/index)�titleZpagez' for descriptions of global parameters.)r7 r@ r9 r> Z
internal_linkr r r r r� 5 s �z;OperationDocumentEventHandler._add_top_level_args_referencec C sn |j }|j}|j}|j�d�}|d kr*d S |j�� |�d� d| j||j f }|jj
d|d� |� d� d S )NZuidz
See also: z%s/%s/%szAWS API Documentation)r� �linkr� ) r7 r� r� Zmetadata�getr> r? r9 � AWS_DOC_BASEr Z
external_linkr@ )r r
r7 r� r� Z service_uidr� r r r r� > s
�z3OperationDocumentEventHandler._add_webapi_crosslinkTc C sP t |t�r4|jr.|r.|j}d�dd� |D ��S dS n|jdkrBdS d|j S d S )N�|c S s g | ] }d | �qS )z"%s"r )rQ �cr r r rS U s zJOperationDocumentEventHandler._json_example_value_name.<locals>.<listcomp>z"string"Zbooleanz
true|falserJ )rj r rk r: � type_name)r r\ �include_enum_valuesru r r r �_json_example_value_nameO s
z6OperationDocumentEventHandler._json_example_value_namec C s` |j |kr2|�|j �dkr2|jdkr.|�d� d S |�|j � z| �|||� W 5 |�� X d S )N� � structurez{ ... recursive ... })r �countr� r9 r �pop�_do_json_example)r r7 r\ �stackr r r �
_json_example] s
z+OperationDocumentEventHandler._json_examplec C sV |j dkr�|�d� |jj tkr8|�d| �|j� � nL|j�� |j�� | �||j|� |j�� |�d� |j� � |j�� |�d� n�|j dk�r8|�d� |j�� | �|j
�}|�d| � |j j tkr�|�| �|j �� n$|j�� | �||j |� |j� � |j�� |�d� |j� � |�d � n|j d
k�rR| � |||� d S ) N�list�[z%s, ...z...�]�map�{z%s: �}r� )
r� r9 �memberr r� r> r^ �new_liner� ra �key�value� _doc_input_structure_members)r r7 r\ r� Z
key_stringr r r r� k s8
z.OperationDocumentEventHandler._do_json_examplec C s |� d� |j�� |j�� |j}t|�D ]�\}}|| }|j}|tkrd|� d|| �|�f � np|dkr�|� d| � | � |||� nJ|dkr�|� d| � | � |||� n$|dkr�|� d| � | � |||� |t
|�d k r,|� d� |j�� q,|j� � |j�� |� d � d S )
Nr� z"%s": %sr� z"%s": r� r� r� �,r� ) r9 r> r^ r� �members� enumerater� r r� r� r+ ra ) r r7 r\ r� r� �i� member_nameZ member_model�member_type_namer r r r� � s4
�
z:OperationDocumentEventHandler._doc_input_structure_membersc K s� t |�\}}|j}|j| }|j| jkr8|j| jkr8d S |j} t� }
|
�|j�r�|
� |||�} | d krjd S | r�|j
� � |� d� |j
�
� | �� D ]} |�| � q�|j
�� | d k �rN| jdk�rN| jjtk�rN| j}
|j
� � |� d� |j
�
� | j|
dd�}|� d||f � t|
t��r8|
j�r8| �||
j� |j
�� |j
� � nN|jtk�r�|j
� � |� d� |j
�
� | j|| g d� |j
�� |j
� � d S ) NzShorthand Syntaxr� ZSyntaxF)r� z %s %s ...z JSON Syntax�r� )r
r7 r r r r r\ r Zsupports_shorthandZgenerate_shorthand_exampler> r? r9 rK �
splitlinesr@ rW r� r� r r� rj r rk �_write_valid_enumsr] r� )r rT r
rs r; Z
service_idZoperation_namer7 Z cli_argumentr\ ZdocgenZexample_shorthand_syntaxZ example_liner� Z example_typer r r r� � s^ �
�
�
�
z0OperationDocumentEventHandler.doc_option_examplec C s: |j �� |�d� |D ]}|�d| � q|�d� d S )NzWhere valid values are:
z %s
rg )r> r? r9 )r r7 Z enum_valuesr� r r r r� � s
z0OperationDocumentEventHandler._write_valid_enumsc K sb |j }|j�d� |j}|j}|d ks,|js8|�d� n&|j�� D ]\}}| j|||g d� qBd S )NZOutput�Noner� ) r7 r> rD r� � output_shaper� r9 r �_doc_member_for_output) r r
rs r; r7 r� r� r� � member_shaper r r �
doc_output� s z(OperationDocumentEventHandler.doc_outputc C sb |j |kr2|�|j �dkr2|jdkr.|�d� d S |�|j � z| �||||� W 5 |�� X d S )Nr� r� z( ... recursive ... ))r r� r� r9 r r� �_do_doc_member_for_output)r r7 r� r� r� r r r r� � s
�z4OperationDocumentEventHandler._doc_member_for_outputc
C s |j }|r(|�d|| �||j�f � n|�d|j � |j�� |j�� |�|� |j�� |j}|dkr�|j� � D ]\}}| �
||||� qxnn|dkr�|j } | j �
dd�}
| �
||
| |� |j} | j �
dd�} | �
|| | |� n |dk�r| �
|d |j|� |j�� |j�� d S )
Nz
%s -> (%s)z(%s)r� r� r r� r� r� r� )r_ r9 r" r� r> r^ r? rE r� r r� r� Z
serializationr� r� r� ra )
r r7 r� r� r� Zdocsr� Zsub_nameZ sub_shapeZ key_shapeZkey_nameZ value_shapeZ
value_namer r r r� � s4 �
z7OperationDocumentEventHandler._do_doc_member_for_outputc K s | � |� d S r )r� r r r r r� s z-OperationDocumentEventHandler.doc_options_endN)T)ro rp rq r� rH r� r� r� r� r� r� r� r� r� r� r� r� r r r r r� ) 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_dbZload_json_indexr r r r r ' s z(TopicListerDocumentEventHandler.__init__c K s8 |j }|jdkr4|�d� |jjddd� |�d� d S )Nr0 r1 �cli:awsr2 re r6 �r7 r8 r9 r> rh rG r r r r= - s
z/TopicListerDocumentEventHandler.doc_breadcrumbsc K s8 |j }|j�� |jjd| jj dd� |j�d� d S )N�cli:aws help %sr� �Zrefnamer� zAWS CLI Topic Guide)r7 r> r? �link_target_definitionr
r rA rG r r r rB 4 s
�z)TopicListerDocumentEventHandler.doc_titlec K s, |j }|j�d� |�| j� |j�� d S rC )r7 r> rD rE � DESCRIPTIONr? rG r r r rH < s z/TopicListerDocumentEventHandler.doc_descriptionc K s d S r r r r r r rL B s z2TopicListerDocumentEventHandler.doc_synopsis_startc K s d S r r r r r r rX E s z0TopicListerDocumentEventHandler.doc_synopsis_endc K s d S r r r r r r rZ H s z1TopicListerDocumentEventHandler.doc_options_startc K s d S r r r r r r r� K s z/TopicListerDocumentEventHandler.doc_options_endc
K s� |j }|j�d� | j�d�}| j�� }t|�� �}|D ]f}|j�|� |j� � t|| �D ]>}| j�
|d�} |� d� |jj d| |d� |� d| � q^q8|j�
� |D ]}|j�|� q�d S )NzAvailable Topics�categoryrF rd r� re z: %s
)r7 r> rD r� ZqueryZget_all_topic_names�sorted�keysZh3r? �get_tag_single_valuer9 rh Zhidden_toctreeZhidden_tocitem)
r r
r; r7 Z
categoriesZ topic_namesZcategory_namesZ
category_nameZ
topic_namerF r r r rw N s,
�
�
z2TopicListerDocumentEventHandler.doc_subitems_startN)
ro rp rq r� r r= rB rH rL rX rZ r� rw r r r r r� s �r� c @ s< e Zd Zdd� Zdd� Zdd� Zdd� Zd d
� Zd d � Zd
S )�TopicDocumentEventHandlerc K sR |j }|jdkrN|�d� |jjddd� |�d� |jjddd� |�d � d S )
Nr0 r1 r� r2 re r4 zcli:aws help topicsZtopicsr6 r� rG r r r r= n s
�z)TopicDocumentEventHandler.doc_breadcrumbsc K sH |j }|j�� |jjd| jj dd� | j�|jd�}|j�|� d S )Nr� r� r� r� ) r7 r> r? r� r
r r� r� rA )r r
r; r7 r� r r r rB z s
� �z#TopicDocumentEventHandler.doc_titlec K s@ |j }tj�| jj|jd �}| �|�}|�|� |j �
� d S )Nz.rst) r7 �os�pathr: r� Z topic_dirr �_remove_tags_from_contentr@ r> r? )r r
r; r7 Ztopic_filename�contentsr r r rH � s �
z)TopicDocumentEventHandler.doc_descriptionc C sX t |d��}|�� }W 5 Q R X d}t|�D ]\}}| �|�s*|} qFq*d�||d � �S )N�rr r� )�open� readlinesr� �
_line_has_tagr: )r �filename�f�linesZcontent_begin_indexr� �liner r r r� � s
z3TopicDocumentEventHandler._remove_tags_from_contentc C s* | j jD ] }|�d| d �r dS qdS )N�:TF)r� Z
valid_tags�
startswith)r r� �tagr r r r� � s z'TopicDocumentEventHandler._line_has_tagc K s d S r r r r r r rw � s z,TopicDocumentEventHandler.doc_subitems_startN) ro rp rq r= rB rH r� r� rw r r r r r� l s
r� ) Zloggingr� Zbotocorer Z botocore.docs.bcdoc.doceventsr Zbotocore.modelr Zbotocore.utilsr Zawsclir Zawscli.argprocessr Zawscli.topictagsr Z awscli.utilsr
Z getLoggerro ZLOG�objectr rr r~ r� r� r� r r r r �<module>
s$
.-3 vN