runcmd 2019.4.13

run shell command

Installation

$ [sudo] pip install runcmd

Classes

class	__doc__
runcmd.Process	Process class

Functions

function	__doc__
runcmd.run(args, cwd=None, background=False)	run command and return Process object

Examples

>>> import runcmd
>>> r = runcmd.run(["echo", "hello world"])
>>> r.code  # exit status code
0
>>> r.out  # stdout
'hello world'
>>> r.err  # stderr
''
>>> r.pid  # process pid
1234

background=True

>>> r = runcmd.run(["sleep","5"],background=True)
>>> while r.running:  # True if process is running and not "zombie process"
>>>     print("running")

kill(signal=None) - kill process

>>> r.kill(-9)

exc() - raise exception if code is not 0

>>> runcmd.run(["ls"]).exc()              # code 0, ok
>>> runcmd.run(["mkdir", "/"]).exc()      # code 1, raise OSError
...
OSError: exited with code 1
mkdir: /: Is a directory

python-readme-generator