added tests for optional dependency checking

Author: tclose

extras/fileformats/extras/core/__init__.py

@@ -1,23 +1,23 @@
 """Only required to hold the automatically generated version for the "core" extras"""
 
+import typing as ty
 import types
 import inspect
 from ._version import __version__
 
 
-def check_optional_dependency(module: types.ModuleType | None) -> None:
+def check_optional_dependency(module: ty.Optional[types.ModuleType]) -> None:
     if module is None:
         frame = inspect.currentframe()
-        prev_frame = None
         while frame:
-            # Find the frame where the extra_implementation method was called
-            if frame.f_code.co_name == "extra_implementation":
-                return frame.f_locals["workflow"]  # local var "workflow" in construct
-            prev_frame = frame
+            # Find the frame where the decorated_extra method was called
+            if frame.f_code.co_name == "decorated_extra":
+                extras_module = frame.f_locals["extras"][0].pkg.split(".")[-1]
+                break
             frame = frame.f_back
         raise ImportError(
-            f"The optional dependency '{module.__name__}' is not installed required to use the "
-            "{} method. It is "
+            f"The optional dependencies are not installed for '{extras_module}', please include it in "
+            f"when installing fileformats-extras, e.g. `pip install 'fileformats-extras[{extras_module}]'`"
         )
 
 

extras/fileformats/extras/core/tests/test_import_check.py

@@ -0,0 +1,10 @@
+from fileformats.testing import MyFormat
+import pytest
+
+
+def test_check_optional_dependency_fail():
+
+    with pytest.raises(
+        ImportError, match="The optional dependencies are not installed for 'testing'"
+    ):
+        MyFormat.sample().dummy_extra()

extras/fileformats/extras/testing/__init__.py

@@ -1,9 +1,12 @@
 from pydra.compose import python
 
-from fileformats.core import converter
-from fileformats.testing import AbstractFile, ConvertibleToFile, EncodedText
+from fileformats.core import converter, extra_implementation
+from fileformats.extras.core import check_optional_dependency
+from fileformats.testing import AbstractFile, ConvertibleToFile, EncodedText, MyFormat
 from fileformats.text import TextFile
 
+dummy_import = None
+
 
 @converter  # pyright: ignore[reportArgumentType]
 @python.define(outputs=["out_file"])  # type: ignore[misc]
@@ -31,3 +34,9 @@ def EncodedToTextConverter(in_file: EncodedText) -> TextFile:
     out_file = TextFile.sample()
     out_file.write_text(decoded_contents)
     return out_file
+
+
+@extra_implementation(MyFormat.dummy_extra)
+def my_format_dummy_extra(my_format: MyFormat) -> int:
+    check_optional_dependency(dummy_import)
+    return 42

fileformats/core/extras.py

@@ -34,7 +34,7 @@ def extra(method: ExtraMethod) -> "ExtraMethod":
     dispatch_method: ty.Callable[..., ty.Any] = functools.singledispatch(method)
 
     @functools.wraps(method)
-    def decorated(obj: DataType, *args: ty.Any, **kwargs: ty.Any) -> ty.Any:
+    def decorated_extra(obj: DataType, *args: ty.Any, **kwargs: ty.Any) -> ty.Any:
         cls = type(obj)
         extras = []
         for tp in cls.referenced_types():  # type: ignore[attr-defined]
@@ -61,8 +61,8 @@ def decorated(obj: DataType, *args: ty.Any, **kwargs: ty.Any) -> ty.Any:
 
     # Store single dispatch method on the decorated function so we can register
     # implementations to it later
-    decorated._dispatch = dispatch_method  # type: ignore[attr-defined]
-    return decorated  # type: ignore[return-value]
+    decorated_extra._dispatch = dispatch_method  # type: ignore[attr-defined]
+    return decorated_extra  # type: ignore[return-value]
 
 
 def extra_implementation(
@@ -78,7 +78,9 @@ def extra_implementation(
             "an implementation"
         )
 
-    def decorator(implementation: ExtraImplementation) -> ExtraImplementation:
+    def extra_implementation_decorator(
+        implementation: ExtraImplementation,
+    ) -> ExtraImplementation:
         msig = inspect.signature(method)
         fsig = inspect.signature(implementation)
         msig_args = list(msig.parameters.values())[1:]
@@ -188,7 +190,7 @@ def type_match(mtype: ty.Union[str, type], ftype: ty.Union[str, type]) -> bool:
         dispatch_method.register(implementation)
         return implementation
 
-    return decorator
+    return extra_implementation_decorator
 
 
 WrappedTask = ty.TypeVar("WrappedTask", bound=ty.Callable[..., ty.Any])

fileformats/core/mixin.py

@@ -773,9 +773,9 @@ class WithOrderedClassifiers(WithClassifiers):
     ordered_classifiers = True
 
 
-def origin_type(tp: ty.Type) -> ty.Type:
+def origin_type(tp: type) -> type:
     """Get the origin type of a possibly generic type"""
-    origin = ty.get_origin(tp)
+    origin: ty.Optional[type] = ty.get_origin(tp)
     if origin is None:
         return tp
-    return origin
+    return origin  # type: ignore[no-any-return]

fileformats/core/utils.py

@@ -280,7 +280,7 @@ def get_optional_type(
     return args[0] if args[0] is not None else args[1]  # type: ignore[no-any-return]
 
 
-def is_union(type_: type, args: list[type] = None) -> bool:
+def is_union(type_: type, args: ty.Optional[ty.List[type]] = None) -> bool:
     """Checks whether a type is a Union, in either ty.Union[T, U] or T | U form
 
     Parameters
@@ -297,6 +297,6 @@ def is_union(type_: type, args: list[type] = None) -> bool:
     """
     if ty.get_origin(type_) in UNION_TYPES:
         if args is not None:
-            return ty.get_args(type_) == args
+            return list(ty.get_args(type_)) == args
         return True
     return False

fileformats/testing/headers.py

@@ -1,3 +1,4 @@
+from fileformats.core import extra
 from fileformats.application import Json
 from fileformats.core.mixin import WithMagicNumber, WithSeparateHeader, WithSideCars
 from fileformats.generic import BinaryFile, UnicodeFile
@@ -21,6 +22,10 @@ class MyFormat(UnicodeFile):
 
     ext = ".my"
 
+    @extra
+    def dummy_extra(self) -> int:  # type: ignore[empty-body]
+        ...  # type: ignore[empty-body]
+
 
 class MyFormatGz(MyFormat):