Exceptions
Exception types raised by ropt.
ropt.exceptions
Exceptions raised within the ropt library.
RoptError
Bases: Exception
Base class for all runtime errors raised by ropt.
Catch this to handle any error raised by ropt itself. Configuration and
validation errors are not part of this hierarchy; they surface as
pydantic.ValidationError. The internal stop signals
(OptimizerStop,
TooFewRealizations,
ExecutorStopped) are control flow, not
errors, and are excluded too.
WorkflowError
Bases: RoptError
A workflow or runtime object was used incorrectly.
For example a compute step, evaluator, or event handler used concurrently or out of order, an ownership or registration conflict, submitting to a dispatcher that is not running, or reusing a locked context.
ExecutionError
Bases: RoptError
The execution infrastructure failed at runtime.
For example a worker pool that cannot start, a broken process pool, a task that cannot be serialized, or an HPC setup or submission problem.
UnsupportedError
Bases: RoptError
An optional dependency is missing or a requested feature is unsupported.
For example a required extra (such as pandas or polars) is not installed, or the selected plugin does not support the requested method.
OptimizerStop
Bases: Exception
Raised internally to stop an optimization with a specific exit code.
Used only within the optimizer core to unwind the backend optimization loop
(for example when a function or batch budget is reached). It carries the
ExitCode the optimization terminates with.
__init__
Initialize the OptimizerStop exception.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
exit_code
|
ExitCode
|
The exit code the optimization terminates with. |
required |
TooFewRealizations
Bases: Exception
Raised when too few realizations are available to compute a result.
A generic signal, carrying no exit code.
ExecutorStopped
Bases: Exception
Raised when the evaluation executor is no longer running.
A generic signal, carrying no exit code, raised by the parallel evaluator when its executor has stopped and the current evaluation cannot proceed.
ExecutorFailure
Bases: Exception
Raised when an executor fails to execute a task.