TypeDAL 3.15.5__tar.gz → 3.16.0__tar.gz

{typedal-3.15.5 → typedal-3.16.0}/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 <!--next-version-placeholder-->
 
+## v3.16.0 (2025-09-01)
+
+### Feature
+
+* Allow reordering table fields via `Table.reorder_fields(...)` ([`79c2c3e`](https://github.com/trialandsuccess/TypeDAL/commit/79c2c3eaf8b44919800e4c12026ab54a2678d141))
+
 ## v3.15.5 (2025-08-29)
 
 ### Fix

{typedal-3.15.5 → typedal-3.16.0}/PKG-INFO

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

{typedal-3.15.5 → typedal-3.16.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.15.5"
+__version__ = "3.16.0"

{typedal-3.15.5 → typedal-3.16.0}/src/typedal/core.py

@@ -2,6 +2,8 @@
 Core functionality of TypeDAL.
 """
 
+from __future__ import annotations
+
 import contextlib
 import csv
 import datetime as dt
@@ -826,6 +828,31 @@ P = typing.ParamSpec("P")
 R = typing.TypeVar("R")
 
 
+def reorder_fields(
+    table: pydal.objects.Table, fields: list[str | Field | TypedField], keep_others: bool = True
+) -> None:
+    """
+    Reorder fields of a pydal table.
+
+    Args:
+        table: The pydal table object (e.g., db.mytable).
+        fields: List of field names (str) or Field objects in desired order.
+        keep_others (bool):
+            - True (default): keep other fields at the end, in their original order.
+            - False: remove other fields (only keep what's specified).
+    """
+    # Normalize input to field names
+    desired = [f.name if isinstance(f, (TypedField, Field, pydal.objects.Field)) else str(f) for f in fields]
+
+    new_order = [f for f in desired if f in table._fields]
+
+    if keep_others:
+        # Start with desired fields, then append the rest
+        new_order.extend(f for f in table._fields if f not in desired)
+
+    table._fields = new_order
+
+
 class TableMeta(type):
     """
     This metaclass contains functionality on table classes, that doesn't exist on its instances.
@@ -1367,6 +1394,19 @@ class TableMeta(type):
         """
         return cls._hook_once(cls._after_delete, fn)
 
+    def reorder_fields(cls, fields: list[str | Field | TypedField], keep_others: bool = True):
+        """
+        Reorder fields of a typedal table.
+
+        Args:
+            fields: List of field names (str) or Field objects in desired order.
+            keep_others (bool):
+                - True (default): keep other fields at the end, in their original order.
+                - False: remove other fields (only keep what's specified).
+        """
+
+        return reorder_fields(cls._table, fields, keep_others=keep_others)
+
 
 class TypedField(Expression, typing.Generic[T_Value]):  # pragma: no cover
     """

{typedal-3.15.5 → typedal-3.16.0}/tests/test_main.py

@@ -115,11 +115,19 @@ def test_mixed_defines(capsys):
     ## insert normal
     db.old_syntax.insert(name="First", age=99, location="Norway", relation=db.relation(id=1))
     db.first_new_syntax.insert(
-        name="First", age=99, location="Norway", old_relation=db.relation(id=1), tags=["first", "second"]
+        name="First",
+        age=99,
+        location="Norway",
+        old_relation=db.relation(id=1),
+        tags=["first", "second"],
     )
     # equals
     FirstNewSyntax.insert(
-        name="First", age=99, location="Norway", old_relation=db.relation(id=1), tags=["first", "second"]
+        name="First",
+        age=99,
+        location="Norway",
+        old_relation=db.relation(id=1),
+        tags=["first", "second"],
     )
     # similar
     SecondNewSyntax.insert(
@@ -570,3 +578,24 @@ def test_try():
 
     with pytest.warns(RuntimeWarning):
         assert db.try_define(SomeTableToRetry, verbose=True)
+
+
+def test_reorder_fields():
+    @db.define()
+    class Base(TypedTable):
+        gid: str
+
+    @db.define()
+    class Sub(Base):
+        name: str
+
+    # default order is kinda cursed due to MRO:
+    assert list(Sub) == [Sub.id, Sub.name, Sub.gid]
+
+    # 'name' should come last:
+    Sub.reorder_fields([Sub.id, Sub.gid])
+    assert list(Sub) == [Sub.id, Sub.gid, Sub.name]
+
+    # 'name' should be dropped:
+    Sub.reorder_fields([Sub.id, Sub.gid], keep_others=False)
+    assert list(Sub) == [Sub.id, Sub.gid]