TypeDAL 3.5.0__py3-none-any.whl → 3.7.0__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.5.0"
+__version__ = "3.7.0"

typedal/cli.py

@@ -40,7 +40,7 @@ from pydal2sql.types import (
     OutputFormat_Option,
     Tables_Option,
 )
-from pydal2sql_core import core_alter, core_create
+from pydal2sql_core import core_alter, core_create, core_stub
 from typing_extensions import Never
 
 from . import caching
@@ -417,6 +417,38 @@ def fake_migrations(
     return 0
 
 
+@app.command(name="migrations.stub")
+@with_exit_code(hide_tb=IS_DEBUG)
+def migrations_stub(
+    migration_name: typing.Annotated[str, typer.Argument()] = "stub_migration",
+    connection: typing.Annotated[str, typer.Option("--connection", "-c")] = None,
+    output_format: OutputFormat_Option = None,
+    output_file: Optional[str] = None,
+    dry_run: typing.Annotated[bool, typer.Option("--dry", "--dry-run")] = False,
+    is_pydal: typing.Annotated[bool, typer.Option("--pydal", "-p")] = False,
+    # defaults to is_typedal of course
+) -> int:
+    """
+    Create an empty migration via pydal2sql.
+    """
+    generic_config = load_config(connection)
+    pydal2sql_config = generic_config.to_pydal2sql()
+    pydal2sql_config.update(
+        format=output_format,
+        output=output_file,
+        _skip_none=True,
+    )
+
+    core_stub(
+        migration_name,  # raw, without date or number
+        output_format=pydal2sql_config.format,
+        output_file=pydal2sql_config.output or None,
+        dry_run=dry_run,
+        is_typedal=not is_pydal,
+    )
+    return 0
+
+
 AnyNestedDict: typing.TypeAlias = dict[str, AnyDict]
 
 

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.5.0.dist-info → typedal-3.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: TypeDAL
-Version: 3.5.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
@@ -23,7 +23,7 @@ Requires-Dist: python-slugify
 Provides-Extra: all
 Requires-Dist: edwh-migrate>=0.8.0; extra == 'all'
 Requires-Dist: py4web; extra == 'all'
-Requires-Dist: pydal2sql[all]>=1.1.4; extra == 'all'
+Requires-Dist: pydal2sql[all]>=1.2.0; extra == 'all'
 Requires-Dist: questionary; extra == 'all'
 Requires-Dist: tabulate; extra == 'all'
 Requires-Dist: tomlkit; extra == 'all'
@@ -43,7 +43,7 @@ Requires-Dist: types-requests; extra == 'dev'
 Requires-Dist: types-tabulate; extra == 'dev'
 Provides-Extra: migrations
 Requires-Dist: edwh-migrate>=0.8.0; extra == 'migrations'
-Requires-Dist: pydal2sql>=1.1.4; extra == 'migrations'
+Requires-Dist: pydal2sql>=1.2.0; extra == 'migrations'
 Requires-Dist: questionary; extra == 'migrations'
 Requires-Dist: tabulate; extra == 'migrations'
 Requires-Dist: tomlkit; extra == 'migrations'
@@ -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.5.0.dist-info → typedal-3.7.0.dist-info}/RECORD

@@ -1,19 +1,19 @@
-typedal/__about__.py,sha256=AjgocyPCjgkgwSg0cozJLLzDEJz3aZN-Ze0xcPDV5pc,206
+typedal/__about__.py,sha256=oird-nTofiqIzNTKZCjENhO8ePCfLiFklOCRjlW0gog,206
 typedal/__init__.py,sha256=QQpLiVl9w9hm2LBxey49Y_tCF_VB2bScVaS_mCjYy54,366
 typedal/caching.py,sha256=SMcJsahLlZ79yykWCveERFx1ZJUNEKhA9SPmCTIuLp8,11798
-typedal/cli.py,sha256=n2TKQGOryck91ByFEcLqwPgh6_kMtoBr3UBIDwU_8n8,18180
+typedal/cli.py,sha256=wzyId6YwRyqfuJ2byxvl6YecDNaKpkLmo-R5HvRuTok,19265
 typedal/config.py,sha256=0qy1zrTUdtmXPM9jHzFnSR1DJsqGJqcdG6pvhzKQHe0,11625
 typedal/core.py,sha256=mbNFMv3NJ2QRDuohs03LCGhVVnffsxjsoe-m887U6c8,98367
 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.5.0.dist-info/METADATA,sha256=pffl-arVDPP0CBg3EcVhlze5mxypyCH-Ds_iZ6sZY6s,9462
-typedal-3.5.0.dist-info/WHEEL,sha256=KGYbc1zXlYddvwxnNty23BeaKzh7YuoSIvIMO4jEhvw,87
-typedal-3.5.0.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
-typedal-3.5.0.dist-info/RECORD,,
+typedal-3.7.0.dist-info/METADATA,sha256=10vZGqAXqubFW6l0W6Vl0A7qsoR8PLmMyftmZ8Kk0oY,10294
+typedal-3.7.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+typedal-3.7.0.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
+typedal-3.7.0.dist-info/RECORD,,

{typedal-3.5.0.dist-info → typedal-3.7.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.17.1
+Generator: hatchling 1.25.0
 Root-Is-Purelib: true
 Tag: py3-none-any