chore: in JobStatus, messages only need to be stored in docstrings

Author: Henri-ColibrITD

mpqp/execution/job.py

@@ -16,9 +16,11 @@
 
 from typing import TYPE_CHECKING, Optional
 
-from aenum import Enum, NoAlias
+from aenum import Enum, NoAlias, auto
 from typeguard import typechecked
 
+from mpqp.tools.generics import MessageEnum
+
 # This is needed because for some reason pyright does not understand that Enum
 # is a class (probably because Enum does weird things to the Enum class)
 if TYPE_CHECKING:
@@ -33,20 +35,20 @@
 from .devices import ATOSDevice, AvailableDevice, AWSDevice, IBMDevice
 
 
-class JobStatus(Enum):
+class JobStatus(MessageEnum):
     """Possible states of a Job."""
 
-    INIT = "initializing the job"
+    INIT = auto()
     """Initializing the job."""
-    QUEUED = "the job is in the queue"
+    QUEUED = auto()
     """The job is in the queue."""
-    RUNNING = "the job is currently running"
+    RUNNING = auto()
     """The job is currently running."""
-    CANCELLED = "the job is cancelled"
+    CANCELLED = auto()
     """The job is cancelled."""
-    ERROR = "an error occurred with the job"
+    ERROR = auto()
     """An error occurred with the job."""
-    DONE = "the job is successfully done"
+    DONE = auto()
     """The job is successfully done."""
 
 

mpqp/tools/generics.py

@@ -19,7 +19,24 @@
 
 import re
 from abc import ABCMeta
-from typing import Any, Callable, Iterable, Iterator, Sequence, TypeVar, Union
+from inspect import getsource
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Callable,
+    Iterable,
+    Iterator,
+    Sequence,
+    TypeVar,
+    Union,
+)
+
+from aenum import Enum
+
+# This is needed because for some reason pyright does not understand that Enum
+# is a class (probably because Enum does weird things to the Enum class)
+if TYPE_CHECKING:
+    from enum import Enum
 
 import numpy as np
 import numpy.typing as npt
@@ -215,3 +232,35 @@ def __init__(self, func: Callable[..., Any]):
 
     def __get__(self, instance: object, owner: object):
         return self.fget(owner)
+
+
+def _get_doc(enum: type[Any], member: str):
+    src = getsource(enum)
+    member_pointer = src.find(member)
+    docstr_start = member_pointer + src[member_pointer:].find('"""') + 3
+    docstr_end = docstr_start + src[docstr_start:].find('"""')
+    return src[docstr_start:docstr_end]
+
+
+class MessageEnum(Enum):
+    """Enum subclass allowing you to access the docstring of the members of your
+    enum through the ``message`` property.
+
+    Example:
+        >>> class A(MessageEnum):
+        ...     '''an enum'''
+        ...     VALUE1 = auto()
+        ...     '''member VALUE1'''
+        ...     VALUE2 = auto()
+        ...     '''member VALUE2'''
+        >>> A.VALUE1.message
+        'member VALUE2'
+
+    """
+
+    message: str
+
+    def __init__(self, *args: Any, **kwds: dict[str, Any]) -> None:
+        super().__init__(*args, **kwds)
+        for member in type(self).__members__:
+            type(self).__members__[member].message = _get_doc(type(self), member)