Fix some pylint warnings (except remaining cyclic imports)

Author: PierreRaybaut

cdl/tests/sigima_tests/image_io_formats_test.py

@@ -4,18 +4,26 @@
 Image I/O formats test
 """
 
+# Note about the modules imported outside top-level:
+#
+# We want to keep the import order under control, so we import the modules only when
+# they are needed, especially for the dynamically defined image formats in the `formats`
+# module. This way, we can ensure that the formats are defined just before we use them
+# in the tests. This is particularly useful for testing the `imageio_formats` option
+# that allows users to set custom image I/O formats.
+
 
 def get_image_formats():
     """Get image formats"""
+    # pylint: disable=import-outside-toplevel
     from sigima_.io.image import formats
 
-    return [
-        class_name for class_name in dir(formats) if class_name.endswith("ImageFormat")
-    ]
+    return [clname for clname in dir(formats) if clname.endswith("ImageFormat")]
 
 
 def test_imageio_formats_option():
     """Set other image I/O formats"""
+    # pylint: disable=import-outside-toplevel
     from sigima_.config import options
     from sigima_.io.image import formats
 

cdl/tests/sigima_tests/images/operation_unit_test.py

@@ -152,7 +152,7 @@ def test_image_product() -> None:
 
 
 @pytest.mark.validation
-def test_image_division(request: pytest.FixtureRequest) -> None:
+def test_image_division(request: pytest.FixtureRequest = None) -> None:
     """Image division test."""
     execenv.print("*** Testing image division:")
     for ima1, ima2 in __iterate_image_couples():

sigima_/computation/base.py

@@ -264,6 +264,13 @@ def dst_n_to_1(
     return dst
 
 
+# Note about `src2` parameter:
+# ----------------------------
+# The `src2` parameter is currently not used in the function, but it is included
+# to maintain a consistent interface with other similar functions (e.g., `dst_n_to_1`).
+# This may be useful in the future if we want to extend the functionality.
+#
+# pylint: disable=unused-argument
 def dst_2_to_1(
     src1: SignalObj | ImageObj,
     src2: SignalObj | ImageObj,

sigima_/config.py

@@ -90,15 +90,14 @@ def check(self, value: Any) -> None:  # pylint: disable=unused-argument
             ValueError: If the value is not valid.
         """
         # This method can be overridden in subclasses for specific validation
-        pass
 
     def get(self) -> Any:
         """Return the current value of the option.
 
         Returns:
             The current value of the option.
         """
-        self._container._ensure_loaded_from_env()
+        self._container.ensure_loaded_from_env()
         return self._value
 
     def set(self, value: Any, sync_env: bool = True) -> None:
@@ -111,7 +110,7 @@ def set(self, value: Any, sync_env: bool = True) -> None:
         self.check(value)  # Validate the new value
         self._value = value
         if sync_env:
-            self._container._sync_env()
+            self._container.sync_env()
 
     def context(self, temp_value: Any) -> Generator[None, None, None]:
         """Temporarily override the option within a context.
@@ -218,13 +217,14 @@ def check(self, value: Any) -> None:
                     "Each item must be a tuple of (format, description) as strings"
                 )
 
-    def set(self, value: Any) -> None:
-        """Set the value of the image I/O formats option.
+    def set(self, value: Any, sync_env: bool = True) -> None:
+        """Set the value of the option.
 
         Args:
             value: The new value to assign.
+            sync_env: Whether to synchronize the environment variable.
         """
-        super().set(value)
+        super().set(value, sync_env)
         from sigima_.io.image import formats  # pylint: disable=import-outside-toplevel
 
         # Generate image I/O format classes based on the new value
@@ -285,9 +285,9 @@ def __init__(self) -> None:
 
 .. note::
 
-    The `sigima` library supports any image format that can be read by the
-    `imageio` library, provided that the associated plugin(s) are installed
-    (see `imageio documentation <https://imageio.readthedocs.io/en/stable/formats/index.html>`_)
+    The `sigima` library supports any image format that can be read by the `imageio`
+    library, provided that the associated plugin(s) are installed (see `imageio
+    documentation <https://imageio.readthedocs.io/en/stable/formats/index.html>`_)
     and that the output NumPy array data type and shape are supported by `sigima`.
 
     To add a new file format, you may use the `imageio_formats` option to specify
@@ -330,19 +330,20 @@ def generate_rst_doc(self) -> str:
                 doc += f"      - {opt.description}\n"
         return doc
 
-    def _ensure_loaded_from_env(self) -> None:
+    def ensure_loaded_from_env(self) -> None:
         """Lazy-load from JSON env var on first access."""
         if self._loaded_from_env:
             return
         if self.ENV_VAR in os.environ:
             try:
                 values = json.loads(os.environ[self.ENV_VAR])
                 self.from_dict(values)
-            except Exception as e:
-                print(f"[sigima] Warning: failed to load options from env: {e}")
+            except Exception as exc:  # pylint: disable=broad-except
+                # If loading fails, we just log a warning and continue with defaults
+                print(f"[sigima] Warning: failed to load options from env: {exc}")
         self._loaded_from_env = True
 
-    def _sync_env(self) -> None:
+    def sync_env(self) -> None:
         """Update env var with current option values."""
         os.environ[self.ENV_VAR] = json.dumps(self.to_dict())
 
@@ -369,7 +370,7 @@ def from_dict(self, values: dict[str, Any]) -> None:
                 opt = getattr(self, name)
                 if isinstance(opt, OptionField):
                     opt.set(value, sync_env=False)
-        self._sync_env()
+        self.sync_env()
 
 
 #: Global instance of the options container

sigima_/worker.py

@@ -36,11 +36,9 @@ class CallbackWorkerProtocol(Protocol):
 
     def set_progress(self, value: float) -> None:
         """Update progress (between 0.0 and 1.0)."""
-        ...
 
     def was_canceled(self) -> bool:
         """Check whether the operation has been canceled."""
-        ...
 
 
 class TextCallbackWorker: