TypeDAL 2.2.0__py3-none-any.whl → 2.2.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__ = "2.2.0"
+__version__ = "2.2.1"

typedal/config.py

@@ -3,6 +3,7 @@ TypeDAL can be configured by a combination of pyproject.toml (static), env (dyna
 """
 import os
 import typing
+import warnings
 from pathlib import Path
 from typing import Any, Optional
 
@@ -154,7 +155,8 @@ def _load_toml(path: str | bool | None = True) -> tuple[str, dict[str, Any]]:
             data = tomli.load(f)
 
         return toml_path or "", typing.cast(dict[str, Any], data["tool"]["typedal"])
-    except Exception:
+    except Exception as e:
+        warnings.warn(f"Could not load typedal config toml: {e}", source=e)
         return toml_path or "", {}
 
 

typedal/core.py

@@ -54,6 +54,7 @@ from .types import (
     Pagination,
     Query,
     Rows,
+    Validator,
     _Types,
 )
 
@@ -523,6 +524,7 @@ class TypeDAL(pydal.DAL):  # type: ignore
                 relationships=typing.cast(dict[str, Relationship[Any]], relationships),
             )
             self._class_map[str(table)] = cls
+            cls.__on_define__(self)
         else:
             warnings.warn("db.define used without inheriting TypedTable. This could lead to strange problems!")
 
@@ -1165,6 +1167,8 @@ class TypedField(typing.Generic[T_Value]):  # pragma: no cover
     _type: T_annotation
     kwargs: Any
 
+    requires: Validator | typing.Iterable[Validator]
+
     def __init__(self, _type: typing.Type[T_Value] | types.UnionType = str, /, **settings: Any) -> None:  # type: ignore
         """
         A TypedFieldType should not be inited manually, but TypedField (from `fields.py`) should be used!
@@ -1381,6 +1385,15 @@ class TypedTable(metaclass=TableMeta):
         inst._setup_instance_methods()
         return inst
 
+    @classmethod
+    def __on_define__(cls, db: TypeDAL) -> None:
+        """
+        Method that can be implemented by tables to do an action after db.define is completed.
+
+        This can be useful if you need to add something like requires=IS_NOT_IN_DB(db, "table.field"),
+        where you need a reference to the current database, which may not exist yet when defining the model.
+        """
+
     def __iter__(self) -> typing.Generator[Any, None, None]:
         """
         Allows looping through the columns.

typedal/for_py4web.py

@@ -1,6 +1,7 @@
 """
 ONLY USE IN COMBINATION WITH PY4WEB!
 """
+import typing
 from datetime import datetime
 from typing import Any, Optional
 
@@ -8,8 +9,11 @@ import json_fix  # noqa: F401
 import threadsafevariable
 from py4web.core import ICECUBE
 from py4web.core import Fixture as _Fixture
+from pydal.validators import CRYPT, IS_EMAIL, IS_NOT_EMPTY, IS_NOT_IN_DB, IS_STRONG
 
-from .core import TypeDAL, TypedTable
+from .core import TypeDAL, TypedField, TypedTable
+from .fields import PasswordField
+from .types import Validator
 
 
 class Fixture(_Fixture):  # type: ignore
@@ -53,13 +57,23 @@ class AuthUser(TypedTable):
 
     # call db.define on this when ready
 
-    email: str
-    password: str
-    first_name: Optional[str]
-    last_name: Optional[str]
-    sso_id: Optional[str]
-    action_token: Optional[str]
-    last_password_change: Optional[datetime]
+    email: TypedField[str]
+    password = PasswordField(requires=[IS_STRONG(entropy=45), CRYPT()])
+    first_name: TypedField[Optional[str]]
+    last_name: TypedField[Optional[str]]
+    sso_id: TypedField[Optional[str]]
+    action_token: TypedField[Optional[str]]
+    last_password_change: TypedField[Optional[datetime]]
+
     # past_passwords_hash: Optional[str]
     # username: Optional[str]
     # phone_number: Optional[str]
+
+    @classmethod
+    def __on_define__(cls, db: TypeDAL) -> None:
+        """
+        Add some requires= to the auth_user fields.
+        """
+        cls.email.requires = typing.cast(tuple[Validator, ...], (IS_EMAIL(), IS_NOT_IN_DB(db, "auth_user.email")))
+        cls.first_name.requires = IS_NOT_EMPTY()
+        cls.last_name.requires = IS_NOT_EMPTY()

typedal/types.py

@@ -12,6 +12,7 @@ from pydal.objects import Field as _Field
 from pydal.objects import Query as _Query
 from pydal.objects import Rows as _Rows
 from pydal.objects import Set as _Set
+from pydal.validators import Validator as _Validator
 from typing_extensions import NotRequired
 
 
@@ -71,6 +72,14 @@ class Rows(_Rows):  # type: ignore
     """
 
 
+class Validator(_Validator):  # type: ignore
+    """
+    Pydal Validator object.
+
+    Make mypy happy.
+    """
+
+
 class _Types:
     """
     Internal type storage for stuff that mypy otherwise won't understand.

{typedal-2.2.0.dist-info → typedal-2.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: TypeDAL
-Version: 2.2.0
+Version: 2.2.1
 Summary: Typing support for PyDAL
 Project-URL: Documentation, https://typedal.readthedocs.io/
 Project-URL: Issues, https://github.com/trialandsuccess/TypeDAL/issues
@@ -62,10 +62,13 @@ the underlying `db.define_table` pydal Tables.
 - `TypeDAL` is the replacement class for DAL that manages the code on top of DAL.
 - `TypedTable` must be the parent class of any custom Tables you define (e.g. `class SomeTable(TypedTable)`)
 - `TypedField` can be used instead of Python native types when extra settings (such as `default`) are required (
-  e.g. `name = TypedField(str, default="John Doe")`). It can also be used in an annotation (`name: TypedField[str]`) to improve
+  e.g. `name = TypedField(str, default="John Doe")`). It can also be used in an annotation (`name: TypedField[str]`) to
+  improve
   editor support over only annotating with `str`.
-- `TypedRows`: can be used as the return type annotation of pydal's `.select()` and subscribed with the actual table class, so
-  e.g. `rows: TypedRows[SomeTable] = db(...).select()`. When using the QueryBuilder, a `TypedRows` instance is returned by `.collect()`.
+- `TypedRows`: can be used as the return type annotation of pydal's `.select()` and subscribed with the actual table
+  class, so
+  e.g. `rows: TypedRows[SomeTable] = db(...).select()`. When using the QueryBuilder, a `TypedRows` instance is returned
+  by `.collect()`.
 
 Version 2.0 also introduces more ORM-like funcionality.
 Most notably, a Typed Query Builder that sees your table classes as models with relationships to each other.
@@ -75,7 +78,7 @@ details.
 ## Quick Overview
 
 Below you'll find a quick overview of translation from pydal to TypeDAL. For more info,
-see [the docs](https://github.com/trialandsuccess/TypeDAL/tree/master/docs).
+see [the docs](https://typedal.readthedocs.io/en/latest/).
 
 ### Translations from pydal to typedal
 
@@ -254,16 +257,6 @@ row: TableName = db.table_name(id=1)
 
 See [2. Defining Tables](docs/2_defining_tables.md)
 
-## Roadmap
-
-This section contains a non-exhaustive list of planned features for future feature releases:
-
-- 2.2
-    - Migrations: currently, you can use pydal's automatic migrations or disable those and manage them yourself, but
-      adding something like [`edwh-migrate`](https://github.com/educationwarehouse/migrate#readme)
-      with [`pydal2sql`](https://github.com/robinvandernoord/pydal2sql-core) as an option could make this project more
-      production-friendly.
-
 ## Caveats
 
 - This package depends heavily on the current implementation of annotations (which are computed when the class is

typedal-2.2.1.dist-info/RECORD

@@ -0,0 +1,15 @@
+typedal/__about__.py,sha256=h_6wVhT5zBpkimIzSHhAe8DZCR_Nn-sqaS8GZXghPko,206
+typedal/__init__.py,sha256=QQpLiVl9w9hm2LBxey49Y_tCF_VB2bScVaS_mCjYy54,366
+typedal/caching.py,sha256=53WU5J_yRLygkKoDfD0rV_dkh5oqqT--64R9Mvz050Y,7457
+typedal/cli.py,sha256=MF2bGwL4SOaIqGzr1JRSvGD6CSujy88hKGgVIehlFNk,11789
+typedal/config.py,sha256=9ORQqJJ_3tDmFiL2Py_9PiceXLihpMR69t6OKZ_qpe8,8387
+typedal/core.py,sha256=LV0Fszbmh0pojAiARD1GKj5ooxakJmmj_4ebpvZZkcs,93644
+typedal/fields.py,sha256=z2PD9vLWqBR_zXtiY0DthqTG4AeF3yxKoeuVfGXnSdg,5197
+typedal/for_py4web.py,sha256=kw44_55-dBWlYmepB7YEev5sj7tbYcgzvp-Ecc7K9_I,2230
+typedal/helpers.py,sha256=ZpHdwBMSANw-P9I5gs56Vf6GUbxGzFsIwbBvASKXX8s,6487
+typedal/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+typedal/types.py,sha256=5qm3PgS8DXGCu9ZTUWQiIi2XXD8gz4_4Csg_vZlu_yo,3379
+typedal-2.2.1.dist-info/METADATA,sha256=-4kp0PN1msDhP9C07HqMh_4VCigOu0AhkN6yNrRPDkM,7623
+typedal-2.2.1.dist-info/WHEEL,sha256=KGYbc1zXlYddvwxnNty23BeaKzh7YuoSIvIMO4jEhvw,87
+typedal-2.2.1.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
+typedal-2.2.1.dist-info/RECORD,,

typedal-2.2.0.dist-info/RECORD

@@ -1,15 +0,0 @@
-typedal/__about__.py,sha256=8gi3xn87HBaC4npgYYvbwLigw3OR5OW7Ke_VUmHuQow,206
-typedal/__init__.py,sha256=QQpLiVl9w9hm2LBxey49Y_tCF_VB2bScVaS_mCjYy54,366
-typedal/caching.py,sha256=53WU5J_yRLygkKoDfD0rV_dkh5oqqT--64R9Mvz050Y,7457
-typedal/cli.py,sha256=MF2bGwL4SOaIqGzr1JRSvGD6CSujy88hKGgVIehlFNk,11789
-typedal/config.py,sha256=zOINxqyZ9QczzlAuPqCVqeFWq94NUiBnVQ2H89FUIWY,8290
-typedal/core.py,sha256=8g8IT3o7DQdNk_uTdjW56CTFRbFddKje6XBgpXTJMxM,93140
-typedal/fields.py,sha256=z2PD9vLWqBR_zXtiY0DthqTG4AeF3yxKoeuVfGXnSdg,5197
-typedal/for_py4web.py,sha256=Y7ceKEkqAThNtyO1rdP1hYZc51o4T4ZUpbkTgiCStQU,1575
-typedal/helpers.py,sha256=ZpHdwBMSANw-P9I5gs56Vf6GUbxGzFsIwbBvASKXX8s,6487
-typedal/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-typedal/types.py,sha256=lIUc826lN59_eKKojmFyhQI2auJwdzJSZ2fNbLl5D0U,3213
-typedal-2.2.0.dist-info/METADATA,sha256=tW3APEybDas5z-1Mb37DO0xkwXVXfAIVQXxVbuUISnA,8110
-typedal-2.2.0.dist-info/WHEEL,sha256=KGYbc1zXlYddvwxnNty23BeaKzh7YuoSIvIMO4jEhvw,87
-typedal-2.2.0.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
-typedal-2.2.0.dist-info/RECORD,,