lamindb 0.76.0__py3-none-any.whl → 0.76.1__py3-none-any.whl

lamindb/__init__.py

@@ -21,9 +21,8 @@ Key functionality:
 .. autosummary::
    :toctree: .
 
+   context
    connect
-   track
-   finish
    Curate
    view
    save
@@ -42,7 +41,7 @@ Modules & settings:
 """
 
 # denote a release candidate for 0.1.0 with 0.1rc1, 0.1a1, 0.1b1, etc.
-__version__ = "0.76.0"
+__version__ = "0.76.1"
 
 import os as _os
 
@@ -93,10 +92,9 @@ if _check_instance_setup(from_lamindb=True):
         integrations,
     )
     from ._curate import Curate
-    from ._finish import finish
     from ._save import save
     from ._view import view
-    from .core._run_context import run_context as _run_context
+    from .core._context import context
     from .core._settings import settings
 
     # schema modules
@@ -107,8 +105,8 @@ if _check_instance_setup(from_lamindb=True):
 
         _reload_schema_modules(_lamindb_setup.settings.instance)
 
-    track = _run_context._track
+    track = context.track  # backward compat
+    finish = context.finish  # backward compat
     settings.__doc__ = """Global :class:`~lamindb.core.Settings`."""
+    context.__doc__ = """Global :class:`~lamindb.core.Context`."""
     from django.db.models import Q
-
-    Annotate = Curate  # backward compat

lamindb/_artifact.py

@@ -107,7 +107,7 @@ def process_pathlike(
                 new_root = list(filepath.parents)[-1]
                 # do not register remote storage locations on hub if the current instance
                 # is not managed on the hub
-                storage_settings = init_storage(
+                storage_settings, _ = init_storage(
                     new_root, prevent_register_hub=not setup_settings.instance.is_on_hub
                 )
                 storage_record = register_storage_in_instance(storage_settings)

lamindb/_curate.py

@@ -313,11 +313,11 @@ class DataFrameCurator:
 
     def clean_up_failed_runs(self):
         """Clean up previous failed runs that don't save any outputs."""
-        from lamindb.core._run_context import run_context
+        from lamindb.core._context import context
 
-        if run_context.transform is not None:
-            Run.filter(transform=run_context.transform, output_artifacts=None).exclude(
-                uid=run_context.run.uid
+        if context.run is not None:
+            Run.filter(transform=context.run.transform, output_artifacts=None).exclude(
+                uid=context.run.uid
             ).delete()
 
 

lamindb/_finish.py

@@ -9,9 +9,6 @@ from typing import TYPE_CHECKING
 import lamindb_setup as ln_setup
 from lamin_utils import logger
 from lamindb_setup.core.hashing import hash_file
-from lnschema_core.types import TransformType
-
-from .core._run_context import is_run_from_ipython, run_context
 
 if TYPE_CHECKING:
     from pathlib import Path
@@ -21,51 +18,7 @@ if TYPE_CHECKING:
     from ._query_set import QuerySet
 
 
-class TrackNotCalled(SystemExit):
-    pass
-
-
-class NotebookNotSaved(SystemExit):
-    pass
-
-
-def get_seconds_since_modified(filepath) -> float:
-    return datetime.now().timestamp() - filepath.stat().st_mtime
-
-
-def finish() -> None:
-    """Mark a tracked run as finished.
-
-    Saves source code and, for notebooks, a run report to your default storage location.
-    """
-    if run_context.run is None:
-        raise TrackNotCalled("Please run `ln.track()` before `ln.finish()`")
-    if run_context.path is None:
-        if run_context.transform.type in {"script", "notebook"}:
-            raise ValueError(
-                f"Transform type is not allowed to be 'script' or 'notebook' but is {run_context.transform.type}."
-            )
-        run_context.run.finished_at = datetime.now(timezone.utc)
-        run_context.run.save()
-        # nothing else to do
-        return None
-    if is_run_from_ipython:  # notebooks
-        if (
-            get_seconds_since_modified(run_context.path) > 3
-            and os.getenv("LAMIN_TESTING") is None
-        ):
-            raise NotebookNotSaved(
-                "Please save the notebook in your editor right before running `ln.finish()`"
-            )
-    save_run_context_core(
-        run=run_context.run,
-        transform=run_context.transform,
-        filepath=run_context.path,
-        finished_at=True,
-    )
-
-
-def save_run_context_core(
+def save_context_core(
     *,
     run: Run,
     transform: Transform,
@@ -76,6 +29,8 @@ def save_run_context_core(
 ) -> str | None:
     import lamindb as ln
 
+    from .core._context import context, is_run_from_ipython
+
     ln.settings.verbosity = "success"
 
     # for scripts, things are easy
@@ -182,7 +137,9 @@ def save_run_context_core(
                     f"replaced transform._source_code_artifact: {transform._source_code_artifact}"
                 )
             else:
-                logger.warning("Please re-run `ln.track()` to make a new version")
+                logger.warning(
+                    "Please re-run `ln.context.track()` to make a new version"
+                )
                 return "rerun-the-notebook"
         else:
             logger.important("source code is already saved")
@@ -282,7 +239,7 @@ def save_run_context_core(
             logger.important(
                 f"if you want to update your {thing} without re-running it, use `lamin save {name}`"
             )
-    # because run & transform changed, update the global run_context
-    run_context.run = run
-    run_context.transform = transform
+    # because run & transform changed, update the global context
+    context._run = run
+    context._transform = transform
     return None

lamindb/_query_manager.py

@@ -40,11 +40,11 @@ class QueryManager(models.Manager):
                 self.source_field_name == "collection"
                 and self.target_field_name == "artifact"
             ):
+                from lamindb.core._context import context
                 from lamindb.core._data import WARNING_RUN_TRANSFORM, _track_run_input
-                from lamindb.core._run_context import run_context
 
                 if (
-                    run_context.run is None
+                    context.run is None
                     and not settings.creation.artifact_silence_missing_run_warning
                 ):
                     logger.warning(WARNING_RUN_TRANSFORM)

lamindb/_query_set.py

@@ -17,14 +17,12 @@ from lnschema_core.models import (
     Transform,
 )
 
+from lamindb.core.exceptions import DoesNotExist
+
 if TYPE_CHECKING:
     from lnschema_core.types import ListLike, StrField
 
 
-class NoResultFound(Exception):
-    pass
-
-
 class MultipleResultsFound(Exception):
     pass
 
@@ -59,7 +57,7 @@ def get_keys_from_df(data: list, registry: Record) -> list[str]:
 
 def one_helper(self):
     if len(self) == 0:
-        raise NoResultFound
+        raise DoesNotExist
     elif len(self) > 1:
         raise MultipleResultsFound(self)
     else:

lamindb/_record.py

@@ -123,13 +123,17 @@ def filter(cls, **expressions) -> QuerySet:
 
 @classmethod  # type:ignore
 @doc_args(Record.get.__doc__)
-def get(cls, idlike: int | str) -> Record:
+def get(
+    cls,
+    idlike: int | str | None = None,
+    **expressions,
+) -> Record:
     """{}"""  # noqa: D415
     from lamindb._filter import filter
 
     if isinstance(idlike, int):
         return filter(cls, id=idlike).one()
-    else:
+    elif isinstance(idlike, str):
         qs = filter(cls, uid__startswith=idlike)
         if issubclass(cls, IsVersioned):
             if len(idlike) <= cls._len_stem_uid:
@@ -138,12 +142,19 @@ def get(cls, idlike: int | str) -> Record:
                 return qs.one()
         else:
             return qs.one()
+    else:
+        assert idlike is None  # noqa: S101
+        # below behaves exactly like `.one()`
+        return cls.objects.get(**expressions)
 
 
 @classmethod  # type:ignore
 @doc_args(Record.df.__doc__)
 def df(
-    cls, include: str | list[str] | None = None, join: str = "inner"
+    cls,
+    include: str | list[str] | None = None,
+    join: str = "inner",
+    limit: int = 100,
 ) -> pd.DataFrame:
     """{}"""  # noqa: D415
     from lamindb._filter import filter
@@ -151,7 +162,7 @@ def df(
     query_set = filter(cls)
     if hasattr(cls, "updated_at"):
         query_set = query_set.order_by("-updated_at")
-    return query_set.df(include=include, join=join)
+    return query_set[:limit].df(include=include, join=join)
 
 
 # from_values doesn't apply for QuerySet or Manager
@@ -473,8 +484,8 @@ def transfer_to_default_db(
             return record_on_default
         if not mute:
             logger.hint(f"saving from instance {db} to default instance: {record}")
+        from lamindb.core._context import context
         from lamindb.core._data import WARNING_RUN_TRANSFORM
-        from lamindb.core._run_context import run_context
 
         if hasattr(record, "created_by_id"):
             # this line is needed to point created_by to default db
@@ -482,16 +493,16 @@ def transfer_to_default_db(
             record.created_by_id = ln_setup.settings.user.id
         if hasattr(record, "run_id"):
             record.run = None
-            if run_context.run is not None:
-                record.run_id = run_context.run.id
+            if context.run is not None:
+                record.run_id = context.run.id
             else:
                 if not settings.creation.artifact_silence_missing_run_warning:
                     logger.warning(WARNING_RUN_TRANSFORM)
                 record.run_id = None
         if hasattr(record, "transform_id") and record._meta.model_name != "run":
             record.transform = None
-            if run_context.transform is not None:
-                record.transform_id = run_context.transform.id
+            if context.run is not None:
+                record.transform_id = context.run.transform_id
             else:
                 record.transform_id = None
         # transfer other foreign key fields

lamindb/core/__init__.py

@@ -35,14 +35,20 @@ Curators:
    MuDataCurator
    CurateLookup
 
-Other:
+Settings & context:
 
 .. autosummary::
    :toctree: .
 
    Settings
+   Context
+
+Data loaders:
+
+.. autosummary::
+   :toctree: .
+
    MappedCollection
-   run_context
 
 Modules:
 
@@ -84,6 +90,6 @@ from lamindb.core._feature_manager import FeatureManager, ParamManager
 from lamindb.core._label_manager import LabelManager
 
 from . import _data, datasets, exceptions, fields, subsettings, types
+from ._context import Context
 from ._mapped_collection import MappedCollection
-from ._run_context import run_context
 from ._settings import Settings