TypeDAL 3.6.0__py3-none-any.whl → 3.7.1__py3-none-any.whl

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__ = "3.6.0"
+__version__ = "3.7.1"

typedal/core.py

@@ -8,6 +8,7 @@ import datetime as dt
 import inspect
 import json
 import math
+import sys
 import types
 import typing
 import warnings
@@ -339,6 +340,22 @@ def to_relationship(
     return Relationship(typing.cast(type[TypedTable], field), condition, typing.cast(JOIN_OPTIONS, join))
 
 
+def evaluate_forward_reference(fw_ref: typing.ForwardRef) -> type:
+    """
+    Extract the original type from a forward reference string.
+    """
+    kwargs = dict(
+        localns=locals(),
+        globalns=globals(),
+        recursive_guard=frozenset(),
+    )
+    if sys.version_info >= (3, 13):
+        # required since 3.13 and not supported before
+        kwargs["type_params"] = ()
+
+    return fw_ref._evaluate(**kwargs)  # type: ignore
+
+
 class TypeDAL(pydal.DAL):  # type: ignore
     """
     Drop-in replacement for pyDAL with layer to convert class-based table definitions to classical pydal define_tables.
@@ -465,6 +482,7 @@ class TypeDAL(pydal.DAL):  # type: ignore
         # when __future__.annotations is implemented, cls.__annotations__ will not work anymore as below.
         # proper way to handle this would be (but gives error right now due to Table implementing magic methods):
         # typing.get_type_hints(cls, globalns=None, localns=None)
+        # -> ERR e.g. `pytest -svxk cli` -> name 'BestFriend' is not defined
 
         # dirty way (with evil eval):
         # [eval(v) for k, v in cls.__annotations__.items()]
@@ -674,9 +692,8 @@ class TypeDAL(pydal.DAL):  # type: ignore
 
         if isinstance(ftype, str):
             # extract type from string
-            ftype = typing.get_args(Type[ftype])[0]._evaluate(
-                localns=locals(), globalns=globals(), recursive_guard=frozenset()
-            )
+            fw_ref: typing.ForwardRef = typing.get_args(Type[ftype])[0]
+            ftype = evaluate_forward_reference(fw_ref)
 
         if mapping := BASIC_MAPPINGS.get(ftype):
             # basi types
@@ -1144,7 +1161,7 @@ class TableMeta(type):
         """
         Add a before insert hook.
         """
-        cls._before_insert.append(fn)  # type: ignore
+        cls._before_insert.append(fn)
         return cls
 
     def after_insert(
@@ -1157,7 +1174,7 @@ class TableMeta(type):
         """
         Add an after insert hook.
         """
-        cls._after_insert.append(fn)  # type: ignore
+        cls._after_insert.append(fn)
         return cls
 
     def before_update(
@@ -1167,7 +1184,7 @@ class TableMeta(type):
         """
         Add a before update hook.
         """
-        cls._before_update.append(fn)  # type: ignore
+        cls._before_update.append(fn)
         return cls
 
     def after_update(
@@ -1177,7 +1194,7 @@ class TableMeta(type):
         """
         Add an after update hook.
         """
-        cls._after_update.append(fn)  # type: ignore
+        cls._after_update.append(fn)
         return cls
 
     def before_delete(cls: Type[T_MetaInstance], fn: typing.Callable[[Set], Optional[bool]]) -> Type[T_MetaInstance]:

typedal/helpers.py

@@ -10,7 +10,12 @@ import typing
 from collections import ChainMap
 from typing import Any
 
-from .types import AnyDict
+from pydal import DAL
+
+from .types import AnyDict, Field, Table
+
+if typing.TYPE_CHECKING:
+    from . import TypeDAL, TypedField, TypedTable  # noqa: F401
 
 T = typing.TypeVar("T")
 
@@ -274,3 +279,27 @@ def utcnow() -> dt.datetime:
     """
     # return dt.datetime.now(dt.UTC)
     return dt.datetime.now(dt.timezone.utc)
+
+
+def get_db(table: "TypedTable | Table") -> "DAL":
+    """
+    Get the underlying DAL instance for a pydal or typedal table.
+    """
+    return typing.cast("DAL", table._db)
+
+
+def get_table(table: "TypedTable | Table") -> "Table":
+    """
+    Get the underlying pydal table for a typedal table.
+    """
+    return typing.cast("Table", table._table)
+
+
+def get_field(field: "TypedField[typing.Any] | Field") -> "Field":
+    """
+    Get the underlying pydal field from a typedal field.
+    """
+    return typing.cast(
+        "Field",
+        field,  # Table.field already is a Field, but cast to make sure the editor knows this too.
+    )

{typedal-3.6.0.dist-info → typedal-3.7.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: TypeDAL
-Version: 3.6.0
+Version: 3.7.1
 Summary: Typing support for PyDAL
 Project-URL: Documentation, https://typedal.readthedocs.io/
 Project-URL: Issues, https://github.com/trialandsuccess/TypeDAL/issues
@@ -12,16 +12,18 @@ Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.10
 Requires-Dist: configurable-json
 Requires-Dist: configuraptor>=1.26.2
 Requires-Dist: dill
+Requires-Dist: legacy-cgi; python_version >= '3.13'
 Requires-Dist: pydal
 Requires-Dist: python-slugify
 Provides-Extra: all
-Requires-Dist: edwh-migrate>=0.8.0; extra == 'all'
+Requires-Dist: edwh-migrate[full]>=0.8.0; extra == 'all'
 Requires-Dist: py4web; extra == 'all'
 Requires-Dist: pydal2sql[all]>=1.2.0; extra == 'all'
 Requires-Dist: questionary; extra == 'all'
@@ -301,6 +303,30 @@ row: TableName = db.table_name(id=1)
 
 See [2. Defining Tables](https://typedal.readthedocs.io/en/stable/2_defining_tables/)
 
+### Helpers
+
+TypeDAL provides some utility functions to interact with the underlying pyDAL objects:
+
+- **`get_db(TableName)`**:  
+  Retrieve the DAL instance associated with a given TypedTable or pyDAL Table.
+
+- **`get_table(TableName)`**:  
+  Access the original PyDAL Table from a TypedTable instance (`db.table_name`).
+
+- **`get_field(TableName.fieldname)`**:  
+  Get the pyDAL Field from a TypedField. This ensures compatibility when interacting directly with PyDAL.
+
+These helpers are useful for scenarios where direct access to the PyDAL objects is needed while still using TypeDAL.
+An example of this is when you need to do a `db.commit()` but you can't import `db` directly:
+
+```python
+from typedal.helpers import get_db #, get_table, get_field
+
+MyTable.insert(...)
+db = get_db(MyTable)
+db.commit() # this is usually done automatically but sometimes you want to manually commit.
+```
+
 ## Caveats
 
 - This package depends heavily on the current implementation of annotations (which are computed when the class is

{typedal-3.6.0.dist-info → typedal-3.7.1.dist-info}/RECORD

@@ -1,19 +1,19 @@
-typedal/__about__.py,sha256=6BHlKIfFsDoanUXT6U-wyOOCusiaMl22UUFAVmE4Clg,206
+typedal/__about__.py,sha256=AFKT4KzzNxE4Z-qbuOweWNrXJbURV-eoLAHkdyWY_9I,206
 typedal/__init__.py,sha256=QQpLiVl9w9hm2LBxey49Y_tCF_VB2bScVaS_mCjYy54,366
 typedal/caching.py,sha256=SMcJsahLlZ79yykWCveERFx1ZJUNEKhA9SPmCTIuLp8,11798
 typedal/cli.py,sha256=wzyId6YwRyqfuJ2byxvl6YecDNaKpkLmo-R5HvRuTok,19265
 typedal/config.py,sha256=0qy1zrTUdtmXPM9jHzFnSR1DJsqGJqcdG6pvhzKQHe0,11625
-typedal/core.py,sha256=mbNFMv3NJ2QRDuohs03LCGhVVnffsxjsoe-m887U6c8,98367
+typedal/core.py,sha256=7zIt-_AXv2E-7FRRi4J1tHzkwCIgD31faIatjMtFcqg,98804
 typedal/fields.py,sha256=z2PD9vLWqBR_zXtiY0DthqTG4AeF3yxKoeuVfGXnSdg,5197
 typedal/for_py4web.py,sha256=d07b8hL_PvNDUS26Z5fDH2OxWb-IETBuAFPSzrRwm04,1285
 typedal/for_web2py.py,sha256=4RHgzGXgKIO_BYB-7adC5e35u52rX-p1t4tPEz-NK24,1867
-typedal/helpers.py,sha256=KbgP4ZRW7KCroyHwTwdErPqylOX4dsqVnKJeZ5TtTFY,7363
+typedal/helpers.py,sha256=uej96exzJ9qVBd6LudP8uJ_7Cmq6vKraerdKvSRBVjc,8128
 typedal/mixins.py,sha256=OHhVYLBGTzPSJKgp1uovBs1Y6NJa0d-DxHTOk9LyOXA,5414
 typedal/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 typedal/types.py,sha256=W2zsmJSPYbIvhjb5Df_ZANH8riCIJhOOHjI8UCQINls,5239
 typedal/web2py_py4web_shared.py,sha256=VK9T8P5UwVLvfNBsY4q79ANcABv-jX76YKADt1Zz_co,1539
 typedal/serializers/as_json.py,sha256=ffo152W-sARYXym4BzwX709rrO2-QwKk2KunWY8RNl4,2229
-typedal-3.6.0.dist-info/METADATA,sha256=yZpPjMmR24Kzh0QRmMrTihEHGNCJFgX4NtyfOIqMf-A,9462
-typedal-3.6.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-typedal-3.6.0.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
-typedal-3.6.0.dist-info/RECORD,,
+typedal-3.7.1.dist-info/METADATA,sha256=XIXYnqey6KJJxJK6PAbFhdom9aIVjEggISd3mzwVcfk,10463
+typedal-3.7.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+typedal-3.7.1.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
+typedal-3.7.1.dist-info/RECORD,,