multi-agent-rlenv 3.6.0__tar.gz → 3.6.1__tar.gz

{multi_agent_rlenv-3.6.0 → multi_agent_rlenv-3.6.1}/.github/workflows/docs.yaml

@@ -2,12 +2,10 @@
 name: Deploy static content to Pages
 
 on:
-  # Runs on pushes targeting the default branch
   push:
     branches: ["main", "master"]
-    # Only deploy the documentation on new version tags
     tags:
-        - 'v[0-9]+.[0-9]+.[0-9]+'
+      - 'v*.*.*'
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:

{multi_agent_rlenv-3.6.0 → multi_agent_rlenv-3.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: multi-agent-rlenv
-Version: 3.6.0
+Version: 3.6.1
 Summary: A strongly typed Multi-Agent Reinforcement Learning framework
 Project-URL: repository, https://github.com/yamoling/multi-agent-rlenv
 Author-email: Yannick Molinghen <yannick.molinghen@ulb.be>

{multi_agent_rlenv-3.6.0 → multi_agent_rlenv-3.6.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "multi-agent-rlenv"
-version = "3.6.0"
+version = "3.6.1"
 description = "A strongly typed Multi-Agent Reinforcement Learning framework"
 authors = [
     { "name" = "Yannick Molinghen", "email" = "yannick.molinghen@ulb.be" },

{multi_agent_rlenv-3.6.0 → multi_agent_rlenv-3.6.1}/src/marlenv/adapters/__init__.py

@@ -1,25 +1,25 @@
 from importlib.util import find_spec
 from .pymarl_adapter import PymarlAdapter
-from marlenv.utils import DummyClass, dummy_function
+from marlenv.utils import dummy_type, dummy_function
 
 HAS_GYM = find_spec("gymnasium") is not None
 if HAS_GYM:
     from .gym_adapter import Gym, make
 else:
-    Gym = DummyClass("gymnasium")
+    Gym = dummy_type("gymnasium")
     make = dummy_function("gymnasium")
 
 HAS_PETTINGZOO = find_spec("pettingzoo") is not None
 if HAS_PETTINGZOO:
     from .pettingzoo_adapter import PettingZoo
 else:
-    PettingZoo = DummyClass("pettingzoo")
+    PettingZoo = dummy_type("pettingzoo")
 
 HAS_SMAC = find_spec("smac") is not None
 if HAS_SMAC:
     from .smac_adapter import SMAC
 else:
-    SMAC = DummyClass("smac", "https://github.com/oxwhirl/smac.git")
+    SMAC = dummy_type("smac", "https://github.com/oxwhirl/smac.git")
 
 __all__ = [
     "PymarlAdapter",

{multi_agent_rlenv-3.6.0 → multi_agent_rlenv-3.6.1}/src/marlenv/catalog/__init__.py

@@ -1,5 +1,5 @@
 from importlib.util import find_spec
-from ..utils.import_placeholders import DummyClass
+from ..utils.import_placeholders import dummy_type
 from marlenv.adapters import SMAC
 from .deepsea import DeepSea
 
@@ -8,13 +8,13 @@ HAS_LLE = find_spec("lle") is not None
 if HAS_LLE:
     from lle import LLE  # pyright: ignore[reportMissingImports]
 else:
-    LLE = DummyClass("lle", "laser-learning-environment")
+    LLE = dummy_type("lle", "laser-learning-environment")
 
 HAS_OVERCOOKED = find_spec("overcooked") is not None
 if HAS_OVERCOOKED:
     from overcooked import Overcooked  # pyright: ignore[reportMissingImports]
 else:
-    Overcooked = DummyClass("overcooked", "overcooked")
+    Overcooked = dummy_type("overcooked", "overcooked")
 
 __all__ = [
     "Overcooked",

{multi_agent_rlenv-3.6.0 → multi_agent_rlenv-3.6.1}/src/marlenv/utils/__init__.py

@@ -1,6 +1,6 @@
 from .cached_property_collector import CachedPropertyCollector, CachedPropertyInvalidator
 from .schedule import ExpSchedule, LinearSchedule, MultiSchedule, RoundedSchedule, Schedule
-from .import_placeholders import DummyClass, dummy_function
+from .import_placeholders import dummy_function, dummy_type
 
 __all__ = [
     "Schedule",
@@ -10,6 +10,6 @@ __all__ = [
     "RoundedSchedule",
     "CachedPropertyCollector",
     "CachedPropertyInvalidator",
-    "DummyClass",
     "dummy_function",
+    "dummy_type",
 ]

multi_agent_rlenv-3.6.1/src/marlenv/utils/import_placeholders.py

@@ -0,0 +1,30 @@
+from typing import Optional, Any
+from types import SimpleNamespace
+
+
+def _raise_error(module_name: str, package_name: Optional[str] = None):
+    raise ImportError(
+        f"The optional dependency `{module_name}` is not installed.\nInstall the `{package_name}` package (e.g. pip install {package_name})."
+    )
+
+
+def dummy_type(module_name: str, package_name: Optional[str] = None):
+    class DummyType(type):
+        def __getattr__(cls, _) -> Any:
+            _raise_error(module_name, package_name)
+
+        def __call__(self, *args: Any, **kwds: Any) -> Any:
+            _raise_error(module_name, package_name)
+
+    class DummyClass(SimpleNamespace, metaclass=DummyType):
+        def __getattr__(self, _) -> Any:
+            _raise_error(module_name, package_name)
+
+    return DummyClass
+
+
+def dummy_function(module_name: str, package_name: Optional[str] = None):
+    def fail(*args, **kwargs) -> Any:
+        _raise_error(module_name, package_name)
+
+    return fail

{multi_agent_rlenv-3.6.0 → multi_agent_rlenv-3.6.1}/tests/test_catalog.py

@@ -1,9 +1,9 @@
 import pytest
 from marlenv import catalog
-from marlenv.utils import DummyClass, dummy_function
+from marlenv.utils import dummy_type, dummy_function
 
-skip_lle = isinstance(catalog.LLE, DummyClass)
-skip_overcooked = isinstance(catalog.Overcooked, DummyClass)
+skip_lle = not catalog.HAS_LLE
+skip_overcooked = not catalog.HAS_OVERCOOKED
 
 
 @pytest.mark.skipif(skip_lle, reason="LLE is not installed")
@@ -16,18 +16,18 @@ def test_overcooked():
     catalog.Overcooked.from_layout("scenario4")
 
 
-def test_dummy_class():
+def test_dummy_type():
     try:
-        x = DummyClass("")
+        x = dummy_type("")
         x.abc
-        assert False, "Expected ImportError upon usage because DummyClass is not installed"
+        assert False, "Expected ImportError upon usage because dummy_type is not installed"
     except ImportError:
         pass
 
     try:
-        x = DummyClass("")
-        x.abc()
-        assert False, "Expected ImportError upon usage because DummyClass is not installed"
+        x = dummy_type("")
+        x.abc()  # type: ignore
+        assert False, "Expected ImportError upon usage because dummy_type is not installed"
     except ImportError:
         pass
 

multi_agent_rlenv-3.6.0/src/marlenv/utils/import_placeholders.py

@@ -1,30 +0,0 @@
-from typing import Optional, Any
-
-
-class DummyClass:
-    def __init__(self, module_name: str, package_name: Optional[str] = None):
-        self.module_name = module_name
-        if package_name is None:
-            self.package_name = module_name
-        else:
-            self.package_name = package_name
-
-    def _raise_error(self):
-        raise ImportError(
-            f"The optional dependency `{self.module_name}` is not installed.\nInstall the `{self.package_name}` package (e.g. pip install {self.package_name})."
-        )
-
-    def __getattr__(self, _):
-        self._raise_error()
-
-    def __call__(self, *args, **kwargs):
-        self._raise_error()
-
-
-def dummy_function(module_name: str, package_name: Optional[str] = None):
-    dummy = DummyClass(module_name, package_name)
-
-    def fail(*args, **kwargs) -> Any:
-        dummy()
-
-    return fail