lamindb_setup 0.76.7__py2.py3-none-any.whl → 0.77.0__py2.py3-none-any.whl

lamindb_setup/_set_managed_storage.py

@@ -1,55 +1,55 @@
-from __future__ import annotations
-
-from typing import TYPE_CHECKING
-
-from lamin_utils import logger
-
-from ._init_instance import register_storage_in_instance
-from .core._hub_core import delete_storage_record
-from .core._settings import settings
-from .core._settings_storage import init_storage
-
-if TYPE_CHECKING:
-    from lamindb_setup.core.types import UPathStr
-
-
-def set_managed_storage(root: UPathStr, **fs_kwargs):
-    """Add or switch to another managed storage location.
-
-    Args:
-        root: `UPathStr` - The new storage root, e.g., an S3 bucket.
-        **fs_kwargs: Additional fsspec arguments for cloud root, e.g., profile.
-
-    """
-    if settings.instance.dialect == "sqlite":
-        raise ValueError(
-            "Can't add additional managed storage locations for sqlite instances."
-        )
-    if not settings.instance.is_on_hub:
-        raise ValueError(
-            "Can't add additional managed storage locations for instances that aren't managed through the hub."
-        )
-    # here the storage is registered in the hub
-    # hub_record_status="hub-record-created" if a new record is created
-    # "hub-record-retireved" if the storage is in the hub already
-    ssettings, hub_record_status = init_storage(
-        root=root, instance_id=settings.instance._id, register_hub=True
-    )
-    if ssettings._instance_id is None:
-        raise ValueError(
-            f"Cannot manage storage without write access: {ssettings.root}"
-        )
-
-    # here the storage is saved in the instance
-    # if any error happens the record in the hub is deleted
-    # if it was created earlier and not retrieved
-    try:
-        register_storage_in_instance(ssettings)
-    except Exception as e:
-        if hub_record_status == "hub-record-created" and ssettings._uuid is not None:
-            delete_storage_record(ssettings._uuid)  # type: ignore
-        raise e
-
-    settings.instance._storage = ssettings
-    settings.instance._persist()  # this also updates the settings object
-    settings.storage._set_fs_kwargs(**fs_kwargs)
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from lamin_utils import logger
+
+from ._init_instance import register_storage_in_instance
+from .core._hub_core import delete_storage_record
+from .core._settings import settings
+from .core._settings_storage import init_storage
+
+if TYPE_CHECKING:
+    from lamindb_setup.core.types import UPathStr
+
+
+def set_managed_storage(root: UPathStr, **fs_kwargs):
+    """Add or switch to another managed storage location.
+
+    Args:
+        root: `UPathStr` - The new storage root, e.g., an S3 bucket.
+        **fs_kwargs: Additional fsspec arguments for cloud root, e.g., profile.
+
+    """
+    if settings.instance.dialect == "sqlite":
+        raise ValueError(
+            "Can't add additional managed storage locations for sqlite instances."
+        )
+    if not settings.instance.is_on_hub:
+        raise ValueError(
+            "Can't add additional managed storage locations for instances that aren't managed through the hub."
+        )
+    # here the storage is registered in the hub
+    # hub_record_status="hub-record-created" if a new record is created
+    # "hub-record-retireved" if the storage is in the hub already
+    ssettings, hub_record_status = init_storage(
+        root=root, instance_id=settings.instance._id, register_hub=True
+    )
+    if ssettings._instance_id is None:
+        raise ValueError(
+            f"Cannot manage storage without write access: {ssettings.root}"
+        )
+
+    # here the storage is saved in the instance
+    # if any error happens the record in the hub is deleted
+    # if it was created earlier and not retrieved
+    try:
+        register_storage_in_instance(ssettings)
+    except Exception as e:
+        if hub_record_status == "hub-record-created" and ssettings._uuid is not None:
+            delete_storage_record(ssettings._uuid)  # type: ignore
+        raise e
+
+    settings.instance._storage = ssettings
+    settings.instance._persist()  # this also updates the settings object
+    settings.storage._set_fs_kwargs(**fs_kwargs)

lamindb_setup/_setup_user.py

@@ -1,118 +1,134 @@
-from __future__ import annotations
-
-from typing import Optional, Union
-
-from lamin_utils import logger
-
-from ._check_setup import _check_instance_setup
-from ._init_instance import register_user
-from .core._settings import settings
-from .core._settings_load import load_or_create_user_settings, load_user_settings
-from .core._settings_save import save_user_settings
-from .core._settings_store import (
-    current_user_settings_file,
-    user_settings_file_email,
-    user_settings_file_handle,
-)
-
-
-def load_user(email: str | None = None, handle: str | None = None) -> str | None:
-    if email is not None:
-        settings_file = user_settings_file_email(email)
-    if handle is not None:
-        settings_file = user_settings_file_handle(handle)
-    if settings_file.exists():
-        user_settings = load_user_settings(settings_file)
-        save_user_settings(user_settings)  # needed to save to current_user.env
-        assert user_settings.email is not None
-    else:
-        user_settings = load_or_create_user_settings()
-        if email is None:
-            raise RuntimeError(
-                "Use your email for your first login in a compute environment. "
-                "After that, you can use your handle."
-            )
-        user_settings.email = email
-        user_settings.handle = handle
-        save_user_settings(user_settings)
-
-    from .core._settings import settings
-
-    settings._user_settings = None  # this is to refresh a settings instance
-
-    return None
-
-
-def login(
-    user: str,
-    *,
-    key: str | None = None,
-    password: str | None = None,  # for backward compat
-) -> None:
-    """Log in user.
-
-    Args:
-        user: handle or email
-        key: API key or legacy passward
-        password: Backward compat, will be removed
-    """
-    if "@" in user:
-        email, handle = user, None
-    else:
-        email, handle = None, user
-    load_user(email, handle)
-
-    user_settings = load_or_create_user_settings()
-
-    if password is not None:
-        logger.warning(
-            "please use --key instead of --password, "
-            "passwords are deprecated and replaced with API keys"
-        )
-        key = password
-
-    if key is not None:
-        # within UserSettings, we still call it "password" for a while
-        user_settings.password = key
-
-    if user_settings.email is None:
-        raise RuntimeError("No stored user email, please call: lamin login {user}")
-
-    if user_settings.password is None:
-        raise RuntimeError(
-            "No stored API key, please call: lamin login <your-email> --key <API-key>"
-        )
-
-    from .core._hub_core import sign_in_hub
-
-    response = sign_in_hub(
-        user_settings.email, user_settings.password, user_settings.handle
-    )
-    if isinstance(response, Exception):
-        raise response
-    else:
-        user_uuid, user_id, user_handle, user_name, access_token = response
-    if handle is None:
-        logger.success(f"logged in with handle {user_handle} (uid: {user_id})")
-    else:
-        logger.success(f"logged in with email {user_settings.email} (uid: {user_id})")
-    user_settings.uid = user_id
-    user_settings.handle = user_handle
-    user_settings.name = user_name
-    user_settings._uuid = user_uuid
-    user_settings.access_token = access_token
-    save_user_settings(user_settings)
-
-    if settings._instance_exists and _check_instance_setup():
-        register_user(user_settings)
-
-    settings._user_settings = None
-    return None
-
-
-def logout():
-    if current_user_settings_file().exists():
-        current_user_settings_file().unlink()
-        logger.success("logged out")
-    else:
-        logger.important("already logged out")
+from __future__ import annotations
+
+import os
+from typing import TYPE_CHECKING, Optional, Union
+
+from lamin_utils import logger
+
+from ._check_setup import _check_instance_setup
+from ._init_instance import register_user
+from .core._settings import settings
+from .core._settings_load import load_or_create_user_settings, load_user_settings
+from .core._settings_save import save_user_settings
+from .core._settings_store import (
+    current_user_settings_file,
+    user_settings_file_email,
+    user_settings_file_handle,
+)
+
+if TYPE_CHECKING:
+    from lamindb_setup.core._settings_save import UserSettings
+
+
+def load_user(email: str | None = None, handle: str | None = None) -> UserSettings:
+    if email is not None:
+        settings_file = user_settings_file_email(email)
+    if handle is not None:
+        settings_file = user_settings_file_handle(handle)
+    if settings_file.exists():
+        user_settings = load_user_settings(settings_file)
+        save_user_settings(user_settings)  # needed to save to current_user.env
+        assert user_settings.email is not None
+    else:
+        user_settings = load_or_create_user_settings()
+        if email is None:
+            raise SystemExit(
+                "✗ Use your email for your first login in a compute environment. "
+                "After that, you can use your handle."
+            )
+        user_settings.email = email
+        user_settings.handle = handle
+        save_user_settings(user_settings)
+
+    from .core._settings import settings
+
+    settings._user_settings = None  # this is to refresh a settings instance
+
+    return user_settings
+
+
+def login(
+    user: str | None = None, *, key: str | None = None, api_key: str | None = None
+) -> None:
+    """Log in user.
+
+    Args:
+        user: handle or email
+        key: API key
+        api_key: Beta API key
+    """
+    if user is None and api_key is None:
+        if "LAMIN_API_KEY" in os.environ:
+            api_key = os.environ["LAMIN_API_KEY"]
+        else:
+            raise ValueError("Both `user` and `api_key` should not be `None`.")
+
+    if api_key is None:
+        if "@" in user:  # type: ignore
+            email, handle = user, None
+        else:
+            email, handle = None, user
+        user_settings = load_user(email, handle)
+
+        if key is not None:
+            # within UserSettings, we still call it "password" for a while
+            user_settings.password = key
+
+        if user_settings.email is None:
+            raise SystemExit(f"✗ No stored user email, please call: lamin login {user}")
+
+        if user_settings.password is None:
+            raise SystemExit(
+                "✗ No stored API key, please call: lamin login <your-email> --key <API-key>"
+            )
+    else:
+        user_settings = load_or_create_user_settings()
+
+    from .core._hub_core import sign_in_hub, sign_in_hub_api_key
+
+    if api_key is None:
+        response = sign_in_hub(
+            user_settings.email,  # type: ignore
+            user_settings.password,  # type: ignore
+            user_settings.handle,
+        )
+    else:
+        response = sign_in_hub_api_key(api_key)
+
+    if isinstance(response, Exception):
+        raise response
+    elif isinstance(response, str):
+        raise SystemExit(f"✗ Unsuccessful login: {response}.")
+    else:
+        user_uuid, user_id, user_handle, user_name, access_token = response
+    if api_key is not None:
+        logger.success(
+            f"logged in with API key (handle: {user_handle}, uid: {user_id})"
+        )
+    elif handle is None:
+        logger.success(f"logged in with handle {user_handle} (uid: {user_id})")
+    else:
+        logger.success(f"logged in with email {user_settings.email} (uid: {user_id})")
+    user_settings.uid = user_id
+    user_settings.handle = user_handle
+    user_settings.name = user_name
+    user_settings._uuid = user_uuid
+    user_settings.access_token = access_token
+    user_settings.api_key = api_key
+    save_user_settings(user_settings)
+
+    if settings._instance_exists and _check_instance_setup():
+        register_user(user_settings)
+
+    settings._user_settings = None
+    return None
+
+
+def logout():
+    if current_user_settings_file().exists():
+        current_user_settings_file().unlink()
+        # update user info
+        settings._user_settings = None
+        logger.success("logged out")
+    else:
+        logger.important("already logged out")

lamindb_setup/_silence_loggers.py

@@ -1,44 +1,44 @@
-from __future__ import annotations
-
-import logging
-
-silenced = False
-
-
-# from https://github.com/boto/boto3/blob/8c6e641bed8130a9d8cb4d97b4acbe7aa0d0657a/boto3/__init__.py#L37
-def set_stream_logger(name, level):
-    logger = logging.getLogger(name)
-    logger.setLevel(level)
-    handler = logging.StreamHandler()
-    handler.setLevel(level)
-    logger.addHandler(handler)
-
-
-def silence_loggers():
-    global silenced
-
-    if not silenced:
-        # this gets logged 6 times
-        set_stream_logger(name="botocore.credentials", level=logging.WARNING)
-        set_stream_logger(name="botocore.hooks", level=logging.WARNING)
-        set_stream_logger(name="botocore.utils", level=logging.WARNING)
-        set_stream_logger(name="botocore.auth", level=logging.WARNING)
-        set_stream_logger(name="botocore.endpoint", level=logging.WARNING)
-        set_stream_logger(name="httpx", level=logging.WARNING)
-        try:
-            import aiobotocore
-
-            # the 7th logging message of credentials came from aiobotocore
-            set_stream_logger(name="aiobotocore.credentials", level=logging.WARNING)
-        except ImportError:
-            pass
-        try:
-            # google also aggressively logs authentication related warnings
-            # in cases where users access public data
-            set_stream_logger(name="google.auth._default", level=logging.ERROR)
-            set_stream_logger(
-                name="google.auth.compute_engine._metadata", level=logging.ERROR
-            )
-        except Exception:
-            pass
-    silenced = True
+from __future__ import annotations
+
+import logging
+
+silenced = False
+
+
+# from https://github.com/boto/boto3/blob/8c6e641bed8130a9d8cb4d97b4acbe7aa0d0657a/boto3/__init__.py#L37
+def set_stream_logger(name, level):
+    logger = logging.getLogger(name)
+    logger.setLevel(level)
+    handler = logging.StreamHandler()
+    handler.setLevel(level)
+    logger.addHandler(handler)
+
+
+def silence_loggers():
+    global silenced
+
+    if not silenced:
+        # this gets logged 6 times
+        set_stream_logger(name="botocore.credentials", level=logging.WARNING)
+        set_stream_logger(name="botocore.hooks", level=logging.WARNING)
+        set_stream_logger(name="botocore.utils", level=logging.WARNING)
+        set_stream_logger(name="botocore.auth", level=logging.WARNING)
+        set_stream_logger(name="botocore.endpoint", level=logging.WARNING)
+        set_stream_logger(name="httpx", level=logging.WARNING)
+        try:
+            import aiobotocore
+
+            # the 7th logging message of credentials came from aiobotocore
+            set_stream_logger(name="aiobotocore.credentials", level=logging.WARNING)
+        except ImportError:
+            pass
+        try:
+            # google also aggressively logs authentication related warnings
+            # in cases where users access public data
+            set_stream_logger(name="google.auth._default", level=logging.ERROR)
+            set_stream_logger(
+                name="google.auth.compute_engine._metadata", level=logging.ERROR
+            )
+        except Exception:
+            pass
+    silenced = True

lamindb_setup/core/__init__.py

@@ -1,21 +1,21 @@
-"""Core setup library.
-
-Settings:
-
-.. autosummary::
-   :toctree:
-
-   SetupSettings
-   UserSettings
-   InstanceSettings
-   StorageSettings
-
-"""
-
-from . import django, types, upath
-from ._deprecated import deprecated
-from ._docs import doc_args
-from ._settings import SetupSettings
-from ._settings_instance import InstanceSettings
-from ._settings_storage import StorageSettings
-from ._settings_user import UserSettings
+"""Core setup library.
+
+Settings:
+
+.. autosummary::
+   :toctree:
+
+   SetupSettings
+   UserSettings
+   InstanceSettings
+   StorageSettings
+
+"""
+
+from . import django, types, upath
+from ._deprecated import deprecated
+from ._docs import doc_args
+from ._settings import SetupSettings
+from ._settings_instance import InstanceSettings
+from ._settings_storage import StorageSettings
+from ._settings_user import UserSettings