관리-도구
편집 파일: __init__.cpython-39.pyc
a -�_g + � @ s� d dl Z d dlZd dlZd dlZd dlmZ d dlmZ d dlm Z d dl m Z d dl m Z d dlmZmZ zee�� jd�ZW n ey� dZY n0 G d d � d e �ZG d d � d �ZdS ) � N)� OrderedDict)�fill)� SoSComponent)� import_policy)�Plugin)�bold�ImporterHelper�x c s� e Zd ZdZdZdZdZdZddiZ� fdd�Z e dd � �Z d d � Z d d � Z dd� Zdd� Zdd� Zdd� Zdd� Zdd� Z� ZS )� SoSHelperz�Provide better, more in-depth help for specific parts of sos than is provided in either standard --help output or in manpages. zDetailed help infomationF�topic� c s t � �|||� | jj| _d S )N)�super�__init__�optsr )�self�parser�argsZcmdline�� __class__� �5/usr/lib/python3.9/site-packages/sos/help/__init__.pyr + s zSoSHelper.__init__c C s* d|_ |�dd�}|jdddddd � d S ) Nzsos help TOPIC [options]zHelp Information Optionsz<These options control what detailed information is displayedr ZTOPICr �?z/name of the topic or component to show help for)�metavar�default�nargs�help)�usage�add_argument_group� add_argument)�clsr Zhelp_grpr r r �add_parser_options/ s � �z SoSHelper.add_parser_optionsc C sB | j j�d�d }dddd�}||v r>| j j�||| �| j _d S )N�.r �cleaner� collector)�clean�mask�collect)r r �split�replace)r Z_com�_replacer r r �sanitize_topic_component: s �z"SoSHelper.sanitize_topic_componentc C s� | j js| �� t�d� | �� z | �� }W nF tyt } z.td| j j� d|� �� t�d� W Y d }~n d }~0 0 |r�z t � }|� |� |� � W q� ty� } ztd|� �� W Y d }~q�d }~0 0 ntd| j j� d�� d S )Nr zCould not load help for 'z': � zError loading help: zNo help section found for '�') r r �display_self_help�sys�exitr* �get_obj_for_topic� Exception�print� HelpSectionZ display_help�display)r �klass�errZhtr r r �executeD s" &zSoSHelper.executec C s� dddddddd�}d }| j j|v rJt�d | j j �}t||| j j �}n@| j| j| j| jd �}|� � D ] \}}| j j� |�rh|� } q�qh|S ) z�Based on the help topic we're after, try to smartly decide which object we need to manipulate in order to get help information. Z SoSReportr Z SoSCleaner� SoSCollectorZRemoteTransportZClusterZPolicy)�report�report.pluginsr" r# zcollector.transportszcollector.clusters�policiesN�sos.)zreport.plugins.z policies.zcollector.transports.zcollector.clusters.) r r � importlib� import_module�getattr�_get_plugin_variant�_get_policy_by_name�_get_collect_transport�_get_collect_cluster�items� startswith)r Z static_mapr �modZ_helpZ_sec�valuer r r r0 \ s, � �zSoSHelper.get_obj_for_topicc C s2 ddl m} | jj�d�d }||v r.|| S d S )Nr )� TRANSPORTSr! ���)Zsos.collector.sosnoderH r r r' )r rH Z _transportr r r rB | s z SoSHelper._get_collect_transportc C sX ddl m} dd l}|�|jjd�}|D ]*}|d | jj�d�d kr(|d S q(d S )Nr )r8 �clustersr! rI r+ ) Z sos.collectorr8 Zsos.collector.clustersZ _load_modulesr# rJ r r r' )r r8 �sosrJ Zclusterr r r rC � s �z SoSHelper._get_collect_clusterc C sd t �d| jj �}| �� t�|tj�}dd� |D �}|D ]$}|�� r:| j � |�� �}| S q:d S )Nr< c S s" g | ]}t |d t�r|d �qS )r+ )� issubclassr )�.0�mr r r � <listcomp>� � z1SoSHelper._get_plugin_variant.<locals>.<listcomp>) r= r> r r Zload_local_policy�inspectZ getmembersZisclass�__subclasses__�policyZ match_plugin)r rF ZmemsZpluginsZpluginr r r r r@ � s z SoSHelper._get_plugin_variantc C sl | j j�d�d }dd l}t|jj�}|�� D ]8}t|�D ]*}|j � � � dd�}||kr:| S q:q.d S )Nr! rI r rS r ) r r r' Zsos.policies.distrosr r; ZdistrosZ get_modulesr �__name__�lowerr( )r Z_topicrK Z_helperrF rS Z_pr r r rA � s z SoSHelper._get_policy_by_namec C s� t dd�}|�dtd�� d�� |�d�}td�}|�d|� d �� td �}|�d |� d �� |�d �}|�d� ddddddd�}|�� D ]&\}}|jdt|�d�|� �dd� q�|�� dS )zhDisplays the help information for this component directly, that is help for `sos help`. zDetailed help for sos helpz�The '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.z�SoS - 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.z How to search using sos helpz$component.$topic.$subtopicz8To get more information on a given topic, use the form 'z'.z sos help report.plugins.kernelz For example 'zM' will provide more information on the kernel plugin for the report function.zAvailable Help Sectionsz�The 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+How sos operates on different distributions)r9 r: zreport.plugins.$pluginr$ r& r; � z<36F)�newlineN)r3 �add_textr � add_sectionrD r4 ) r Z self_helpZsubsectr Zrep_exZ avail_help�sectionsZsectrG r r r r- � s@ ��� �� �� zSoSHelper.display_self_help)rT � __module__� __qualname__�__doc__ZdescZconfigure_loggingZ load_policyZ load_probeZ arg_defaultsr � classmethodr r* r7 r0 rB rC r@ rA r- � __classcell__r r r r r s$ � r c @ sH e Zd ZdZddd�Zdd� Zddd �Zdd d �Zdd d �Zdd� Z dS )r3 z�This class is used to build the output displayed by `sos help` in a standard fashion that provides easy formatting controls. r c C s || _ || _|| _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)�title�content�indentr rZ �r r` ra rb r r r r � s zHelpSection.__init__c C s || _ dS )z�Set or override the title for this help section :param title: The name to set for this help section :type title: ``str`` N)r` )r r` r r r � set_title� s zHelpSection.set_titleTc C s, | j r|rdnd}|| }| j |7 _ dS )z�Add 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)ra )r ra rW �lnr r r rX � s zHelpSection.add_textc C s | � |||� | j| S )ac Add 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_sectionrZ rc r r r rY s zHelpSection.add_sectionc C s( || j v rtd��t|||�| j |< dS )z�Internal 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)rZ r1 r3 rc r r r rg s zHelpSection._add_sectionc C sd t tt| j�t| jd�� | j�� D ]}t t|t| jd�� q$| jD ]}t d� | j| � � qDdS )zWPrint the HelpSection contents, including any subsections, to console. )�width�initial_indentr N) r2 r r r` �TERMSIZErb ra � splitlinesrZ r4 )r rf �sectionr r r r4 $ s � zHelpSection.displayN)r r r )T)r r )r r ) rT r[ r\ r] r rd rX rY rg r4 r r r r r3 � s r3 )rQ r= r. �os� collectionsr �textwrapr Z sos.componentr Z sos.policiesr Zsos.report.pluginsr Z sos.utilitiesr r �min�get_terminal_size�columnsrj r1 r r3 r r r r �<module> s >