TypeDAL 4.9.0__tar.gz → 4.9.1__tar.gz

{typedal-4.9.0 → typedal-4.9.1}/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 <!--next-version-placeholder-->
 
+## v4.9.1 (2026-07-02)
+
+### Fix
+
+* **typing:** `select(distinct=` can also be a str ([`dc05389`](https://github.com/trialandsuccess/TypeDAL/commit/dc05389e89102cfb5de4a3b174857b8a7866a005))
+* Improved typing for Permissions ([`236e4a8`](https://github.com/trialandsuccess/TypeDAL/commit/236e4a8ebfc42ed438dc8f626c192c6baca52f02))
+
+### Documentation
+
+* Added info about `permissions` in docs ([`a5a9a85`](https://github.com/trialandsuccess/TypeDAL/commit/a5a9a85bb737acf5d5521e8923df56b3608b1ef5))
+
 ## v4.9.0 (2026-06-12)
 
 ### Feature

{typedal-4.9.0 → typedal-4.9.1}/PKG-INFO

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

{typedal-4.9.0 → typedal-4.9.1}/docs/2_defining_tables.md

@@ -89,6 +89,27 @@ Important constraints and behavior:
 | `Field('name', 'string', required=True)` | `name: str`                                                               | `name: TypedField[str]`                                                                           | `name = TypedField(str, required=True)`               | `name = StringField(required=True)`  |
 | `Field('name', 'text', required=False)`  | `name: typing.Optional[str]` or  <br/> <code>name: str &#124; None</code> | `name: TypedField[typing.Optional[str]]` or  <br/> <code>name: TypedField[str &#124; None]</code> | `name = TypedField(str, type="text", required=False)` | `name = StringField(required=False)` |
 
+### Table permissions
+
+You can restrict table-level operations when defining a model:
+
+```python
+@db.define(permissions={"read": True, "insert": False, "update": True, "delete": False})
+class Article(TypedTable):
+    title: str
+    body: str
+```
+
+Permissions are currently available for:
+
+- `read`
+- `insert`
+- `update`
+- `delete`
+
+Any permission you do not specify is treated as allowed by default.
+Use this when a table should exist in the schema but should not be writable, or when you want to prevent reads from a given model entirely.
+
 # Hooks
 
 Some logic can be added when data is added/edited/deleted from the database.

{typedal-4.9.0 → typedal-4.9.1}/docs/3_building_queries.md

@@ -219,6 +219,28 @@ Be aware doing this might break some caching functionality!
 
 **Note:** For caching function results (instead of just query results), see [9. Function Memoization](./9_memoization.md).
 
+### permissions
+
+TypeDAL lets you override permissions on a query builder without changing the underlying table definition.
+This is useful when a query should be more restrictive or more permissive than the model defaults.
+
+```python
+# deny reads for this query
+restricted = Article.permissions(read=False).where(id=1)
+
+# allow a write operation only for this chain
+Article.where(id=1).permissions(update=True, delete=False).update(title="New title")
+```
+
+The same method is available on `TypedTable` as a convenience wrapper:
+
+```python
+Article.permissions(read=False).where(id=1).collect()
+```
+
+Permissions merge across the table definition and the query chain, with the most restrictive value winning.
+Supported flags are `read`, `insert`, `update`, and `delete`.
+
 ### Collecting
 
 The Query Builder has a few operations that don't return a new builder instance:

{typedal-4.9.0 → typedal-4.9.1}/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.9.0"
+__version__ = "4.9.1"

{typedal-4.9.0 → typedal-4.9.1}/src/typedal/tables.py

@@ -370,7 +370,9 @@ class TableMeta(type):
         """
         return QueryBuilder(self).cache(*deps, **kwargs)
 
-    def permissions(self: t.Type[T_MetaInstance], **permissions: bool) -> "QueryBuilder[T_MetaInstance]":
+    def permissions(
+        self: t.Type[T_MetaInstance], **permissions: t.Unpack[Permissions]
+    ) -> "QueryBuilder[T_MetaInstance]":
         """
         See QueryBuilder.permissions!
         """

{typedal-4.9.0 → typedal-4.9.1}/src/typedal/types.py

@@ -46,7 +46,14 @@ type AnyDict = dict[str, t.Any]
 
 PermissionType = t.Literal["read", "insert", "update", "delete"]
 
-type Permissions = dict[PermissionType, bool]
+
+# type Permissions = dict[PermissionType, bool]
+class Permissions(t.TypedDict):
+    # note: extra source of truth because the dynamic dict doesn't work for all type checkers
+    read: bool
+    insert: bool
+    update: bool
+    delete: bool
 
 
 def merge_permissions(*permission_sets: Permissions | None) -> Permissions:
@@ -276,7 +283,7 @@ class SelectKwargs(t.TypedDict, total=False):
     groupby: "GroupBy | t.Iterable[GroupBy] | None"
     having: "Having | None"
     limitby: t.Optional[tuple[int, int]]
-    distinct: bool | Field | Expression
+    distinct: bool | Field | Expression | str
     orderby_on_limitby: bool
     cacheable: bool
     cache: "CacheTuple"

{typedal-4.9.0 → typedal-4.9.1}/tests/test_helpers.py

@@ -274,6 +274,7 @@ def test_sql_expression_314():
 
     test_sql_expression_314(database)
 
+
 def test_merge_permissions():
     combined = merge_permissions({"read": True, "insert": False}, {"read": False, "insert": False})
     assert len(combined) == 4

typedal-4.9.0/.crush/.gitignore

@@ -1 +0,0 @@
-*

typedal-4.9.0/.crush/logs/crush.log

@@ -1,37 +0,0 @@
-{"time":"2026-01-20T14:19:21.359487106+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/config.(*catwalkSync).Get.func1","file":"github.com/charmbracelet/crush/internal/config/catwalk.go","line":55},"msg":"Fetching providers from Catwalk"}
-{"time":"2026-01-20T14:19:21.518115889+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/config.(*catwalkSync).Get.func1","file":"github.com/charmbracelet/crush/internal/config/catwalk.go","line":63},"msg":"Catwalk providers not modified"}
-{"time":"2026-01-20T14:19:21.52626179+01:00","level":"INFO","msg":"OK   20250424200609_initial.sql (1.52ms)"}
-{"time":"2026-01-20T14:19:21.526651475+01:00","level":"INFO","msg":"OK   20250515105448_add_summary_message_id.sql (330.71µs)"}
-{"time":"2026-01-20T14:19:21.526995425+01:00","level":"INFO","msg":"OK   20250624000000_add_created_at_indexes.sql (325.29µs)"}
-{"time":"2026-01-20T14:19:21.527303588+01:00","level":"INFO","msg":"OK   20250627000000_add_provider_to_messages.sql (293.15µs)"}
-{"time":"2026-01-20T14:19:21.52790648+01:00","level":"INFO","msg":"OK   20250810000000_add_is_summary_message.sql (495.71µs)"}
-{"time":"2026-01-20T14:19:21.528316924+01:00","level":"INFO","msg":"OK   20250812000000_add_todos_to_sessions.sql (389.38µs)"}
-{"time":"2026-01-20T14:19:21.528324939+01:00","level":"INFO","msg":"goose: successfully migrated database to version: 20250812000000"}
-{"time":"2026-01-20T14:19:21.528356959+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/app.(*App).initLSPClients","file":"github.com/charmbracelet/crush/internal/app/lsp.go","line":21},"msg":"LSP clients initialization started in background"}
-{"time":"2026-01-20T14:19:21.52843831+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/app.New.func1","file":"github.com/charmbracelet/crush/internal/app/app.go","line":102},"msg":"Initializing MCP clients"}
-{"time":"2026-01-20T14:21:06.413595152+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/agent.(*sessionAgent).generateTitle","file":"github.com/charmbracelet/crush/internal/agent/agent.go","line":788},"msg":"generated title with small model"}
-{"time":"2026-01-20T14:21:14.539289381+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/agent.(*sessionAgent).generateTitle","file":"github.com/charmbracelet/crush/internal/agent/agent.go","line":788},"msg":"generated title with small model"}
-{"time":"2026-01-20T14:21:15.710688424+01:00","level":"WARN","source":{"function":"github.com/charmbracelet/crush/internal/agent/tools.init.func1","file":"github.com/charmbracelet/crush/internal/agent/tools/rg.go","line":18},"msg":"Ripgrep (rg) not found in $PATH. Some grep features might be limited or slower."}
-{"time":"2026-01-20T14:21:17.08089755+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/agent.(*sessionAgent).generateTitle","file":"github.com/charmbracelet/crush/internal/agent/agent.go","line":788},"msg":"generated title with small model"}
-{"time":"2026-01-20T14:21:17.151106375+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/agent.(*sessionAgent).generateTitle","file":"github.com/charmbracelet/crush/internal/agent/agent.go","line":788},"msg":"generated title with small model"}
-{"time":"2026-01-20T14:22:05.503761296+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/agent.(*sessionAgent).generateTitle","file":"github.com/charmbracelet/crush/internal/agent/agent.go","line":788},"msg":"generated title with small model"}
-{"time":"2026-01-20T14:26:05.030425805+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/agent.(*sessionAgent).generateTitle","file":"github.com/charmbracelet/crush/internal/agent/agent.go","line":788},"msg":"generated title with small model"}
-{"time":"2026-01-20T14:36:26.778665189+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/agent.(*sessionAgent).generateTitle","file":"github.com/charmbracelet/crush/internal/agent/agent.go","line":788},"msg":"generated title with small model"}
-{"time":"2026-01-20T14:38:51.314473736+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/agent.(*sessionAgent).generateTitle","file":"github.com/charmbracelet/crush/internal/agent/agent.go","line":788},"msg":"generated title with small model"}
-{"time":"2026-01-20T15:02:22.602405814+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/app.(*App).Shutdown.func1","file":"github.com/charmbracelet/crush/internal/app/app.go","line":403},"msg":"Shutdown took 6.62949ms"}
-{"time":"2026-01-20T15:02:23.719585648+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/config.(*catwalkSync).Get.func1","file":"github.com/charmbracelet/crush/internal/config/catwalk.go","line":55},"msg":"Fetching providers from Catwalk"}
-{"time":"2026-01-20T15:02:23.881789126+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/config.(*catwalkSync).Get.func1","file":"github.com/charmbracelet/crush/internal/config/catwalk.go","line":63},"msg":"Catwalk providers not modified"}
-{"time":"2026-01-20T15:02:23.884044691+01:00","level":"INFO","msg":"goose: no migrations to run. current version: 20250812000000"}
-{"time":"2026-01-20T15:02:23.884082792+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/app.(*App).initLSPClients","file":"github.com/charmbracelet/crush/internal/app/lsp.go","line":21},"msg":"LSP clients initialization started in background"}
-{"time":"2026-01-20T15:02:23.884273487+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/app.New.func1","file":"github.com/charmbracelet/crush/internal/app/app.go","line":102},"msg":"Initializing MCP clients"}
-{"time":"2026-01-20T15:04:13.024457515+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/agent.(*sessionAgent).generateTitle","file":"github.com/charmbracelet/crush/internal/agent/agent.go","line":788},"msg":"generated title with small model"}
-{"time":"2026-01-20T15:04:14.232072885+01:00","level":"WARN","source":{"function":"github.com/charmbracelet/crush/internal/agent/tools.init.func1","file":"github.com/charmbracelet/crush/internal/agent/tools/rg.go","line":18},"msg":"Ripgrep (rg) not found in $PATH. Some grep features might be limited or slower."}
-{"time":"2026-01-20T15:11:24.612161916+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/app.(*App).Shutdown.func1","file":"github.com/charmbracelet/crush/internal/app/app.go","line":403},"msg":"Shutdown took 9.537141ms"}
-{"time":"2026-01-20T15:11:25.263960575+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/config.(*catwalkSync).Get.func1","file":"github.com/charmbracelet/crush/internal/config/catwalk.go","line":55},"msg":"Fetching providers from Catwalk"}
-{"time":"2026-01-20T15:11:25.431990051+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/config.(*catwalkSync).Get.func1","file":"github.com/charmbracelet/crush/internal/config/catwalk.go","line":63},"msg":"Catwalk providers not modified"}
-{"time":"2026-01-20T15:11:25.434282035+01:00","level":"INFO","msg":"goose: no migrations to run. current version: 20250812000000"}
-{"time":"2026-01-20T15:11:25.434366662+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/app.(*App).initLSPClients","file":"github.com/charmbracelet/crush/internal/app/lsp.go","line":21},"msg":"LSP clients initialization started in background"}
-{"time":"2026-01-20T15:11:25.434579879+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/app.New.func1","file":"github.com/charmbracelet/crush/internal/app/app.go","line":102},"msg":"Initializing MCP clients"}
-{"time":"2026-01-20T15:24:40.456010578+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/agent.(*sessionAgent).generateTitle","file":"github.com/charmbracelet/crush/internal/agent/agent.go","line":788},"msg":"generated title with small model"}
-{"time":"2026-01-20T15:24:51.673808433+01:00","level":"WARN","source":{"function":"github.com/charmbracelet/crush/internal/agent/tools.init.func1","file":"github.com/charmbracelet/crush/internal/agent/tools/rg.go","line":18},"msg":"Ripgrep (rg) not found in $PATH. Some grep features might be limited or slower."}
-{"time":"2026-01-20T15:26:03.868420566+01:00","level":"INFO","source":{"function":"github.com/charmbracelet/crush/internal/agent.(*sessionAgent).Cancel","file":"github.com/charmbracelet/crush/internal/agent/agent.go","line":907},"msg":"Request cancellation initiated","session_id":"4c2d1684-8db2-4ffd-83bb-9c08fe850f29"}