lazycluster.exceptions.md

module lazycluster.exceptions

Exception module.

---

class LazyclusterError

Basic exception class for lazycluster library errors.

method __init__

__init__(msg: str, predecessor_excp: Optional[Exception] = None)

Constructor method.

Args:

• msg: The error message.
• predecessor_excp: Optionally, a predecessor exception can be passed on.

---

class TaskExecutionError

This error relates to exceptions occured during RuntimeTask execution.

method __init__

__init__(
    task_step_index: int,
    task: Any,
    host: str,
    execution_log_file_path: str,
    output: str,
    predecessor_excp: Optional[Exception] = None
)

Initialization method.

Args:

• task_step_index: The index of the task step, where an error occured.
• task: The RuntimeTask during which execution the error occured.
• host: The host where the execution failed.
• execution_log_file_path: The path to the execution log file on the manager.
• output: Thr ouput (stdout/stderr) generated on the Runtime during execution.
• predecessor_excp: Optionally, a predecessor exception can be passed on.

---

class InvalidRuntimeError

Error indicating that a Runtime can not be instantiated properly.

method __init__

__init__(host: str)

Constructor method.

Args:

• host: The host which cannot be instantiated as Runtime.

---

class NoRuntimesDetectedError

Error indicating that no Runtime could be detcted automatically by a RuntimeManager for example.

method __init__

__init__(predecessor_excp: Optional[Exception] = None)

---

class PortInUseError

Error indicating that a port is already in use in a RuntimeGroup or on the local machine.

method __init__

__init__(
    port: int,
    group: Optional[Any] = None,
    runtime: Optional[Any] = None
) → None

Constructor.

Args:

• port (int): [description]
• group (Optional[Any], optional): [description]. Defaults to None.
• runtime (Optional[Any], optional): [description]. Defaults to None.

---

class NoPortsLeftError

Error indicating that there are no more ports left from the given port list.

method __init__

__init__() → None

Constructor method.

---

class PathCreationError

Error indicating that a given path could not be created.

method __init__

__init__(path: str, host: Optional[str] = None)

Constructor method.

Args:

• path: The path which should be created.
• host: The host where the path should be created.

---

This file was automatically generated via lazydocs.