lamindb_setup 1.7.0__tar.gz → 1.7.2__tar.gz

{lamindb_setup-1.7.0 → lamindb_setup-1.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: lamindb_setup
-Version: 1.7.0
+Version: 1.7.2
 Summary: Setup & configure LaminDB.
 Author-email: Lamin Labs <open-source@lamin.ai>
 Requires-Python: >=3.10

{lamindb_setup-1.7.0 → lamindb_setup-1.7.2}/docs/hub-cloud/08-test-multi-session.ipynb

@@ -54,15 +54,6 @@
     "ln_setup.init(storage=\"./testsetup\")"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "assert ln_setup.settings.instance.slug == \"testuser1/testsetup\""
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -120,7 +111,43 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Connect to another instance in the same process:"
+    "Let us try to init another instance in the same Python session:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from lamindb_setup._init_instance import CannotSwitchDefaultInstance\n",
+    "\n",
+    "with pytest.raises(CannotSwitchDefaultInstance):\n",
+    "    ln_setup.init(storage=\"./testsetup2\")\n",
+    "with pytest.raises(CannotSwitchDefaultInstance):\n",
+    "    ln_setup.connect(\"testsetup\")\n",
+    "with pytest.raises(RuntimeError):\n",
+    "    ln_setup.migrate.create()\n",
+    "with pytest.raises(RuntimeError):\n",
+    "    ln_setup.migrate.deploy()\n",
+    "\n",
+    "assert ln_setup.settings.instance.slug == \"testuser1/testsetup\""
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Reset `django` and connect to another instance:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "ln_setup.core.django.reset_django()"
    ]
   },
   {

{lamindb_setup-1.7.0 → lamindb_setup-1.7.2}/lamindb_setup/__init__.py

@@ -35,7 +35,7 @@ Modules & settings:
 
 """
 
-__version__ = "1.7.0"  # denote a release candidate for 0.1.0 with 0.1rc1
+__version__ = "1.7.2"  # denote a release candidate for 0.1.0 with 0.1rc1
 
 import os
 

{lamindb_setup-1.7.0 → lamindb_setup-1.7.2}/lamindb_setup/_connect_instance.py

@@ -9,7 +9,10 @@ from lamin_utils import logger
 
 from ._check_setup import _check_instance_setup, _get_current_instance_settings
 from ._disconnect import disconnect
-from ._init_instance import load_from_isettings
+from ._init_instance import (
+    MESSAGE_CANNOT_SWITCH_DEFAULT_INSTANCE,
+    load_from_isettings,
+)
 from ._silence_loggers import silence_loggers
 from .core._hub_core import connect_instance_hub
 from .core._hub_utils import (
@@ -238,9 +241,9 @@ def connect(instance: str | None = None, **kwargs: Any) -> str | tuple | None:
                     logger.important(f"connected lamindb: {settings.instance.slug}")
                     return None
                 else:
-                    from lamindb_setup.core.django import reset_django
-
-                    reset_django()
+                    raise CannotSwitchDefaultInstance(
+                        MESSAGE_CANNOT_SWITCH_DEFAULT_INSTANCE
+                    )
             elif (
                 _write_settings
                 and settings._instance_exists

{lamindb_setup-1.7.0 → lamindb_setup-1.7.2}/lamindb_setup/_init_instance.py

@@ -98,24 +98,24 @@ def register_initial_records(isettings: InstanceSettings, usettings: UserSetting
 
     try:
         Space.objects.get_or_create(
-            uid="a",
+            uid=12 * "a",
             name="all",
             description="Every team & user with access to the instance has access.",
         )
         Branch.objects.get_or_create(
             id=-1,
-            uid="t",
+            uid=12 * "t",
             name="trash",
             description="The trash.",
         )
         Branch.objects.get_or_create(
             id=0,
-            uid="a",
+            uid=12 * "a",
             name="archive",
             description="The archive.",
         )
         Branch.objects.get_or_create(
-            uid="m",
+            uid=12 * "m",
             name="main",
             description="The main & default branch of the instance.",
         )
@@ -215,6 +215,16 @@ def validate_init_args(
     return name_str, instance_id, instance_state, instance_slug
 
 
+MESSAGE_CANNOT_SWITCH_DEFAULT_INSTANCE = """
+You cannot write to different instances in the same Python session.
+
+Do you want to read from another instance via `SQLRecord.using()`? For example:
+
+ln.Artifact.using("laminlabs/cellxgene").filter()
+
+Or do you want to switch off auto-connect via `lamin settings set auto-connect false`?
+"""
+
 DOC_STORAGE_ARG = "A local or remote folder (`'s3://...'` or `'gs://...'`). Defaults to current working directory."
 DOC_INSTANCE_NAME = (
     "Instance name. If not passed, it will equal the folder name passed to `storage`."
@@ -262,9 +272,7 @@ def init(
         from ._check_setup import _check_instance_setup
 
         if _check_instance_setup() and not _test:
-            from lamindb_setup.core.django import reset_django
-
-            reset_django()
+            raise CannotSwitchDefaultInstance(MESSAGE_CANNOT_SWITCH_DEFAULT_INSTANCE)
         elif _write_settings:
             disconnect(mute=True)
         from .core._hub_core import init_instance_hub

{lamindb_setup-1.7.0 → lamindb_setup-1.7.2}/lamindb_setup/core/_hub_client.py

@@ -70,7 +70,7 @@ def connect_hub(
         # increase to avoid rare timeouts for edge functions
         client_options = ClientOptions(
             auto_refresh_token=False,
-            function_client_timeout=20,
+            function_client_timeout=30,
             postgrest_client_timeout=20,
         )
     return create_client(env.supabase_api_url, env.supabase_anon_key, client_options)

{lamindb_setup-1.7.0 → lamindb_setup-1.7.2}/lamindb_setup/core/_hub_core.py

@@ -380,14 +380,16 @@ def _connect_instance_hub(
             .data
         )
         if len(data) != 0 and (instance_data := data[0]["instance"]) is not None:
-            new_name = instance_data["name"]  # the instance was renamed
-            logger.warning(
-                f"'{owner}/{name}' was renamed, please use '{owner}/{new_name}'"
-            )
-            response = client.functions.invoke(
-                "get-instance-settings-v1",
-                invoke_options={"body": {"owner": owner, "name": new_name}},
-            )
+            new_name = instance_data["name"]
+            # the instance was renamed
+            if new_name != name:
+                logger.warning(
+                    f"'{owner}/{name}' was renamed, please use '{owner}/{new_name}'"
+                )
+                response = client.functions.invoke(
+                    "get-instance-settings-v1",
+                    invoke_options={"body": {"owner": owner, "name": new_name}},
+                )
     # no instance found, check why is that
     if response == b"{}":
         # try the via single requests, will take more time

{lamindb_setup-1.7.0 → lamindb_setup-1.7.2}/lamindb_setup/core/_settings.py

@@ -22,6 +22,8 @@ from .upath import LocalPathClasses, UPath
 if TYPE_CHECKING:
     from pathlib import Path
 
+    from lamindb.models import Branch, Space
+
     from lamindb_setup.core import InstanceSettings, StorageSettings, UserSettings
     from lamindb_setup.types import UPathStr
 
@@ -54,6 +56,8 @@ class SetupSettings:
     _instance_settings_env: str | None = None
 
     _auto_connect_path: Path = settings_dir / "auto_connect"
+    _branch_path: Path = settings_dir / "branch_uid.txt"
+    _space_path: Path = settings_dir / "space_uid.txt"
     _private_django_api_path: Path = settings_dir / "private_django_api"
 
     _cache_dir: Path | None = None
@@ -91,6 +95,58 @@ class SetupSettings:
         else:
             self._auto_connect_path.unlink(missing_ok=True)
 
+    @property
+    def branch(self) -> Branch:
+        """Default branch."""
+        from lamindb import Branch
+
+        idlike: str | int = 1
+        if self._branch_path.exists():
+            idlike = self._branch_path.read_text()
+        return Branch.get(idlike)
+
+    @branch.setter
+    def branch(self, value: str | Branch) -> None:
+        from lamindb import Branch, Q
+        from lamindb.errors import DoesNotExist
+
+        if isinstance(value, Branch):
+            assert value._state.adding is False, "Branch must be saved"
+            branch_record = value
+        else:
+            branch_record = Branch.filter(Q(name=value) | Q(uid=value)).one_or_none()
+            if branch_record is None:
+                raise DoesNotExist(
+                    f"Branch '{value}', please check on the hub UI whether you have the correct `uid` or `name`."
+                )
+        self._branch_path.write_text(branch_record.uid)
+
+    @property
+    def space(self) -> Space:
+        """Default space."""
+        from lamindb import Space
+
+        idlike: str | int = 1
+        if self._space_path.exists():
+            idlike = self._space_path.read_text()
+        return Space.get(idlike)
+
+    @space.setter
+    def space(self, value: str | Space) -> None:
+        from lamindb import Q, Space
+        from lamindb.errors import DoesNotExist
+
+        if isinstance(value, Space):
+            assert value._state.adding is False, "Space must be saved"
+            space_record = value
+        else:
+            space_record = Space.filter(Q(name=value) | Q(uid=value)).one_or_none()
+            if space_record is None:
+                raise DoesNotExist(
+                    f"Space '{value}', please check on the hub UI whether you have the correct `uid` or `name`."
+                )
+        self._space_path.write_text(space_record.uid)
+
     @property
     def is_connected(self) -> bool:
         """Determine whether the current instance is fully connected and ready to use.
@@ -205,16 +261,22 @@ class SetupSettings:
         # do not show current setting representation when building docs
         if "sphinx" in sys.modules:
             return object.__repr__(self)
-        repr = f"Auto-connect in Python: {self.auto_connect}\n"
-        repr += f"Private Django API: {self.private_django_api}\n"
-        repr += f"Cache directory: {self.cache_dir.as_posix()}\n"
-        repr += f"User settings directory: {settings_dir.as_posix()}\n"
-        repr += f"System settings directory: {system_settings_dir.as_posix()}\n"
-        repr += self.user.__repr__() + "\n"
+        repr = ""
         if self._instance_exists:
+            repr += "Current branch & space:\n"
+            repr += f" - branch: {self.branch.name}\n"
+            repr += f" - space: {self.space.name}\n"
             repr += self.instance.__repr__()
         else:
-            repr += "\nNo instance connected"
+            repr += "Current instance: None"
+        repr += "\nConfig:\n"
+        repr += f" - auto-connect in Python: {self.auto_connect}\n"
+        repr += f" - private Django API: {self.private_django_api}\n"
+        repr += "Local directories:\n"
+        repr += f" - cache: {self.cache_dir.as_posix()}\n"
+        repr += f" - user settings: {settings_dir.as_posix()}\n"
+        repr += f" - system settings: {system_settings_dir.as_posix()}\n"
+        repr += self.user.__repr__()
         return repr
 
 

{lamindb_setup-1.7.0 → lamindb_setup-1.7.2}/lamindb_setup/core/_settings_instance.py

@@ -97,13 +97,13 @@ class InstanceSettings:
 
     def __repr__(self):
         """Rich string representation."""
-        representation = f"Current instance: {self.slug}"
-        attrs = ["owner", "name", "storage", "db", "modules", "git_repo"]
+        representation = "Current instance:"
+        attrs = ["slug", "storage", "db", "modules", "git_repo"]
         for attr in attrs:
             value = getattr(self, attr)
             if attr == "storage":
-                representation += f"\n- storage root: {value.root_as_str}"
-                representation += f"\n- storage region: {value.region}"
+                representation += f"\n - storage root: {value.root_as_str}"
+                representation += f"\n - storage region: {value.region}"
             elif attr == "db":
                 if self.dialect != "sqlite":
                     model = LaminDsnModel(db=value)
@@ -117,11 +117,11 @@ class InstanceSettings:
                     )
                 else:
                     db_print = value
-                representation += f"\n- {attr}: {db_print}"
+                representation += f"\n - {attr}: {db_print}"
             elif attr == "modules":
-                representation += f"\n- {attr}: {value if value else '{}'}"
+                representation += f"\n - {attr}: {value if value else '{}'}"
             else:
-                representation += f"\n- {attr}: {value}"
+                representation += f"\n - {attr}: {value}"
         return representation
 
     @property

{lamindb_setup-1.7.0 → lamindb_setup-1.7.2}/lamindb_setup/core/_settings_user.py

@@ -38,11 +38,11 @@ class UserSettings:
 
     def __repr__(self) -> str:
         """Rich string representation."""
-        representation = f"Current user: {self.handle}"
+        representation = "Current user:"
         attrs = ["handle", "email", "uid"]
         for attr in attrs:
             value = getattr(self, attr)
-            representation += f"\n- {attr}: {value}"
+            representation += f"\n - {attr}: {value}"
         return representation
 
     @property

{lamindb_setup-1.7.0 → lamindb_setup-1.7.2}/tests/hub-prod/test_global_settings.py

@@ -4,6 +4,7 @@ import subprocess
 from pathlib import Path
 
 import lamindb_setup as ln_setup
+import pytest
 from lamindb_setup.core.hashing import hash_dir
 
 
@@ -16,6 +17,30 @@ def test_auto_connect():
     ln_setup.settings.auto_connect = current_state
 
 
+def test_branch():
+    import lamindb as ln
+
+    ln_setup.settings._branch_path.unlink(missing_ok=True)
+    assert ln_setup.settings.branch.uid == 12 * "m"
+    ln_setup.settings.branch = "archive"
+    assert ln_setup.settings._branch_path.read_text() == 12 * "a"
+    ln_setup.settings.branch = "main"
+    assert ln_setup.settings._branch_path.read_text() == 12 * "m"
+    with pytest.raises(ln.errors.DoesNotExist):
+        ln_setup.settings.branch = "not_exists"
+
+
+def test_space():
+    import lamindb as ln
+
+    ln_setup.settings._space_path.unlink(missing_ok=True)
+    assert ln_setup.settings.space.uid == 12 * "a"
+    ln_setup.settings.space = "all"
+    assert ln_setup.settings._space_path.read_text() == 12 * "a"
+    with pytest.raises(ln.errors.DoesNotExist):
+        ln_setup.settings.space = "not_exists"
+
+
 def test_private_django_api():
     from django import db