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

lamindb_setup/core/_private_django_api.py

@@ -1,88 +1,88 @@
-from __future__ import annotations
-
-import os
-from pathlib import Path
-
-
-def find_vscode_stubs_folder() -> Path | None:
-    # Possible locations of VSCode extensions
-    possible_locations = [
-        Path.home() / ".vscode" / "extensions",  # Linux and macOS
-        Path.home() / ".vscode-server" / "extensions",  # Remote development
-        Path(os.environ.get("APPDATA", "")) / "Code" / "User" / "extensions",  # Windows
-        Path("/usr/share/code/resources/app/extensions"),  # Some Linux distributions
-    ]
-    for location in possible_locations:
-        if location.exists():
-            # Look for Pylance extension folder
-            pylance_folders = list(location.glob("ms-python.vscode-pylance-*"))
-            if pylance_folders:
-                # Sort to get the latest version
-                latest_pylance = sorted(pylance_folders)[-1]
-                stubs_folder = (
-                    latest_pylance / "dist" / "bundled" / "stubs" / "django-stubs"
-                )
-                if stubs_folder.exists():
-                    return stubs_folder
-
-    return None
-
-
-def private_django_api(reverse=False):
-    from django import db
-
-    # the order here matters
-    # changing it might break the tests
-    attributes = [
-        "DoesNotExist",
-        "MultipleObjectsReturned",
-        "add_to_class",
-        "adelete",
-        "refresh_from_db",
-        "asave",
-        "clean",
-        "clean_fields",
-        "date_error_message",
-        "get_constraints",
-        "get_deferred_fields",
-        "prepare_database_save",
-        "save_base",
-        "serializable_value",
-        "unique_error_message",
-        "validate_constraints",
-        "validate_unique",
-    ]
-    if reverse:
-        attributes.append("arefresh_from_db")
-        attributes.append("full_clean")
-    else:
-        attributes.append("a_refresh_from_db")
-        attributes.append("full__clean")
-
-    django_path = Path(db.__file__).parent.parent
-
-    encoding = "utf8" if os.name == "nt" else None
-
-    def prune_file(file_path):
-        content = file_path.read_text(encoding=encoding)
-        original_content = content
-
-        for attr in attributes:
-            old_name = f"_{attr}" if reverse else attr
-            new_name = attr if reverse else f"_{attr}"
-            content = content.replace(old_name, new_name)
-
-        if not reverse:
-            content = content.replace("Field_DoesNotExist", "FieldDoesNotExist")
-            content = content.replace("Object_DoesNotExist", "ObjectDoesNotExist")
-
-        if content != original_content:
-            file_path.write_text(content, encoding=encoding)
-
-    for file_path in django_path.rglob("*.py"):
-        prune_file(file_path)
-
-    pylance_path = find_vscode_stubs_folder()
-    if pylance_path is not None:
-        for file_path in pylance_path.rglob("*.pyi"):
-            prune_file(file_path)
+from __future__ import annotations
+
+import os
+from pathlib import Path
+
+
+def find_vscode_stubs_folder() -> Path | None:
+    # Possible locations of VSCode extensions
+    possible_locations = [
+        Path.home() / ".vscode" / "extensions",  # Linux and macOS
+        Path.home() / ".vscode-server" / "extensions",  # Remote development
+        Path(os.environ.get("APPDATA", "")) / "Code" / "User" / "extensions",  # Windows
+        Path("/usr/share/code/resources/app/extensions"),  # Some Linux distributions
+    ]
+    for location in possible_locations:
+        if location.exists():
+            # Look for Pylance extension folder
+            pylance_folders = list(location.glob("ms-python.vscode-pylance-*"))
+            if pylance_folders:
+                # Sort to get the latest version
+                latest_pylance = sorted(pylance_folders)[-1]
+                stubs_folder = (
+                    latest_pylance / "dist" / "bundled" / "stubs" / "django-stubs"
+                )
+                if stubs_folder.exists():
+                    return stubs_folder
+
+    return None
+
+
+def private_django_api(reverse=False):
+    from django import db
+
+    # the order here matters
+    # changing it might break the tests
+    attributes = [
+        "DoesNotExist",
+        "MultipleObjectsReturned",
+        "add_to_class",
+        "adelete",
+        "refresh_from_db",
+        "asave",
+        "clean",
+        "clean_fields",
+        "date_error_message",
+        "get_constraints",
+        "get_deferred_fields",
+        "prepare_database_save",
+        "save_base",
+        "serializable_value",
+        "unique_error_message",
+        "validate_constraints",
+        "validate_unique",
+    ]
+    if reverse:
+        attributes.append("arefresh_from_db")
+        attributes.append("full_clean")
+    else:
+        attributes.append("a_refresh_from_db")
+        attributes.append("full__clean")
+
+    django_path = Path(db.__file__).parent.parent
+
+    encoding = "utf8" if os.name == "nt" else None
+
+    def prune_file(file_path):
+        content = file_path.read_text(encoding=encoding)
+        original_content = content
+
+        for attr in attributes:
+            old_name = f"_{attr}" if reverse else attr
+            new_name = attr if reverse else f"_{attr}"
+            content = content.replace(old_name, new_name)
+
+        if not reverse:
+            content = content.replace("Field_DoesNotExist", "FieldDoesNotExist")
+            content = content.replace("Object_DoesNotExist", "ObjectDoesNotExist")
+
+        if content != original_content:
+            file_path.write_text(content, encoding=encoding)
+
+    for file_path in django_path.rglob("*.py"):
+        prune_file(file_path)
+
+    pylance_path = find_vscode_stubs_folder()
+    if pylance_path is not None:
+        for file_path in pylance_path.rglob("*.pyi"):
+            prune_file(file_path)

lamindb_setup/core/_settings.py

@@ -1,138 +1,138 @@
-from __future__ import annotations
-
-import os
-from typing import TYPE_CHECKING
-
-from ._settings_load import (
-    load_instance_settings,
-    load_or_create_user_settings,
-)
-from ._settings_store import current_instance_settings_file, settings_dir
-
-if TYPE_CHECKING:
-    from pathlib import Path
-
-    from lamindb_setup.core import InstanceSettings, StorageSettings, UserSettings
-
-
-class SetupSettings:
-    """Setup settings."""
-
-    _using_key: str | None = None  # set through lamindb.settings
-
-    _user_settings: UserSettings | None = None
-    _instance_settings: InstanceSettings | None = None
-
-    _user_settings_env: str | None = None
-    _instance_settings_env: str | None = None
-
-    _auto_connect_path: Path = settings_dir / "auto_connect"
-    _private_django_api_path: Path = settings_dir / "private_django_api"
-
-    @property
-    def _instance_settings_path(self) -> Path:
-        return current_instance_settings_file()
-
-    @property
-    def settings_dir(self) -> Path:
-        """The directory that holds locally persisted settings."""
-        return settings_dir
-
-    @property
-    def auto_connect(self) -> bool:
-        """Auto-connect to loaded instance upon lamindb import.
-
-        `lamin init` and `lamin load` switch this to `True`.
-
-        `ln.connect()` doesn't change the value of this setting.
-        """
-        return self._auto_connect_path.exists()
-
-    @auto_connect.setter
-    def auto_connect(self, value: bool) -> None:
-        if value:
-            self._auto_connect_path.touch()
-        else:
-            self._auto_connect_path.unlink(missing_ok=True)
-
-    @property
-    def private_django_api(self) -> bool:
-        """Turn internal Django API private to clean up the API (default `False`).
-
-        This patches your local pip-installed django installation. You can undo
-        the patch by setting this back to `False`.
-        """
-        return self._private_django_api_path.exists()
-
-    @private_django_api.setter
-    def private_django_api(self, value: bool) -> None:
-        from ._private_django_api import private_django_api
-
-        # we don't want to call private_django_api() twice
-        if value and not self.private_django_api:
-            private_django_api()
-            self._private_django_api_path.touch()
-        elif not value and self.private_django_api:
-            private_django_api(reverse=True)
-            self._private_django_api_path.unlink(missing_ok=True)
-
-    @property
-    def user(self) -> UserSettings:
-        """Settings of current user."""
-        env_changed = (
-            self._user_settings_env is not None
-            and self._user_settings_env != get_env_name()
-        )
-        if self._user_settings is None or env_changed:
-            self._user_settings = load_or_create_user_settings()
-            self._user_settings_env = get_env_name()
-            if self._user_settings and self._user_settings.uid is None:
-                raise RuntimeError("Need to login, first: lamin login <email>")
-        return self._user_settings  # type: ignore
-
-    @property
-    def instance(self) -> InstanceSettings:
-        """Settings of current LaminDB instance."""
-        env_changed = (
-            self._instance_settings_env is not None
-            and self._instance_settings_env != get_env_name()
-        )
-        if self._instance_settings is None or env_changed:
-            self._instance_settings = load_instance_settings()
-            self._instance_settings_env = get_env_name()
-        return self._instance_settings  # type: ignore
-
-    @property
-    def storage(self) -> StorageSettings:
-        """Settings of default storage."""
-        return self.instance.storage
-
-    @property
-    def _instance_exists(self):
-        try:
-            self.instance  # noqa
-            return True
-        # this is implicit logic that catches if no instance is loaded
-        except SystemExit:
-            return False
-
-    def __repr__(self) -> str:
-        """Rich string representation."""
-        repr = self.user.__repr__()
-        repr += f"\nAuto-connect in Python: {self.auto_connect}\n"
-        repr += f"Private Django API: {self.private_django_api}\n"
-        if self._instance_exists:
-            repr += self.instance.__repr__()
-        else:
-            repr += "\nNo instance connected"
-        return repr
-
-
-def get_env_name():
-    if "LAMIN_ENV" in os.environ:
-        return os.environ["LAMIN_ENV"]
-    else:
-        return "prod"
-
-
-settings = SetupSettings()
+from __future__ import annotations
+
+import os
+from typing import TYPE_CHECKING
+
+from ._settings_load import (
+    load_instance_settings,
+    load_or_create_user_settings,
+)
+from ._settings_store import current_instance_settings_file, settings_dir
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+    from lamindb_setup.core import InstanceSettings, StorageSettings, UserSettings
+
+
+class SetupSettings:
+    """Setup settings."""
+
+    _using_key: str | None = None  # set through lamindb.settings
+
+    _user_settings: UserSettings | None = None
+    _instance_settings: InstanceSettings | None = None
+
+    _user_settings_env: str | None = None
+    _instance_settings_env: str | None = None
+
+    _auto_connect_path: Path = settings_dir / "auto_connect"
+    _private_django_api_path: Path = settings_dir / "private_django_api"
+
+    @property
+    def _instance_settings_path(self) -> Path:
+        return current_instance_settings_file()
+
+    @property
+    def settings_dir(self) -> Path:
+        """The directory that holds locally persisted settings."""
+        return settings_dir
+
+    @property
+    def auto_connect(self) -> bool:
+        """Auto-connect to loaded instance upon lamindb import.
+
+        `lamin init` and `lamin load` switch this to `True`.
+
+        `ln.connect()` doesn't change the value of this setting.
+        """
+        return self._auto_connect_path.exists()
+
+    @auto_connect.setter
+    def auto_connect(self, value: bool) -> None:
+        if value:
+            self._auto_connect_path.touch()
+        else:
+            self._auto_connect_path.unlink(missing_ok=True)
+
+    @property
+    def private_django_api(self) -> bool:
+        """Turn internal Django API private to clean up the API (default `False`).
+
+        This patches your local pip-installed django installation. You can undo
+        the patch by setting this back to `False`.
+        """
+        return self._private_django_api_path.exists()
+
+    @private_django_api.setter
+    def private_django_api(self, value: bool) -> None:
+        from ._private_django_api import private_django_api
+
+        # we don't want to call private_django_api() twice
+        if value and not self.private_django_api:
+            private_django_api()
+            self._private_django_api_path.touch()
+        elif not value and self.private_django_api:
+            private_django_api(reverse=True)
+            self._private_django_api_path.unlink(missing_ok=True)
+
+    @property
+    def user(self) -> UserSettings:
+        """Settings of current user."""
+        env_changed = (
+            self._user_settings_env is not None
+            and self._user_settings_env != get_env_name()
+        )
+        if self._user_settings is None or env_changed:
+            self._user_settings = load_or_create_user_settings()
+            self._user_settings_env = get_env_name()
+            if self._user_settings and self._user_settings.uid is None:
+                raise RuntimeError("Need to login, first: lamin login <email>")
+        return self._user_settings  # type: ignore
+
+    @property
+    def instance(self) -> InstanceSettings:
+        """Settings of current LaminDB instance."""
+        env_changed = (
+            self._instance_settings_env is not None
+            and self._instance_settings_env != get_env_name()
+        )
+        if self._instance_settings is None or env_changed:
+            self._instance_settings = load_instance_settings()
+            self._instance_settings_env = get_env_name()
+        return self._instance_settings  # type: ignore
+
+    @property
+    def storage(self) -> StorageSettings:
+        """Settings of default storage."""
+        return self.instance.storage
+
+    @property
+    def _instance_exists(self):
+        try:
+            self.instance  # noqa
+            return True
+        # this is implicit logic that catches if no instance is loaded
+        except SystemExit:
+            return False
+
+    def __repr__(self) -> str:
+        """Rich string representation."""
+        repr = self.user.__repr__()
+        repr += f"\nAuto-connect in Python: {self.auto_connect}\n"
+        repr += f"Private Django API: {self.private_django_api}\n"
+        if self._instance_exists:
+            repr += self.instance.__repr__()
+        else:
+            repr += "\nNo instance connected"
+        return repr
+
+
+def get_env_name():
+    if "LAMIN_ENV" in os.environ:
+        return os.environ["LAMIN_ENV"]
+    else:
+        return "prod"
+
+
+settings = SetupSettings()