lamindb_setup 0.77.0__tar.gz → 0.77.1__tar.gz

{lamindb_setup-0.77.0 → lamindb_setup-0.77.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lamindb_setup
-Version: 0.77.0
+Version: 0.77.1
 Summary: Setup & configure LaminDB.
 Author-email: Lamin Labs <open-source@lamin.ai>
 Description-Content-Type: text/markdown

{lamindb_setup-0.77.0 → lamindb_setup-0.77.1}/lamindb_setup/__init__.py

@@ -34,7 +34,7 @@ Modules & settings:
 
 """
 
-__version__ = "0.77.0"  # denote a release candidate for 0.1.0 with 0.1rc1
+__version__ = "0.77.1"  # denote a release candidate for 0.1.0 with 0.1rc1
 
 import os as _os
 import sys as _sys
@@ -45,6 +45,7 @@ from ._close import close
 from ._connect_instance import connect, load
 from ._delete import delete
 from ._django import django
+from ._entry_points import call_registered_entry_points as _call_registered_entry_points
 from ._init_instance import init
 from ._migrate import migrate
 from ._register_instance import register
@@ -68,4 +69,7 @@ if _os.name == "nt":
 
         threading.excepthook = _except_hook
 
+# provide a way for other packages to run custom code on import
+_call_registered_entry_points("lamindb_setup.on_import")
+
 settings.__doc__ = """Global :class:`~lamindb.setup.core.SetupSettings`."""

lamindb_setup-0.77.1/lamindb_setup/_entry_points.py

@@ -0,0 +1,22 @@
+import sys
+import warnings
+from importlib.metadata import entry_points
+
+
+def call_registered_entry_points(group, **kwargs):
+    """load and call entry points registered under group."""
+    if sys.version_info >= (3, 10):
+        eps = entry_points(group=group)
+    else:
+        eps = entry_points().get(group, [])
+
+    for ep in eps:
+        func = ep.load()
+        try:
+            func(**kwargs)
+        except BaseException as e:
+            warnings.warn(
+                f"Error loading entry point of group {group!r}: {ep} -> {e}",
+                RuntimeWarning,
+                stacklevel=2,
+            )

lamindb_setup-0.77.1/tests/storage/test_entry_point.py

@@ -0,0 +1,76 @@
+import shlex
+import subprocess
+import sys
+
+import pytest
+
+pyproject_toml = """\
+[project]
+name = "my_custom_module"
+version = "0.0.1"
+
+# pyproject.toml
+[project.entry-points."lamindb_setup.on_import"]
+my_custom_function = "my_custom_module:my_custom_function"
+"""
+
+my_custom_module = """\
+import os
+
+def my_custom_function():
+    os.environ["MY_CUSTOM_ENV_VAR"] = "1"
+"""
+
+
+@pytest.fixture
+def installed_custom_module(tmp_path):
+    (tmp_path / "pyproject.toml").write_text(pyproject_toml)
+    (tmp_path / "my_custom_module.py").write_text(my_custom_module)
+    cmd_install = [sys.executable, "-m", "pip", "install", str(tmp_path)]
+    cmd_cleanup = [sys.executable, "-m", "pip", "uninstall", "my_custom_module", "-y"]
+
+    subprocess.run(shlex.join(cmd_install), shell=True, check=True)
+    try:
+        yield
+    finally:
+        subprocess.run(shlex.join(cmd_cleanup), shell=True, check=True)
+
+
+@pytest.mark.parametrize(
+    "output,install_custom",
+    [
+        pytest.param(b"0", False, id="no-entry-point"),
+        pytest.param(b"1", True, id="with-entry-point"),
+    ],
+)
+def test_on_import_entry_point(output, install_custom, request):
+    if install_custom:
+        request.getfixturevalue("installed_custom_module")
+
+    cmd = [
+        sys.executable,
+        "-c",
+        "import lamindb_setup; import os; print(os.environ.get('MY_CUSTOM_ENV_VAR', '0'), end='')",
+    ]
+    out = subprocess.run(
+        shlex.join(cmd),
+        shell=True,
+        capture_output=True,
+        env={"PYTHONWARNINGS": "error"},
+    )
+    assert out.returncode == 0
+    assert out.stderr == b""
+    assert out.stdout == output
+
+
+def test_call_registered_entry_points(installed_custom_module):
+    from lamindb_setup._entry_points import call_registered_entry_points
+
+    call_registered_entry_points("lamindb_setup.on_import")
+
+
+def test_broken_entry_points_does_not_crash(installed_custom_module):
+    from lamindb_setup._entry_points import call_registered_entry_points
+
+    with pytest.warns(RuntimeWarning, match="Error loading entry point"):
+        call_registered_entry_points("lamindb_setup.on_import", broken_kwarg=object())