correct implem for mpi4py and medcoupling type hints

Author: roland-lenain

.pylintrc

@@ -550,5 +550,5 @@ preferred-modules=
 
 # Exceptions that will emit a warning when being caught. Defaults to
 # "BaseException, Exception".
-overgeneral-exceptions=BaseException,
-                       Exception
+overgeneral-exceptions=builtins.BaseException,
+                       builtins.Exception

src/icoco/problem.py

@@ -10,17 +10,27 @@
 
 This module contains the API for ICoCo specifications
 """
-
+from __future__ import annotations
 from abc import ABC, abstractmethod
 from enum import Enum
-from typing import List, Tuple
+from typing import TYPE_CHECKING, List, Tuple
 
-# from .utils import MPIComm, medcoupling  # type: ignore
-from .utils import medcoupling  # type: ignore
 from .exception import NotImplementedMethod
 from .version import get_icoco_version, get_version_int
 
 
+if TYPE_CHECKING:  # pragma: no cover
+    class medcoupling:  # pylint: disable=too-few-public-methods, invalid-name
+        """dummy class for type hinting"""
+        class MEDCouplingFieldDouble:  # pylint: disable=too-few-public-methods
+            """dummy class for MEDCouplingFieldDouble type hinting"""
+        class MEDCouplingFieldInt:  # pylint: disable=too-few-public-methods
+            """dummy class for MEDCouplingFieldInt type hinting"""
+        class MEDCouplingField:  # pylint: disable=too-few-public-methods
+            """dummy class for MEDCouplingField type hinting"""
+    from mpi4py.MPI import Intracomm as MPIComm  # type: ignore  # pylint: disable=unused-import
+
+
 ICOCO_VERSION = get_icoco_version()
 """ICoCo version as 'X.Y'."""
 ICOCO_MAJOR_VERSION = int(get_version_int()[0])
@@ -115,7 +125,7 @@ def setDataFile(self, datafile: str) -> None:
         raise NotImplementedMethod(prob=f"{self.__class__.__module__}.{self.__class__.__name__}",
                                    method="setDataFile")
 
-    def setMPIComm(self, mpicomm: 'MPIComm') -> None:  # noqa: F821
+    def setMPIComm(self, mpicomm: MPIComm) -> None:  # noqa: F821
         """(Optional) Provide the MPI communicator to be used by the code for parallel computations.
 
         This method must be called before initialize(). The communicator should include all the

src/icoco/utils.py

@@ -9,30 +9,6 @@
 """
 
 
-try:
-    import medcoupling  # pylint: disable=unused-import
-except ImportError:  # pragma: no cover
-    import warnings
-    warnings.warn(message="medcoupling module not found",
-                  category=ImportWarning)
-
-    class medcoupling:  # pylint: disable=too-few-public-methods, invalid-name
-        """dummy class for type hinting"""
-        class MEDCouplingFieldDouble:  # pylint: disable=too-few-public-methods
-            """dummy class for MEDCouplingFieldDouble type hinting"""
-        class MEDCouplingFieldInt:  # pylint: disable=too-few-public-methods
-            """dummy class for MEDCouplingFieldInt type hinting"""
-        class MEDCouplingField:  # pylint: disable=too-few-public-methods
-            """dummy class for MEDCouplingField type hinting"""
-
-
-# try:
-#     from mpi4py.MPI import Intracomm as MPIComm  # type: ignore  # pylint: disable=unused-import
-# except ModuleNotFoundError:  # pragma: no cover
-#     class MPIComm:  # pylint: disable=too-few-public-methods
-#         """Basic class for type hinting when mi4py is not available"""
-
-
 class ICoCoMethods:  # pylint: disable=too-few-public-methods
     """Namespace to list all ICoCo methods."""
 

tests/test_problem.py

@@ -7,6 +7,7 @@
 import pytest
 
 import icoco
+import icoco.utils
 
 
 def test_version():
@@ -28,6 +29,23 @@ def test_version():
     assert icoco.ValueType.String.name == "String"
 
 
+def test_utils():
+    """Tests utils"""
+
+    assert len(icoco.utils.ICoCoMethods.PROBLEM) == 4
+    assert len(icoco.utils.ICoCoMethods.TIME_STEP) == 11
+    assert len(icoco.utils.ICoCoMethods.RESTORE) == 3
+    assert len(icoco.utils.ICoCoMethods.IO_FIELD) == 19
+    assert len(icoco.utils.ICoCoMethods.IO_VALUE) == 10
+    assert len(icoco.utils.ICoCoMethods.ALL) == 48
+
+    assert len(icoco.utils.ICoCoMethodContext.ONLY_BEFORE_INITIALIZE) == 3
+    assert len(icoco.utils.ICoCoMethodContext.ONLY_AFTER_INITIALIZE ) == (
+        len(icoco.utils.ICoCoMethods.ALL) - 6)
+    assert len(icoco.utils.ICoCoMethodContext.ONLY_INSIDE_TIME_STEP_DEFINED) == 4
+    assert len(icoco.utils.ICoCoMethodContext.ONLY_OUTSIDE_TIME_STEP_DEFINED) == 8
+
+
 def test_static_methods():
     """Tests static methods of the package"""
 

tests/test_utils.py

@@ -0,0 +1,23 @@
+"""test icoco.utils module"""
+import icoco.utils
+
+
+def test_utils_icoco_methods():
+    """Tests ICoCoMethods"""
+
+    assert len(icoco.utils.ICoCoMethods.PROBLEM) == 4
+    assert len(icoco.utils.ICoCoMethods.TIME_STEP) == 11
+    assert len(icoco.utils.ICoCoMethods.RESTORE) == 3
+    assert len(icoco.utils.ICoCoMethods.IO_FIELD) == 19
+    assert len(icoco.utils.ICoCoMethods.IO_VALUE) == 10
+    assert len(icoco.utils.ICoCoMethods.ALL) == 48
+
+
+def test_utils_icoco_method_context():
+    """Tests ICoCoMethodContext"""
+
+    assert len(icoco.utils.ICoCoMethodContext.ONLY_BEFORE_INITIALIZE) == 3
+    assert len(icoco.utils.ICoCoMethodContext.ONLY_AFTER_INITIALIZE ) == (
+        len(icoco.utils.ICoCoMethods.ALL) - 6)
+    assert len(icoco.utils.ICoCoMethodContext.ONLY_INSIDE_TIME_STEP_DEFINED) == 4
+    assert len(icoco.utils.ICoCoMethodContext.ONLY_OUTSIDE_TIME_STEP_DEFINED) == 8