lamindb_setup 1.10.2__tar.gz → 1.12.0__tar.gz

{lamindb_setup-1.10.2 → lamindb_setup-1.12.0}/.github/workflows/build.yml

@@ -15,7 +15,7 @@ jobs:
     timeout-minutes: 12
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         with:
           python-version: "3.10"
           cache: "pip"
@@ -52,7 +52,7 @@ jobs:
           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           aws-region: eu-central-1
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
           cache: "pip"
@@ -97,7 +97,7 @@ jobs:
     timeout-minutes: 12
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         with:
           python-version: "3.10"
           cache: "pip"
@@ -139,7 +139,7 @@ jobs:
           echo "AWS_ACCESS_KEY_ID_HOSTED_S3=${{ secrets.AWS_ACCESS_KEY_ID }}" >> .env.local
           echo "AWS_SECRET_ACCESS_KEY_HOSTED_S3=${{ secrets.AWS_SECRET_ACCESS_KEY }}" >> .env.local
         working-directory: laminhub/rest-hub/supabase
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v6
         with:
           python-version: "3.11" # we need to run everything for coverage on 3.11
           cache: "pip"
@@ -168,7 +168,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v6
         with:
           python-version: "3.11"
           cache: "pip"
@@ -205,7 +205,7 @@ jobs:
           ssh-key: ${{ secrets.READ_LNDOCS }}
           path: lndocs
           ref: main
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         with:
           python-version: "3.10"
           cache: "pip"

{lamindb_setup-1.10.2 → lamindb_setup-1.12.0}/.gitignore

@@ -69,6 +69,9 @@ instance/
 # Scrapy stuff:
 .scrapy
 
+# Ruff
+.ruff_cache
+
 # Sphinx documentation
 docs/_build/
 

{lamindb_setup-1.10.2 → lamindb_setup-1.12.0}/.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/rbubley/mirrors-prettier
-    rev: v3.5.1
+    rev: v3.6.2
     hooks:
       - id: prettier
         exclude: |
@@ -17,13 +17,13 @@ repos:
               docs/notes/
           )
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.8.6
+    rev: v0.14.0
     hooks:
-      - id: ruff
+      - id: ruff-check
         args: [--fix, --exit-non-zero-on-fix, --unsafe-fixes]
       - id: ruff-format
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v6.0.0
     hooks:
       - id: detect-private-key
       - id: check-ast
@@ -37,7 +37,7 @@ repos:
       - id: trailing-whitespace
       - id: check-case-conflict
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.7.1
+    rev: v1.18.1
     hooks:
       - id: mypy
         exclude: |

{lamindb_setup-1.10.2 → lamindb_setup-1.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: lamindb_setup
-Version: 1.10.2
+Version: 1.12.0
 Summary: Setup & configure LaminDB.
 Author-email: Lamin Labs <open-source@lamin.ai>
 Requires-Python: >=3.10
@@ -10,10 +10,11 @@ Requires-Dist: django>=5.1,<5.2
 Requires-Dist: dj_database_url>=1.3.0,<3.0.0
 Requires-Dist: pydantic-settings
 Requires-Dist: platformdirs<5.0.0
+Requires-Dist: httpx_retries<1.0.0
 Requires-Dist: requests
 Requires-Dist: universal_pathlib==0.2.6
 Requires-Dist: botocore<2.0.0
-Requires-Dist: supabase>=2.8.1,<=2.15.0
+Requires-Dist: supabase>=2.8.1,<=2.16.0
 Requires-Dist: gotrue<=2.12.0
 Requires-Dist: storage3!=0.11.2; python_version < '3.11'
 Requires-Dist: pyjwt<3.0.0

{lamindb_setup-1.10.2 → lamindb_setup-1.12.0}/docs/hub-cloud/03-add-managed-storage.ipynb

@@ -52,6 +52,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "import os\n",
     "import laminci\n",
     "import pytest\n",
     "from pathlib import Path\n",
@@ -305,6 +306,16 @@
     "Cloud storage:"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "47affaad",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "cloud_storage = f\"s3://lamindb-ci/storage3_{os.getenv('LAMIN_ENV', 'prod')}\""
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -312,7 +323,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "set_managed_storage(\"s3://lamindb-ci/storage3\")"
+    "set_managed_storage(cloud_storage)"
    ]
   },
   {
@@ -327,7 +338,7 @@
    "outputs": [],
    "source": [
     "assert ln_setup.settings.storage.type_is_cloud\n",
-    "assert ln_setup.settings.storage.root_as_str == \"s3://lamindb-ci/storage3\"\n",
+    "assert ln_setup.settings.storage.root_as_str == cloud_storage\n",
     "assert ln_setup.settings.storage.region == \"us-west-1\"\n",
     "assert (\n",
     "    ln_setup.settings.storage.root / \".lamindb/storage_uid.txt\"\n",
@@ -354,7 +365,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "set_managed_storage(\"s3://lamindb-ci/storage3\", cache_regions=False)"
+    "set_managed_storage(cloud_storage, cache_regions=False)"
    ]
   },
   {
@@ -395,71 +406,61 @@
    "id": "83a2ee6b",
    "metadata": {},
    "source": [
-    "Add testuser2 as a collaborator to the instance:"
+    "Add testuser2 as a collaborator to the instance, sign them in and let them add another storage location:"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "9a4029b0",
+   "id": "67e455af",
    "metadata": {},
    "outputs": [],
    "source": [
-    "from laminhub_rest.core.legacy._instance_collaborator import InstanceCollaboratorHandler\n",
-    "from laminhub_rest.core.account import AccountHandler\n",
     "from lamindb_setup.core._hub_client import connect_hub_with_auth\n",
-    "from lamindb.models import User\n",
+    "from laminhub_rest.core._central_client import SupabaseClientWrapper\n",
+    "from laminhub_rest.core.instance_collaborator import InstanceCollaboratorHandler\n",
+    "from laminhub_rest.core.organization import OrganizationMemberHandler\n",
+    "\n",
+    "admin_hub = SupabaseClientWrapper(connect_hub_with_auth())\n",
+    "organization_member_handler = OrganizationMemberHandler(admin_hub)\n",
+    "\n",
+    "assert ln_setup.settings.user.handle == \"testuser1\"\n",
+    "organization_id = ln_setup.settings.user._uuid  # testuser1\n",
     "\n",
-    "admin_hub = connect_hub_with_auth()\n",
-    "testuser2 = AccountHandler(admin_hub).get_by_handle(\"testuser2\")\n",
-    "InstanceCollaboratorHandler(admin_hub).add(\n",
-    "    instance_id=instance_id,\n",
-    "    account_id=testuser2.id,\n",
-    "    role=\"write\",\n",
-    "    schema_id=None,\n",
-    "    skip_insert_user_table=True,\n",
-    ")\n",
-    "User.objects.create(uid=testuser2.lnid, handle=testuser2.handle, name=testuser2.name)\n",
-    "admin_hub.auth.close()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "e9d64cad",
-   "metadata": {},
-   "source": [
-    "Sign them in and let them add another storage location:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "d6915638-db49-4d3d-bd91-819bb4719ef7",
-   "metadata": {},
-   "outputs": [],
-   "source": [
     "ln_setup.login(\"testuser2\")\n",
-    "set_managed_storage(\"./storage4\", host=\"testuser2-laptop\")\n",
-    "assert ln_setup.settings.storage.root_as_str == f\"{Path.cwd()}/storage4\""
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "60ac7cb2",
-   "metadata": {},
-   "source": [
-    "Attempt to delete instance with testuser2:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "6de90900",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "with pytest.raises(PermissionError) as error:\n",
-    "    ln_setup.delete(\"testuser1/test-add-managed-storage\", force=True)"
+    "assert ln_setup.settings.user.handle == \"testuser2\"\n",
+    "account_id = ln_setup.settings.user._uuid\n",
+    "\n",
+    "try:\n",
+    "    organization_member_handler.add(\n",
+    "        organization_id=organization_id,\n",
+    "        account_id=account_id,\n",
+    "        role=\"member\",\n",
+    "    )\n",
+    "    try:\n",
+    "        InstanceCollaboratorHandler(admin_hub).add(\n",
+    "            account_id=account_id,\n",
+    "            instance_id=instance_id,\n",
+    "            role=\"write\",\n",
+    "        )\n",
+    "    except TypeError:\n",
+    "        # the above failes in the mid due to no resource_db_server associated with the instance\n",
+    "        # but still adds the collaborator\n",
+    "        pass\n",
+    "\n",
+    "    # although technically a user doesn't have to be a collaborator to insert into storage table\n",
+    "    set_managed_storage(\"./storage4\", host=\"testuser2-laptop\")\n",
+    "    assert ln_setup.settings.storage.root_as_str == f\"{Path.cwd()}/storage4\"\n",
+    "    # attempt to delete the instance with testuser2\n",
+    "    with pytest.raises(PermissionError) as error:\n",
+    "        ln_setup.delete(\"testuser1/test-add-managed-storage\", force=True)\n",
+    "\n",
+    "finally:\n",
+    "    organization_member_handler.remove(\n",
+    "        organization_id=organization_id,\n",
+    "        account_id=account_id,\n",
+    "    )\n",
+    "    admin_hub.auth.sign_out(options={\"scope\": \"local\"})"
    ]
   },
   {
@@ -510,7 +511,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "py312",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -524,7 +525,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.8"
+   "version": "3.10.16"
   }
  },
  "nbformat": 4,

{lamindb_setup-1.10.2 → lamindb_setup-1.12.0}/docs/hub-cloud/08-test-multi-session.ipynb

@@ -8,10 +8,14 @@
    ]
   },
   {
-   "cell_type": "markdown",
+   "cell_type": "code",
+   "execution_count": null,
    "metadata": {},
+   "outputs": [],
    "source": [
-    "This notebook is complemented by the `faq/setup.ipynb` notebook in lamindb."
+    "!lamin login testuser1\n",
+    "!lamin init --storage \"./testsetup-prepare\"\n",
+    "!lamin disconnect"
    ]
   },
   {
@@ -20,8 +24,16 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "!lamin login testuser1\n",
-    "!lamin init --storage \"./testsetup-prepare\""
+    "import lamindb_setup as ln_setup\n",
+    "import lamindb as ln\n",
+    "import pytest"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "If you try to use lamindb, it will raise an `CurrentInstanceNotConfigured` and ask you to `init` or `connect` an instance via the python API."
    ]
   },
   {
@@ -30,8 +42,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import lamindb_setup as ln_setup\n",
-    "import pytest"
+    "with pytest.raises(ln.setup.errors.CurrentInstanceNotConfigured):\n",
+    "    ln.track()"
    ]
   },
   {
@@ -98,6 +110,71 @@
     "    User.objects.get(handle=\"testuser2\")"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "ln.track()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Let us try connecting to another instance:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "with pytest.raises(ln.setup.errors.CannotSwitchDefaultInstance) as error:\n",
+    "    ln.connect(\"testsetup3\")\n",
+    "assert error.exconly().endswith(\n",
+    "    \"Cannot switch default instance while `ln.track()` is live: call `ln.finish()`\"\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Let us try to init another instance in the same Python session."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "with pytest.raises(ln.setup.errors.CannotSwitchDefaultInstance) as error:\n",
+    "    ln.setup.init(storage=\"./testsetup2\")\n",
+    "assert error.exconly().endswith(\n",
+    "    \"Cannot switch default instance while `ln.track()` is live: call `ln.finish()`\"\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Switch off `ln.track()`."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "ln.context._transform = None"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},

{lamindb_setup-1.10.2 → lamindb_setup-1.12.0}/lamindb_setup/__init__.py

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

{lamindb_setup-1.10.2 → lamindb_setup-1.12.0}/lamindb_setup/_connect_instance.py

@@ -104,6 +104,7 @@ def _connect_instance(
     db: str | None = None,
     raise_permission_error: bool = True,
     use_root_db_user: bool = False,
+    use_proxy_db: bool = False,
     access_token: str | None = None,
 ) -> InstanceSettings:
     settings_file = instance_settings_file(name, owner)
@@ -118,8 +119,7 @@ def _connect_instance(
             if db is not None and isettings.dialect == "postgresql":
                 isettings._db = db
     if make_hub_request:
-        # the following will return a string if the instance does not exist
-        # on the hub
+        # the following will return a string if the instance does not exist on the hub
         # do not call hub if the user is anonymous
         if owner != "anonymous":
             hub_result = connect_instance_hub(
@@ -127,6 +127,7 @@ def _connect_instance(
                 name=name,
                 access_token=access_token,
                 use_root_db_user=use_root_db_user,
+                use_proxy_db=use_proxy_db,
             )
         else:
             hub_result = "anonymous-user"
@@ -192,11 +193,10 @@ def reset_django_module_variables():
     #     import lamindb as ln
     #     ln.connect(...)
     #
-    # Then it will **not** work and the `ln` variable becomes stale and hold a reference
-    # to the old classes
+    # Then it will **not** work and the `ln` variable becomes stale and hold a reference to the old classes
     # Other functions that dynamically import are no problem because the variables
     # are automatically refreshed when the function runs the next time after ln.connect() was called
-    logger.important_hint("resetting django module variables")
+    logger.debug("resetting django module variables")
 
     # django.apps needs to be a local import to refresh variables
     from django.apps import apps
@@ -242,11 +242,15 @@ def reset_django_module_variables():
                 continue
 
 
-def _connect_cli(instance: str, use_root_db_user: bool = False) -> None:
+def _connect_cli(
+    instance: str, use_root_db_user: bool = False, use_proxy_db: bool = False
+) -> None:
     from lamindb_setup import settings as settings_
 
     owner, name = get_owner_name_from_identifier(instance)
-    isettings = _connect_instance(owner, name, use_root_db_user=use_root_db_user)
+    isettings = _connect_instance(
+        owner, name, use_root_db_user=use_root_db_user, use_proxy_db=use_proxy_db
+    )
     isettings._persist(write_to_disk=True)
     if not isettings.is_on_hub or isettings._is_cloud_sqlite:
         # there are two reasons to call the full-blown connect
@@ -259,6 +263,36 @@ def _connect_cli(instance: str, use_root_db_user: bool = False) -> None:
     return None
 
 
+def validate_connection_state(
+    owner: str, name: str, use_root_db_user: bool = False
+) -> None:
+    from django.db import connection
+
+    if (
+        settings._instance_exists
+        and f"{owner}/{name}" == settings.instance.slug
+        # below is to ensure that if another process interferes
+        # we don't use the in-memory mock database
+        # could be made more specific by checking whether the django
+        # configured database is the same as the one in settings
+        and connection.settings_dict["NAME"] != ":memory:"
+        and not use_root_db_user  # always re-connect for root db user
+    ):
+        logger.important(
+            f"doing nothing, already connected lamindb: {settings.instance.slug}"
+        )
+        return None
+    else:
+        if settings._instance_exists and settings.instance.slug != "none/none":
+            import lamindb as ln
+
+            if ln.context.transform is not None:
+                raise CannotSwitchDefaultInstance(
+                    "Cannot switch default instance while `ln.track()` is live: call `ln.finish()`"
+                )
+        reset_django()
+
+
 @unlock_cloud_sqlite_upon_exception(ignore_prev_locker=True)
 def connect(instance: str | None = None, **kwargs: Any) -> str | tuple | None:
     """Connect to an instance.
@@ -274,6 +308,7 @@ def connect(instance: str | None = None, **kwargs: Any) -> str | tuple | None:
     # validate kwargs
     valid_kwargs = {
         "use_root_db_user",
+        "use_proxy_db",
         "_db",
         "_write_settings",
         "_raise_not_found_error",
@@ -284,15 +319,18 @@ def connect(instance: str | None = None, **kwargs: Any) -> str | tuple | None:
     for kwarg in kwargs:
         if kwarg not in valid_kwargs:
             raise TypeError(f"connect() got unexpected keyword argument '{kwarg}'")
-    isettings: InstanceSettings = None  # type: ignore
-    # _db is still needed because it is called in init
+
     use_root_db_user: bool = kwargs.get("use_root_db_user", False)
+    use_proxy_db = kwargs.get("use_proxy_db", False)
+    # _db is still needed because it is called in init
     _db: str | None = kwargs.get("_db", None)
     _write_settings: bool = kwargs.get("_write_settings", False)
     _raise_not_found_error: bool = kwargs.get("_raise_not_found_error", True)
     _reload_lamindb: bool = kwargs.get("_reload_lamindb", True)
     _test: bool = kwargs.get("_test", False)
 
+    isettings: InstanceSettings = None  # type: ignore
+
     access_token: str | None = None
     _user: UserSettings | None = kwargs.get("_user", None)
     if _user is not None:
@@ -317,36 +355,11 @@ def connect(instance: str | None = None, **kwargs: Any) -> str | tuple | None:
             if _db is not None and isettings.dialect == "postgresql":
                 isettings._db = _db
         else:
-            from django.db import connection
-
             owner, name = get_owner_name_from_identifier(instance)
             if _check_instance_setup() and not _test:
-                if (
-                    settings._instance_exists
-                    and f"{owner}/{name}" == settings.instance.slug
-                    # below is to ensure that if another process interferes
-                    # we don't use the in-memory mock database
-                    # could be made more specific by checking whether the django
-                    # configured database is the same as the one in settings
-                    and connection.settings_dict["NAME"] != ":memory:"
-                    and not use_root_db_user  # always re-connect for root db user
-                ):
-                    logger.important(
-                        f"doing nothing, already connected lamindb: {settings.instance.slug}"
-                    )
-                    return None
-                else:
-                    if (
-                        settings._instance_exists
-                        and settings.instance.slug != "none/none"
-                    ):
-                        import lamindb as ln
-
-                        if ln.context.transform is not None:
-                            raise CannotSwitchDefaultInstance(
-                                "Cannot switch default instance while `ln.track()` is live: call `ln.finish()`"
-                            )
-                    reset_django()
+                validate_connection_state(
+                    owner, name, use_root_db_user=use_root_db_user
+                )
             elif (
                 _write_settings
                 and settings._instance_exists
@@ -362,6 +375,7 @@ def connect(instance: str | None = None, **kwargs: Any) -> str | tuple | None:
                     db=_db,
                     access_token=access_token,
                     use_root_db_user=use_root_db_user,
+                    use_proxy_db=use_proxy_db,
                 )
             except InstanceNotFoundError as e:
                 if _raise_not_found_error:
@@ -416,7 +430,7 @@ def connect(instance: str | None = None, **kwargs: Any) -> str | tuple | None:
     return None
 
 
-def get_owner_name_from_identifier(identifier: str):
+def get_owner_name_from_identifier(identifier: str) -> tuple[str, str]:
     if "/" in identifier:
         if identifier.startswith("https://lamin.ai/"):
             identifier = identifier.replace("https://lamin.ai/", "")

{lamindb_setup-1.10.2 → lamindb_setup-1.12.0}/lamindb_setup/_delete.py

@@ -21,6 +21,8 @@ if TYPE_CHECKING:
 
 
 def delete_cache(isettings: InstanceSettings):
+    if isettings.storage is None:
+        return
     # avoid init of root
     root = isettings.storage._root_init
     if not isinstance(root, LocalPathClasses):
@@ -40,7 +42,7 @@ def delete_by_isettings(isettings: InstanceSettings) -> None:
     if settings_file.exists():
         settings_file.unlink()
     delete_cache(isettings)
-    if isettings.dialect == "sqlite":
+    if isettings.dialect == "sqlite" and isettings.storage is not None:
         try:
             if isettings._sqlite_file.exists():
                 isettings._sqlite_file.unlink()