Simple process runner
Project description
Runner
Simple wrapper around subprocess.Popen.
Multiple commands can be configured to be executed. Each command can have some predetermined parameters and additional parameters or overrides can be passed when application is executed. Multiple instances of one application can be running using aliases.
To communicate to running processes Channel classes are used. These provide non-blocking byte- or line-oriented data. Currently STDIO and UNIX socket are supported.
Examples:
Using STDIO.
runner = Runner()
runner.update_config({"cat": {"command": "cat", "type": "stdio"}})
runner.ensure_running('cat')
channel = runner.get_channel('cat')
channel.write(b'hello, world')
# later
line = channel.read() # Will return b'hello, world'
Using UNIX socket.
runner = Runner()
self._runner.update_config({"socat":
{"command": "socat SYSTEM:cat UNIX-LISTEN:socket",
"type": "socket",
"socket": "socket"}})
runner.ensure_running('socat')
channel = runner.get_channel('socat')
channel.write(b'hello, world')
# later
line = channel.read() # Will return b'hello, world'
Classes
Runner
add(self, name, command, **kwargs)
Add the application to the list of registered applications or update if already added.
name
: application namecommand
: the command to be executed
**kwargs
can include the following:
type
: eitherstdio
orsocket
. Default isstdio
cwd
: working directory of the processsocket
: if type issocket
, this is the name of the UNIX socket file to connect tosetpgrp
: ifTrue
the process is moved to a separate process group and will not receive signals sent to main process. Default isFalse
buffering
: if set to"line"
the channel is line-buffered for reading
update_config(self, config)
Config must be a dictionary where each key is an alias of an application and value is a dictionary of that application's configuration. runner.add("app", "command", **kwargs)
is equivalent to runner.update_config({"app": {"command": "command", **kwargs}})
. Useful for adding multiple applications at once.
ensure_running(self, app_name, alias=None, with_args=None, **kwargs)
start(self, app_name, alias=None, with_args=None, **kwargs)
Start the process. If the process with the same alias is already running, start
will raise ProcessExistsException
, while ensure_running
will silently do nothing.
app_name
: application alias, given in the configurationalias
: alias that will be given to actual started process. IfNone
, application alias will be usedwith_args
: list of additional arguments that will be added to the commandkwargs
: extend or override parameters in application config
get_channel(self, alias)
Returns the Channel
object to communicate to the running process.
terminate(self, alias)
Terminates the process.
Channel
read(self)
Performs a non-blocking read and returns any bytes available. Raises EndpointClosedException
if the process on the other side of the channel is terminated.
write(self, *data)
Writes chunks of bytes to the channel. Raises EndpointClosedException
.
close(self)
Closes the channel and frees up the resources.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for yet_another_runner-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1a683d94cf8c169c3e66c81f82dba06bb0809f3be75deb89c5c350c3a402e4a1 |
|
MD5 | 9c92b3318ee83e621f8a5e5fc1dc793e |
|
BLAKE2b-256 | 51aa0ccd21add7b8ed232deb2de5bb0f130175cafcaacfcdca56534e697ce4b1 |