lamindb 1.5.3__py3-none-any.whl → 1.6.0__py3-none-any.whl

lamindb/models/__init__.py

@@ -3,23 +3,21 @@
 .. autosummary::
    :toctree: .
 
-   BasicRecord
-   Record
+   BaseSQLRecord
+   SQLRecord
    Registry
    BasicQuerySet
    QuerySet
    ArtifactSet
    QueryManager
-   RecordList
+   SQLRecordList
    FeatureManager
-   ParamManager
    LabelManager
    IsVersioned
    CanCurate
    HasParents
    TracksRun
    TracksUpdates
-   ParamValue
    FeatureValue
    InspectResult
    ValidateFields
@@ -31,19 +29,21 @@
 from lamin_utils._inspect import InspectResult
 from ._is_versioned import IsVersioned
 from .can_curate import CanCurate
-from .record import (
-    BasicRecord,
-    Record,
+from .sqlrecord import (
+    BaseSQLRecord,
+    SQLRecord,
     Registry,
     Space,
+    Branch,
+    Migration,
     ValidateFields,
     format_field_value,
     record_repr,
-    LinkORM,
+    IsLink,
 )
 from .core import Storage
 from .transform import Transform
-from .run import Run, TracksRun, TracksUpdates, current_run, Param, ParamValue, User
+from .run import Run, TracksRun, TracksUpdates, current_run, User
 from .feature import Feature, FeatureValue
 from .schema import Schema
 from .ulabel import ULabel
@@ -51,13 +51,11 @@ from .ulabel import ULabel
 # should come last as it needs everything else
 from .artifact import Artifact
 from ._feature_manager import FeatureManager
-from .run import ParamManager
 from ._label_manager import LabelManager
 from .collection import Collection, CollectionArtifact
 from .project import Person, Project, Reference
-from .flextable import FlexTable, RunData
 from .query_manager import QueryManager
-from .query_set import BasicQuerySet, QuerySet, RecordList
+from .query_set import BasicQuerySet, QuerySet, SQLRecordList
 from .artifact_set import ArtifactSet
 from .has_parents import HasParents
 from datetime import datetime as _datetime
@@ -65,8 +63,7 @@ from datetime import datetime as _datetime
 FeatureSet = Schema  # backward compat
 
 # link models
-from .artifact import ArtifactFeatureValue, ArtifactParamValue
-from .flextable import FlexTableData
+from .artifact import ArtifactFeatureValue
 from .project import (
     ArtifactProject,
     TransformProject,
@@ -76,14 +73,34 @@ from .project import (
     SchemaProject,
     ArtifactReference,
     CollectionReference,
+    SheetProject,
+    RunProject,
+    RecordProject,
+    PersonProject,
 )
-from .record import Migration
-from .run import RunParamValue
+from .run import RunFeatureValue
 from .schema import (
     SchemaFeature,
-    SchemaParam,
     ArtifactSchema,
     SchemaComponent,
     SchemaOptionals,
 )
 from .ulabel import ArtifactULabel, TransformULabel, RunULabel, CollectionULabel
+
+from .record import (
+    Record,
+    Sheet,
+    RecordJson,
+    RecordRecord,
+    RecordULabel,
+    RecordRun,
+    RecordArtifact,
+)
+
+
+LinkORM = IsLink  # backward compat
+ParamValue = FeatureValue  # backward compat
+ArtifactParamValue = ArtifactFeatureValue  # backward compat
+RunParamValue = RunFeatureValue  # backward compat
+Param = Feature  # backward compat
+BasicRecord = BaseSQLRecord  # backward compat

lamindb/models/_describe.py

@@ -89,10 +89,10 @@ def describe_header(self: Artifact | Collection | Run) -> Tree:
         logger.warning(
             f"This is not the latest version of the {self.__class__.__name__}."
         )
-    if hasattr(self, "_branch_code"):
-        if self._branch_code == 0:  # type: ignore
-            logger.warning("This artifact is hidden.")
-        elif self._branch_code == -1:  # type: ignore
+    if hasattr(self, "branch_id"):
+        if self.branch_id == 0:  # type: ignore
+            logger.warning("This artifact is archived.")
+        elif self.branch_id == -1:  # type: ignore
             logger.warning("This artifact is in the trash.")
     # initialize tree
     suffix = self.suffix if hasattr(self, "suffix") and self.suffix else ""

lamindb/models/_django.py

@@ -15,7 +15,31 @@ from .schema import Schema
 
 if TYPE_CHECKING:
     from .artifact import Artifact
-    from .record import Record
+    from .sqlrecord import SQLRecord
+
+
+def patch_many_to_many_descriptor() -> None:
+    """Patches Django's `ManyToManyDescriptor.__get__` method to suggest better errors when saving relationships of an unsaved model.
+
+    Before this patch: Cryptic errors are raised when relationships of an unsaved
+    record are attempted to be modified.
+
+    After this patch: Attempts to access M2M relationships on unsaved objects
+    will raise ValueError, suggesting explicit .save() of the record to be modified
+    before relationship creation.
+    """
+    from django.db.models.fields.related_descriptors import ManyToManyDescriptor
+
+    original_get = ManyToManyDescriptor.__get__
+
+    def patched_get(self, instance, cls=None):
+        if instance is not None and instance.pk is None:
+            raise ValueError(
+                f"You are trying to access the many-to-many relationships of an unsaved {instance.__class__.__name__} object. Please save it first using '.save()'."
+            )
+        return original_get(self, instance, cls)
+
+    ManyToManyDescriptor.__get__ = patched_get
 
 
 def get_related_model(model, field_name):
@@ -35,7 +59,7 @@ def get_related_model(model, field_name):
 
 
 def get_artifact_with_related(
-    artifact: Record,
+    artifact: SQLRecord,
     include_fk: bool = False,
     include_m2m: bool = False,
     include_feature_link: bool = False,
@@ -51,7 +75,9 @@ def get_artifact_with_related(
     foreign_key_fields = [
         f.name
         for f in model._meta.fields
-        if f.is_relation and f.related_model.__get_module_name__() in schema_modules
+        if f.is_relation
+        and f.related_model.__get_module_name__() in schema_modules
+        and f.name != "branch"  # TODO: re-enable at some point
     ]
 
     m2m_relations = (
@@ -89,7 +115,10 @@ def get_artifact_with_related(
 
     for link in link_tables:
         link_model = getattr(model, link).rel.related_model
-        if not hasattr(link_model, "feature"):
+        if (
+            not hasattr(link_model, "feature")
+            or link_model.__name__ == "RecordArtifact"
+        ):
             continue
         label_field = link.removeprefix("links_").replace("_", "")
         annotations[f"linkfield_{link}"] = Subquery(
@@ -198,6 +227,8 @@ def get_schema_m2m_relations(artifact: Artifact, slot_schema: dict, limit: int =
         name_field = get_name_field(related_model)
 
         # Get the correct field names for the through table
+        if not hasattr(getattr(Schema, name), "through"):
+            continue
         through_model = getattr(Schema, name).through
 
         # Subquery to get limited related records
@@ -238,3 +269,6 @@ def get_schema_m2m_relations(artifact: Artifact, slot_schema: dict, limit: int =
         )
 
     return result
+
+
+patch_many_to_many_descriptor()