File: //lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyc
�
d�bc @ sc d d l Z d d l Z d d l Z d d l j j Z d d l m Z e e d � s� d � Z d e
f d � � YZ e e _ e e _ n d � Z e
d d � Z e
e
d d � Z d
� Z d � Z d e
f d
� � YZ d � Z d d e j e j e e
e
e
d � Z d e j e j e e
d � Z d � Z g Z e j � Z d � Z d � Z d � Z d S( i����N( t ustrt check_outputc O s� d | k r t d � � n t j d t j | | � } | j � \ } } | j � } | r� | j d � } | d k r� | d } n t j | | d | �� n | S( s/ Backport from subprocess module from python 2.7t stdouts3 stdout argument not allowed, it will be overridden.t argsi t outputN( t
ValueErrort
subprocesst Popent PIPEt communicatet pollt gett Nonet CalledProcessError( t popenargst kwargst processR t
unused_errt retcodet cmd( ( sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyR s
R
c B s e Z d d � Z d � Z RS( c C s | | _ | | _ | | _ d S( N( t
returncodeR R ( t selfR R R ( ( sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyt __init__/ s c C s d j | j | j � S( Ns/ Command '{0}' returned non-zero exit status {1}( t formatR R ( R ( ( sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyt __str__4 s N( t __name__t
__module__R R R ( ( ( sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyR
. s c C s t | t � S( s9
Return True if the given command is on the path
( t runt False( R ( ( sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyt has_commandC s c C s7 | d k r g } n t | d | d | �\ } } | S( s)
Note: Deprecating in favour of `azurelinuxagent.common.utils.shellutil.run_command` function.
Calls run_get_output on 'cmd', returning only the return code.
If chk_err=True then errors will be reported in the log.
If chk_err=False then errors will be suppressed from the log.
t chk_errt expected_errorsN( R t run_get_output( R R R R t out( ( sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyR J s c C s? | d k r g } n | r. t j d | � n y� t | d t j d t j d t �} | j � \ } } t | j
� t | � } | j d k r� | r� d j
| | j | � } | j | k r� t j | � q� t j | � n | j | f SWnH t k
r4} | r$t j d j
| t | � � � n d t | � f SXd | f S(
s�
Wrapper for subprocess.check_output.
Execute 'cmd'. Returns return code and STDOUT, trapping expected
exceptions.
Reports exceptions to Error if chk_err parameter is True
For new callers, consider using run_command instead as it separates stdout from stderr,
returns only stdout on success, logs both outputs and return code on error and raises an exception.
u Command: [{0}]R t stderrt shelli u1 Command: [{0}], return code: [{1}], result: [{2}]u0 Command [{0}] raised unexpected exception: [{1}]i����N( R t loggert verboset _popenR R t STDOUTt TrueR t _on_command_completedt pidt __encode_command_outputR R t infot errort ExceptionR ( R R t log_cmdR R R t _t msgt exception( ( sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyR W s.
$
c C sb t | t � r^ | rQ t | d t � rQ d j g | D] } d j | � ^ q5 � Sd j | � S| S( s
Formats the command taken by run_command/run_pipe.
Examples:
> __format_command("sort")
'sort'
> __format_command(["sort", "-u"])
'sort -u'
> __format_command([["sort"], ["unique", "-n"]])
'sort | unique -n'
i s | t ( t
isinstancet listt join( t commandR ( ( sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyt __format_command� s
)
c C s( t | d k r | n d d d d d �S( sH
Encodes the stdout/stderr returned by subprocess.communicate()
t t encodings utf-8t errorst backslashreplaceN( R R ( R ( ( sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyR+ � s t CommandErrorc B s& e Z d Z e d � � Z d � Z RS( sT
Exception raised by run_command/run_pipe when the command returns an error
c C sJ t | t � r+ t | � d k r+ | d n | } d j | | | j � � S( Ni s '{0}' failed: {1} ({2})( R4 R5 t lenR t rstrip( R7 t return_codeR" t command_name( ( sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyt _get_message� s 1c C sM t t | � j t j | | | � � | | _ | | _ | | _ | | _ d S( N( t superR. R R= RB R7 R R R" ( R R7 R@ R R" ( ( sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyR � s
% ( R R t __doc__t staticmethodRB R ( ( ( sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyR= � s c C s� y� | � \ } } } | r6 t | � } t | � } n | d k r� | rj t j d t | � | | | � n t d t | � d | d | d | � � n | SWnQ t k
r� � n> t k
r� } | r� t j d t | � t | � � n � n Xd S( s�
Executes the given command_action and returns its stdout. The command_action is a function that executes a command/pipe
and returns its exit code, stdout, and stderr.
If there are any errors executing the command it raises a RunCommandException; if 'log_error'
is True, it also logs details about the error.
If encode_output is True the stdout is returned as a string, otherwise it is returned as a bytes object.
i s? Command: [{0}], return code: [{1}], stdout: [{2}] stderr: [{3}]R7 R@ R R" u0 Command [{0}] raised unexpected exception: [{1}]N( R+ R$ R- R8 R= R. R ( t command_actionR7 t log_errort
encode_outputR@ R R" R2 ( ( sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyt
__run_command� s*
*
"c
sg � d k r' � d k r' t d � � n � � � � � � � f d � } t d | d � d | d | � S( sV
Executes the given command and returns its stdout.
If there are any errors executing the command it raises a RunCommandException; if 'log_error'
is True, it also logs details about the error.
If encode_output is True the stdout is returned as a string, otherwise it is returned as a bytes object.
If track_process is False the command is not added to list of running commands
This function is a thin wrapper around Popen/communicate in the subprocess module:
* The 'input' parameter corresponds to the same parameter in communicate
* The 'stdin' parameter corresponds to the same parameters in Popen
* Only one of 'input' and 'stdin' can be specified
* The 'stdout' and 'stderr' parameters correspond to the same parameters in Popen, except that they
default to subprocess.PIPE instead of None
* If the output of the command is redirected using the 'stdout' or 'stderr' parameters (i.e. if the
value for these parameters is anything other than the default (subprocess.PIPE)), then the corresponding
values returned by this function or the CommandError exception will be empty strings.
Note: This is the preferred method to execute shell commands over `azurelinuxagent.common.utils.shellutil.run` function.
s4 The input and stdin arguments are mutually exclusivec s� d } } � d k rI t j } � r@ t � t � r@ � j � n � } n � d k rd � } d } n � r� t � d | d � d � d t �} n' t j � d | d � d � d t �} | j d | � \ } } � r� t
| j � n | j | | f S( Nt stdinR R" R# t input(
R R R R4 t strt encodeR& R R R R) R* R ( t popen_stdint communicate_inputR t command_stdoutt command_stderr( R7 t encode_inputRK R" RJ R t
track_process( sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyRF � s
* ''RF R7 RG RH N( R R RI (
R7 RK RJ R R" RG RR RH RS RF ( ( R7 RR RK R" RJ R RS sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyt run_command� s !c sX t � � d k r! t d � � n � � � � f d � } t d | d � d | d | � S( sN
Executes the given commands as a pipe and returns its stdout as a string.
The pipe is a list of commands, which in turn are a list of strings, e.g.
[["sort"], ["uniq", "-n"]] represents 'sort | unique -n'
If there are any errors executing the command it raises a RunCommandException; if 'log_error'
is True, it also logs details about the error.
If encode_output is True the stdout is returned as a string, otherwise it is returned as a bytes object.
This function is a thin wrapper around Popen/communicate in the subprocess module:
* The 'stdin' parameter is used as input for the first command in the pipe
* The 'stdout', and 'stderr' can be used to redirect the output of the pipe
* If the output of the pipe is redirected using the 'stdout' or 'stderr' parameters (i.e. if the
value for these parameters is anything other than the default (subprocess.PIPE)), then the corresponding
values returned by this function or the CommandError exception will be empty strings.
i s, The pipe must consist of at least 2 commandsc s� d } zw� } � t j k r3 t j � } | } n � } g } d } x] | t � � d k r� | j t � | d | d t j d | �� | | j } | d 7} qH W| j t � | d | d � d | �� d } x5 | t | � d k r | | j j � | d 7} q� W| | j
� \ } } x | D] } t | j � q)W| d k rh| j
d � | j � } n | | j | | f SWd | d k r�| j � n Xd S( Ni i RJ R R" ( R R R t tempfilet
TemporaryFileR> t appendR& R t closeR R) R* t seekt readR ( t stderr_fileRN t popen_stderrt processest it pipe_stdoutt pipe_stderrt proc( t pipeR" RJ R ( sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyRF s6 ,
)
RF R7 RG RH ( R> R RI ( Rb RJ R R" RG RH RF ( ( Rb R" RJ R sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyt run_pipe s )c C s> t | t t f � s! | f } n d j t d � | D� � � S( s�
Quote a list or tuple of strings for Unix Shell as words, using the
byte-literal single quote.
The resulting string is safe for use with ``shell=True`` in ``subprocess``,
and in ``os.system``. ``assert shlex.split(ShellQuote(wordList)) == wordList``.
See POSIX.1:2013 Vol 3, Chap 2, Sec 2.2.2:
http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_02_02
R3 c s s* | ] } d j | j d d � � Vq d S( s '{0}'t 's '\''N( R t replace( t .0t s( ( sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pys <genexpr>S s ( R4 t tupleR5 R6 ( t word_list( ( sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyt quoteE s c O s7 t �+ t j | | � } t j | j � | SWd QXd S( N( t _running_commands_lockR R t _running_commandsRW R* ( R R R ( ( sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyR& ^ s c C s t � t j | � Wd QXd S( N( Rk Rl t remove( R* ( ( sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyR) e s c C s t �
t SWd QXd S( sr
Returns the commands started by run/run_get_output/run_command/run_pipe that are currently running.
NOTE: This function is not synchronized with process completion, so the returned array may include processes that have
already completed. Also, keep in mind that by the time this function returns additional processes may have
started or completed.
N( Rk Rl ( ( ( sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyt get_running_commandsj s ( R RU t threadingt azurelinuxagent.common.loggert commonR$ t azurelinuxagent.common.futureR t hasattrR R. R
R R( R R R R8 R+ R= RI R R RT Rc Rj Rl t RLockRk R& R) Rn ( ( ( sJ /usr/lib/python2.7/site-packages/azurelinuxagent/common/utils/shellutil.pyt <module> s0
) &'1 C