HEX

File: //lib/python3.9/site-packages/sos/__pycache__/utilities.cpython-39.pyc
a

^��c+H�@s^ddlZddlZddlZddlmZmZmZddlZddlZddl	Z	ddl
Z
ddlZddlZddl
Z
ddlZddlZddlmZddlmZzddlmZWney�ddlmZYn0dZzddlZe�e�dZWnNeef�y(e� d	�Z!dd
l"m#Z#dZ$e!�%de#e$d
dd�d�Yn0dZ&dd�Z'dLdd�Z(dMdd�Z)dd�Z*dNdd�Z+dd �Z,dOd!d"�Z-e&dddddddddf
d#d$�Z.dPd%d&�Z/dQd(d)�Z0dRd+d,�Z1ej2fd-d.�Z3d/d0�Z4d1d2�Z5d3d4�Z6d5d6�Z7d7d8�Z8ej9d9�d:d;�Z:d<d=�Z;gfd>d?�Z<d@dA�ZGdBdC�dC�Z=GdDdE�dEe
j>�Z?GdFdG�dGe@�ZAGdHdI�dI�ZBGdJdK�dKeC�ZDdS)S�N)�Popen�PIPE�STDOUT)�closing)�deque)�
parse_version)�parseFT�sos)�fillz�WARNING: Failed to load 'magic' module version >= 0.4.20 which sos aims to use for detecting binary files. A less effective method will be used. It is recommended to install proper python3-magic package with the module.
�
�H)Zreplace_whitespacei,cCsTt|d��6}t�|�j|kr*|�|d�|��Wd�S1sF0YdS)z,Returns the last number_of_bytes of filename�rb�N)�open�os�stat�st_size�seek�read)�filenameZnumber_of_bytes�f�r�1/usr/lib/python3.9/site-packages/sos/utilities.py�tail2sr�rcCs\t|t�rPzt||�WStyLt�d�}|�d|�tt�	��YS0nt|�SdS)z@Returns a file-like object that can be used as a context managerr	zfileobj: %s could not be openedN)
�
isinstance�strr�IOError�logging�	getLogger�debugr�io�StringIO)Zpath_or_file�mode�logrrr�fileobj:s

r%���@�cCsdt|�}||krd||S||kr0d||S||krDd||S||krXd||Sd|SdS)zCConverts a number of bytes to a shorter, more human friendly formatz%.1fTz%.1fGz%.1fMz%.1fKz%dN)�float)Zbytes_�K�M�G�T�fnrrr�
convert_bytesGsr0c	s�trNz6t�|��ddg}�jdko8t�fdd�|D��WStyLYn0t|d��N}z|�d�WWd�d	Sty�YWd�d
S0Wd�n1s�0YdS)azHelper to determine if a given file contains binary content or not.

    This is especially helpful for `sos clean`, which cannot obfuscate binary
    data and instead, by default, will remove binary files.

    :param fname:   The full path of the file to check binaryness of
    :type fname:    ``str``

    :returns:   True if binary, else False
    :rtype:     ``bool``
    ztext/zinode/�binaryc3s|]}�j�|�VqdS�N)Z	mime_type�
startswith)�.0Z_mt�Z_ftuprr�	<genexpr>h�z!file_is_binary.<locals>.<genexpr>�tr�NFT)	�	magic_mod�magic�detect_from_filename�encoding�any�	Exceptionrr�UnicodeDecodeError)�fnameZ_mimesZtfilerr5r�file_is_binaryVs 

��
rBc	cs�|r"tj�|��tjj�}||7}t�|�D]^\}}}|rV|�tjj�|krV|dd�=|rht�||�shq,t�||�D]}tj�||�Vqtq,dS)z�Generator function to find files recursively.
    Usage::

        for filename in find("*.properties", "/var/log/foobar"):
            print filename
    N)	r�path�dirname�count�sep�walk�fnmatch�filter�join)	Zfile_patternZtop_dirZ	max_depth�path_patternZ
base_depthrC�dirlistZfilelist�namerrr�findxs
rNc	sRg}|D]D}t|��(}|��fdd�|D��Wd�q1sB0Yq|S)z�Returns lines matched in fnames, where fnames can either be pathnames to
    files to grep through or open file objects to grep through line by linec3s|]}t��|�r|VqdSr2)�re�match)r4�line��patternrrr6�r7zgrep.<locals>.<genexpr>N)r%�extend)rSZfiles_or_paths�matchesZfop�forrRr�grep�s

8rWcs\tj�dd��tjj�}�g�fdd�|D�}�rJ|�fdd�|D�7}tdd�|D��S)z6Returns if a command matches an executable on the PATH�PATH�csg|]}tj�|���qSr)rrCrJ)r4�p)�commandrr�
<listcomp>�r7z!is_executable.<locals>.<listcomp>cs g|]}tj��|�d���qS)�/)rrCrJ�lstrip)r4�c��sysrootrrr\�scss|]}t�|tj�VqdSr2)r�access�X_OK)r4rCrrrr6�r7z is_executable.<locals>.<genexpr>)r�environ�get�splitrC�pathsepr>)r[ra�pathsZ
candidatesr)r[rar�
is_executable�s�ric
sb��fdd�}�fdd�}tj��}
d|
d<|r\|��D]"\}}|rN||
|<q8|
�|d�q8|r~td�r~d	|rrd
nd||f}t�|�}g}|D]F}|�d�r�d
|vr�t	�	|�}|r�|�
|�q�|�|�q�|�|�q�|
r�t|
d�}nt
}z�t|d||r�tnt
d|
d|d�}|
�s$t|j||�}n
t||�}��rJ|j�r�||��q4n^z|�|�rZ|nd�WnDt�y�|��|
�r�|��d|_d|��|jd�YWS0|
�r�|��|��du�rȐq�|��}|j}Wn^t�y6}zD|
�r�|��|jtjk�rdddd�WYd}~S|�WYd}~n
d}~00|jdk�sP|jdk�rTd}|j||d�S)z�Execute a command and return a dictionary of status and output,
    optionally changing root or current working directory before
    executing command.
    cs(�r�dkrt����r$t���dS�Nr])r�chroot�chdirr)rlrkrr�_child_prep_fn�s
z.sos_get_command_output.<locals>._child_prep_fncs,��s|��dkr|��t�t�d�dS)N�|�{�G�z�?)�poll�	terminate�SoSTimeoutError�time�sleep)�proc)�pollerrr�
_check_poller�sz-sos_get_command_output.<locals>._check_pollerzC.UTF-8�LC_ALLN�timeoutztimeout %s %ds %sz--foregroundrYr]�*�wF���T)�shell�stdout�stderr�bufsize�envZ	close_fdsZ
preexec_fnrn)�status�output�	truncated��~r7)rrd�copy�items�popri�shlexrfr3�globrT�appendrrrr�AsyncReaderr~�
FakeReader�running�waitr?rq�close�get_contents�is_fullrp�OSError�errno�ENOENT�
returncode)r[ryrrkrlr�Z
foregroundr1�	sizelimitrvZto_filermrwZcmd_env�key�value�argsZ
expanded_args�argZexpanded_argZ_outputrZ�readerr~r��er)rlrkrvr�sos_get_command_output�s�


�


�
�
�r�csX��d�d}t�t�t�|g�}�fdd�t�|tj�D�}�rT�fdd�|D�}|S)aImports the module module_fqname and returns a list of defined classes
    from that module. If superclasses is defined then the classes returned will
    be subclasses of the specified superclass or superclasses. If superclasses
    is plural it must be a tuple of classes.�.r|csg|]\}}|j�kr|�qSr)�
__module__)r4Zcname�class_)�
module_fqnamerrr\s
�z!import_module.<locals>.<listcomp>csg|]}t|��r|�qSr)�
issubclass)r4�m)�superclassesrrr\"r7)�
rpartition�
__import__�globals�locals�inspectZ
getmembersZisclass)r�r�Zmodule_name�module�modulesr)r�r�r�
import_modules
�r��cCst||||d�dS)zeShell out to an external command and return the output or the empty
    string in case of error.
    )ryrkrlr�)r�)�cmdryrkZrunatrrr�	shell_out's
��r�rcCs@gd�}d}|dkr.|dkr.|d7}|d}qd||||fS)N)�BZKiBZMiBZGiBZTiBrr&�r9g�@z%.*f%sr)�sizeZ	precision�suffixesZsuffixindexrrr�get_human_readable/s
r�cCs>|r,|tjkr,|�|�s,tj�||�d��}t||�}||�Srj)rrFr3rCrJr^�getattr)rCra�methodr�Z_methrrr�_os_wrapper9s


r�cCst||d�S)N�exists�r��rCrarrr�path_existsAsr�cCst||d�S)N�isdirr�r�rrr�
path_isdirEsr�cCst||d�S)N�isfiler�r�rrr�path_isfileIsr�cCst||d�S)N�islinkr�r�rrr�path_islinkMsr�cCst||dt�S)N�listdir)r�rr�rrrr�Qsr�r`cGs8|r$|�|�s$tj�||�tj��}tjj|g|�R�Sr2)r3rrCrJr^rF)rCrarZrrr�	path_joinUsr�cCsd|dS)a"Helper to make text bold in console output, without pulling in
    dependencies to the project unneccessarily.

    :param text:    The text to make bold
    :type text:     ``str``

    :returns:       The text wrapped in the ASCII codes to display as bold
    :rtype:         ``str``
    z[1mz[0mr)�textrrr�bold[s
r�c	s�g}g�|�|�t|t�r�|��D]~\}���|�|rB||vrR|�t���q$t�t�r$z$|�t�fdd�|D��d�Wnty�Yn0������q$n
|�|��fdd�|D�S)a	Recursively compile all elements of a potentially nested dict by a set
    of keys. If a given key is a dict within ``dobj``, then _all_ elements
    within that dict, regardless of child keys, will be returned.

    For example, if a Plugin searches the devices dict for the 'storage' key,
    then all storage devices under the that dict (e.g. block, fibre, etc...)
    will be returned. However, if the Plugin specifies 'block' via ``keys``,
    then only the block devices within the devices['storage'] dict will be
    returned.

    Any elements passed here that are _not_ keys within the dict or any nested
    dicts will also be returned.

    :param dobj:    The 'top-level' dict to intially search by
    :type dobj:     ``dict``

    :param keys:    Which keys to compile elements from within ``dobj``. If no
                    keys are given, all nested elements are returned
    :param keys:    ``list`` of ``str``

    :returns:       All elements within the dict and any nested dicts
    :rtype:         ``list``
    c3s|]}|�vr�|VqdSr2r)r4r�)�vrrr6�sz/recursive_dict_values_by_key.<locals>.<genexpr>rcsg|]}|�vr|�qSrr)r4�d)�_filtrrr\�r7z0recursive_dict_values_by_key.<locals>.<listcomp>)rTr�dictr�r��recursive_dict_values_by_key�
IndexError�keys)Zdobjr�Z_items�kr)r�r�rr�hs,



���
r�cCst|�S)zParse the version string
    )�
version_parse)�versionrrrr�src@s8eZdZdZdd�Zedd��Zdd�Zedd	��Zd
S)r�z�Used as a replacement AsyncReader for when we are writing directly to
    disk, and allows us to keep more simplified flows for executing,
    monitoring, and collecting command output.
    cCs||_||_dSr2)�processr1)�selfr�r1rrr�__init__�szFakeReader.__init__cCsdS)NFr�r�rrrr��szFakeReader.is_fullcCs|js
dSdS)NrYr7)r1r�rrrr��szFakeReader.get_contentscCs|j��duSr2)r�rpr�rrrr��szFakeReader.runningN)	�__name__r��__qualname__�__doc__r��propertyr�r�r�rrrrr��s
r�cs<eZdZdZ�fdd�Zdd�Zdd�Zedd	��Z�Z	S)
r�z�Used to limit command output to a given size without deadlocking
    sos.

    Takes a sizelimit value in MB, and will compile stdout from Popen into a
    string that is limited to the given sizelimit.
    csbtt|���||_||_d|_d|_|rB|d}t||j�|_t|jd�|_d|_	|�
�dS)Nir')�maxlenT)�superr�r��chanr1�	chunksize�slots�intrr��start)r�Zchannelr�r1��	__class__rrr��szAsyncReader.__init__c	CsHz&|j�|j�}|sq$|j�|�qWnttfy<Yn0d|_dS)alReads from the channel (pipe) that is the output pipe for a
        called Popen. As we are reading from the pipe, the output is added
        to a deque. After the size of the deque exceeds the sizelimit
        earlier (older) entries are removed.

        This means the returned output is chunksize-sensitive, but is not
        really byte-sensitive.
        FN)r�rr�rr��
ValueErrorrr�)r�rQrrr�run�s	zAsyncReader.runcCsH|jrt�d�q|js.d�dd�|jD��Sd�dd�|jD��SdS)z-Returns the contents of the deque as a stringrorYcss|]}|�dd�VqdS)zutf-8�ignoreN)�decode�r4Zlnrrrr6�r7z+AsyncReader.get_contents.<locals>.<genexpr>r7css|]
}|VqdSr2rr�rrrr6�r7N)r�rsrtr1rJrr�rrrr��s
zAsyncReader.get_contentscCs|js
dSt|j�|jkS)z?Checks if the deque is full, implying that output was truncatedF)r��lenrr�rrrr��szAsyncReader.is_full)
r�r�r�r�r�r�r�r�r��
__classcell__rrr�rr��s
r�c@s8eZdZdZdd�Zdd�Zdd�Zdd	�Zd
d�ZdS)
�ImporterHelperz�Provides a list of modules that can be imported in a package.
    Importable modules are located along the module __path__ list and modules
    are files that end in .py.
    cCs
||_dS)zopackage is a package module
        import my.package.module
        helper = ImporterHelper(my.package.module)N)�package)r�r�rrrr��szImporterHelper.__init__cCs tj�|�}tj�|�\}}|S)z-Returns the plugin module name given the path)rrC�basename�splitext)r�rC�baserM�extrrr�_plugin_nameszImporterHelper._plugin_namecs�fdd�|D�}|��|S)Ncs(g|] }d|vr|�d�r��|��qS)r�z.py)�endswithr�)r4Zpluginr�rrr\
s�z9ImporterHelper._get_plugins_from_list.<locals>.<listcomp>)�sort)r�Zlist_�pluginsrr�r�_get_plugins_from_list	s

�z%ImporterHelper._get_plugins_from_listcCs4tj�|�r0ttd|��}|�|�}|r,|SgSdS)Nz*.py)rrCr��listrNr�)r�rCZpy_filesZpnamesrrr�_find_plugins_in_dirs
z#ImporterHelper._find_plugins_in_dircCs2g}|jjD] }tj�|�r|�|�|��q|S)zQReturns the list of importable modules in the configured python
        package. )r��__path__rrCr�rTr�)r�r�rCrrr�get_moduless
zImporterHelper.get_modulesN)	r�r�r�r�r�r�r�r�r�rrrrr��s	r�c@s$eZdZdd�Zdd�Zdd�ZdS)�TempFileUtilcCs||_g|_dSr2)�tmp_dir�files)r�r�rrrr�&szTempFileUtil.__init__cCs2tj|jd�\}}t�|d�}|j�||f�|S)N)�dirzw+)�tempfileZmkstempr�r�fdopenr�r�)r��fdrAZfobjrrr�new*szTempFileUtil.newc	Csd|jD]R\}}z|��|��Wnty4Yn0zt�|�WqtyVYq0qg|_dSr2)r��flushr�r?r�unlink)r�rArrrr�clean1szTempFileUtil.cleanN)r�r�r�r�rrrrrrr�$sr�c@seZdZdS)rrN)r�r�r�rrrrrr?srr)r)r&r'r(r))NN)N)N)r�NN)r)ErrOr��
subprocessrrrrrHr�r�r�r��	threadingrsr!�
contextlibr�collectionsrZ
pkg_resourcesrr��SyntaxErrorZpackaging.versionrr:r;r<�__file__�ImportError�AttributeErrorrr$�textwrapr
�msgZwarningZTIMEOUT_DEFAULTrr%r0rBrNrWrir�r�r�r�rCr�r�r�r�r�r�rFr�r�r�r��Threadr��objectr�r�r�rrrrrr�<module>	sv

"

"

�
q




6=-