pineforge_hpo.error.HpoError Class Reference

Inheritance diagram for pineforge_hpo.error.HpoError:

Public Member Functions
dict[str, Any]|None	failure_args (self)
	with_failure (self, str|None code, dict[str, Any]|None args, str origin="hpo")

Public Attributes
	code
	origin

Static Public Attributes
str	code = "hpo_unclassified_error"
str	origin = "hpo"

Protected Attributes
	_failure_args

Detailed Description

Exception base preserving legacy types and exposing typed failure args.

``str(error)`` and ``error.args`` retain the legacy message contract.
``error.failure_args`` is the scalar JSON object used by the failure protocol.

Definition at line 8 of file error.py.

Member Function Documentation

failure_args()

dict[str, Any] | None pineforge_hpo.error.HpoError.failure_args

(

self

)

Definition at line 19 of file error.py.

with_failure()

pineforge_hpo.error.HpoError.with_failure	(		self,
		str | None	code,
		dict[str, Any] | None	args,
		str	origin = "hpo"
	)

Definition at line 23 of file error.py.

Referenced by pineforge_hpo.request_inventory.RequestInventoryError.__init__(), pineforge_hpo.request_inventory.RequestTimeframeError.__init__(), and pineforge_hpo.window_plan.WindowPlanError.__init__().

Member Data Documentation

_failure_args

pineforge_hpo.error.HpoError._failure_args

protected

Definition at line 27 of file error.py.

code [1/2]

str pineforge_hpo.error.HpoError.code = "hpo_unclassified_error"

static

Definition at line 15 of file error.py.

Referenced by pineforge_hpo.dsr.DsrError.__reduce__(), pineforge_hpo.holdout.HoldoutError.__reduce__(), pineforge_hpo.neighbourhood.NeighbourhoodError.__reduce__(), pineforge_hpo.pareto.ParetoError.__reduce__(), pineforge_hpo.walkforward.WalkforwardError.__reduce__(), pineforge_hpo.dsr.DsrError.document(), pineforge_hpo.holdout.HoldoutError.document(), pineforge_hpo.neighbourhood.NeighbourhoodError.document(), pineforge_hpo.pareto.ParetoError.document(), pineforge_hpo.pbo.PboError.document(), and pineforge_hpo.walkforward.WalkforwardError.document().

code [2/2]

pineforge_hpo.error.HpoError.code

Definition at line 26 of file error.py.

Referenced by pineforge_hpo.dsr.DsrError.__reduce__(), pineforge_hpo.holdout.HoldoutError.__reduce__(), pineforge_hpo.neighbourhood.NeighbourhoodError.__reduce__(), pineforge_hpo.pareto.ParetoError.__reduce__(), pineforge_hpo.walkforward.WalkforwardError.__reduce__(), pineforge_hpo.dsr.DsrError.document(), pineforge_hpo.holdout.HoldoutError.document(), pineforge_hpo.neighbourhood.NeighbourhoodError.document(), pineforge_hpo.pareto.ParetoError.document(), pineforge_hpo.pbo.PboError.document(), and pineforge_hpo.walkforward.WalkforwardError.document().

origin [1/2]

str pineforge_hpo.error.HpoError.origin = "hpo"

static

Definition at line 16 of file error.py.

origin [2/2]

pineforge_hpo.error.HpoError.origin

Definition at line 28 of file error.py.

---

The documentation for this class was generated from the following file:

• error.py