File: //proc/self/root/lib/python3.6/site-packages/awscli/__pycache__/help.cpython-36.pyc
3
�T_5 � @ s� d dl Z d dlZd dlZd dlZd dlZd dlmZmZ d dlm Z d dl
m Z d dl m
Z
d dl mZ d dl mZ d dl mZ d d l mZ d d
lmZ d d lmZ d d lmZ d d
lmZ d dlmZ d dl m Z d dl m Z e j d�Z!G dd� de"�Z#dd� Z$G dd� de%�Z&G dd� de&�Z'G dd� de&�Z(G d d � d e%�Z)G d d � d e)�Z*G d d!� d!e)�Z+G d"d#� d#e)�Z,G d$d%� d%e)�Z-G d&d'� d'e)�Z.dS )(� N)�Popen�PIPE)�publish_string)�manpage)� ProviderDocumentEventHandler)�ServiceDocumentEventHandler)� OperationDocumentEventHandler)� TopicListerDocumentEventHandler)�TopicDocumentEventHandler)� docevents)� ReSTDocument)�
TextWriter)�ParamShorthandParser)�ArgTableArgParser)�
TopicTagDB)�
ignore_ctrl_cz awscli.helpc s e Zd Z� fdd�Z� ZS )�ExecutableNotFoundErrorc s t t| �jd| � d S )Nz$Could not find executable named "%s")�superr �__init__)�selfZexecutable_name)� __class__� �/usr/lib/python3.6/help.pyr ) s
z ExecutableNotFoundError.__init__)�__name__�
__module__� __qualname__r �
__classcell__r r )r r r ( s r c C s t j� dkrt� S t� S dS )zZ
Return the appropriate HelpRenderer implementation for the
current platform.
ZWindowsN)�platform�system�WindowsHelpRenderer�PosixHelpRendererr r r r � get_renderer. s r! c @ sJ e Zd ZdZejfdd�ZdZdd� Zdd� Z d d
� Z
d d � Z d
d� Z dS )�PagingHelpRendererz�
Interface for a help renderer.
The renderer is responsible for displaying the help content on
a particular platform.
c C s
|| _ d S )N)�
output_stream)r r# r r r r A s zPagingHelpRenderer.__init__Nc C s: | j }dtjkr tjd }ndtjkr0tjd }tj|�S )NZMANPAGER�PAGER)r$ �os�environ�shlex�split)r Zpagerr r r �get_pager_cmdlineF s
z$PagingHelpRenderer.get_pager_cmdlinec C s | j |�}| j|� dS )z`
Each implementation of HelpRenderer must implement this
render method.
N)�_convert_doc_content�_send_output_to_pager)r �contentsZconverted_contentr r r �renderN s
zPagingHelpRenderer.renderc C s2 | j � }tjd|� | j|td�}|j|d� d S )NzRunning command: %s)�stdin)�input)r) �LOG�debug�_popenr � communicate)r �output�cmdline�pr r r r+ V s z(PagingHelpRenderer._send_output_to_pagerc O s
t ||�S )N)r )r �args�kwargsr r r r2 \ s zPagingHelpRenderer._popenc C s |S )Nr )r r, r r r r* _ s z'PagingHelpRenderer._convert_doc_content)
r r r �__doc__�sys�stdoutr r$ r) r- r+ r2 r* r r r r r" 9 s r" c @ s, e Zd ZdZdZdd� Zdd� Zdd� Zd S )
r z[
Render help content on a Posix-like system. This includes
Linux and MacOS X.
zless -Rc C sb t |tj� d�}| jd�s"td��dddddg}tjd|� | j|tttd�}|j |d �d
}|S ) N)�writerZgroffz-m�manz-T�asciizRunning command: %s)r. r; �stderr)r/ r )
r r �Writer�_exists_on_pathr r0 r1 r2 r r3 )r r, Z man_contentsr5 Zp3Z groff_outputr r r r* k s
z&PosixHelpRenderer._convert_doc_contentc C s� | j � }| j|d �sLtjd|d � | jj|jd�d � | jj� d S tjd|� t� � | j |t
d�}|j |d� W d Q R X d S )Nr z0Pager '%s' not found in PATH, printing raw help.zutf-8�
zRunning command: %s)r. )r/ ) r) rA r0 r1 r# �write�decode�flushr r2 r r3 )r r4 r5 r6 r r r r+ u s
z'PosixHelpRenderer._send_output_to_pagerc s( t � fdd�tjjdd�jtj�D ��S )Nc s" g | ]}t jjt jj|� ���qS r )r% �path�exists�join)�.0r6 )�namer r �
<listcomp>� s z5PosixHelpRenderer._exists_on_path.<locals>.<listcomp>�PATH� )�anyr% r& �getr( �pathsep)r rJ r )rJ r rA � s z!PosixHelpRenderer._exists_on_pathN)r r r r9 r$ r* r+ rA r r r r r c s
r c @ s$ e Zd ZdZdZdd� Zdd� ZdS )r z*Render help content on a Windows platform.Zmorec C s t |t� d�}|S )N)r< )r r
)r r, Z text_outputr r r r* � s
z(WindowsHelpRenderer._convert_doc_contentc O s d|d< t ||�S )NT�shell)r )r r7 r8 r r r r2 � s zWindowsHelpRenderer._popenN)r r r r9 r$ r* r2 r r r r r � s r c @ sT e Zd ZdZdZdd� Zedd� �Zedd� �Zed d
� �Z ed d � �Z
d
d� Z dS )� HelpCommandak
HelpCommand Interface
---------------------
A HelpCommand object acts as the interface between objects in the
CLI (e.g. Providers, Services, Operations, etc.) and the documentation
system (bcdoc).
A HelpCommand object wraps the object from the CLI space and provides
a consistent interface to critical information needed by the
documentation pipeline such as the object's name, description, etc.
The HelpCommand object is passed to the component of the
documentation pipeline that fires documentation events. It is
then passed on to each document event handler that has registered
for the events.
All HelpCommand objects contain the following attributes:
+ ``session`` - A ``botocore`` ``Session`` object.
+ ``obj`` - The object that is being documented.
+ ``command_table`` - A dict mapping command names to
callable objects.
+ ``arg_table`` - A dict mapping argument names to callable objects.
+ ``doc`` - A ``Document`` object that is used to collect the
generated documentation.
In addition, please note the `properties` defined below which are
required to allow the object to be used in the document pipeline.
Implementations of HelpCommand are provided here for Provider,
Service and Operation objects. Other implementations for other
types of objects might be needed for customization in plugins.
As long as the implementations conform to this basic interface
it should be possible to pass them to the documentation system
and generate interactive and static help files.
Nc C sT || _ || _|d kri }|| _|d kr*i }|| _i | _g | _t� | _tdd�| _ d S )Nr= )�target)
�session�obj�
command_table� arg_table�_subcommand_table�_related_itemsr! �rendererr �doc)r rT rU rV rW r r r r � s zHelpCommand.__init__c C s dS )aX
Return the ``event_class`` for this object.
The ``event_class`` is used by the documentation pipeline
when generating documentation events. For the event below::
doc-title.<event_class>.<name>
The document pipeline would use this property to determine
the ``event_class`` value.
Nr )r r r r � event_class� s
zHelpCommand.event_classc C s dS )z�
Return the name of the wrapped object.
This would be called by the document pipeline to determine
the ``name`` to be inserted into the event, as shown above.
Nr )r r r r rJ � s zHelpCommand.namec C s | j S )z=These are the commands that may follow after the help command)rX )r r r r �subcommand_table� s z HelpCommand.subcommand_tablec C s | j S )z:This is list of items that are related to the help command)rY )r r r r �
related_items� s zHelpCommand.related_itemsc C sv |r@t i | j�}|j|�\}}t|dd �d k r@| j|j ||�S | j| �}tj| j| � | j j
| j j � � |j
� d S )N�
subcommand)r r] Zparse_known_args�getattrr_ �EventHandlerClassr Zgenerate_eventsrT rZ r- r[ �getvalueZ
unregister)r r7 Zparsed_globalsZsubcommand_parserZparsedZ remaining�instancer r r �__call__ s
zHelpCommand.__call__) r r r r9 ra r �propertyr\ rJ r] r^ rd r r r r rR � s $
rR c @ sH e Zd ZdZeZdd� Zedd� �Zedd� �Z edd � �Z
d
d � Z d S )
�ProviderHelpCommandz^Implements top level help command.
This is what is called when ``aws help`` is run.
c C s< t j| |d ||� || _|| _|| _d | _d | _dg| _d S )Nzaws help topics)rR r � description�synopsisZ
help_usagerX �
_topic_tag_dbrY )r rT rV rW rg rh Zusager r r r s
z ProviderHelpCommand.__init__c C s dS )N�awsr )r r r r r\ ' s z ProviderHelpCommand.event_classc C s dS )Nrj r )r r r r rJ + s zProviderHelpCommand.namec C s6 | j d kr0| jd kr t� | _| jj� | j� | _ | j S )N)rX ri r Zload_json_index�_create_subcommand_table)r r r r r] / s
z$ProviderHelpCommand.subcommand_tablec C sF i }t | j�}||d< | jj� }x |D ]}t| j|�}|||< q&W |S )N�topics)�TopicListerCommandrT ri Zget_all_topic_names�TopicHelpCommand)r r] Ztopic_lister_commandZ topic_names�
topic_nameZtopic_help_commandr r r rk 8 s
z,ProviderHelpCommand._create_subcommand_tableN) r r r r9 r ra r re r\ rJ r] rk r r r r rf s rf c s< e Zd ZdZeZ� fdd�Zedd� �Zedd� �Z � Z
S )�ServiceHelpCommandz�Implements service level help.
This is the object invoked whenever a service command
help is implemented, e.g. ``aws ec2 help``.
c s& t t| �j||||� || _|| _d S )N)r rp r �_name� _event_class)r rT rU rV rW rJ r\ )r r r r P s zServiceHelpCommand.__init__c C s | j S )N)rr )r r r r r\ W s z ServiceHelpCommand.event_classc C s | j S )N)rq )r r r r rJ [ s zServiceHelpCommand.name) r r r r9 r ra r re r\ rJ r r r )r r rp F s
rp c @ s4 e Zd ZdZeZdd� Zedd� �Zedd� �Z dS ) �OperationHelpCommandz�Implements operation level help.
This is the object invoked whenever help for a service is requested,
e.g. ``aws ec2 describe-instances help``.
c C s* t j| ||d |� t� | _|| _|| _d S )N)rR r r Zparam_shorthandrq rr )r rT Zoperation_modelrW rJ r\ r r r r i s z OperationHelpCommand.__init__c C s | j S )N)rr )r r r r r\ p s z OperationHelpCommand.event_classc C s | j S )N)rq )r r r r rJ t s zOperationHelpCommand.nameN)
r r r r9 r ra r re r\ rJ r r r r rs ` s
rs c s8 e Zd ZeZ� fdd�Zedd� �Zedd� �Z� Z S )rm c s t t| �j|d i i � d S )N)r rm r )r rT )r r r r | s zTopicListerCommand.__init__c C s dS )Nrl r )r r r r r\ s z TopicListerCommand.event_classc C s dS )Nrl r )r r r r rJ � s zTopicListerCommand.name)
r r r r ra r re r\ rJ r r r )r r rm y s rm c s8 e Zd ZeZ� fdd�Zedd� �Zedd� �Z� Z S )rn c s t t| �j|d i i � || _d S )N)r rn r � _topic_name)r rT ro )r r r r � s zTopicHelpCommand.__init__c C s
d| j S )Nztopics.)rJ )r r r r r\ � s z TopicHelpCommand.event_classc C s | j S )N)rt )r r r r rJ � s zTopicHelpCommand.name)
r r r r
ra r re r\ rJ r r r )r r rn � s rn )/Zloggingr% r: r r' �
subprocessr r Z
docutils.corer Zdocutils.writersr Zawscli.clidocsr r r r r
Z awscli.bcdocr Zawscli.bcdoc.restdocr Zawscli.bcdoc.textwriterr
Zawscli.argprocessr Zawscli.argparserr Zawscli.topictagsr Z awscli.utilsr Z getLoggerr0 � Exceptionr r! �objectr" r r rR rf rp rs rm rn r r r r �<module>
s>
*1o2