TypeDAL 3.6.0__tar.gz → 3.7.0__tar.gz

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

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

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

@@ -2,6 +2,12 @@
 
 <!--next-version-placeholder-->
 
+## 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.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: TypeDAL
-Version: 3.6.0
+Version: 3.7.0
 Summary: Typing support for PyDAL
 Project-URL: Documentation, https://typedal.readthedocs.io/
 Project-URL: Issues, https://github.com/trialandsuccess/TypeDAL/issues
@@ -301,6 +301,28 @@ 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
+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.0}/README.md

@@ -247,6 +247,28 @@ 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
+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.0}/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.0"

{typedal-3.6.0 → typedal-3.7.0}/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.0}/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
-*