File: //lib/python2.7/site-packages/awscli/help.pyc
�
R$�_c @ s* d d l Z d d l Z d d l Z d d l Z d d l Z d d l m Z m Z d d l m Z d d l
m Z d d l m
Z
d d l m Z d d l m Z d d l m Z d d l m Z d d
l m Z d d l m Z d d l m Z d d
l m Z d d l m Z d d l m Z d d l m Z e j d � Z! d e" f d � � YZ# d � Z$ d e% f d � � YZ& d e& f d � � YZ' d e& f d � � YZ( d e% f d � � YZ) d e) f d � � YZ* d e) f d � � YZ+ d! e) f d" � � YZ, d# e) f d$ � � YZ- d% e) f d& � � YZ. d S(' i����N( t Popent PIPE( t publish_string( t manpage( t ProviderDocumentEventHandler( t ServiceDocumentEventHandler( t OperationDocumentEventHandler( t TopicListerDocumentEventHandler( t TopicDocumentEventHandler( t docevents( t ReSTDocument( t
TextWriter( t ParamShorthandParser( t ArgTableArgParser( t
TopicTagDB( t
ignore_ctrl_cs awscli.helpt ExecutableNotFoundErrorc B s e Z d � Z RS( c C s t t | � j d | � d S( Ns$ Could not find executable named "%s"( t superR t __init__( t selft executable_name( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR ) s ( t __name__t
__module__R ( ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR ( s c C s$ t j � d k r t � St � Sd S( sZ
Return the appropriate HelpRenderer implementation for the
current platform.
t WindowsN( t platformt systemt WindowsHelpRenderert PosixHelpRenderer( ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyt get_renderer. s t PagingHelpRendererc B sP e Z d Z e j d � Z d Z d � Z d � Z d � Z
d � Z d � Z RS( s�
Interface for a help renderer.
The renderer is responsible for displaying the help content on
a particular platform.
c C s
| | _ d S( N( t
output_stream( R R ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR A s c C sT | j } d t j k r( t j d } n d t j k rG t j d } n t j | � S( Nt MANPAGERt PAGER( R t ost environt shlext split( R t pager( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyt get_pager_cmdlineF s c C s | j | � } | j | � d S( s`
Each implementation of HelpRenderer must implement this
render method.
N( t _convert_doc_contentt _send_output_to_pager( R t contentst converted_content( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyt renderN s c C sE | j � } t j d | � | j | d t �} | j d | � d S( Ns Running command: %st stdint input( R& t LOGt debugt _popenR t communicate( R t outputt cmdlinet p( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR( V s c O s
t | | � S( N( R ( R t argst kwargs( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR0 \ s c C s | S( N( ( R R) ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR' _ s N(
R R t __doc__t syst stdoutR t NoneR R& R+ R( R0 R' ( ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR 9 s R c B s/ e Z d Z d Z d � Z d � Z d � Z RS( s[
Render help content on a Posix-like system. This includes
Linux and MacOS X.
s less -Rc C s� t | d t j � �} | j d � s6 t d � � n d d d d d g } t j d | � | j | d t d t d
t �} | j d | � d } | S(
Nt writert groffs -mt mans -Tt asciis Running command: %sR, R9 t stderrR- i (
R R t Writert _exists_on_pathR R. R/ R0 R R1 ( R R) t man_contentsR3 t p3t groff_output( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR' k s !c C s� | j � } | j | d � sb t j d | d � | j j | j d � d � | j j � d St j d | � t � �* | j | d t
�} | j d | � Wd QXd S( Ni s0 Pager '%s' not found in PATH, printing raw help.s utf-8s
s Running command: %sR, R- ( R& RA R. R/ R t writet decodet flushR R0 R R1 ( R R2 R3 R4 ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR( u s
c C sS t g t j j d d � j t j � D]' } t j j t j j | | � � ^ q% � S( Nt PATHt ( t anyR! R" t getR$ t pathsept patht existst join( R t nameR4 ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyRA � s ( R R R7 R R' R( RA ( ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR c s
R c B s& e Z d Z d Z d � Z d � Z RS( s* Render help content on a Windows platform.t morec C s t | d t � �} | S( NR; ( R R ( R R) t text_output( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR' � s c O s t | d <t | | � S( Nt shell( t TrueR ( R R5 R6 ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR0 � s
( R R R7 R R' R0 ( ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR � s t HelpCommandc B sb e Z d Z d Z d � Z e d � � Z e d � � Z e d � � Z e d � � Z
d � Z RS( sk
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.
c C s� | | _ | | _ | d k r' i } n | | _ | d k rE i } n | | _ i | _ g | _ t � | _ t d d � | _
d S( Nt targetR= ( t sessiont objR: t
command_tablet arg_tablet _subcommand_tablet _related_itemsR t rendererR
t doc( R RW RX RY RZ ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR � s c C s d S( sX
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.
N( ( R ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyt event_class� s
c C s d S( s�
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.
N( ( R ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyRP � s c C s | j S( s= These are the commands that may follow after the help command( R[ ( R ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyt subcommand_table� s c C s | j S( s: This is list of items that are related to the help command( R\ ( R ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyt
related_items� s c C s� | r_ t i | j � } | j | � \ } } t | d d � d k r_ | j | j | | � Sn | j | � } t j | j | � | j
j | j j
� � | j � d S( Nt
subcommand( R
R` t parse_known_argst getattrR: Rb t EventHandlerClassR t generate_eventsRW R] R+ R^ t getvaluet
unregister( R R5 t parsed_globalst subcommand_parsert parsedt remainingt instance( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyt __call__ s
N( R R R7 R: Re R t propertyR_ RP R` Ra Rn ( ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyRU � s $
t ProviderHelpCommandc B sS e Z d Z e Z d � Z e d � � Z e d � � Z e d � � Z d � Z
RS( s^ Implements top level help command.
This is what is called when ``aws help`` is run.
c C sV t j | | d | | � | | _ | | _ | | _ d | _ d | _ d g | _ d S( Ns aws help topics( RU R R: t descriptiont synopsist
help_usageR[ t
_topic_tag_dbR\ ( R RW RY RZ Rq Rr t usage( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR s
c C s d S( Nt aws( ( R ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR_ ' s c C s d S( NRv ( ( R ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyRP + s c C sS | j d k rL | j d k r- t � | _ n | j j � | j � | _ n | j S( N( R[ R: Rt R t load_json_indext _create_subcommand_table( R ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR` / s
c C s_ i } t | j � } | | d <| j j � } x* | D]" } t | j | � } | | | <q5 W| S( Nt topics( t TopicListerCommandRW Rt t get_all_topic_namest TopicHelpCommand( R R` t topic_lister_commandt topic_namest
topic_namet topic_help_command( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyRx 8 s
( R R R7 R Re R Ro R_ RP R` Rx ( ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyRp s t ServiceHelpCommandc B s; e Z d Z e Z d � Z e d � � Z e d � � Z RS( s� Implements service level help.
This is the object invoked whenever a service command
help is implemented, e.g. ``aws ec2 help``.
c C s5 t t | � j | | | | � | | _ | | _ d S( N( R R� R t _namet _event_class( R RW RX RY RZ RP R_ ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR P s c C s | j S( N( R� ( R ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR_ W s c C s | j S( N( R� ( R ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyRP [ s ( R R R7 R Re R Ro R_ RP ( ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR� F s
t OperationHelpCommandc B s; e Z d Z e Z d � Z e d � � Z e d � � Z RS( s� 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( RU R R: R t param_shorthandR� R� ( R RW t operation_modelRZ RP R_ ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR i s c C s | j S( N( R� ( R ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR_ p s c C s | j S( N( R� ( R ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyRP t s ( R R R7 R Re R Ro R_ RP ( ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR� ` s
Rz c B s5 e Z e Z d � Z e d � � Z e d � � Z RS( c C s# t t | � j | d i i � d S( N( R Rz R R: ( R RW ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR | s c C s d S( NRy ( ( R ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR_ s c C s d S( NRy ( ( R ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyRP � s ( R R R Re R Ro R_ RP ( ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyRz y s R| c B s5 e Z e Z d � Z e d � � Z e d � � Z RS( c C s, t t | � j | d i i � | | _ d S( N( R R| R R: t _topic_name( R RW R ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR � s c C s d | j S( Ns topics.( RP ( R ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR_ � s c C s | j S( N( R� ( R ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyRP � s ( R R R Re R Ro R_ RP ( ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyR| � s (/ t loggingR! R8 R R# t
subprocessR R t
docutils.coreR t docutils.writersR t awscli.clidocsR R R R R t awscli.bcdocR t awscli.bcdoc.restdocR
t awscli.bcdoc.textwriterR t awscli.argprocessR t awscli.argparserR
t awscli.topictagsR t awscli.utilsR t getLoggerR. t ExceptionR R t objectR R R RU Rp R� R� Rz R| ( ( ( s/ /usr/lib/python2.7/site-packages/awscli/help.pyt <module>
s> *1o2