iron-sql 0.4.0__tar.gz → 0.4.2__tar.gz

{iron_sql-0.4.0 → iron_sql-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iron-sql
-Version: 0.4.0
+Version: 0.4.2
 Summary: iron_sql generates typed async PostgreSQL clients and runtime helpers from schemas and SQL queries
 Keywords: postgresql,sql,sqlc,psycopg,codegen,async
 Author: Ilia Ablamonov
@@ -16,7 +16,7 @@ Requires-Dist: psycopg>=3.3.2
 Requires-Dist: psycopg-pool>=3.3.0
 Requires-Dist: pydantic>=2.12.4
 Requires-Dist: inflection>=0.5.1 ; extra == 'codegen'
-Requires-Dist: sqlc>=1.30.0 ; extra == 'codegen'
+Requires-Dist: sqlc>=1.30.0.post18 ; extra == 'codegen'
 Requires-Python: >=3.13
 Project-URL: Homepage, https://github.com/Flamefork/iron_sql
 Project-URL: Repository, https://github.com/Flamefork/iron_sql.git
@@ -81,6 +81,7 @@ The `sqlc` binary is bundled automatically via the `sqlc` Python package.
    This writes `myapp/db/mydb.py` containing:
    - a connection pool singleton,
    - `*_connection()` and `*_transaction()` context managers,
+   - `*_listen_session(channel)` and `*_notify(channel, payload="")` helpers,
    - dataclasses for multi-column results (deduplicated by table),
    - `StrEnum` classes for PostgreSQL enums,
    - a query class per statement with typed methods,
@@ -95,6 +96,7 @@ The `sqlc` binary is bundled automatically via the `sqlc` Python package.
 
 ## Runtime Highlights
 - `ConnectionPool` opens lazily and reopens after `close()`, with `ContextVar`-based connection reuse for nested contexts.
+- `*_listen_session()` uses a dedicated pooled connection and doesn't reuse `ContextVar` transaction connections.
 - `query_single_row()` raises `NoRowsError`; `query_optional_row()` returns `None`. Both raise `TooManyRowsError` on 2+ rows.
 - JSONB params are sent with `pgjson.Jsonb`; JSON with `pgjson.Json`. Scalar row factories validate types at runtime.
 - `json_validated` decorator applies Pydantic model validation to dataclass fields on construction.

{iron_sql-0.4.0 → iron_sql-0.4.2}/README.md

@@ -55,6 +55,7 @@ The `sqlc` binary is bundled automatically via the `sqlc` Python package.
    This writes `myapp/db/mydb.py` containing:
    - a connection pool singleton,
    - `*_connection()` and `*_transaction()` context managers,
+   - `*_listen_session(channel)` and `*_notify(channel, payload="")` helpers,
    - dataclasses for multi-column results (deduplicated by table),
    - `StrEnum` classes for PostgreSQL enums,
    - a query class per statement with typed methods,
@@ -69,6 +70,7 @@ The `sqlc` binary is bundled automatically via the `sqlc` Python package.
 
 ## Runtime Highlights
 - `ConnectionPool` opens lazily and reopens after `close()`, with `ContextVar`-based connection reuse for nested contexts.
+- `*_listen_session()` uses a dedicated pooled connection and doesn't reuse `ContextVar` transaction connections.
 - `query_single_row()` raises `NoRowsError`; `query_optional_row()` returns `None`. Both raise `TooManyRowsError` on 2+ rows.
 - JSONB params are sent with `pgjson.Jsonb`; JSON with `pgjson.Json`. Scalar row factories validate types at runtime.
 - `json_validated` decorator applies Pydantic model validation to dataclass fields on construction.

{iron_sql-0.4.0 → iron_sql-0.4.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "iron-sql"
-version = "0.4.0"
+version = "0.4.2"
 
 description = "iron_sql generates typed async PostgreSQL clients and runtime helpers from schemas and SQL queries"
 readme = "README.md"
@@ -26,7 +26,7 @@ dependencies = [
 [project.optional-dependencies]
 codegen = [
     "inflection>=0.5.1",
-    "sqlc>=1.30.0",
+    "sqlc>=1.30.0.post18",
 ]
 
 [project.urls]
@@ -52,7 +52,6 @@ dev = [
 ]
 
 [tool.pyright]
-ignore = ["example"]
 typeCheckingMode = "strict"
 reportUnknownArgumentType = "none"
 reportUnknownLambdaType = "none"
@@ -71,7 +70,6 @@ reportImplicitRelativeImport = true
 
 [tool.ruff]
 target-version = "py313"
-exclude = ["example"]
 
 [tool.ruff.format]
 preview = true
@@ -100,6 +98,7 @@ ignore = [
 
 [tool.ruff.lint.per-file-ignores]
 "test_*.py" = ["A002", "PLR2004", "S", "FBT"]
+"example/*.py" = ["E501", "T201", "PGH004"]
 
 [tool.ruff.lint.isort]
 force-single-line = true

{iron_sql-0.4.0 → iron_sql-0.4.2}/src/iron_sql/codegen/generator.py

@@ -382,6 +382,7 @@ import datetime
 import decimal
 import ipaddress
 import uuid
+from collections.abc import AsyncGenerator
 from collections.abc import AsyncIterator
 from collections.abc import Sequence
 from contextlib import asynccontextmanager
@@ -426,6 +427,20 @@ async def {package_name}_transaction() -> AsyncIterator[None]:
         yield
 
 
+@asynccontextmanager
+async def {package_name}_listen_session(
+    channel: str,
+) -> AsyncIterator[AsyncGenerator[str]]:
+    async with {package_name.upper()}_POOL.connection() as conn:
+        async with runtime.listen(conn, channel) as payloads:
+            yield payloads
+
+
+async def {package_name}_notify(channel: str, payload: str = "") -> None:
+    async with {package_name}_connection() as conn:
+        await runtime.notify(conn, channel, payload)
+
+
 {"\n\n\n".join(enums)}
 
 

{iron_sql-0.4.0 → iron_sql-0.4.2}/src/iron_sql/runtime.py

@@ -1,4 +1,6 @@
+import contextlib
 import types
+from collections.abc import AsyncGenerator
 from collections.abc import AsyncIterator
 from collections.abc import Callable
 from collections.abc import Sequence
@@ -13,6 +15,7 @@ from typing import overload
 import psycopg
 import psycopg.rows
 import psycopg_pool
+from psycopg import sql
 from psycopg.types import json as pgjson
 from pydantic import TypeAdapter
 
@@ -20,11 +23,9 @@ _adapter_cache: dict[object, TypeAdapter[object]] = {}
 
 
 def get_adapter(typ: object) -> TypeAdapter[object]:
-    adapter = _adapter_cache.get(typ)
-    if adapter is None:
-        adapter = TypeAdapter(typ)
-        _adapter_cache[typ] = adapter
-    return adapter
+    if typ not in _adapter_cache:
+        _adapter_cache[typ] = TypeAdapter(typ)
+    return _adapter_cache[typ]
 
 
 class NoRowsError(Exception):
@@ -35,6 +36,66 @@ class TooManyRowsError(Exception):
     pass
 
 
+@asynccontextmanager
+async def listen(
+    conn: psycopg.AsyncConnection, channel: str
+) -> AsyncIterator[AsyncGenerator[str]]:
+    _validate_channel(channel)
+    if await _has_active_listen_subscriptions(conn):
+        msg = "listen() requires a connection without active LISTEN subscriptions"
+        raise RuntimeError(msg)
+    await execute_listen(conn, channel)
+
+    async def _payloads() -> AsyncGenerator[str]:
+        async for notify_msg in conn.notifies():
+            yield notify_msg.payload
+
+    gen = _payloads()
+    try:
+        yield gen
+    finally:
+        with contextlib.suppress(psycopg.OperationalError, psycopg.InterfaceError):
+            await gen.aclose()
+        with contextlib.suppress(psycopg.OperationalError, psycopg.InterfaceError):
+            await execute_unlisten(conn, channel)
+
+
+async def notify(conn: psycopg.AsyncConnection, channel: str, payload: str) -> None:
+    _validate_channel(channel)
+    await conn.execute(
+        sql.SQL("NOTIFY {}, {}").format(
+            sql.Identifier(channel),
+            sql.Literal(payload),
+        )
+    )
+
+
+async def execute_listen(conn: psycopg.AsyncConnection, channel: str) -> None:
+    _validate_channel(channel)
+    await conn.execute(sql.SQL("LISTEN {}").format(sql.Identifier(channel)))
+
+
+async def execute_unlisten(conn: psycopg.AsyncConnection, channel: str) -> None:
+    _validate_channel(channel)
+    await conn.execute(sql.SQL("UNLISTEN {}").format(sql.Identifier(channel)))
+
+
+async def _has_active_listen_subscriptions(conn: psycopg.AsyncConnection) -> bool:
+    async with conn.cursor() as cur:
+        await cur.execute("SELECT EXISTS (SELECT FROM pg_listening_channels())")
+        row = await cur.fetchone()
+    if row is None:
+        msg = "Expected a single boolean row from active LISTEN check"
+        raise RuntimeError(msg)
+    return bool(row[0])
+
+
+def _validate_channel(name: str) -> None:
+    if not name:
+        msg = "Channel name must not be empty"
+        raise ValueError(msg)
+
+
 class ConnectionPool:
     def __init__(
         self,