hpcflow.sdk.helper package#

Submodules#

hpcflow.sdk.helper.cli module#

hpcflow.sdk.helper.cli.get_helper_CLI(app)#

Generate the CLI to provide some server-like functionality.

hpcflow.sdk.helper.helper module#

hpcflow.sdk.helper.helper.clear_helper(app)#
hpcflow.sdk.helper.helper.get_PID_file_path(app)#

Get the path to the file containing the process ID of the helper, if running.

hpcflow.sdk.helper.helper.get_helper_PID(app)#
hpcflow.sdk.helper.helper.get_helper_log_path(app)#

Get the log file path for the helper.

hpcflow.sdk.helper.helper.get_helper_logger(app)#
hpcflow.sdk.helper.helper.get_helper_uptime(app)#
hpcflow.sdk.helper.helper.get_helper_watch_list(app)#

Get the list of workflows currently being watched by the helper process.

hpcflow.sdk.helper.helper.get_user_data_dir(app)#

We segregate by hostname to account for the case where multiple machines might use the same shared file system.

hpcflow.sdk.helper.helper.get_watcher_file_path(app)#

Get the path to the watcher file, which contains a list of workflows to watch.

hpcflow.sdk.helper.helper.helper_timeout(app, timeout, controller, logger)#

Kill the helper due to running duration exceeding the timeout.

hpcflow.sdk.helper.helper.kill_proc_tree(pid, sig=Signals.SIGTERM, include_parent=True, timeout=None, on_terminate=None)#

Kill a process tree (including grandchildren) with signal “sig” and return a (gone, still_alive) tuple. “on_terminate”, if specified, is a callback function which is called as soon as a child terminates.

hpcflow.sdk.helper.helper.restart_helper(app, timeout=3600, timeout_check_interval=60, watch_interval=10)#
hpcflow.sdk.helper.helper.run_helper(app, timeout=3600, timeout_check_interval=60, watch_interval=10)#
hpcflow.sdk.helper.helper.start_helper(app, timeout=3600, timeout_check_interval=60, watch_interval=10, logger=None)#
hpcflow.sdk.helper.helper.stop_helper(app, return_logger=False)#

hpcflow.sdk.helper.watcher module#

class hpcflow.sdk.helper.watcher.MonitorController(workflow_dirs_file_path, watch_interval, logger)#

Bases: object

join()#
on_modified(event)#
static parse_watch_workflows_file(path, logger)#
stop()#
class hpcflow.sdk.helper.watcher.WorkflowMonitor(workflow_paths, watch_interval, logger)#

Bases: object

on_modified(event)#
stop()#
update_workflow_paths(new_paths)#

Module contents#