Add more TypedDict definitions

This commit adds more `TypedDict` definitions for `File`, `Dirent`, and
`Directory` objects. In addition, it adds the `exitCode` entry to the
`CWLRuntimeParameterContext`, which was missing.

Author: GlassOfWhiskey

cwl_utils/expression.py

@@ -125,7 +125,7 @@ def evaluator(
         try:
             if first_symbol in ("inputs", "self", "runtime"):
                 symbol = cast(
-                    Literal["inputs"] | Literal["self"] | Literal["runtime"],
+                    Literal["inputs", "self", "runtime"],
                     first_symbol,
                 )
                 if inspect.iscoroutinefunction(js_engine.regex_eval):

cwl_utils/types.py

@@ -1,8 +1,15 @@
 # SPDX-License-Identifier: Apache-2.0
 # From https://github.com/rabix/sbpack/blob/b8404a0859ffcbe1edae6d8f934e51847b003320/sbpack/lib.py
 """Shared Python type definitions for commons JSON like CWL objects."""
+import sys
 from collections.abc import MutableMapping, MutableSequence
-from typing import TypeAlias, TypedDict
+from typing import Literal, TypeAlias, TypedDict
+
+if sys.version_info >= (3, 11):
+    from typing import Required
+else:
+    from typing_extensions import Required
+
 
 built_in_types: list[str] = [
     "null",
@@ -21,12 +28,46 @@
 ]
 
 
+DirectoryDict = TypedDict(
+    "DirectoryDict",
+    {
+        "class": Required[Literal["Directory"]],
+        "location": str,
+        "path": str,
+        "basename": str,
+        "listing": MutableSequence["FileDict | DirectoryDict"],
+    },
+    total=False,
+)
+
+
+FileDict = TypedDict(
+    "FileDict",
+    {
+        "class": Required[Literal["File"]],
+        "location": str,
+        "path": str,
+        "basename": str,
+        "dirname": str,
+        "nameroot": str,
+        "nameext": str,
+        "checksum": str,
+        "size": int,
+        "secondaryFiles": MutableSequence["FileDict | DirectoryDict"],
+        "format": str,
+        "contents": str,
+    },
+    total=False,
+)
+
+
 CWLOutputAtomType: TypeAlias = (
     None
     | bool
     | str
     | int
-    | float
+    | FileDict
+    | DirectoryDict
     | MutableSequence["CWLOutputAtomType"]
     | MutableMapping[str, "CWLOutputAtomType"]
 )
@@ -35,6 +76,8 @@
     | str
     | int
     | float
+    | FileDict
+    | DirectoryDict
     | MutableSequence[CWLOutputAtomType]
     | MutableMapping[str, CWLOutputAtomType]
 )
@@ -49,9 +92,16 @@ class CWLRuntimeParameterContext(TypedDict, total=False):
     ram: float | str
     outdirSize: float | str
     tmpdirSize: float | str
+    exitCode: int
 
 
 class CWLParameterContext(TypedDict, total=False):
     inputs: CWLObjectType
     self: CWLOutputType | None
     runtime: CWLRuntimeParameterContext
+
+
+class DirentDict(TypedDict, total=False):
+    entry: Required[str]
+    entryname: str
+    writable: bool