U id*@sddlZddlZddlZddlZddlmZddlmZddlm Z ddl m Z ddl m Z mZddlmZzeejdZWnek rdZYnXGd d d eZGd d d ZdS) N) OrderedDict) SoSComponent) import_policy)Plugin)boldImporterHelper)fillxcseZdZdZdZdZdZdZddiZfddZ e dd Z d d Z d d Z ddZddZddZddZddZddZZS) SoSHelperzProvide better, more in-depth help for specific parts of sos than is provided in either standard --help output or in manpages. zDetailed help infomationFtopiccs"tt|||||jj|_dS)N)superr __init__optsr )selfparserargsZcmdline __class__3/usr/lib/python3/dist-packages/sos/help/__init__.pyr+szSoSHelper.__init__cCs*d|_|dd}|jdddddd dS) Nzsos help TOPIC [options]zHelp Information Optionsz|jj||||j_dS)N.rcleaner collector)cleanmaskcollect)rr splitreplace)rZ_com_replacerrrsanitize_topic_component:sz"SoSHelper.sanitize_topic_componentc Cs|jjs|td|z |}Wn@tk rn}z"td|jj|ftdW5d}~XYnX|rzt }| || Wqtk r}ztd|W5d}~XYqXntd|jjdS)Nrz Could not load help for '%s': %szError loading help: %szNo help section found for '%s') rr display_self_helpsysexitr)get_obj_for_topic Exceptionprint HelpSectionZ display_helpdisplay)rklasserrZhtrrrexecuteDs"     zSoSHelper.executecCsdddddddd}d }|jj|krJtd |jj}t|||jj}n<|j|j|j|jd }|D] }|jj |rd||}qqd|S) zBased on the help topic we're after, try to smartly decide which object we need to manipulate in order to get help information. Z SoSReportrZ SoSCleaner SoSCollectorZRemoteTransportZClusterZPolicy)reportreport.pluginsr!r"zcollector.transportszcollector.clusterspoliciesNsos.)zreport.plugins.z policies.zcollector.transports.zcollector.clusters.) rr importlib import_modulegetattr_get_plugin_variant_get_policy_by_name_get_collect_transport_get_collect_cluster startswith)rZ static_maprmodZ_helpZ_secrrrr.\s,   zSoSHelper.get_obj_for_topiccCs2ddlm}|jjdd}||kr.||SdS)Nr) TRANSPORTSr )Zsos.collector.sosnoderDrr r&)rrDZ _transportrrrr@|s z SoSHelper._get_collect_transportcCsXddlm}ddl}||jjd}|D]*}|d|jjddkr(|dSq(dS)Nr)r6clustersr rEr*) Z sos.collectorr6Zsos.collector.clustersZ _load_modulesr"rFrr r&)rr6sosrFZclusterrrrrAs  zSoSHelper._get_collect_clustercCsdtd|jj}|t|tj}dd|D}|D]$}|r:|j |}|Sq:dS)Nr:cSs"g|]}t|dtr|dqS)r*) issubclassr).0mrrr sz1SoSHelper._get_plugin_variant..) r;r<rr Zload_local_policyinspectZ getmembersZisclass__subclasses__policyZ match_plugin)rrCZmemsZpluginsZpluginrrrrr>szSoSHelper._get_plugin_variantcCsl|jjdd}ddl}t|jj}|D]8}t|D]*}|j dd}||kr:|Sq:q.dS)Nr rErrNr ) rr r&Zsos.policies.distrosrr9ZdistrosZ get_modulesr__name__lowerr')rZ_topicrGZ_helperrCrNZ_prrrr?s   zSoSHelper._get_policy_by_namecCstdd}|dtd|d}td}|d|td}|d ||d }|d d d ddddd}|D]"}|jdt|||ddq||dS)zhDisplays the help information for this component directly, that is help for `sos help`. zDetailed help for sos helpzThe 'help' sub-command is used to provide more detailed information on different sub-commands available to sos as well as different components at play within those sub-commands.ahSoS - officially pronounced "ess-oh-ess" - is a diagnostic and supportability utility used by several Linux distributions as an easy-to-use tool for standardized data collection. The most known component of which is %s (formerly sosreport) which is used to collect troubleshooting information into an archive for review by sysadmins or technical support teams.z sos reportzHow to search using sos helpz$component.$topic.$subtopiczr?r+ __classcell__rrrrr s&       r c@sHeZdZdZdddZddZddd Zdd d Zdd d ZddZ dS)r1zThis class is used to build the output displayed by `sos help` in a standard fashion that provides easy formatting controls. r cCs||_||_||_t|_dS)a :param title: The title of the output section, will be prominently displayed :type title: ``str`` :param content: The text content to be displayed with this section :type content: ``str`` :param indent: If the section should be nested, set this to a multiple of 4. :type indent: ``int`` N)titlecontentindentrrUrr[r\r]rrrrs zHelpSection.__init__cCs ||_dS)zSet or override the title for this help section :param title: The name to set for this help section :type title: ``str`` N)r[)rr[rrr set_titleszHelpSection.set_titleTcCs,|jr|rdnd}||}|j|7_dS)zAdd body text to this section. If content for this section already exists, append the new ``content`` after a newline. :param content: The text to add to the section :type content: ``str`` z  N)r\)rr\rQlnrrrrRs zHelpSection.add_textcCs|||||j|S)acAdd a section of text to the help section that will be displayed when the HelpSection object is printed. Sections will be printed *in the order added*. This will return a subsection object with which block(s) of text may be added to the subsection associated with ``title``. :param title: The title of the subsection being added :type title: ``str`` :param content: The text the new section should contain :type content: ``str`` :returns: The newly created subsection for ``title`` :rtype: ``HelpSection`` ) _add_sectionrUr^rrrrSszHelpSection.add_sectioncCs(||jkrtdt||||j|<dS)zInternal method used to add a new subsection to this help output :param title: The title of the subsection being added :type title: ``str` z(A section with that title already existsN)rUr/r1r^rrrrbs zHelpSection._add_sectioncCsdttt|jt|jd|jD]}tt|t|jdq$|jD]}td|j| qDdS)zWPrint the HelpSection contents, including any subsections, to console. )widthZinitial_indentr N) r0rrr[TERMSIZEr]r\ splitlinesrUr2)rraZsectionrrrr2#s zHelpSection.displayN)r r r )T)r r )r r ) rOrVrWrXrr_rRrSrbr2rrrrr1s   r1)rLr;r,os collectionsrZ sos.componentrZ sos.policiesrZsos.report.pluginsrZ sos.utilitiesrrtextwraprminget_terminal_sizecolumnsrdr/r r1rrrr s       =