lamindb_setup 0.77.1__py2.py3-none-any.whl → 0.77.3__py2.py3-none-any.whl

lamindb_setup/core/django.py

@@ -1,113 +1,114 @@
-from __future__ import annotations
-
-# flake8: noqa
-import builtins
-import os
-from pathlib import Path
-import time
-from lamin_utils import logger
-from ._settings_store import current_instance_settings_file
-from ._settings_instance import InstanceSettings
-
-IS_RUN_FROM_IPYTHON = getattr(builtins, "__IPYTHON__", False)
-IS_SETUP = False
-IS_MIGRATING = False
-CONN_MAX_AGE = 299
-
-
-def close_if_health_check_failed(self) -> None:
-    if self.close_at is not None:
-        if time.monotonic() >= self.close_at:
-            self.close()
-        self.close_at = time.monotonic() + CONN_MAX_AGE
-
-
-# this bundles set up and migration management
-def setup_django(
-    isettings: InstanceSettings,
-    deploy_migrations: bool = False,
-    create_migrations: bool = False,
-    configure_only: bool = False,
-    init: bool = False,
-    view_schema: bool = False,
-):
-    if IS_RUN_FROM_IPYTHON:
-        os.environ["DJANGO_ALLOW_ASYNC_UNSAFE"] = "true"
-
-    import dj_database_url
-    import django
-    from django.conf import settings
-    from django.core.management import call_command
-
-    # configuration
-    if not settings.configured:
-        default_db = dj_database_url.config(
-            default=isettings.db,
-            # see comment next to patching BaseDatabaseWrapper below
-            conn_max_age=CONN_MAX_AGE,
-            conn_health_checks=True,
-        )
-        DATABASES = {
-            "default": default_db,
-        }
-        from .._init_instance import get_schema_module_name
-
-        schema_names = ["core"] + list(isettings.schema)
-        installed_apps = [get_schema_module_name(n) for n in schema_names]
-        if view_schema:
-            installed_apps = installed_apps[::-1]  # to fix how apps appear
-            installed_apps += ["schema_graph", "django.contrib.staticfiles"]
-
-        kwargs = dict(
-            INSTALLED_APPS=installed_apps,
-            DATABASES=DATABASES,
-            DEFAULT_AUTO_FIELD="django.db.models.BigAutoField",
-            TIME_ZONE="UTC",
-            USE_TZ=True,
-        )
-        if view_schema:
-            kwargs.update(
-                DEBUG=True,
-                ROOT_URLCONF="lamindb_setup._schema",
-                SECRET_KEY="dummy",
-                TEMPLATES=[
-                    {
-                        "BACKEND": "django.template.backends.django.DjangoTemplates",
-                        "APP_DIRS": True,
-                    },
-                ],
-                STATIC_ROOT=f"{Path.home().as_posix()}/.lamin/",
-                STATICFILES_FINDERS=[
-                    "django.contrib.staticfiles.finders.AppDirectoriesFinder",
-                ],
-                STATIC_URL="static/",
-            )
-        settings.configure(**kwargs)
-        django.setup(set_prefix=False)
-        # https://laminlabs.slack.com/archives/C04FPE8V01W/p1698239551460289
-        from django.db.backends.base.base import BaseDatabaseWrapper
-
-        BaseDatabaseWrapper.close_if_health_check_failed = close_if_health_check_failed
-
-    if configure_only:
-        return None
-
-    # migrations management
-    if create_migrations:
-        call_command("makemigrations")
-        return None
-
-    if deploy_migrations:
-        call_command("migrate", verbosity=2)
-        isettings._update_cloud_sqlite_file(unlock_cloud_sqlite=False)
-    elif init:
-        global IS_MIGRATING
-        IS_MIGRATING = True
-        call_command("migrate", verbosity=0)
-        IS_MIGRATING = False
-
-    global IS_SETUP
-    IS_SETUP = True
-
-    if isettings.keep_artifacts_local:
-        isettings._search_local_root()
+from __future__ import annotations
+
+# flake8: noqa
+import builtins
+import os
+from pathlib import Path
+import time
+from lamin_utils import logger
+from ._settings_store import current_instance_settings_file
+from ._settings_instance import InstanceSettings
+
+IS_RUN_FROM_IPYTHON = getattr(builtins, "__IPYTHON__", False)
+IS_SETUP = False
+IS_MIGRATING = False
+CONN_MAX_AGE = 299
+
+
+def close_if_health_check_failed(self) -> None:
+    if self.close_at is not None:
+        if time.monotonic() >= self.close_at:
+            self.close()
+        self.close_at = time.monotonic() + CONN_MAX_AGE
+
+
+# this bundles set up and migration management
+def setup_django(
+    isettings: InstanceSettings,
+    deploy_migrations: bool = False,
+    create_migrations: bool = False,
+    configure_only: bool = False,
+    init: bool = False,
+    view_schema: bool = False,
+):
+    if IS_RUN_FROM_IPYTHON:
+        os.environ["DJANGO_ALLOW_ASYNC_UNSAFE"] = "true"
+
+    import dj_database_url
+    import django
+    from django.conf import settings
+    from django.core.management import call_command
+
+    # configuration
+    if not settings.configured:
+        default_db = dj_database_url.config(
+            env="LAMINDB_DJANGO_DATABASE_URL",
+            default=isettings.db,
+            # see comment next to patching BaseDatabaseWrapper below
+            conn_max_age=CONN_MAX_AGE,
+            conn_health_checks=True,
+        )
+        DATABASES = {
+            "default": default_db,
+        }
+        from .._init_instance import get_schema_module_name
+
+        schema_names = ["core"] + list(isettings.schema)
+        installed_apps = [get_schema_module_name(n) for n in schema_names]
+        if view_schema:
+            installed_apps = installed_apps[::-1]  # to fix how apps appear
+            installed_apps += ["schema_graph", "django.contrib.staticfiles"]
+
+        kwargs = dict(
+            INSTALLED_APPS=installed_apps,
+            DATABASES=DATABASES,
+            DEFAULT_AUTO_FIELD="django.db.models.BigAutoField",
+            TIME_ZONE="UTC",
+            USE_TZ=True,
+        )
+        if view_schema:
+            kwargs.update(
+                DEBUG=True,
+                ROOT_URLCONF="lamindb_setup._schema",
+                SECRET_KEY="dummy",
+                TEMPLATES=[
+                    {
+                        "BACKEND": "django.template.backends.django.DjangoTemplates",
+                        "APP_DIRS": True,
+                    },
+                ],
+                STATIC_ROOT=f"{Path.home().as_posix()}/.lamin/",
+                STATICFILES_FINDERS=[
+                    "django.contrib.staticfiles.finders.AppDirectoriesFinder",
+                ],
+                STATIC_URL="static/",
+            )
+        settings.configure(**kwargs)
+        django.setup(set_prefix=False)
+        # https://laminlabs.slack.com/archives/C04FPE8V01W/p1698239551460289
+        from django.db.backends.base.base import BaseDatabaseWrapper
+
+        BaseDatabaseWrapper.close_if_health_check_failed = close_if_health_check_failed
+
+    if configure_only:
+        return None
+
+    # migrations management
+    if create_migrations:
+        call_command("makemigrations")
+        return None
+
+    if deploy_migrations:
+        call_command("migrate", verbosity=2)
+        isettings._update_cloud_sqlite_file(unlock_cloud_sqlite=False)
+    elif init:
+        global IS_MIGRATING
+        IS_MIGRATING = True
+        call_command("migrate", verbosity=0)
+        IS_MIGRATING = False
+
+    global IS_SETUP
+    IS_SETUP = True
+
+    if isettings.keep_artifacts_local:
+        isettings._search_local_root()

lamindb_setup/core/exceptions.py

@@ -1,12 +1,12 @@
-from __future__ import annotations
-
-from typing import Optional
-
-
-class DefaultMessageException(Exception):
-    default_message: str | None = None
-
-    def __init__(self, message: str | None = None):
-        if message is None:
-            message = self.default_message
-        super().__init__(message)
+from __future__ import annotations
+
+from typing import Optional
+
+
+class DefaultMessageException(Exception):
+    default_message: str | None = None
+
+    def __init__(self, message: str | None = None):
+        if message is None:
+            message = self.default_message
+        super().__init__(message)

lamindb_setup/core/hashing.py

@@ -1,114 +1,114 @@
-from __future__ import annotations
-
-"""Hashing.
-
-.. autosummary::
-   :toctree: .
-
-   hash_set
-   hash_file
-
-"""
-
-import base64
-import hashlib
-from concurrent.futures import ThreadPoolExecutor
-from typing import TYPE_CHECKING, Iterable
-
-import psutil
-
-HASH_LENGTH = 22
-
-if TYPE_CHECKING:
-    from .types import Path, UPathStr
-
-
-def hash_and_encode_as_b62(s: str) -> str:
-    from lamin_utils._base62 import encodebytes
-
-    return encodebytes(hashlib.md5(s.encode()).digest())
-
-
-def to_b64_str(bstr: bytes):
-    b64 = base64.urlsafe_b64encode(bstr).decode().strip("=")
-    return b64
-
-
-def b16_to_b64(s: str):
-    return to_b64_str(base64.b16decode(s.strip('"'), casefold=True))
-
-
-# a lot to read about this: lamin-notes/2022/hashing
-def hash_set(s: set[str]) -> str:
-    bstr = ":".join(sorted(s)).encode("utf-8")
-    # as we're truncating at 22 b64, we choose md5 over sha512
-    return to_b64_str(hashlib.md5(bstr).digest())[:HASH_LENGTH]
-
-
-def hash_md5s_from_dir(hashes: Iterable[str]) -> tuple[str, str]:
-    # need to sort below because we don't want the order of parsing the dir to
-    # affect the hash
-    digests = b"".join(
-        hashlib.md5(hash.encode("utf-8")).digest() for hash in sorted(hashes)
-    )
-    digest = hashlib.md5(digests).digest()
-    return to_b64_str(digest)[:HASH_LENGTH], "md5-d"
-
-
-def hash_code(file_path: UPathStr):
-    with open(file_path, "rb") as fp:
-        data = fp.read()
-    data_size = len(data)
-    header = f"blob {data_size}\0".encode()
-    blob = header + data
-    return hashlib.sha1(blob)
-
-
-def hash_file(
-    file_path: Path,
-    file_size: int | None = None,
-    chunk_size: int | None = 50 * 1024 * 1024,
-) -> tuple[str, str]:
-    with open(file_path, "rb") as fp:
-        if file_size is None:
-            fp.seek(0, 2)
-            file_size = fp.tell()
-            fp.seek(0, 0)
-        if chunk_size is None:
-            chunk_size = file_size
-        first_chunk = fp.read(chunk_size)
-        if file_size <= chunk_size:
-            digest = hashlib.md5(first_chunk).digest()
-            hash_type = "md5"
-        else:
-            fp.seek(-chunk_size, 2)
-            last_chunk = fp.read(chunk_size)
-            digest = hashlib.sha1(
-                hashlib.sha1(first_chunk).digest() + hashlib.sha1(last_chunk).digest()
-            ).digest()
-            hash_type = "sha1-fl"
-    return to_b64_str(digest)[:HASH_LENGTH], hash_type
-
-
-def hash_dir(path: Path):
-    files = (subpath for subpath in path.rglob("*") if subpath.is_file())
-
-    def hash_size(file):
-        file_size = file.stat().st_size
-        return hash_file(file, file_size)[0], file_size
-
-    try:
-        n_workers = len(psutil.Process().cpu_affinity())
-    except AttributeError:
-        n_workers = psutil.cpu_count()
-    if n_workers > 1:
-        with ThreadPoolExecutor(n_workers) as pool:
-            hashes_sizes = pool.map(hash_size, files)
-    else:
-        hashes_sizes = map(hash_size, files)
-    hashes, sizes = zip(*hashes_sizes)
-
-    hash, hash_type = hash_md5s_from_dir(hashes)
-    n_objects = len(hashes)
-    size = sum(sizes)
-    return size, hash, hash_type, n_objects
+from __future__ import annotations
+
+"""Hashing.
+
+.. autosummary::
+   :toctree: .
+
+   hash_set
+   hash_file
+
+"""
+
+import base64
+import hashlib
+from concurrent.futures import ThreadPoolExecutor
+from typing import TYPE_CHECKING, Iterable
+
+import psutil
+
+HASH_LENGTH = 22
+
+if TYPE_CHECKING:
+    from .types import Path, UPathStr
+
+
+def hash_and_encode_as_b62(s: str) -> str:
+    from lamin_utils._base62 import encodebytes
+
+    return encodebytes(hashlib.md5(s.encode()).digest())
+
+
+def to_b64_str(bstr: bytes):
+    b64 = base64.urlsafe_b64encode(bstr).decode().strip("=")
+    return b64
+
+
+def b16_to_b64(s: str):
+    return to_b64_str(base64.b16decode(s.strip('"'), casefold=True))
+
+
+# a lot to read about this: lamin-notes/2022/hashing
+def hash_set(s: set[str]) -> str:
+    bstr = ":".join(sorted(s)).encode("utf-8")
+    # as we're truncating at 22 b64, we choose md5 over sha512
+    return to_b64_str(hashlib.md5(bstr).digest())[:HASH_LENGTH]
+
+
+def hash_md5s_from_dir(hashes: Iterable[str]) -> tuple[str, str]:
+    # need to sort below because we don't want the order of parsing the dir to
+    # affect the hash
+    digests = b"".join(
+        hashlib.md5(hash.encode("utf-8")).digest() for hash in sorted(hashes)
+    )
+    digest = hashlib.md5(digests).digest()
+    return to_b64_str(digest)[:HASH_LENGTH], "md5-d"
+
+
+def hash_code(file_path: UPathStr):
+    with open(file_path, "rb") as fp:
+        data = fp.read()
+    data_size = len(data)
+    header = f"blob {data_size}\0".encode()
+    blob = header + data
+    return hashlib.sha1(blob)
+
+
+def hash_file(
+    file_path: Path,
+    file_size: int | None = None,
+    chunk_size: int | None = 50 * 1024 * 1024,
+) -> tuple[str, str]:
+    with open(file_path, "rb") as fp:
+        if file_size is None:
+            fp.seek(0, 2)
+            file_size = fp.tell()
+            fp.seek(0, 0)
+        if chunk_size is None:
+            chunk_size = file_size
+        first_chunk = fp.read(chunk_size)
+        if file_size <= chunk_size:
+            digest = hashlib.md5(first_chunk).digest()
+            hash_type = "md5"
+        else:
+            fp.seek(-chunk_size, 2)
+            last_chunk = fp.read(chunk_size)
+            digest = hashlib.sha1(
+                hashlib.sha1(first_chunk).digest() + hashlib.sha1(last_chunk).digest()
+            ).digest()
+            hash_type = "sha1-fl"
+    return to_b64_str(digest)[:HASH_LENGTH], hash_type
+
+
+def hash_dir(path: Path):
+    files = (subpath for subpath in path.rglob("*") if subpath.is_file())
+
+    def hash_size(file):
+        file_size = file.stat().st_size
+        return hash_file(file, file_size)[0], file_size
+
+    try:
+        n_workers = len(psutil.Process().cpu_affinity())
+    except AttributeError:
+        n_workers = psutil.cpu_count()
+    if n_workers > 1:
+        with ThreadPoolExecutor(n_workers) as pool:
+            hashes_sizes = pool.map(hash_size, files)
+    else:
+        hashes_sizes = map(hash_size, files)
+    hashes, sizes = zip(*hashes_sizes)
+
+    hash, hash_type = hash_md5s_from_dir(hashes)
+    n_objects = len(hashes)
+    size = sum(sizes)
+    return size, hash, hash_type, n_objects

lamindb_setup/core/types.py

@@ -1,19 +1,19 @@
-from __future__ import annotations
-
-"""Types.
-
-.. autosummary::
-   :toctree: .
-
-   UPathStr
-"""
-# we need Union here because __future__ annotations doesn't work with TypeAlias
-from pathlib import Path
-from typing import (
-    Union,
-)
-
-# UPath is subclass of Path, hence, it's not necessary to list UPath
-# we keep it in the name of the TypeAlias to make it clear to users that
-# cloud paths are allowed / PathStr is often associated with local paths
-UPathStr = Union[str, Path]  # typing.TypeAlias, >3.10 on but already deprecated
+from __future__ import annotations
+
+"""Types.
+
+.. autosummary::
+   :toctree: .
+
+   UPathStr
+"""
+# we need Union here because __future__ annotations doesn't work with TypeAlias
+from pathlib import Path
+from typing import (
+    Union,
+)
+
+# UPath is subclass of Path, hence, it's not necessary to list UPath
+# we keep it in the name of the TypeAlias to make it clear to users that
+# cloud paths are allowed / PathStr is often associated with local paths
+UPathStr = Union[str, Path]  # typing.TypeAlias, >3.10 on but already deprecated