sqlakit 0.17.0__tar.gz → 0.18.0__tar.gz

{sqlakit-0.17.0 → sqlakit-0.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sqlakit
-Version: 0.17.0
+Version: 0.18.0
 Summary: A toolkit for SQLAlchemy applications.
 Keywords: sqlalchemy,database,orm,sql,asyncio
 Author: Anton Ruhlov

{sqlakit-0.17.0 → sqlakit-0.18.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sqlakit"
-version = "0.17.0"
+version = "0.18.0"
 description = "A toolkit for SQLAlchemy applications."
 readme = "README.md"
 license = "MIT"

{sqlakit-0.17.0 → sqlakit-0.18.0}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "sqlakit"
-version = "0.17.0"
+version = "0.18.0"
 description = "A toolkit for SQLAlchemy applications."
 readme = "README.md"
 license = "MIT"

{sqlakit-0.17.0 → sqlakit-0.18.0}/sqlakit/asyncio/orm.py

@@ -545,12 +545,28 @@ class QueryDescriptor(Generic[QueryT]):
 
         query = QueryDescriptor(AppQuery)
     ```
+
+    Given `Query` itself, as `ModelMixin` does, it reads as a query of the model
+    it is read from: `User.query` is a `Query[User]`, so `User.query.get(1)` is
+    a `User | None`.
     """
 
     def __init__(self, query_class: type[QueryT]) -> None:
         self.query_class = query_class
 
-    def __get__(self, instance: object | None, owner: type[Any]) -> QueryT:
+    # `ClassVar` cannot hold a type variable, so the base declares the query
+    # every model has and a read narrows it to the model it is read from.
+    @overload
+    def __get__(
+        self: QueryDescriptor[Query[Any]],
+        instance: object | None,
+        owner: type[ModelT],
+    ) -> Query[ModelT]: ...
+
+    @overload
+    def __get__(self, instance: object | None, owner: type[Any]) -> QueryT: ...
+
+    def __get__(self, instance: object | None, owner: type[Any]) -> Query[Any]:
         return self.query_class(owner, owner.db)
 
 

{sqlakit-0.17.0 → sqlakit-0.18.0}/sqlakit/orm.py

@@ -533,12 +533,28 @@ class QueryDescriptor(Generic[QueryT]):
 
         query = QueryDescriptor(AppQuery)
     ```
+
+    Given `Query` itself, as `ModelMixin` does, it reads as a query of the model
+    it is read from: `User.query` is a `Query[User]`, so `User.query.get(1)` is
+    a `User | None`.
     """
 
     def __init__(self, query_class: type[QueryT]) -> None:
         self.query_class = query_class
 
-    def __get__(self, instance: object | None, owner: type[Any]) -> QueryT:
+    # `ClassVar` cannot hold a type variable, so the base declares the query
+    # every model has and a read narrows it to the model it is read from.
+    @overload
+    def __get__(
+        self: QueryDescriptor[Query[Any]],
+        instance: object | None,
+        owner: type[ModelT],
+    ) -> Query[ModelT]: ...
+
+    @overload
+    def __get__(self, instance: object | None, owner: type[Any]) -> QueryT: ...
+
+    def __get__(self, instance: object | None, owner: type[Any]) -> Query[Any]:
         return self.query_class(owner, owner.db)