lamindb_setup 1.8.3__py3-none-any.whl → 1.9.1__py3-none-any.whl

lamindb_setup/__init__.py

@@ -1,107 +1,107 @@
-"""Setup & configure LaminDB.
-
-Many functions in this "setup API" have a matching command in the :doc:`docs:cli` CLI.
-
-Guide: :doc:`docs:setup`.
-
-Basic operations:
-
-.. autosummary::
-   :toctree:
-
-   login
-   logout
-   init
-   disconnect
-   delete
-
-Instance operations:
-
-.. autosummary::
-   :toctree:
-
-   migrate
-
-Modules & settings:
-
-.. autosummary::
-   :toctree:
-
-   settings
-   core
-   django
-   errors
-   types
-
-"""
-
-__version__ = "1.8.3"  # denote a release candidate for 0.1.0 with 0.1rc1
-
-import os
-
-from packaging import version as packaging_version
-
-from . import core, errors, types
-from ._check_setup import _check_instance_setup
-from ._connect_instance import connect
-from ._delete import delete
-from ._disconnect import disconnect
-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
-from ._setup_user import login, logout
-from .core._settings import settings
-
-# check that the version of s3fs is higher than the lower bound
-# needed because spatialdata installs old versions of s3fs
-try:
-    from s3fs import __version__ as s3fs_version
-
-    if packaging_version.parse(s3fs_version) < packaging_version.parse("2023.12.2"):
-        raise RuntimeError(
-            f"The version of s3fs you have ({s3fs_version}) is impompatible "
-            "with lamindb, please upgrade it: pip install s3fs>=2023.12.2"
-        )
-except ImportError:
-    # might be not installed
-    pass
-
-
-def _is_CI_environment() -> bool:
-    ci_env_vars = [
-        "LAMIN_TESTING",  # Set by our nox configurations
-        "CI",  # Commonly set by many CI systems
-        "TRAVIS",  # Travis CI
-        "GITHUB_ACTIONS",  # GitHub Actions
-        "GITLAB_CI",  # GitLab CI/CD
-        "CIRCLECI",  # CircleCI
-        "JENKINS_URL",  # Jenkins
-        "TEAMCITY_VERSION",  # TeamCity
-        "BUILDKITE",  # Buildkite
-        "BITBUCKET_BUILD_NUMBER",  # Bitbucket Pipelines
-        "APPVEYOR",  # AppVeyor
-        "AZURE_HTTP_USER_AGENT",  # Azure Pipelines
-        "BUDDY",  # Buddy
-        "DRONE",  # Drone CI
-        "HUDSON_URL",  # Hudson
-        "CF_BUILD_ID",  # Codefresh
-        "WERCKER",  # Wercker
-        "NOW_BUILDER",  # ZEIT Now
-        "TASKCLUSTER_ROOT_URL",  # TaskCluster
-        "SEMAPHORE",  # Semaphore CI
-        "BUILD_ID",  # Generic build environments
-    ]
-    return any(env_var in os.environ for env_var in ci_env_vars)
-
-
-_TESTING = _is_CI_environment()
-
-# 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`."""
-
-
-close = disconnect  # backward compatibility
+"""Setup & configure LaminDB.
+
+Many functions in this "setup API" have a matching command in the :doc:`docs:cli` CLI.
+
+Guide: :doc:`docs:setup`.
+
+Basic operations:
+
+.. autosummary::
+   :toctree:
+
+   login
+   logout
+   init
+   disconnect
+   delete
+
+Instance operations:
+
+.. autosummary::
+   :toctree:
+
+   migrate
+
+Modules & settings:
+
+.. autosummary::
+   :toctree:
+
+   settings
+   core
+   django
+   errors
+   types
+
+"""
+
+__version__ = "1.9.1"  # denote a release candidate for 0.1.0 with 0.1rc1
+
+import os
+
+from packaging import version as packaging_version
+
+from . import core, errors, types
+from ._check_setup import _check_instance_setup
+from ._connect_instance import connect
+from ._delete import delete
+from ._disconnect import disconnect
+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
+from ._setup_user import login, logout
+from .core._settings import settings
+
+# check that the version of s3fs is higher than the lower bound
+# needed because spatialdata installs old versions of s3fs
+try:
+    from s3fs import __version__ as s3fs_version
+
+    if packaging_version.parse(s3fs_version) < packaging_version.parse("2023.12.2"):
+        raise RuntimeError(
+            f"The version of s3fs you have ({s3fs_version}) is impompatible "
+            "with lamindb, please upgrade it: pip install s3fs>=2023.12.2"
+        )
+except ImportError:
+    # might be not installed
+    pass
+
+
+def _is_CI_environment() -> bool:
+    ci_env_vars = [
+        "LAMIN_TESTING",  # Set by our nox configurations
+        "CI",  # Commonly set by many CI systems
+        "TRAVIS",  # Travis CI
+        "GITHUB_ACTIONS",  # GitHub Actions
+        "GITLAB_CI",  # GitLab CI/CD
+        "CIRCLECI",  # CircleCI
+        "JENKINS_URL",  # Jenkins
+        "TEAMCITY_VERSION",  # TeamCity
+        "BUILDKITE",  # Buildkite
+        "BITBUCKET_BUILD_NUMBER",  # Bitbucket Pipelines
+        "APPVEYOR",  # AppVeyor
+        "AZURE_HTTP_USER_AGENT",  # Azure Pipelines
+        "BUDDY",  # Buddy
+        "DRONE",  # Drone CI
+        "HUDSON_URL",  # Hudson
+        "CF_BUILD_ID",  # Codefresh
+        "WERCKER",  # Wercker
+        "NOW_BUILDER",  # ZEIT Now
+        "TASKCLUSTER_ROOT_URL",  # TaskCluster
+        "SEMAPHORE",  # Semaphore CI
+        "BUILD_ID",  # Generic build environments
+    ]
+    return any(env_var in os.environ for env_var in ci_env_vars)
+
+
+_TESTING = _is_CI_environment()
+
+# 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`."""
+
+
+close = disconnect  # backward compatibility

lamindb_setup/_cache.py

@@ -1,87 +1,87 @@
-from __future__ import annotations
-
-import shutil
-from pathlib import Path
-
-from dotenv import dotenv_values
-from lamin_utils import logger
-
-from .core._settings_save import save_platform_user_storage_settings
-from .core._settings_store import system_settings_file
-
-
-def clear_cache_dir():
-    from lamindb_setup import disconnect, settings
-
-    try:
-        if settings.instance._is_cloud_sqlite:
-            logger.warning(
-                "disconnecting the current instance to update the cloud sqlite database."
-            )
-            disconnect()
-    except SystemExit as e:
-        if str(e) != "No instance connected! Call `lamin connect` or `lamin init`":
-            raise e
-
-    cache_dir = settings.cache_dir
-    if cache_dir.exists():
-        shutil.rmtree(cache_dir)
-        cache_dir.mkdir()
-        logger.success("the cache directory was cleared")
-    else:
-        logger.warning("the cache directory doesn't exist")
-
-
-def get_cache_dir():
-    from lamindb_setup import settings
-
-    return settings.cache_dir.as_posix()
-
-
-def set_cache_dir(cache_dir: str):
-    from lamindb_setup.core._settings import (
-        DEFAULT_CACHE_DIR,
-        _process_cache_path,
-        settings,
-    )
-
-    old_cache_dir = settings.cache_dir
-    new_cache_dir = _process_cache_path(cache_dir)
-
-    system_cache_dir = None
-    if (system_settings := system_settings_file()).exists():
-        system_cache_dir = dotenv_values(system_settings).get(
-            "lamindb_cache_path", None
-        )
-        system_cache_dir = (
-            Path(system_cache_dir) if system_cache_dir is not None else None
-        )
-
-    need_reset = False
-    if new_cache_dir is None:
-        need_reset = True
-        new_cache_dir = (
-            DEFAULT_CACHE_DIR if system_cache_dir is None else system_cache_dir
-        )
-
-    if new_cache_dir != old_cache_dir:
-        if old_cache_dir.exists():
-            shutil.copytree(old_cache_dir, new_cache_dir, dirs_exist_ok=True)
-            logger.info(
-                f"the current cache directory was copied to {new_cache_dir.as_posix()} "
-            )
-            if old_cache_dir != system_cache_dir:
-                shutil.rmtree(old_cache_dir)
-                logger.info(
-                    f"cleared the old cache directory {old_cache_dir.as_posix()}"
-                )
-            else:
-                logger.info(
-                    f"didn't clear the system cache directory {system_cache_dir.as_posix()}, "
-                    "please clear it manually if you need"
-                )
-        else:
-            new_cache_dir.mkdir(parents=True, exist_ok=True)
-        new_cache_dir = new_cache_dir.resolve()
-    save_platform_user_storage_settings(None if need_reset else new_cache_dir)
-    settings._cache_dir = new_cache_dir
+from __future__ import annotations
+
+import shutil
+from pathlib import Path
+
+from dotenv import dotenv_values
+from lamin_utils import logger
+
+from .core._settings_save import save_platform_user_storage_settings
+from .core._settings_store import system_settings_file
+
+
+def clear_cache_dir():
+    from lamindb_setup import disconnect, settings
+
+    try:
+        if settings.instance._is_cloud_sqlite:
+            logger.warning(
+                "disconnecting the current instance to update the cloud sqlite database."
+            )
+            disconnect()
+    except SystemExit as e:
+        if str(e) != "No instance connected! Call `lamin connect` or `lamin init`":
+            raise e
+
+    cache_dir = settings.cache_dir
+    if cache_dir.exists():
+        shutil.rmtree(cache_dir)
+        cache_dir.mkdir()
+        logger.success("the cache directory was cleared")
+    else:
+        logger.warning("the cache directory doesn't exist")
+
+
+def get_cache_dir():
+    from lamindb_setup import settings
+
+    return settings.cache_dir.as_posix()
+
+
+def set_cache_dir(cache_dir: str):
+    from lamindb_setup.core._settings import (
+        DEFAULT_CACHE_DIR,
+        _process_cache_path,
+        settings,
+    )
+
+    old_cache_dir = settings.cache_dir
+    new_cache_dir = _process_cache_path(cache_dir)
+
+    system_cache_dir = None
+    if (system_settings := system_settings_file()).exists():
+        system_cache_dir = dotenv_values(system_settings).get(
+            "lamindb_cache_path", None
+        )
+        system_cache_dir = (
+            Path(system_cache_dir) if system_cache_dir is not None else None
+        )
+
+    need_reset = False
+    if new_cache_dir is None:
+        need_reset = True
+        new_cache_dir = (
+            DEFAULT_CACHE_DIR if system_cache_dir is None else system_cache_dir
+        )
+
+    if new_cache_dir != old_cache_dir:
+        if old_cache_dir.exists():
+            shutil.copytree(old_cache_dir, new_cache_dir, dirs_exist_ok=True)
+            logger.info(
+                f"the current cache directory was copied to {new_cache_dir.as_posix()} "
+            )
+            if old_cache_dir != system_cache_dir:
+                shutil.rmtree(old_cache_dir)
+                logger.info(
+                    f"cleared the old cache directory {old_cache_dir.as_posix()}"
+                )
+            else:
+                logger.info(
+                    f"didn't clear the system cache directory {system_cache_dir.as_posix()}, "
+                    "please clear it manually if you need"
+                )
+        else:
+            new_cache_dir.mkdir(parents=True, exist_ok=True)
+        new_cache_dir = new_cache_dir.resolve()
+    save_platform_user_storage_settings(None if need_reset else new_cache_dir)
+    settings._cache_dir = new_cache_dir