MNT: Type-annotate Pydra

pydra/engine/core.py

@@ -10,7 +10,7 @@
 from copy import deepcopy
 from uuid import uuid4
 
-import cloudpickle as cp
+import cloudpickle as cp  # type: ignore[import]
 from filelock import SoftFileLock
 import shutil
 from tempfile import mkdtemp

pydra/engine/helpers.py

@@ -2,7 +2,7 @@
 import asyncio
 import asyncio.subprocess as asp
 import attr
-import cloudpickle as cp
+import cloudpickle as cp  # type: ignore[import]
 from pathlib import Path
 from filelock import SoftFileLock, Timeout
 import os

pydra/engine/specs.py

@@ -8,6 +8,8 @@
 
 from .helpers_file import template_update_single
 
+T = ty.TypeVar("T")
+
 
 def attr_fields(spec, exclude_names=()):
     return [field for field in spec.__attrs_attrs__ if field.name not in exclude_names]
@@ -21,15 +23,15 @@ def attr_fields_dict(spec, exclude_names=()):
     }
 
 
-class File:
-    """An :obj:`os.pathlike` object, designating a file."""
+File = ty.NewType("File", Path)
+"""An :obj:`os.pathlike` object, designating a file."""
 
 
-class Directory:
-    """An :obj:`os.pathlike` object, designating a folder."""
+Directory = ty.NewType("Directory", Path)
+"""An :obj:`os.pathlike` object, designating a folder."""
 
 
-class MultiInputObj:
+class MultiInputObj(ty.Generic[T]):
     """A ty.List[ty.Any] object, converter changes a single values to a list"""
 
     @classmethod
@@ -42,7 +44,7 @@ def converter(cls, value):
             return ensure_list(value)
 
 
-class MultiOutputObj:
+class MultiOutputObj(ty.Generic[T]):
     """A ty.List[ty.Any] object, converter changes an 1-el list to the single value"""
 
     @classmethod
@@ -53,11 +55,11 @@ def converter(cls, value):
             return value
 
 
-class MultiInputFile(MultiInputObj):
+class MultiInputFile(MultiInputObj[File]):
     """A ty.List[File] object, converter changes a single file path to a list"""
 
 
-class MultiOutputFile(MultiOutputObj):
+class MultiOutputFile(MultiOutputObj[File]):
     """A ty.List[File] object, converter changes an 1-el list to the single value"""
 
 

pydra/engine/task.py

@@ -41,7 +41,7 @@
 import platform
 import re
 import attr
-import cloudpickle as cp
+import cloudpickle as cp  # type: ignore[import]
 import inspect
 import typing as ty
 import shlex

pydra/engine/tests/test_helpers.py

@@ -5,7 +5,7 @@
 import platform
 
 import pytest
-import cloudpickle as cp
+import cloudpickle as cp  # type: ignore[import]
 
 from .utils import multiply, raise_xeq1
 from ..helpers import (

pydra/engine/tests/test_task.py

@@ -2,7 +2,7 @@
 import os, sys
 import attr
 import pytest
-import cloudpickle as cp
+import cloudpickle as cp  # type: ignore[import]
 from pathlib import Path
 import re
 import json

pydra/utils/messenger.py

@@ -182,7 +182,7 @@ def collect_messages(collected_path, message_path, ld_op="compact"):
         Option used by pld.jsonld
     """
 
-    import pyld as pld
+    import pyld as pld  # type: ignore[import]
     import json
     from glob import glob
 

pyproject.toml

@@ -50,6 +50,7 @@ dask = [
 ]
 dev = [
     "black",
+    "mypy",
     "pre-commit",
     "pydra[test]",
 ]
@@ -101,3 +102,9 @@ exclude = "pydra/_version.py"
 
 [tool.codespell]
 ignore-words = ".codespell-ignorewords"
+
+[tool.mypy]
+warn_unused_configs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+no_implicit_optional = true