exectools.std

Tools for running external processes using the subprocess module.

Classes

BaseToolController([logger])	Base class for controlling command line tools.
StdToolController([logger])	Class for controlling command line tools.

class exectools.std.StdToolController(logger=None)

Bases: exectools.BaseToolController

Class for controlling command line tools.

A tool controller runs an external tool in controlled way. The output of the child process is handled by the controller and, optionally, notifications can be achieved at sub-process termination.

A tool controller also allow to stop the controlled process.

finalize_run(*args, **kwargs)

Perform finalization actions.

This method is called when the controlled process terminates to perform finalization actions like:

• read and handle residual data in buffers,
• flush and close output handlers,
• close subprocess file descriptors
• run the “finalize_run_hook” method
• reset the controller instance

This method is not meant to be called by the user but the user can provide custom implementations in subclasses.

If one just needs to perfor some additional finalization action it should be better to use a custom “finalize_run_hook” instead of overriging “finalize_run”.

handle_stderr(*args)

Handle standard error.

This method is not meant to be directly called by the user.

The user, anyway, can provide a custom implementation in derived classes.

handle_stdout(*args)

Handle standard output data.

This method is not meant to be directly called by the user.

The user, anyway, can provide a custom implementation in derived classes.

isbusy

If True then the controller is already running a subprocess.

reset()

Reset the tool controller instance.

Kill the controlled subprocess and reset the controller instance loosing all unprocessed data.

run_tool(tool, *args, **kwargs)

Run an external tool in controlled way.

The output of the child process is handled by the controller and, optionally, notifications can be achieved at sub-process termination.

stop_tool(force=True)

Stop the execution of controlled subprocess.

When this method is invoked the controller instance is always reset even if the controller is unable to stop the subprocess.

When possible the controller try to kill the subprocess in a polite way. If this fails it also tryes brute killing by default (force=True). This behaviour can be controlled using the force parameter.