Method run_cmd

shell_helpers.py:140–251

Run a command. Write the command to stdout before running it. Wait until the command finishes execution. :param cmd: command to run. LF entries are magic get skipped. :type cmd: List[str] :param cmd_file: if not None, write the command to be run to that fi

(
            self,
            cmd,
            cmd_file=None,
            out_file=None,
            show_stdout=True,
            show_cmd=True,
            extra_env=None,
            extra_paths=None,
            delete_env=None,
            raise_on_failure=True,
            **kwargs
        )

            os.chmod(cmd_file, st.st_mode | stat.S_IXUSR)

    def run_cmd(
            self,
            cmd,
            cmd_file=None,
            out_file=None,
            show_stdout=True,
            show_cmd=True,
            extra_env=None,
            extra_paths=None,
            delete_env=None,
            raise_on_failure=True,
            **kwargs
        ):
        '''
        Run a command. Write the command to stdout before running it.

        Wait until the command finishes execution.

        :param cmd: command to run. LF entries are magic get skipped.
        :type cmd: List[str]

        :param cmd_file: if not None, write the command to be run to that file
        :type cmd_file: str

        :param out_file: if not None, write the stdout and stderr of the command the file
        :type out_file: str

        :param show_stdout: wether to show stdout and stderr on the terminal or not
        :type show_stdout: bool

        :param extra_env: extra environment variables to add when running the command
        :type extra_env: Dict[str,str]

        :return: exit status of the command
        :rtype: int
        '''
        if out_file is not None:
            stdout = subprocess.PIPE
            stderr = subprocess.STDOUT
        else:
            if show_stdout:
                stdout = None
                stderr = None
            else:
                stdout = subprocess.DEVNULL
                stderr = subprocess.DEVNULL
        if extra_env is None:
            extra_env = {}
        if delete_env is None:
            delete_env = []
        if 'cwd' in kwargs:
            cwd = kwargs['cwd']
        else:
            cwd = None
        env = os.environ.copy()
        env.update(extra_env)
        if extra_paths is not None:
            path = ':'.join(extra_paths)