Skip to content

enums

This module provides enumerations for interfaces.

ReturnCode

Bases: IntEnum

Enum for Merlin return codes.

This class defines various return codes used in the Merlin system to indicate the status of operations. Each return code corresponds to a specific outcome of a process.

Attributes:

Name Type Description
OK int

Indicates a successful operation. Numeric value: 0.
ERROR int

Indicates a general error occurred. Numeric value: 1.
RESTART int

Indicates that the process should be restarted. Numeric value: 100.
SOFT_FAIL int

Indicates a non-critical failure that allows for recovery. Numeric value: 101.
HARD_FAIL int

Indicates a critical failure that cannot be recovered from. Numeric value: 102.
DRY_OK int

Indicates a successful operation in a dry run (no changes made). Numeric value: 103.
RETRY int

Indicates that the operation should be retried. Numeric value: 104.
STOP_WORKERS int

Indicates that worker processes should be stopped. Numeric value: 105.
RAISE_ERROR int

Indicates that an error should be raised. Numeric value: 106.
Source code in merlin/common/enums.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
class ReturnCode(IntEnum):
    """
    Enum for Merlin return codes.

    This class defines various return codes used in the Merlin system to indicate
    the status of operations. Each return code corresponds to a specific outcome
    of a process.

    Attributes:
        OK (int): Indicates a successful operation. Numeric value: 0.
        ERROR (int): Indicates a general error occurred. Numeric value: 1.
        RESTART (int): Indicates that the process should be restarted. Numeric value: 100.
        SOFT_FAIL (int): Indicates a non-critical failure that allows for recovery. Numeric value: 101.
        HARD_FAIL (int): Indicates a critical failure that cannot be recovered from. Numeric value: 102.
        DRY_OK (int): Indicates a successful operation in a dry run (no changes made). Numeric value: 103.
        RETRY (int): Indicates that the operation should be retried. Numeric value: 104.
        STOP_WORKERS (int): Indicates that worker processes should be stopped. Numeric value: 105.
        RAISE_ERROR (int): Indicates that an error should be raised. Numeric value: 106.
    """

    OK: int = 0
    ERROR: int = 1
    RESTART: int = 100
    SOFT_FAIL: int = 101
    HARD_FAIL: int = 102
    DRY_OK: int = 103
    RETRY: int = 104
    STOP_WORKERS: int = 105
    RAISE_ERROR: int = 106