shell_utils.py 3.96 KB
Newer Older
1 2
# Copyright (c) 2009, Willow Garage, Inc.
# All rights reserved.
3
#
4 5
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
6
#
7 8 9 10 11 12 13 14
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above copyright
#       notice, this list of conditions and the following disclaimer in the
#       documentation and/or other materials provided with the distribution.
#     * Neither the name of the Willow Garage, Inc. nor the names of its
#       contributors may be used to endorse or promote products derived from
#       this software without specific prior written permission.
15
#
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.

# Author Tully Foote/tfoote@willowgarage.com

from __future__ import print_function

import os
import sys
import stat
import subprocess
import tempfile

from .core import rd_debug

40
if sys.hexversion > 0x03000000:  # Python3
41 42 43 44
    python3 = True
else:
    python3 = False

45 46 47
env = dict(os.environ)
env['LANG'] = 'C'

48

49
def read_stdout(cmd, capture_stderr=False):
50
    """
51 52 53 54 55 56 57 58 59
    Execute given command and return stdout and if requested also stderr.

    :param cmd: command in a form that Popen understands (list of strings or one string)
    :param suppress_stderr: If evaluates to True, capture output from stderr as
    well and return it as well.
    :return: if `capture_stderr` is evaluates to False, return the stdout of
    the program as string (Note: stderr will be printed to the running
    terminal).  If it evaluates to True, tuple of strings: stdout output and
    standard error output each as string.
60
    """
61 62 63 64 65 66 67
    if capture_stderr:
        p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env)
        std_out, std_err = p.communicate()
        if python3:
            return std_out.decode(), std_err.decode()
        else:
            return std_out, std_err
68
    else:
69
        p = subprocess.Popen(cmd, stdout=subprocess.PIPE, env=env)
70
        std_out, std_err = p.communicate()  # ignore stderr
71 72 73 74 75
        if python3:
            return std_out.decode()
        else:
            return std_out

76 77 78 79 80 81 82 83

def create_tempfile_from_string_and_execute(string_script, path=None, exec_fn=None):
    """
    :param path: (optional) path to temp directory, or ``None`` to use default temp directory, ``str``
    :param exec_fn: override subprocess.call with alternate executor (for testing)
    """
    if path is None:
        path = tempfile.gettempdir()
84

85 86 87 88 89
    result = 1
    try:
        fh = tempfile.NamedTemporaryFile('w', delete=False)
        fh.write(string_script)
        fh.close()
90
        rd_debug('Executing script below with cwd=%s\n{{{\n%s\n}}}\n' % (path, string_script))
91 92 93 94 95
        try:
            os.chmod(fh.name, stat.S_IRWXU)
            if exec_fn is None:
                result = subprocess.call(fh.name, cwd=path)
            else:
96
                result = exec_fn(fh.name, cwd=path)
97
        except OSError as ex:
98
            print('Execution failed with OSError: %s' % (ex))
99 100 101 102
    finally:
        if os.path.exists(fh.name):
            os.remove(fh.name)

103 104
    rd_debug('Return code was: %s' % (result))
    return result == 0