subprocrunner 1.2.0

A Python wrapper library for subprocess module.

subprocrunner

• Summary

• Examples

  • Execute a command

  • dry run

  • Get execution command history

  • Get a command information

• Installation

  • Install from PyPI

  • Install from PPA (for Ubuntu)

• Dependencies

  • Optional dependencies

  • Test dependencies

Summary

A Python wrapper library for subprocess module.

Examples

Execute a command

Sample Code:

from subprocrunner import SubprocessRunner

runner = SubprocessRunner("echo test")
print("command: {:s}".format(runner.command))
print("return code: {:d}".format(runner.run()))
print("stdout: {:s}".format(runner.stdout))

runner = SubprocessRunner("ls __not_exist_dir__")
print("command: {:s}".format(runner.command))
print("return code: {:d}".format(runner.run()))
print("stderr: {:s}".format(runner.stderr))

Output:

command: echo test
return code: 0
stdout: test

command: ls __not_exist_dir__
return code: 2
stderr: ls: cannot access '__not_exist_dir__': No such file or directory

dry run

Sample Code:

from subprocrunner import SubprocessRunner

runner = SubprocessRunner("echo test", dry_run=True)
print("command: {:s}".format(runner.command))
print("return code: {:d}".format(runner.run()))
print("stdout: {:s}".format(runner.stdout))

Output:

command: echo test
return code: 0
stdout:

Get execution command history

Sample Code:

from subprocrunner import SubprocessRunner

SubprocessRunner.clear_history()
SubprocessRunner.is_save_history = True

SubprocessRunner("echo hoge").run()
SubprocessRunner("echo foo").run()

print("\n".join(SubprocessRunner.get_history()))

Output:

echo hoge
echo foo

Get a command information

>>> from subprocrunner import Which
>>> which = Which("ls")
>>> which.is_exist()
True
>>> which.abspath()
'/usr/bin/ls'
>>> which
command=ls, is_exist=True, abspath=/usr/bin/ls

Installation

Install from PyPI

pip install subprocrunner

Install from PPA (for Ubuntu)

sudo add-apt-repository ppa:thombashi/ppa
sudo apt update
sudo apt install python3-subprocrunner

Dependencies

Python 3.5+

• mbstrdecoder

Optional dependencies

• loguru

  • Used for logging if the package installed

Test dependencies

• pytest

• tox

• typepy