.. _doot._interface: =============== doot._interface =============== .. py:module:: doot._interface Type Aliases ------------ .. autoapisummary:: doot._interface.Loadable Enums ----- .. autoapisummary:: doot._interface.ExitCodes Module Contents =============== .. py:data:: Loadable :type: TypeAlias :value: pl.Path | Traversable .. _doot._interface.ExitCodes: .. py:class:: ExitCodes Bases: :py:obj:`enum.IntEnum` Enum where members are also (and must be) ints .. py:attribute:: SUCCESS :value: 0 .. py:attribute:: UNKNOWN_FAIL :value: -1 .. py:attribute:: NOT_SETUP :value: -2 .. py:attribute:: EARLY :value: -3 .. py:attribute:: MISSING_CONFIG :value: -4 .. py:attribute:: BAD_CONFIG :value: -5 .. py:attribute:: BAD_CMD :value: -6 .. py:attribute:: TASK_FAIL :value: -7 .. py:attribute:: BAD_STATE :value: -8 .. py:attribute:: BAD_STRUCT :value: -9 .. py:attribute:: TRACKING_FAIL :value: -10 .. py:attribute:: BACKEND_FAIL :value: -11 .. py:attribute:: FRONTEND_FAIL :value: -12 .. py:attribute:: DOOT_FAIL :value: -13 .. py:attribute:: NOT_IMPLEMENTED :value: -14 .. py:attribute:: IMPORT_FAIL :value: -15 .. py:attribute:: PYTHON_FAIL :value: -16 .. py:attribute:: INITIAL :value: -99