File: //usr/lib/python3/dist-packages/sos/__pycache__/utilities.cpython-38.pyc
U
f`gRN � @ sB d dl Z d dlZd dlZd dlZd dlmZmZmZ d dlZd dl Z d dl
Z
d dl Z d dl Z d dl
Z
d dlZd dlZd dlZd dlmZ d dlmZ zd dlmZ W n ek
r� d dlmZ Y nX e�d�ZdZ d Z d
d d d
ddddddddddddddd d d d d gZ d!d"� Z dGd$d%�Z d&d � Z!dHd(d�Z"d)d*� Z#d+d� Z$dId,d�Z%d-d� Z&dJd.d�Z'e ddddddddddf d/d �Z(dKd0d�Z)dLd2d �Z*dMd4d�Z+e j,fd5d6�Z-d7d� Z.d8d� Z/d9d� Z0d:d� Z1d;d� Z2e j3d<�d=d �Z4d>d� Z5g fd?d �Z6G d@dA� dA�Z7G dBdC� dCej8�Z9G dDd � d �Z:G dEd
� d
�Z;G dFd � d e<�Z=dS )N� N)�Popen�PIPE�STDOUT)�closing)�deque)�parse)�
parse_versionZsosFi, �TIMEOUT_DEFAULT�ImporterHelper�SoSTimeoutError� TempFileUtil�bold�file_is_binary�fileobj�find�get_human_readable�grep�
import_module�
is_executable�listdirr � path_exists�
path_isdir� path_isfile� path_islink� path_join� recursive_dict_values_by_key� shell_out�sos_get_command_output�tailc
C s� t �d�}zF|j| dd�\}}}|s*| W S t �dd|��d�}|� d|� �}|W S tk
r� } z"t�d| � d |� �� | W Y �S d
}~X Y nX d
S ) z< Convert the version into a PEP440 compliant version scheme.z2^([0-9][0-9.]*(?:(?:a|b|rc|.post|.dev)[0-9]+)*)\+?� )�maxsplitz[+~]+�.�-�+zUnable to format z to pep440 format: N)�re�compile�split�sub�strip� Exception�log�debug)�verZpublic_version_re�_ZpublicZlocalZsanitized_localZpep440_version�err� r/ �//usr/lib/python3/dist-packages/sos/utilities.py�format_version_to_pep440A s �r1 Tc C s |rt | �}t|�S t| �S )z6 Converts the version to PEP440 format before parsing )r1 r )r, Zpep440Z
ver_pep440r/ r/ r0 �sos_parse_versionR s r2 c
C sH t | d��4}t�| �j|kr*|�| d� |�� W 5 Q R � S Q R X dS )z,Returns the last number_of_bytes of filename�rb� N)�open�os�stat�st_size�seek�read)�filenameZnumber_of_bytes�fr/ r/ r0 r [ s �rc C s\ t | t�rPzt| |dd�W S tk
rL t�d| � d�� tt�� � Y S X nt| �S dS )z@Returns a file-like object that can be used as a context manager�utf-8��encodingz fileobj: z could not be openedN) �
isinstance�strr5 �IOErrorr* r+ r �io�StringIO)Z path_or_file�moder/ r/ r0 r c s
c C sH ddddd�}|� � D ]*\}}| |krt| �| d�|� � S q| � S )zCConverts a number of bytes to a shorter, more human friendly formatl i @� � )�T�G�M�Kz.1f)�items�float)Z num_bytesZsizesZsymbol�sizer/ r/ r0 �
convert_byteso s
rP c s� t rPz6t�| �� ddg}� jdko8t� fdd�|D �� W S tk
rN Y nX t| ddd��B}z|�d � W W 5 Q R � d
S tk
r� Y W 5 Q R � d S X W 5 Q R X d S )
az Helper 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/�binaryc 3 s | ]}� j �|�V qd S �N)Z mime_type�
startswith)�.0Z_mt�Z_ftupr/ r0 � <genexpr>� s z!file_is_binary.<locals>.<genexpr>Ztrr> r? r FTN) � magic_mod�magicZdetect_from_filenamer@ �anyr) r5 r: �UnicodeDecodeError)�fnameZ_mimesZtfiler/ rU r0 r x s
��
c c s� |r"t j�|��t jj�}||7 }t �|�D ]^\}}}|rV|�t jj�|krV|dd�= |rht�||�shq,t�|| �D ]}t j�||�V qtq,dS )z�Generator function to find files recursively.
Usage::
for filename in find("*.properties", "/var/log/foobar"):
print filename
N) r6 �path�dirname�count�sep�walk�fnmatch�filter�join) Z file_patternZtop_dirZ max_depthZ path_patternZ
base_depthr\ �dirlistZfilelist�namer/ r/ r0 r � s
c
s> g }|D ]0}t |�� }|�� fdd�|D �� W 5 Q R X q|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 linec 3 s | ]}t �� |�r|V qd S rR )r$ �match)rT �line��patternr/ r0 rV � s zgrep.<locals>.<genexpr>)r �extend)ri Zfiles_or_pathsZmatchesZfopZfor/ rh r0 r � s
$c s\ t j�dd��t jj�}� g� fdd�|D � }�rJ|�fdd�|D �7 }tdd� |D ��S )z6Returns if a command matches an executable on the PATH�PATH� c s g | ]}t j�|� ��qS r/ )r6 r\ rc )rT �p)�commandr/ r0 �
<listcomp>� s z!is_executable.<locals>.<listcomp>c s g | ]}t j�� |�d ���qS )�/)r6 r\ rc �lstrip)rT �c��sysrootr/ r0 ro � s c s s | ]}t �|t j�V qd S rR )r6 �access�X_OK)rT r\ r/ r/ r0 rV � s z is_executable.<locals>.<genexpr>)r6 �environ�getr& r\ �pathseprY )rn rt �pathsZ
candidatesr/ )rn rt r0 r � s �c
s� � ��fdd�} �fdd�}
�rBt ���}|�|j�|j�d�� tj�� }d|d< |r�|�� D ]"\}}|rv|||< q`|�|d� q`|r�t d �r�d
|r�d nd � d
|� d| � �} t
� | �}g }|D ]F}|� d�r�d|kr�t
�
|�}|r�|�|� n
|�|� q�|�|� q�|
�r t|
ddd�}nt}�z0t|d||�r8tntd|d| d���}|
�sbt|j||�}n
t||�}��r�|j�r�|
|� �qrnlz|�|�r�|nd� W nR tk
�r� |�� |
�r�|�� d|_d|� � |j d� Y W 5 Q R � W S X |
�r|�� |� � dk�r�q|j dk�r&d}n|� � }|j ||j d�W 5 Q R � W S Q R X W nX t k
�r� } z8|
�rv|�� |j!t!j"k�r�d d d d� W Y �
S |�W 5 d}~X Y nX dS ) z�Execute a command and return a dictionary of status and output,
optionally changing root or current working directory before
executing command.
c sb �r�dkrt ��� �rPt �t���j� t �t���j� t �t���j � � r^t �� � d S �Nrp )
r6 �chroot�setgid�pwd�getpwnamZpw_gid�setuidZpw_uid�chdir�pw_dirr/ )r� r| �runasr/ r0 �_child_prep_fn� s
z.sos_get_command_output.<locals>._child_prep_fnc s, � � s| � � dkr | �� t�t�d� d S )N�| �{�G�z�?)�poll� terminater �time�sleep)�proc)�pollerr/ r0 �
_check_poller� s z-sos_get_command_output.<locals>._check_poller)�HOMEZLOGNAMEZPWDZUSERzC.UTF-8�LC_ALLN�timeoutztimeout z --foregroundrl � zs rp �*�wr> r? F���T)�shell�stdout�stderr�bufsize�envZ close_fdsZ
preexec_fnr� )Zstatus�outputZ truncated)�~ � � r� )#r~ r �updater� r6 rw �copyrM �popr �shlexr& rS �globrj �appendr5 r r r � AsyncReaderr� �
FakeReader�running�waitr) r� �close� get_contents�is_fullr� �
returncode�OSError�errnoZENOENT)rn r� r� r| r� r� Z
foregroundrQ � sizelimitr� Zto_filer� r� r� Zpwd_userZcmd_env�key�value�argsZ
expanded_args�argZ expanded_argZ_outputrm �readerr� �er/ )r� r| r� r� r0 r � s�
�
�
� � c
s� � � d�d }zt� t� t� |g�}W n> tk
rd } z td� � d|jj� �� |�W 5 d}~X Y nX � fdd�t� |tj
�D �}�r��fdd�|D �}|S ) a Imports 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! r� z"Error while trying to load module z: Nc s g | ]\}}|j � kr|�qS r/ )�
__module__)rT ZcnameZclass_)�
module_fqnamer/ r0 ro N s
�z!import_module.<locals>.<listcomp>c s g | ]}t |� �r|�qS r/ )�
issubclass)rT �m)� superclassesr/ r0 ro R s
) �
rpartition�
__import__�globals�locals� ImportError�print� __class__�__name__�inspectZ
getmembersZisclass)r� r� Z module_name�moduler� �modulesr/ )r� r� r0 r B s
�� c C s t | |||d�d S )zeShell out to an external command and return the output or the empty
string in case of error.
)r� r| r� r� )r )�cmdr� r| Zrunatr/ r/ r0 r W s ��r4 c C sN dddddg}d}| dkr4|dk r4|d 7 }| d
} q| d |� d ��|| � �S )
N�BZKiBZMiBZGiBZTiBr rH � r g �@r! r< r/ )rO Z precision�suffixesZ suffixindexr/ r/ r0 r _ s
c C s> |r,|t jkr,| �|�s,t j�|| �d��} t||�}|| �S r{ )r6 r_ rS r\ rc rq �getattr)r\ rt �methodr� Z_methr/ r/ r0 � _os_wrapperi s
r� c C s$ d| krt | |dtd�S t | |d�S )Nr� r� )r� �exists)r� r� �r\ rt r/ r/ r0 r q s c C s t | |d�S )N�isdir�r� r� r/ r/ r0 r w s c C s t | |d�S )N�isfiler� r� r/ r/ r0 r { s c C s t | |d�S )N�islinkr� r� r/ r/ r0 r s c C s t | |dt�S )Nr )r� r6 r� r/ r/ r0 r � s rs c G s6 |r$| � |�s$tj�|| �tj��} tjj| f|�� S rR )rS r6 r\ rc rq r_ )r\ rt rm r/ r/ r0 r � s c C s d| d S )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/ )�textr/ r/ r0 r
� s
c s� g }g � |� |� t| t�r�| �� D ]�\}�� �|� |rB||krR|� t��� q$t�t�r$z$|� t�fdd�|D ��d � W n tk
r� Y nX � � ��� � 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``
c 3 s | ]}|� kr� | V qd S rR r/ )rT r� )�vr/ r0 rV � s z/recursive_dict_values_by_key.<locals>.<genexpr>r c s g | ]}|� kr|�qS r/ r/ )rT �d)�_filtr/ r0 ro � s z0recursive_dict_values_by_key.<locals>.<listcomp>)rj rA �dictrM r� r �
IndexError�keys)Zdobjr� Z_items�kr/ )r� r� r0 r � s,
���
c @ s8 e Zd ZdZdd� 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.
c C s || _ || _d S rR )�processrQ )�selfr� rQ r/ r/ r0 �__init__� s zFakeReader.__init__c C s dS )NFr/ �r� r/ r/ r0 r� � s zFakeReader.is_fullc C s | j s
dS dS )Nrl r� )rQ r� r/ r/ r0 r� � s zFakeReader.get_contentsc C s | j �� d kS rR )r� r� r� r/ r/ r0 r� � s zFakeReader.runningN) r� r� � __qualname__�__doc__r� �propertyr� r� r� r/ r/ r/ r0 r� � s
r� c s< e Zd ZdZ� 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.
c s^ t � �� || _|| _d| _d | _|r>|d }t|| j �| _t| jd�| _d| _| � � d S )Ni rG )�maxlenT)
�superr� �chanrQ � chunksize�slots�intr r� �start)r� Zchannelr� rQ �r� r/ r0 r� � s
zAsyncReader.__init__c C sJ z&| j �| j�}|sq$| j�|� qW n ttfk
r> Y nX d| _dS )al Reads 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� r: r� r r� �
ValueErrorrC r� )r� rg r/ r/ r0 �run� s zAsyncReader.runc C sD | j rt�d� q | js.d�dd� | jD ��S d�dd� | jD ��S )z-Returns the contents of the deque as a stringr� rl c s s | ]}|� d d�V qdS )r> �ignoreN)�decode�rT Zlnr/ r/ r0 rV s z+AsyncReader.get_contents.<locals>.<genexpr>r� c s s | ]
}|V qd S rR r/ r� r/ r/ r0 rV s )r� r� r� rQ rc r r� r/ r/ r0 r� s
zAsyncReader.get_contentsc C s | j s
dS t| j�| j kS )z?Checks if the deque is full, implying that output was truncatedF)r� �lenr r� r/ r/ r0 r� s zAsyncReader.is_full)
r� r� r� r� r� r� r� r� r� �
__classcell__r/ r/ r� r0 r� � s
r� c @ s8 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd S )
r
z�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.
c C s
|| _ dS )zopackage is a package module
import my.package.module
helper = ImporterHelper(my.package.module)N)�package)r� r� r/ r/ r0 r� ( s zImporterHelper.__init__c C s t j�|�}t j�|�\}}|S )z-Returns the plugin module name given the path)r6 r\ �basename�splitext)r� r\ �basere r- r/ r/ r0 � _plugin_name. s zImporterHelper._plugin_namec s � fdd�|D �}|� � |S )Nc s( g | ] }d |kr|� d�r� �|��qS )r� z.py)�endswithr� )rT Zpluginr� r/ r0 ro 5 s
�z9ImporterHelper._get_plugins_from_list.<locals>.<listcomp>)�sort)r� Zlist_�pluginsr/ r� r0 �_get_plugins_from_list4 s
�z%ImporterHelper._get_plugins_from_listc C s0 t j�|�r,ttd|��}| �|�}|r,|S g S )Nz*.py)r6 r\ r� �listr r� )r� r\ Zpy_filesZpnamesr/ r/ r0 �_find_plugins_in_dir; s
z#ImporterHelper._find_plugins_in_dirc C s2 g }| j jD ] }tj�|�r |�| �|�� q |S )zQReturns the list of importable modules in the configured python
package. )r� �__path__r6 r\ r� rj r� )r� r� r\ r/ r/ r0 � get_modulesC s
zImporterHelper.get_modulesN) r� r� r� r� r� r� r� r� r� r/ r/ r/ r0 r
" s c @ s$ e Zd Zdd� Zdd� Zdd� ZdS )r c C s || _ g | _d S rR )�tmp_dir�files)r� r� r/ r/ r0 r� P s zTempFileUtil.__init__c C s2 t j| jd�\}}t�|d�}| j�||f� |S )N)�dirzw+)�tempfileZmkstempr� r6 �fdopenr� r� )r� �fdr[ Zfobjr/ r/ r0 �newT s zTempFileUtil.newc C sh | j D ]V\}}z|�� |�� W n tk
r6 Y nX zt�|� W q tk
rZ Y qX qg | _ d S rR )r� �flushr� r) r6 �unlink)r� r[ r< r/ r/ r0 �clean[ s zTempFileUtil.cleanN)r� r� r� r� r r r/ r/ r/ r0 r N s c @ s e Zd ZdS )r N)r� r� r� r/ r/ r/ r0 r k s )T)r= )NN)N)N)r� NN)r4 )>r6 r~ r$ r� �
subprocessr r r Zloggingra r� r� r� r Z threadingr� rD �
contextlibr � collectionsr Zpackaging.versionr r r� Z
pkg_resourcesZ getLoggerr* rW r �__all__r1 r2 r r rP r r r r r r r r r\ r� r r r r r r_ r r
r r� ZThreadr� r
r r� r r/ r/ r/ r0 �<module> s�
�
"
�
z
6<,