Merge pull request #17381 from nsoranzo/17367_followup

More specific type annotation for ``BaseJobExec.parse_status()``
galaxyproject · Jan 31, 2024 · fa670f8 · fa670f8
2 parents da12de9 + dad746e
commit fa670f8
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/lib/galaxy/jobs/runners/util/cli/job/__init__.py b/lib/galaxy/jobs/runners/util/cli/job/__init__.py
@@ -11,10 +11,12 @@
     List,
 )
 
+from typing_extensions import TypeAlias
+
 try:
     from galaxy.model import Job
 
-    job_states = Job.states
+    job_states: TypeAlias = Job.states
 except ImportError:
     # Not in Galaxy, map Galaxy job states to Pulsar ones.
     class job_states(str, Enum):  # type: ignore[no-redef]
@@ -64,13 +66,13 @@ def get_single_status(self, job_id):
         """
 
     @abstractmethod
-    def parse_status(self, status: str, job_ids: List[str]) -> Dict[str, str]:
+    def parse_status(self, status: str, job_ids: List[str]) -> Dict[str, job_states]:
         """
         Parse the statuses of output from get_status command.
         """
 
     @abstractmethod
-    def parse_single_status(self, status, job_id):
+    def parse_single_status(self, status: str, job_id: str) -> job_states:
         """
         Parse the status of output from get_single_status command.
         """

diff --git a/lib/galaxy/jobs/runners/util/cli/job/torque.py b/lib/galaxy/jobs/runners/util/cli/job/torque.py
@@ -100,7 +100,7 @@ def parse_single_status(self, status, job_id):
         # no state found, job has exited
         return job_states.OK
 
-    def _get_job_state(self, state: str) -> str:
+    def _get_job_state(self, state: str) -> job_states:
         try:
             return {"E": job_states.RUNNING, "R": job_states.RUNNING, "Q": job_states.QUEUED, "C": job_states.OK}[state]
         except KeyError:

diff --git a/lib/galaxy/model/__init__.py b/lib/galaxy/model/__init__.py
@@ -111,6 +111,7 @@
 from typing_extensions import (
     Literal,
     Protocol,
+    TypeAlias,
     TypedDict,
 )
 
@@ -1380,7 +1381,7 @@ class Job(Base, JobLike, UsesCreateAndUpdateTime, Dictifiable, Serializable):
     _numeric_metric = JobMetricNumeric
     _text_metric = JobMetricText
 
-    states = JobState
+    states: TypeAlias = JobState
 
     # states that are not expected to change, except through admin action or re-scheduling
     terminal_states = [states.OK, states.ERROR, states.DELETED]