File: //lib/python3.6/site-packages/awscli/__pycache__/clidocs.cpython-36.opt-1.pyc
3
�T_ n � @ 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 je�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)� StringShape)�is_json_value_header)� SCALAR_TYPES)�ParamShorthandDocGen)�
DOC_EVENTS)�
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#d$� Zd%d&� Zd'd(� Zd)S )*�CLIDocumentEventHandlerc C s, || _ | j|j|j� | j|�| _g | _d S )N)� help_command�register�session� event_class�_build_arg_table_groups� _arg_groups�_documented_arg_groups)�selfr � r � /usr/lib/python3.6/clidocs.py�__init__ s z CLIDocumentEventHandler.__init__c C s> i }x4|j j� D ]&\}}|jd k r|j|jg �j|� qW |S )N)� 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 )NZJSON)r )r �shape�defaultr r r �_get_argument_type_name+ s z/CLIDocumentEventHandler._get_argument_type_namec C sz xtt D ]l}|jdd�}t| |�rt| |�}t | }t|jd��d }|fd| } ||| }
|| } ||
|| � qW d S )N�-�_�.� �*)r$ )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 |||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 | j | 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�|jjd�}|jd� |jd� dg}xD|d d � D ]4}|jd� |j|� dj|�}|jd ||f � qDW |jd
� d S ) N�manr" z[ z:ref:`aws <cli:aws>`�aws� z . � z:ref:`%s <cli:%s>`z ]���)�doc�targetr r) �writer �join)r r �kwargsr2 Z cmd_namesZ
full_cmd_list�cmdZ
full_cmd_namer r r �doc_breadcrumbsT s
z'CLIDocumentEventHandler.doc_breadcrumbsc K sN |j }|jj� |jjdd�}|dkr.d| }|jd| � |jj|j� d S )Nr" r0 r. zaws z .. _cli:%s:)r2 �style�
new_paragraphr r% �writeln�h1r )r r r6 r2 Z referencer r r � doc_titleb s
z!CLIDocumentEventHandler.doc_titlec K s, |j }|jjd� |j|j� |jj� d S )N� Description)r2 r9 �h2�include_doc_string� descriptionr: )r r r6 r2 r r r �doc_descriptionk s z'CLIDocumentEventHandler.doc_descriptionc K s6 g | _ |j}|jjd� |jj� |jd|j � d S )N�Synopsisz%s)r r2 r9 r? �start_codeblockr; r )r r r6 r2 r r r �doc_synopsis_startq s
z*CLIDocumentEventHandler.doc_synopsis_startc K s� |j }|j| }|j| jkrX|j| jkr,d S djdd� | j|j D ��}| jj|j� n"|jjd�rpd|j }n
d|j }|j p�t
|dd�s�d | }|j d
| � d S ) Nz | 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>Z_DOCUMENT_AS_REQUIREDFz[%s]z%s) r2 r r r r r5 r rF �
startswithZrequiredr' r; )r �arg_namer r6 r2 �argumentZ
option_strr r r �doc_synopsis_optionx s
z+CLIDocumentEventHandler.doc_synopsis_optionc K s |j }|jj� g | _d S )N)r2 r9 �
end_codeblockr )r r r6 r2 r r r �doc_synopsis_end� s
z(CLIDocumentEventHandler.doc_synopsis_endc K s& |j }|jjd� |js"|jd� d S )N�Optionsz*None*
)r2 r9 r? r r4 )r r r6 r2 r r r �doc_options_start� s z)CLIDocumentEventHandler.doc_options_startc K s� |j }|j| }|j| jkrX|j| jkr,d S djdd� | j|j D ��}| jj|j� n
d|j }|jd|| j |j
|j �f � |j j
� |j|j� t|d�r�| j|j
|� | j|j
|� |j j� |j j� d S )Nz | c S s g | ]}d |j �qS )z``%s``)rF )rG rH r r r rI � s z6CLIDocumentEventHandler.doc_option.<locals>.<listcomp>z``%s``z%s (%s)
�argument_model)r2 r r r r r5 r rF r4 r rR �
cli_type_namer9 �indentr@ �
documentationr& �_document_enums�_document_nested_structure�dedentr: )r rK r r6 r2 rL r r r r �
doc_option� s&
z"CLIDocumentEventHandler.doc_optionc K s |j r|j}|jjd� d S )NzSee Also)Z
related_itemsr2 r9 r? )r r r6 r2 r r r �doc_relateditems_start� s z.CLIDocumentEventHandler.doc_relateditems_startc K s2 |j }|jd� |jjd| |d� |jd� d S )Nz* zcli:%s)�label�text�
)r2 r4 r9 �sphinx_reference_label)r r Z related_itemr6 r2 r r r �doc_relateditem� s
z'CLIDocumentEventHandler.doc_relateditemc C s\ t |t�rX|jrX|jj� |jd� |jj� x |jD ]}|jjd| � q6W |jj� dS )z#Documents top-level parameter enumszPossible values:z``%s``N) �
isinstancer �enumr9 r: r4 �start_ul�li�end_ul)r �modelr2 ra r r r rV � s
z'CLIDocumentEventHandler._document_enumsc
C s� t |dd�}|dkrDx�|jj� D ] \}}| j||||jgd� q W n~|dkrf| j|d|j|jgd� n\|dkr�|j}|jjdd �}| j||||jgd� |j }|jjdd
�} | j|| ||jgd� dS ) z5Recursively documents parameters in nested structures� type_nameN� structure)�stack�list� �mapr �key�value)
r' �membersr � _doc_memberr �memberrl �
serialization�getrm )
r re r2 �member_type_name� member_name� member_shape� key_shape�key_name� value_shape�
value_namer r r rW � s
z2CLIDocumentEventHandler._document_nested_structurec C sb |j |kr2|j|j �dkr2|jdkr.|jd� d S |j|j � z| j||||� W d |j� X d S )Nr/ rg z( ... recursive ... ))r �countrf r4 r �_do_doc_member�pop)r r2 rt ru rh r r r ro � s
z#CLIDocumentEventHandler._doc_memberc
C s |j }|r(|jd|| j||j�f � n|jd|j � |jj� |jj� |j|� |jj� |j}|dkr�x�|jj � D ]\}}| j
||||� qzW nn|dkr�|j } | j j
dd�}
| j
||
| |� |j} | j j
dd�} | j
|| | |� n |dk�r| j
|d |j|� |jj� |jj� d S )
Nz
%s -> (%s)z(%s)rg rk r rl rm ri rj )rU r4 r rf r9 rT r: r@ rn r ro rl rq rr rm rp rX )
r r2 rt ru rh Zdocsrs Zsub_nameZ sub_shaperv rw rx ry r r r r{ � s0
z&CLIDocumentEventHandler._do_doc_memberN)�__name__�
__module__� __qualname__r r r r+ r r, r8 r= rB rE rM rO rQ rY rZ r_ rV rW ro 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 )Nr )r r �
event_namer6 r r r r8 s z,ProviderDocumentEventHandler.doc_breadcrumbsc K s0 |j }|jjd� |jj|j� |j|j� d S )NrC )r2 r9 r? Z codeblockZsynopsisr@ Z
help_usage)r r r6 r2 r r r rE s z/ProviderDocumentEventHandler.doc_synopsis_startc K s d S )Nr )r rK r r6 r r r rM s z0ProviderDocumentEventHandler.doc_synopsis_optionc K s |j }|jj� d S )N)r2 r9 r: )r r r6 r2 r r r rO s z-ProviderDocumentEventHandler.doc_synopsis_endc K s |j }|jjd� d S )NrP )r2 r9 r? )r r r6 r2 r r r rQ s z.ProviderDocumentEventHandler.doc_options_startc K sl |j }|j| }|jd|j|jf � |j|j� |jrh|jj � x|jD ]}|jj
|� qJW |jj � d S )Nz ``%s`` (%s)) r2 r r; rF rS r@ rU �choicesr9 rb rc rd )r rK r r6 r2 rL Zchoicer r r rY s
z'ProviderDocumentEventHandler.doc_optionc K s |j }|jjd� |jj� d S )NzAvailable Services)r2 r9 r? �toctree)r r r6 r2 r r r �doc_subitems_start( s z/ProviderDocumentEventHandler.doc_subitems_startc K s" |j }d| }|jj||d� d S )Nz%s/index)� file_name)r2 r9 �tocitem)r � command_namer r6 r2 r� r r r � doc_subitem- s z(ProviderDocumentEventHandler.doc_subitemN) r} r~ r r8 rE rM rO rQ 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 s d S )Nr )r r r6 r r r rE 6 s z.ServiceDocumentEventHandler.doc_synopsis_startc K s d S )Nr )r rK r r6 r r r rM 9 s z/ServiceDocumentEventHandler.doc_synopsis_optionc K s d S )Nr )r r r6 r r r rO < s z,ServiceDocumentEventHandler.doc_synopsis_endc K s d S )Nr )r r r6 r r r rQ @ s z-ServiceDocumentEventHandler.doc_options_startc K s d S )Nr )r rK r r6 r r r rY C s z&ServiceDocumentEventHandler.doc_optionc K s d S )Nr )r rK r r6 r r r �doc_option_exampleF s z.ServiceDocumentEventHandler.doc_option_examplec K s d S )Nr )r r r6 r r r �doc_options_endI s z+ServiceDocumentEventHandler.doc_options_endc K s( |j }|j}|jjd� |j|j� d S )Nr> )r2 �objr9 r? r@ rU )r r r6 r2 �
service_modelr r r rB L s z+ServiceDocumentEventHandler.doc_descriptionc K s |j }|jjd� |jj� d S )NzAvailable Commands)r2 r9 r? r� )r r r6 r2 r r r r� S s z.ServiceDocumentEventHandler.doc_subitems_startc K sR |j }|j| }t|di �}t|�dkrBd| }|jj||d� n |jj|� d S )N�subcommand_tabler z%s/index)r� )r2 Z
command_tabler' r( r9 r� )r r� r r6 r2 Z
subcommandr� r� r r r r� X s
z'ServiceDocumentEventHandler.doc_subitemN)
r} r~ r rE rM rO rQ rY r� r� rB r� r� r r r r r� 3 s r� c @ sj e Zd ZdZdd� Zdd� Zdd� Zdd d
�Zd d � Zd
d� Z dd� Z
dd� Z dd� Z dd� Z
dd� ZdS )� OperationDocumentEventHandlerz'https://docs.aws.amazon.com/goto/WebAPIc K s< |j }|j}|jjd� |j|j� | j|� | j|� d S )Nr> )r2 r� r9 r? r@ rU �_add_webapi_crosslink� _add_top_level_args_reference)r r r6 r2 �operation_modelr r r rB j s
z-OperationDocumentEventHandler.doc_descriptionc C s: |j jd� |j jd� |j jjddd� |j jd� d S )Nrj zSee z
'aws help'z/reference/index)�titleZpagez' for descriptions of global parameters.)r2 r; r4 r9 Z
internal_link)r r r r r r� r s z;OperationDocumentEventHandler._add_top_level_args_referencec C sn |j }|j}|j}|jjd�}|d kr*d S |jj� |jd� d| j||j f }|jj
d|d� |j d� d S )NZuidz
See also: z%s/%s/%szAWS API Documentation)r� �linkrj ) r2 r� r� Zmetadatarr r9 r: r4 � AWS_DOC_BASEr Z
external_linkr; )r r r2 r� r� Z service_uidr� r r r r� { s
z3OperationDocumentEventHandler._add_webapi_crosslinkTc C sP t |t�r4|jr.|r.|j}djdd� |D ��S dS n|jdkrBdS d|j S d S )N�|c S s g | ] }d | �qS )z"%s"r )rG �cr r r rI � s zJOperationDocumentEventHandler._json_example_value_name.<locals>.<listcomp>z"string"Zbooleanz
true|falsez%s)r` r ra r5 rf )r rR �include_enum_valuesr� r r r �_json_example_value_name� s
z6OperationDocumentEventHandler._json_example_value_namec
C s` |j |kr2|j|j �dkr2|jdkr.|jd� d S |j|j � z| j|||� W d |j� X d S )Nr/ rg z{ ... recursive ... })r rz rf r4 r �_do_json_exampler| )r r2 rR rh r r r �
_json_example� s
z+OperationDocumentEventHandler._json_examplec C sV |j dkr�|jd� |jj tkr8|jd| j|j� � nL|jj� |jj� | j||j|� |jj� |jd� |jj � |jj� |jd� n�|j dk�r8|jd� |jj� | j|j
�}|jd| � |j j tkr�|j| j|j �� n$|jj� | j||j |� |jj � |jj� |jd� |jj � |jd � n|j d
k�rR| j |||� d S ) Nri �[z%s, ...z...�]rk �{z%s: �}rg )
rf r4 rp r r� r9 rT �new_liner� rX rl rm � _doc_input_structure_members)r r2 rR rh Z
key_stringr r r r� � s8
z.OperationDocumentEventHandler._do_json_examplec C s |j d� |jj� |jj� |j}x�t|�D ]�\}}|| }|j}|tkrf|j d|| j|�f � np|dkr�|j d| � | j |||� nJ|dkr�|j d| � | j |||� n$|dkr�|j d| � | j |||� |t
|�d k r.|j d� |jj� q.W |jj � |jj� |j d � d S )
Nr� z"%s": %srg z"%s": rk ri r/ �,r� ) r4 r9 rT r� rn � enumeraterf r r� r� r( rX ) r r2 rR rh rn �irt Z member_modelrs r r r r� � s2
z:OperationDocumentEventHandler._doc_input_structure_membersc K s� t |�\}}|j}|j| }|j| jkr8|j| jkr8d S |j} t� }
|
j|j�r�|
j |||�} | d krjd S | r�|j
j � |j d� |j
j
� x| j� D ]} |j| � q�W |j
j� | d k o�| jdko�| jjtk�rN| j}
|j
j � |j d� |j
j
� | j|
dd�}|j d||f � t|
t��r8|
j�r8| j||
j� |j
j� |j
j � nN|jtk�r�|j
j � |j d� |j
j
� | j|| g d� |j
j� |j
j � d S ) NzShorthand Syntaxri ZSyntaxF)r� z %s %s ...z JSON Syntax)rh )r r2 r r r r rR r Zsupports_shorthandZgenerate_shorthand_exampler9 r: r4 rD �
splitlinesr; rN rf rp r r� r` r ra �_write_valid_enumsrS r� )r rK r r� r6 Z
service_idZoperation_namer2 Z cli_argumentrR ZdocgenZexample_shorthand_syntaxZ example_linerp Z example_typer r r r� � sP
z0OperationDocumentEventHandler.doc_option_examplec C s> |j j� |jd� x|D ]}|jd| � qW |jd� d S )NzWhere valid values are:
z %s
r] )r9 r: r4 )r r2 Z enum_valuesrm r r r r� s
z0OperationDocumentEventHandler._write_valid_enumsc K sh |j }|jjd� |j}|j}|d ks.|j r:|jd� n*x(|jj� D ]\}}| j|||g d� qFW d S )NZOutput�None)rh ) r2 r9 r? r� � output_shapern r4 r ro ) r r r� r6 r2 r� r� rt ru r r r �
doc_output" s z(OperationDocumentEventHandler.doc_outputc K s | j |� d S )N)r� )r r r6 r r r r� - s z-OperationDocumentEventHandler.doc_options_endN)T)r} r~ r r� rB r� r� r� r� r� r� r� r� r� r� r r r r r� f 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|j� t� | _| jj� d S )N)r r r
r r �
_topic_tag_dbZload_json_index)r r r r r r : s z(TopicListerDocumentEventHandler.__init__c K s8 |j }|jdkr4|jd� |jjddd� |jd� d S )Nr- z[ zcli:awsr. )r[ r\ z ])r2 r3 r4 r9 r^ )r r r6 r2 r r r r8 @ s
z/TopicListerDocumentEventHandler.doc_breadcrumbsc K s8 |j }|jj� |jjd| jj dd� |jjd� d S )Nzcli:aws help %srj )�refnamer� zAWS CLI Topic Guide)r2 r9 r: �link_target_definitionr r r< )r r r6 r2 r r r r= G s
z)TopicListerDocumentEventHandler.doc_titlec K s, |j }|jjd� |j| j� |jj� d S )Nr> )r2 r9 r? r@ � DESCRIPTIONr: )r r r6 r2 r r r rB O s z/TopicListerDocumentEventHandler.doc_descriptionc K s d S )Nr )r r r6 r r r rE U s z2TopicListerDocumentEventHandler.doc_synopsis_startc K s d S )Nr )r r r6 r r r rO X s z0TopicListerDocumentEventHandler.doc_synopsis_endc K s d S )Nr )r r r6 r r r rQ [ s z1TopicListerDocumentEventHandler.doc_options_startc K s d S )Nr )r r r6 r r r r� ^ s z/TopicListerDocumentEventHandler.doc_options_endc
K s� |j }|jjd� | jjd�}| jj� }t|j� �}xr|D ]j}|jj|� |jj � xNt|| �D ]>}| jj
|d�} |j d� |jj d| |d� |j d| � qbW q:W |jj
� x|D ]}|jj|� q�W d S )NzAvailable Topics�categoryrA z* zcli:aws help %s)r[ r\ z: %s
)r2 r9 r? r� ZqueryZget_all_topic_names�sorted�keysZh3r: �get_tag_single_valuer4 r^ Zhidden_toctreeZhidden_tocitem)
r r r6 r2 Z
categoriesZ topic_namesZcategory_namesZ
category_nameZ
topic_namerA r r r r� a s&
z2TopicListerDocumentEventHandler.doc_subitems_startN)
r} r~ r r� r r8 r= rB rE rO rQ r� r� r r r r r� 1 s r� c @ s< e Zd Zdd� Zdd� Zdd� Zdd� Zd d
� Zd d � Zd
S )�TopicDocumentEventHandlerc K sR |j }|jdkrN|jd� |jjddd� |jd� |jjddd� |jd � d S )
Nr- z[ zcli:awsr. )r[ r\ z . zcli:aws help topicsZtopicsz ])r2 r3 r4 r9 r^ )r r r6 r2 r r r r8 � s
z)TopicDocumentEventHandler.doc_breadcrumbsc K sH |j }|jj� |jjd| jj dd� | jj|jd�}|jj|� d S )Nzcli:aws help %srj )r� r� r� ) r2 r9 r: r� r r r� r� r< )r r r6 r2 r� r r r r= � s
z#TopicDocumentEventHandler.doc_titlec K s@ |j }tjj| jj|jd �}| j|�}|j|� |j j
� d S )Nz.rst) r2 �os�pathr5 r� Z topic_dirr �_remove_tags_from_contentr; r9 r: )r r r6 r2 Ztopic_filename�contentsr r r rB � s
z)TopicDocumentEventHandler.doc_descriptionc C sZ t |d��}|j� }W d Q R X d}x$t|�D ]\}}| j|�s,|}P q,W dj||d � �S )N�rr rj )�open� readlinesr� �
_line_has_tagr5 )r �filename�f�linesZcontent_begin_indexr� �liner r r r� � s
z3TopicDocumentEventHandler._remove_tags_from_contentc C s, x&| j jD ]}|jd| d �r
dS q
W dS )N�:TF)r� Z
valid_tagsrJ )r r� �tagr r r r� � s z'TopicDocumentEventHandler._line_has_tagc K s d S )Nr )r r r6 r r r r� � s z,TopicDocumentEventHandler.doc_subitems_startN) r} r~ r r8 r= rB r� r� r� r r r r r� s
r� ) Zloggingr� Zbotocorer Zbotocore.modelr Zbotocore.utilsr Zawsclir Zawscli.argprocessr Zawscli.bcdoc.doceventsr Zawscli.topictagsr Z awscli.utilsr Z getLoggerr} ZLOG�objectr
r� r� r� r� r� r r r r �<module>
s$
k-3 LN