File: processes.py

package info (click to toggle)
ppa-dev-tools 0.6.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,096 kB
  • sloc: python: 5,069; makefile: 3
file content (82 lines) | stat: -rw-r--r-- 3,217 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
#!/usr/bin/env python3
# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
#
# Copyright (C) 2011-2012 Bryce Harrington <bryce@bryceharrington.org>
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

from time import sleep
from subprocess import (Popen, PIPE)

from .debug import dbg
from .text import o2str


class ReturnCode(BaseException):
    def __init__(self, code, errors=None, output=None):
        self.code = code
        self.output = output
        if type(errors) in (list, tuple):
            self.errors = errors
        else:
            self.errors = [errors]

    def __str__(self):
        text = '\n'.join(self.errors)
        return f"{text}Returned error code {self.code}"


def shell(command, in_text=None):
    """Execute command in a shell, returns stdout, raises exception on error."""
    dbg(f"shell: {command}")
    if in_text:
        proc = Popen(command, shell=True, stdout=PIPE, stderr=PIPE, stdin=PIPE)
        output, errors = proc.communicate(input=in_text)
    else:
        proc = Popen(command, shell=True, stdout=PIPE, stderr=PIPE)
        output, errors = proc.communicate()
    if proc.returncode:
        raise ReturnCode(proc.returncode, o2str(errors), output=o2str(output))
    return o2str(output)


def execute(command, in_text=None):
    """Execute command, returns stdout; prints errors to stderr."""
    dbg(f"execute: `{command}`")
    if in_text is None:
        proc = Popen(command, shell=False, stdout=PIPE, stderr=PIPE)
    else:
        proc = Popen(command, shell=False, stdout=PIPE, stderr=PIPE, stdin=PIPE)
        dbg(f"execute: polling ({in_text})...")
        while proc.poll() is None and proc.stdin is not None:
            dbg("execute: Sending to process stdin")
            proc.stdin.write(in_text)
            dbg("execute: sleeping")
            sleep(0.01)
    output = proc.stdout.read()
    if proc.returncode:
        dbg(f"Received return code {proc.returncode}")
        raise ReturnCode(proc.returncode, proc.stderr.readlines(), output=output)
    return o2str(output)


def execute_with_input(command, in_text):
    """Execute command, passing in_text to stdin if provided."""
    execute(command, in_text)