TypeDAL 3.6.0__tar.gz → 3.7.1__tar.gz

{typedal-3.6.0 → typedal-3.7.1}/.gitignore

@@ -5,6 +5,7 @@ venv*
 *.egg-info
 dist/
 build/
+htmlcov/
 .coverage
 coverage.json
 coverage.xml

{typedal-3.6.0 → typedal-3.7.1}/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 <!--next-version-placeholder-->
 
+## v3.7.1 (2024-10-09)
+
+### Fix
+
+* Prepare for python 3.13 (-> cgi dependency, changes in forward reference evaluation); except psycopg2 ([`bbcca8f`](https://github.com/trialandsuccess/TypeDAL/commit/bbcca8f7a5d2f8a6ddc8caf3a1b05fde3ed2fdd2))
+* Require legacy-cgi for python 3.13+ ([`7ba9489`](https://github.com/trialandsuccess/TypeDAL/commit/7ba94898cde600008a350e718783a4d0dbc05e45))
+
+### Documentation
+
+* **readme:** Include `from typedal.helpers import get_db` in example ([`8853052`](https://github.com/trialandsuccess/TypeDAL/commit/8853052575b4576945901eb87da94bf709e99526))
+
+## v3.7.0 (2024-08-17)
+
+### Feature
+
+* Add get_db, get_table, get_field helpers to get pydal objects back from typedal ([`2363e9d`](https://github.com/trialandsuccess/TypeDAL/commit/2363e9d3f15eb4500a0d5bc8354bf0326161bd1e))
+
 ## v3.6.0 (2024-08-05)
 
 ### Feature

{typedal-3.6.0 → typedal-3.7.1}/PKG-INFO

@@ -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 → typedal-3.7.1}/README.md

@@ -247,6 +247,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 → typedal-3.7.1}/pyproject.toml

@@ -19,6 +19,7 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: Implementation :: CPython",
     "Programming Language :: Python :: Implementation :: PyPy",
 ]
@@ -28,6 +29,7 @@ dependencies = [
     "configuraptor >= 1.26.2", # config
     "Configurable-JSON", # json dumping
     "python-slugify",
+    "legacy-cgi; python_version >= '3.13'"
 ]
 
 [project.optional-dependencies]
@@ -49,7 +51,7 @@ all = [
     "typer",
     "tabulate",
     "pydal2sql[all]>=1.2.0",
-    "edwh-migrate>=0.8.0",
+    "edwh-migrate[full]>=0.8.0",
     "questionary",
     "tomlkit",
 ]

{typedal-3.6.0 → typedal-3.7.1}/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__ = "3.6.0"
+__version__ = "3.7.1"

{typedal-3.6.0 → typedal-3.7.1}/src/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-3.6.0 → typedal-3.7.1}/src/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 → typedal-3.7.1}/tests/test_helpers.py

@@ -1,7 +1,9 @@
 import typing
 from datetime import datetime, timedelta
 
+import pydal
 import pytest
+from pydal import DAL
 
 from src.typedal.caching import get_expire
 from src.typedal.helpers import (
@@ -16,8 +18,10 @@ from src.typedal.helpers import (
     mktable,
     origin_is_subclass,
     to_snake,
-    unwrap_type,
+    unwrap_type, get_db, get_table, get_field,
 )
+from typedal import TypeDAL, TypedTable
+from typedal.types import Field
 
 
 def test_is_union():
@@ -175,3 +179,30 @@ def test_match_strings():
     string_list = ["file1.txt", "file2.jpg", "file3.txt", "file4.png"]
     expected_matches = []
     assert sorted(match_strings(patterns, string_list)) == sorted(expected_matches)
+
+
+database = TypeDAL("sqlite:memory")
+assert database._db_uid
+
+
+@database.define()
+class TestGetFunctions(TypedTable):
+    string: str
+
+
+def test_get_functions():
+    db = get_db(TestGetFunctions)
+    assert isinstance(db, DAL)
+    assert db._db_uid == database._db_uid
+    db = get_db(db.test_get_functions)
+    assert db._db_uid == database._db_uid
+    table = get_table(TestGetFunctions)
+    assert hasattr(table, "string")
+    assert issubclass(TestGetFunctions, TypedTable)
+    assert isinstance(table, pydal.objects.Table)
+    assert not isinstance(table, TypedTable)
+    field = get_field(TestGetFunctions.string)
+    print(
+        type(field)
+    )
+    assert isinstance(field, Field)

typedal-3.6.0/htmlcov/.gitignore

@@ -1,2 +0,0 @@
-# Created by coverage.py
-*