o G%@ik+@sddlZddlZddlZddlZddlmZddlmZddlm Z ddl m Z ddl m Z ddlmZmZz eejdZWn eyKdZYnwGd d d e ZGd d d ZdS) N) OrderedDict)fill) SoSComponent) import_policy)Plugin)boldImporterHelperxcseZdZdZdZdZdZdZddiZfddZ 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 infomationFtopiccst||||jj|_dS)N)super__init__optsr )selfparserargscmdline __class__3/usr/lib/python3/dist-packages/sos/help/__init__.pyr+szSoSHelper.__init__cCs*d|_|dd}|jdddddd dS) Nzsos help TOPIC [options]zHelp Information Optionszs"z1SoSHelper._get_plugin_variant..) rJrKrr load_local_policyinspect getmembersisclass__subclasses__policy match_plugin)rrTmemspluginspluginr!rrrrMszSoSHelper._get_plugin_variantcCsl|jjdd}ddl}t|jj}|D]}t|D]}|j dd}||kr2|SqqdS)Nr$rYrrkr ) rr r*sos.policies.distrosrrGdistros get_modulesr__name__lowerr+)r_topicr`_helperrTrk_prrrrNs    zSoSHelper._get_policy_by_namec Cstdd}|dtdd|d}td}|d|d td }|d |d |d }|ddddddddd}|D]\}}|jdt|d|ddqG|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.zSoS - 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 z sos reportz (formerly sosreport) which is used to collect troubleshooting information into an archive for review by sysadmins or technical support teams.zHow to search using sos helpz$component.$topic.$subtopicz8To get more information on a given topic, use the form 'z'.zsos help report.plugins.kernelz For example 'zM' will provide more information on the kernel plugin for the report function.zAvailable Help SectionszThe following help sections are available. Additional help topics and subtopics may be displayed within their respective help section. z#Detailed help on the report commandz'Information on the plugin design of sosz!Information on a specific $pluginz"Detailed help on the clean commandz$Detailed help on the collect commandz#Detailed help on the upload commandz+How sos operates on different distributions)rErFzreport.plugins.$pluginr'r)rHrG z<36F)newlineN)r7add_textr add_sectionrQr9) r self_helpsubsectrrep_ex avail_helpsectionssectrWrrrr1sB    zSoSHelper.display_self_help)rs __module__ __qualname____doc__descconfigure_logging load_policy load_probe arg_defaultsr classmethodr#r.r=r4rOrPrMrNr1 __classcell__rrrrr s&    !   r c@sHeZdZdZdddZddZddd Zdd d Zdd d ZddZ dS)r7zThis 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)titlecontentindentrrrrrrrrrrs  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)rrrrr set_titles zHelpSection.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)rrrylnrrrrzs 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_sectionrrrrrr{s zHelpSection.add_sectioncCs(||jvr tdt||||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)rr5r7rrrrrs zHelpSection._add_sectioncCsdttt|jt|jd|jD] }tt|t|jdq|jD] }td|j| q"dS)zWPrint the HelpSection contents, including any subsections, to console. )widthinitial_indentr N) r6rrrTERMSIZErr splitlinesrr9)rrsectionrrrr9&s zHelpSection.displayN)r r r )T)r r ) rsrrrrrrzr{rr9rrrrr7s    r7)rgrJr2os collectionsrtextwrapr sos.componentr sos.policiesrsos.report.pluginsr sos.utilitiesrrminget_terminal_sizecolumnsrr5r r7rrrrs$       @