subprocrunner
A Python wrapper library for subprocess
module.
- Sample Code
from subprocrunner import SubprocessRunner runner = SubprocessRunner(["echo", "test"]) print(runner) print(f"return code: {runner.run()}") print(f"stdout: {runner.stdout}") runner = SubprocessRunner(["ls", "__not_exist_dir__"]) print(runner) print(f"return code: {runner.run()}") print(f"stderr: {runner.stderr}")
- Output
SubprocessRunner(command='echo test', returncode='not yet executed') return code: 0 stdout: test SubprocessRunner(command='ls __not_exist_dir__', returncode='not yet executed') return code: 2 stderr: ls: cannot access '__not_exist_dir__': No such file or directory
- Sample Code
from subprocrunner import Retry, SubprocessRunner SubprocessRunner(command).run(retry=Retry(total=3, backoff_factor=0.2, jitter=0.2))
- Sample Code
import sys from subprocrunner import SubprocessRunner from subprocrunner.error import CalledProcessError runner = SubprocessRunner("ls not-exist-dir") # raise an exception at run try: runner.run(check=True) except CalledProcessError as e: print(f"run(check=True): {e}\n{e.stderr}", file=sys.stderr) # raise an exception after run runner.run() try: runner.raise_for_returncode() except CalledProcessError as e: print(f"raise_for_returncode(): {e}\n{e.stderr}", file=sys.stderr)
- Output
run(check=True): Command 'ls not-exist-dir' returned non-zero exit status 2. ls: cannot access 'not-exist-dir': No such file or directory raise_for_returncode(): Command 'ls not-exist-dir' returned non-zero exit status 2. ls: cannot access 'not-exist-dir': No such file or directory
Commands are not actually run when passing dry_run=True
to SubprocessRunner
class constructor.
- Sample Code
from subprocrunner import SubprocessRunner runner = SubprocessRunner("echo test", dry_run=True) print(runner) print(f"return code: {runner.run()}") print(f"stdout: {runner.stdout}")
- Output
SubprocessRunner(command='echo test', returncode='not yet executed', dryrun=True) return code: 0 stdout:
- 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
>>> 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
pip install subprocrunner
sudo add-apt-repository ppa:thombashi/ppa
sudo apt update
sudo apt install python3-subprocrunner
- loguru
- Used for logging if the package installed