TypeDAL 4.2.1__tar.gz → 4.2.2__tar.gz

{typedal-4.2.1 → typedal-4.2.2}/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 <!--next-version-placeholder-->
 
+## v4.2.2 (2025-12-10)
+
+### Fix
+
+* Improved type hints for relationships (when join='inner') ([`e54cf91`](https://github.com/trialandsuccess/TypeDAL/commit/e54cf918461757b2fd146f1f3c7d9957c723f68c))
+
 ## v4.2.1 (2025-12-10)
 
 ### Fix

{typedal-4.2.1 → typedal-4.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TypeDAL
-Version: 4.2.1
+Version: 4.2.2
 Summary: Typing support for PyDAL
 Project-URL: Documentation, https://typedal.readthedocs.io/
 Project-URL: Issues, https://github.com/trialandsuccess/TypeDAL/issues

{typedal-4.2.1 → typedal-4.2.2}/src/typedal/__about__.py

@@ -5,4 +5,4 @@ This file contains the Version info for this package.
 # SPDX-FileCopyrightText: 2023-present Robin van der Noord <robinvandernoord@gmail.com>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "4.2.1"
+__version__ = "4.2.2"

{typedal-4.2.1 → typedal-4.2.2}/src/typedal/relationships.py

@@ -277,6 +277,28 @@ def relationship(
     """
 
 
+@t.overload
+def relationship(
+    _type: t.Type[To_Type] | str,
+    condition: Condition = None,
+    *,
+    join: t.Literal["inner"],
+    on: OnQuery = None,
+    lazy: LazyPolicy | None = None,
+    explicit: bool = False,
+) -> To_Type:
+    """
+    Define a relationship that returns a single related instance (never None with inner join).
+
+    Args:
+        _type: A type or string reference like City to indicate a single related record.
+        join: Set to 'inner' to guarantee a non-null result.
+
+    Returns:
+        A single related instance (guaranteed non-null with inner join).
+    """
+
+
 @t.overload
 def relationship(
     _type: t.Type[To_Type] | str,
@@ -313,6 +335,7 @@ def relationship(
         condition: Lambda function defining the join condition between tables.
                    Example: lambda self, post: self.id == post.author
         join: Join strategy ('left', 'inner', etc.). Defaults to 'left' when using 'on'.
+              When 'inner' is used with a single type, the result is guaranteed non-null.
         on: Alternative to condition for complex queries with pivot tables.
             Allows specifying multiple join conditions to avoid cross joins.
         lazy: Controls behavior when accessing relationship data without explicitly joining: