lamindb 0.49.3__py3-none-any.whl → 0.50.1__py3-none-any.whl

lamindb/{_manager.py → _query_manager.py}

@@ -3,8 +3,8 @@ from typing import Optional
 from django.db import models
 
 
-class Manager(models.Manager):
-    """Extension of Django Manager.
+class QueryManager(models.Manager):
+    """Manage queries through fields.
 
     See Also:
 
@@ -44,9 +44,12 @@ class Manager(models.Manager):
             return [item for item in self.values_list(field, flat=True)]
 
     def df(self, **kwargs):
-        """Convert to DataFrame."""
+        """Convert to DataFrame.
+
+        For `**kwargs`, see :meth:`lamindb.dev.QuerySet.df`.
+        """
         return self.all().df(**kwargs)
 
 
-setattr(models.Manager, "list", Manager.list)
-setattr(models.Manager, "df", Manager.df)
+setattr(models.Manager, "list", QueryManager.list)
+setattr(models.Manager, "df", QueryManager.df)

lamindb/{_queryset.py → _query_set.py}

@@ -4,7 +4,7 @@ from typing import Iterable, List, NamedTuple, Optional
 import pandas as pd
 from django.db import models
 from lamindb_setup.dev._docs import doc_args
-from lnschema_core import ORM
+from lnschema_core.models import Registry, SynonymsAware, ValidationAware
 from lnschema_core.types import ListLike, StrField
 
 
@@ -23,12 +23,7 @@ def format_and_convert_to_local_time(series: pd.Series):
 
 
 class QuerySet(models.QuerySet):
-    """Extension of Django QuerySet.
-
-    This brings some of the SQLAlchemy/SQLModel/SQL-inspired calls.
-
-    As LaminDB was based on SQLAlchemy/SQLModel in the beginning, and might
-    support it again in the future, these calls will be supported longtime.
+    """Lazily loaded queried records returned by queries.
 
     See Also:
 
@@ -114,20 +109,20 @@ class QuerySet(models.QuerySet):
                     lookup_str = "__".join(split[1:])
                 else:
                     lookup_str = "id"
-                ORM = self.model
-                field = getattr(ORM, field_name)
+                Registry = self.model
+                field = getattr(Registry, field_name)
                 if not isinstance(field.field, models.ManyToManyField):
                     raise ValueError("Only many-to-many fields are allowed here.")
                 related_ORM = (
                     field.field.model
-                    if field.field.model != ORM
+                    if field.field.model != Registry
                     else field.field.related_model
                 )
-                if ORM == related_ORM:
-                    left_side_link_model = f"from_{ORM.__name__.lower()}"
-                    values_expression = f"to_{ORM.__name__.lower()}__{lookup_str}"
+                if Registry == related_ORM:
+                    left_side_link_model = f"from_{Registry.__name__.lower()}"
+                    values_expression = f"to_{Registry.__name__.lower()}__{lookup_str}"
                 else:
-                    left_side_link_model = f"{ORM.__name__.lower()}"
+                    left_side_link_model = f"{Registry.__name__.lower()}"
                     values_expression = f"{related_ORM.__name__.lower()}__{lookup_str}"
                 link_df = pd.DataFrame(
                     field.through.objects.values(
@@ -141,7 +136,7 @@ class QuerySet(models.QuerySet):
                 df.rename(columns={values_expression: expression}, inplace=True)
         return df
 
-    def list(self, field: Optional[str] = None) -> List[ORM]:
+    def list(self, field: Optional[str] = None) -> List[Registry]:
         """Populate a list with the results.
 
         Examples:
@@ -160,7 +155,7 @@ class QuerySet(models.QuerySet):
         else:
             return [item for item in self.values_list(field, flat=True)]
 
-    def first(self) -> Optional[ORM]:
+    def first(self) -> Optional[Registry]:
         """If non-empty, the first result in the query set, otherwise None.
 
         Examples:
@@ -173,7 +168,7 @@ class QuerySet(models.QuerySet):
             return None
         return self[0]
 
-    def one(self) -> ORM:
+    def one(self) -> Registry:
         """Exactly one result. Throws error if there are more or none.
 
         Examples:
@@ -188,7 +183,7 @@ class QuerySet(models.QuerySet):
         else:
             return self[0]
 
-    def one_or_none(self) -> Optional[ORM]:
+    def one_or_none(self) -> Optional[Registry]:
         """At most one result. Returns it if there is one, otherwise returns None.
 
         Examples:
@@ -205,31 +200,38 @@ class QuerySet(models.QuerySet):
         else:
             raise MultipleResultsFound
 
-    @doc_args(ORM.search.__doc__)
+    @doc_args(Registry.search.__doc__)
     def search(self, string: str, **kwargs):
         """{}"""
-        from ._orm import _search
+        from ._registry import _search
 
         return _search(cls=self, string=string, **kwargs)
 
-    @doc_args(ORM.lookup.__doc__)
+    @doc_args(Registry.lookup.__doc__)
     def lookup(self, field: Optional[StrField] = None) -> NamedTuple:
         """{}"""
-        from ._orm import _lookup
+        from ._registry import _lookup
 
         return _lookup(cls=self, field=field)
 
-    @doc_args(ORM.inspect.__doc__)
-    def inspect(self, identifiers: ListLike, field: StrField, **kwargs):
+    @doc_args(ValidationAware.validate.__doc__)
+    def validate(self, values: ListLike, field: StrField, **kwargs):
+        """{}"""
+        from ._validate import _validate
+
+        return _validate(cls=self, values=values, field=field, **kwargs)
+
+    @doc_args(ValidationAware.inspect.__doc__)
+    def inspect(self, values: ListLike, field: StrField, **kwargs):
         """{}"""
-        from ._orm import _inspect
+        from ._validate import _inspect
 
-        return _inspect(cls=self, identifiers=identifiers, field=field, **kwargs)
+        return _inspect(cls=self, values=values, field=field, **kwargs)
 
-    @doc_args(ORM.map_synonyms.__doc__)
+    @doc_args(SynonymsAware.map_synonyms.__doc__)
     def map_synonyms(self, synonyms: Iterable, **kwargs):
         """{}"""
-        from ._orm import _map_synonyms
+        from ._synonym import _map_synonyms
 
         return _map_synonyms(cls=self, synonyms=synonyms, **kwargs)
 
@@ -241,5 +243,6 @@ setattr(models.QuerySet, "one", QuerySet.one)
 setattr(models.QuerySet, "one_or_none", QuerySet.one_or_none)
 setattr(models.QuerySet, "search", QuerySet.search)
 setattr(models.QuerySet, "lookup", QuerySet.lookup)
+setattr(models.QuerySet, "validate", QuerySet.validate)
 setattr(models.QuerySet, "inspect", QuerySet.inspect)
 setattr(models.QuerySet, "map_synonyms", QuerySet.map_synonyms)