o !dx5@sddlZddlZddlZddlZddlZddlmZmZddlm Z ddl m Z ddl m Z ddl mZddl mZddl mZdd l mZdd lmZdd lmZdd lmZdd lmZddlmZddlmZddlmZe dZ!Gddde"Z#ddZ$Gddde%Z&Gddde&Z'Gddde&Z(Gddde%Z)Gddde)Z*Gd d!d!e)Z+Gd"d#d#e)Z,Gd$d%d%e)Z-Gd&d'd'e)Z.dS)(N)PopenPIPE)publish_string)manpage)ProviderDocumentEventHandler)ServiceDocumentEventHandler)OperationDocumentEventHandler)TopicListerDocumentEventHandler)TopicDocumentEventHandler) docevents) ReSTDocument) TextWriter)ParamShorthandParser)ArgTableArgParser) TopicTagDB) ignore_ctrl_cz awscli.helpcseZdZfddZZS)ExecutableNotFoundErrorcstt|d|dS)Nz$Could not find executable named "%s")superr__init__)selfZexecutable_name __class__/usr/lib/python3.10/site-packages/awscli/help.pyr)s z ExecutableNotFoundError.__init__)__name__ __module__ __qualname__r __classcell__rrrrr(srcCstdkr tStS)zZ Return the appropriate HelpRenderer implementation for the current platform. Windows)platformsystemWindowsHelpRendererPosixHelpRendererrrrr get_renderer.s r#c@sJeZdZdZejfddZdZddZddZ d d Z d d Z d dZ dS)PagingHelpRendererz Interface for a help renderer. The renderer is responsible for displaying the help content on a particular platform. cCs ||_dSN) output_stream)rr&rrrrAs zPagingHelpRenderer.__init__NcCs:|j}dtjvrtjd}n dtjvrtjd}t|S)NZMANPAGERPAGER)r'osenvironshlexsplit)rZpagerrrrget_pager_cmdlineFs      z$PagingHelpRenderer.get_pager_cmdlinecCs||}||dS)z` Each implementation of HelpRenderer must implement this render method. N)_convert_doc_content_send_output_to_pager)rcontentsZconverted_contentrrrrenderNs zPagingHelpRenderer.rendercCs2|}td||j|td}|j|ddS)NRunning command: %sstdininput)r,LOGdebug_popenr communicateroutputcmdlineprrrr.Vs z(PagingHelpRenderer._send_output_to_pagercOst|i|Sr%rrargskwargsrrrr8\szPagingHelpRenderer._popencCs|Sr%r)rr/rrrr-_sz'PagingHelpRenderer._convert_doc_content) rrr__doc__sysstdoutrr'r,r0r.r8r-rrrrr$9s r$c@s,eZdZdZdZddZddZddZd S) r"z[ Render help content on a Posix-like system. This includes Linux and MacOS X. zless -RcCsrt|td}|drgd}n|drgd}ntdtd||j|tttd}|j |d d }|S) Nwritergroff)rGz-mman-Tasciimandoc)rKrIrJzgroff or mandocr1)r3rDstderrr4r) rrWriter_exists_on_pathrr6r7r8rr9)rr/Z man_contentsr<Zp3r;rrrr-ks     z&PosixHelpRenderer._convert_doc_contentcCs|}||ds&td|d|j|dd|jdStd|t|j |t d}|j |dWddS1sHwYdS)Nrz0Pager '%s' not found in PATH, printing raw help.zutf-8 r1r2r4) r,rNr6r7r&writedecodeflushrr8rr9r:rrrr.xs   "z'PosixHelpRenderer._send_output_to_pagercs(tfddtjddtjDS)Ncs"g|] }tjtj|qSr)r(pathexistsjoin).0r=namerr sz5PosixHelpRenderer._exists_on_path..PATH)anyr(r)getr+pathsep)rrXrrWrrNs z!PosixHelpRenderer._exists_on_pathN)rrrrBr'r-r.rNrrrrr"cs  r"c@s$eZdZdZdZddZddZdS)r!z*Render help content on a Windows platform.morecCst|td}|S)NrE)rr )rr/Z text_outputrrrr-sz(WindowsHelpRenderer._convert_doc_contentcOsd|d<t|i|S)NTshellr>r?rrrr8szWindowsHelpRenderer._popenN)rrrrBr'r-r8rrrrr!s  r!c@sVeZdZdZdZ ddZeddZeddZed d Z ed d Z d dZ 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. NcCsT||_||_|dur i}||_|duri}||_i|_g|_t|_tdd|_ dS)NrH)target) sessionobj command_table arg_table_subcommand_table_related_itemsr#rendererr doc)rrcrdrerfrrrrszHelpCommand.__init__cCdS)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.. The document pipeline would use this property to determine the ``event_class`` value. Nrrrrr event_classs zHelpCommand.event_classcCrk)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. NrrlrrrrXszHelpCommand.namecC|jS)z=These are the commands that may follow after the help command)rgrlrrrsubcommand_tablezHelpCommand.subcommand_tablecCrn)z:This is list of items that are related to the help command)rhrlrrr related_itemsrpzHelpCommand.related_itemscCsv|r ti|j}||\}}t|dddur |j|j||S||}t|j||j |j | dS)N subcommand)rroZparse_known_argsgetattrrrEventHandlerClassr Zgenerate_eventsrcrir0rjgetvalue unregister)rr@Zparsed_globalsZsubcommand_parserparsed remaininginstancerrr__call__s    zHelpCommand.__call__) rrrrBrtrpropertyrmrXrorqrzrrrrras%     rac@sHeZdZdZeZddZeddZeddZ edd Z d d Z d S) ProviderHelpCommandz^Implements top level help command. This is what is called when ``aws help`` is run. cCs<t||d||||_||_||_d|_d|_dg|_dS)Nzaws help topics)rar descriptionsynopsisZ help_usagerg _topic_tag_dbrh)rrcrerfr}r~usagerrrrs  zProviderHelpCommand.__init__cCrkNZawsrrlrrrrm*zProviderHelpCommand.event_classcCrkrrrlrrrrX.rzProviderHelpCommand.namecCs6|jdur|jdurt|_|j||_|jSr%)rgrrZload_json_index_create_subcommand_tablerlrrrro2s    z$ProviderHelpCommand.subcommand_tablecCsBi}t|j}||d<|j}|D] }t|j|}|||<q|SNZtopics)TopicListerCommandrcrZget_all_topic_namesTopicHelpCommand)rroZtopic_lister_commandZ topic_names topic_nameZtopic_help_commandrrrr;s    z,ProviderHelpCommand._create_subcommand_tableN) rrrrBrrtrr{rmrXrorrrrrr|s    r|cs<eZdZdZeZfddZeddZeddZ Z S)ServiceHelpCommandzImplements service level help. This is the object invoked whenever a service command help is implemented, e.g. ``aws ec2 help``. cs&tt|||||||_||_dSr%)rrr_name _event_class)rrcrdrerfrXrmrrrrSs  zServiceHelpCommand.__init__cCrnr%rrlrrrrmZzServiceHelpCommand.event_classcCrnr%rrlrrrrX^rzServiceHelpCommand.name) rrrrBrrtrr{rmrXrrrrrrIs  rc@s4eZdZdZeZddZeddZeddZ dS) OperationHelpCommandzImplements operation level help. This is the object invoked whenever help for a service is requested, e.g. ``aws ec2 describe-instances help``. cCs*t|||d|t|_||_||_dSr%)rarrZparam_shorthandrr)rrcZoperation_modelrfrXrmrrrrls zOperationHelpCommand.__init__cCrnr%rrlrrrrmsrz OperationHelpCommand.event_classcCrnr%rrlrrrrXwrzOperationHelpCommand.nameN) rrrrBrrtrr{rmrXrrrrrcs rc8eZdZeZfddZeddZeddZZ S)rcstt||diidSr%)rrr)rrcrrrrszTopicListerCommand.__init__cCrkrrrlrrrrmrzTopicListerCommand.event_classcCrkrrrlrrrrXrzTopicListerCommand.name) rrrr rtrr{rmrXrrrrrr|s  rcr)rcs tt||dii||_dSr%)rrr _topic_name)rrcrrrrrs zTopicHelpCommand.__init__cCs d|jS)Nztopics.rWrlrrrrms zTopicHelpCommand.event_classcCrnr%)rrlrrrrXrzTopicHelpCommand.name) rrrr rtrr{rmrXrrrrrrs  r)/loggingr(rCrr* subprocessrrZ docutils.corerZdocutils.writersrZawscli.clidocsrrrr r Z awscli.bcdocr Zawscli.bcdoc.restdocr Zawscli.bcdoc.textwriterr Zawscli.argprocessrZawscli.argparserrZawscli.topictagsrZ awscli.utilsr getLoggerr6 Exceptionrr#objectr$r"r!rar|rrrrrrrrs@                 *4o2