orchestro.utils package#

Submodules#

orchestro.utils.child module#

exception orchestro.utils.child.InvalidChild(child: str | OrcheChild, phase: Literal['initial', 'runtime'], about: str | None = None)[source]#

Bases: Exception

Exception for when the child could not be instantiated.

Note

Similar or identical to classes in other projects.

Parameters:
  • child – Name or child that is determined invalid.

  • phase – From which phase child was found invalid.

  • about – Additional information for the exception.

phase: Literal['initial', 'runtime']#
child: str#
about: str | None = None#

orchestro.utils.param module#

exception orchestro.utils.param.InvalidParam(error: Literal['minimal', 'invalid', 'missing', 'noexist'], about: str | None = None, *, child: OrcheChild | None = None, param: str | None = None, value: Any | None = None)[source]#

Bases: Exception

Exception for after invalid parameters are encountered.

Note

Similar or identical to classes in other projects.

Parameters:
  • error – Simple code describing the invalid error.

  • about – Additional information for the exception.

  • child – Child class instance related to exception.

  • param – Name of the parameter which is not valid.

  • value – Value if any specified for the parameter.

error: Literal['minimal', 'invalid', 'missing', 'noexist']#
about: str | None = None#
child: OrcheChild | None = None#
param: str | None = None#
value: Any | None = None#

Module contents#

exception orchestro.utils.InvalidChild(child: str | OrcheChild, phase: Literal['initial', 'runtime'], about: str | None = None)[source]#

Bases: Exception

Exception for when the child could not be instantiated.

Note

Similar or identical to classes in other projects.

Parameters:
  • child – Name or child that is determined invalid.

  • phase – From which phase child was found invalid.

  • about – Additional information for the exception.

phase: Literal['initial', 'runtime']#
child: str#
about: str | None = None#
exception orchestro.utils.InvalidParam(error: Literal['minimal', 'invalid', 'missing', 'noexist'], about: str | None = None, *, child: OrcheChild | None = None, param: str | None = None, value: Any | None = None)[source]#

Bases: Exception

Exception for after invalid parameters are encountered.

Note

Similar or identical to classes in other projects.

Parameters:
  • error – Simple code describing the invalid error.

  • about – Additional information for the exception.

  • child – Child class instance related to exception.

  • param – Name of the parameter which is not valid.

  • value – Value if any specified for the parameter.

error: Literal['minimal', 'invalid', 'missing', 'noexist']#
about: str | None = None#
child: OrcheChild | None = None#
param: str | None = None#
value: Any | None = None#