weaver.status

Module Contents

class weaver.status.StatusCompliant

Utility enum.Enum methods.

Create an extended enum with these utilities as follows.

class CustomEnum(ExtendedEnum):
    ItemA = "A"
    ItemB = "B"

Warning

Must not define any enum value here to allow inheritance by subclasses.

OGC = 'OGC'

PYWPS = 'PYWPS'

OWSLIB = 'OWSLIB'

OPENEO = 'OPENEO'

class weaver.status.StatusCategory

Utility enum.Enum methods.

Create an extended enum with these utilities as follows.

class CustomEnum(ExtendedEnum):
    ItemA = "A"
    ItemB = "B"

Warning

Must not define any enum value here to allow inheritance by subclasses.

FINISHED = 'FINISHED'

RUNNING = 'RUNNING'

PENDING = 'PENDING'

FAILED = 'FAILED'

SUCCESS = 'SUCCESS'

class weaver.status.Status

Constants container that provides similar functionalities to ExtendedEnum without explicit Enum membership.

CREATED = 'created'

QUEUED = 'queued'

ACCEPTED = 'accepted'

STARTED = 'started'

PAUSED = 'paused'

SUCCEEDED = 'succeeded'

SUCCESSFUL = 'successful'

FAILED = 'failed'

ERROR = 'error'

FINISHED = 'finished'

RUNNING = 'running'

CANCELED = 'canceled'

DISMISSED = 'dismissed'

EXCEPTION = 'exception'

UNKNOWN = 'unknown'

weaver.status.JOB_STATUS_CATEGORIES

weaver.status.JOB_STATUS_CODE_API

weaver.status.JOB_STATUS_SEARCH_API

weaver.status.STATUS_PYWPS_MAP

weaver.status.STATUS_PYWPS_IDS

weaver.status.StatusType: Status

weaver.status.map_status(wps_status: AnyStatusType) → StatusType

weaver.status.map_status(wps_status: AnyStatusType, compliant: StatusCompliant) → StatusType

weaver.status.map_status(wps_status: AnyStatusType, *, category: Any) → StatusCategory

Maps execution statuses between compatible values of different implementations.

Mapping is supported for values from weaver.status, OWSLib, pywps, openEO, as well as some specific one-of values of custom OAP implementations.

For each compliant combination, unsupported statuses are changed to corresponding ones with the closest logical match. Statuses are returned following Status format. Specifically, this ensures statues are lowercase and not prefixed by Process (as in XML response of OWS WPS like ProcessSucceeded for example).

Parameters:

• wps_status – One of Status or its literal value to map to compliant standard.

• compliant – One of StatusCompliant values.

• category – Request that the StatusCategory corresponding to the supplied status is returned.

Returns:

Mapped status complying to the requested compliant category, or Status.UNKNOWN if no match found.