Skip to main content

running commands through a system shell

Project description

Look at envoy first. envoy.run(command) waits for completion before returning output, which is not what you need when wrapping long running tools, where output needed as soon as it appears, shellrun.run(command) does not intercept output - there is a separate command for that.

>>> import shellrun
>>> r = shellrun.run('uptime')
 04:06:37 up 2 min,  1 user,  load average: 0.20, 0.19, 0.08
>>> r.output
>>> r.success
True
>>> r.retcode
0

To capture output envoy-style, use run_capture. stdout and stderr are merged, because that’s how users see it:

>>> r = shellrun.run_capture('uptime')
>>> r.output
' 04:07:16 up 2 min,  1 user,  load average: 0.11, 0.17, 0.08\n'
>>> r.success
True
>>> r.retcode
0

Quick comparison of result objects:

envoy.Response

shellrun.Result

.command

.command

.status_code

.retcode

.success

.output

.std_out

.std_err

Example of .success usage:

from shellrun import run_capture

r = run_capture('ls -la')
if r.success:
    print(r.output)
else:
    print("Error: '%s' exit code %s" % (r.command, r.retcode))
    print("         ...")
    # print last three lines of output
    for line in r.output.splitlines()[-3:]:
        print("       %s" % line)

Project details


Release history Release notifications | RSS feed

This version

3.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shellrun-3.1.zip (3.9 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page