TypeDAL 4.6.4__tar.gz → 4.7.0__tar.gz

{typedal-4.6.4 → typedal-4.7.0}/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 <!--next-version-placeholder-->
 
+## v4.7.0 (2026-04-20)
+
+### Feature
+
+* Support typing.Literal and Enum as field type with IS_IN_SET-based default 'requires' ([`221f60c`](https://github.com/trialandsuccess/TypeDAL/commit/221f60cf6db5cad5c12b5e8308ff00324583a6cb))
+
 ## v4.6.4 (2026-03-30)
 
 ### Fix

{typedal-4.6.4 → typedal-4.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TypeDAL
-Version: 4.6.4
+Version: 4.7.0
 Summary: Typing support for PyDAL
 Project-URL: Documentation, https://typedal.readthedocs.io/
 Project-URL: Issues, https://github.com/trialandsuccess/TypeDAL/issues

{typedal-4.6.4 → typedal-4.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__ = "4.6.4"
+__version__ = "4.7.0"

{typedal-4.6.4 → typedal-4.7.0}/src/typedal/define.py

@@ -7,11 +7,13 @@ Since otherwise helper methods would clutter up the TypeDAl class.
 from __future__ import annotations
 
 import copy
+import enum
 import types
 import typing as t
 import warnings
 
 import pydal
+from pydal.validators import IS_IN_SET, ValidationError, Validator
 
 from .constants import BASIC_MAPPINGS
 from .core import TypeDAL, evaluate_forward_reference, resolve_annotation
@@ -42,6 +44,20 @@ except ImportError:  # pragma: no cover
     from typing import ForwardRef
 
 
+class IS_IN_ENUM(Validator):
+    def __init__(self, etype: type[enum.Enum], error_message: str = "value not allowed"):
+        super().__init__()
+        self.etype = etype
+        self.error_message = error_message
+
+    def validate(self, value: t.Any, _record_id: int | None = None) -> t.Any:
+        if value not in self.etype:
+            raise ValidationError(self.translator(self.error_message))
+
+        # normalize value:
+        return self.etype(value).value
+
+
 class TableDefinitionBuilder:
     """Handles the conversion of TypedTable classes to pydal tables."""
 
@@ -157,6 +173,16 @@ class TableDefinitionBuilder:
         elif origin_is_subclass(ftype, TypedField):
             # TypedField[int]
             return self.annotation_to_pydal_fieldtype(t.get_args(ftype)[0], mut_kw)
+        elif t.get_origin(ftype) is t.Literal:
+            mut_kw.setdefault("requires", [IS_IN_SET(t.get_args(ftype))])
+            _child_type = type(t.get_args(ftype)[0])
+            return self.annotation_to_pydal_fieldtype(_child_type, mut_kw)
+        elif isinstance(ftype, type) and issubclass(ftype, enum.Enum):
+            _values = [v.value for v in ftype]
+            _child_type = type(_values[0])
+            # mut_kw.setdefault("requires", [IS_IN_SET(_values)])
+            mut_kw.setdefault("requires", [IS_IN_ENUM(ftype)])
+            return self.annotation_to_pydal_fieldtype(_child_type, mut_kw)
         elif isinstance(ftype, types.GenericAlias) and t.get_origin(ftype) in (list, TypedField):
             # list[str] -> str -> string -> list:string
             _child_type = t.get_args(ftype)[0]

{typedal-4.6.4 → typedal-4.7.0}/tests/test_main.py

@@ -1,3 +1,4 @@
+import enum
 import re
 import sys
 import typing
@@ -639,3 +640,42 @@ def test_reorder_fields():
     # 'name' should be dropped:
     Sub.reorder_fields(Sub.id, Sub.gid, keep_others=False)
     assert list(Sub) == [Sub.id, Sub.gid]
+
+
+def test_literal_enum_fields():
+    class TestEnum(enum.Enum):
+        FIRST = "first"
+        SECOND = 2
+
+    @db.define()
+    class LiteralTable(TypedTable):
+        lit_one: t.Literal["first", "second"]
+        lit_two = TypedField(t.Literal["first", "second"])
+
+        enum_one: TestEnum
+        enum_two = TypedField(TestEnum)
+
+    # should be ok
+    row, err = LiteralTable.validate_and_insert(
+        lit_one="first",
+        lit_two="second",
+        enum_one=TestEnum.FIRST,
+        enum_two=2,
+    )
+    assert not err, "unexpected error"
+    assert row, "expected row"
+
+    # should error on lit_one
+    row, err = LiteralTable.validate_and_insert(
+        lit_one="wrong",
+        lit_two="wronger",
+        enum_one=1,
+        enum_two="two",
+    )
+    assert not row, "unexpected row"
+    assert err, "expected err"
+
+    assert "lit_one" in err
+    assert "lit_two" in err
+    assert "enum_one" in err
+    assert "enum_two" in err