sqlrules-sqlite 1.0.1__py3-none-any.whl

sqlrules_sqlite/__init__.py

@@ -0,0 +1,55 @@
+from __future__ import annotations
+
+from sqlrules.plugins import PLUGIN_API_VERSION
+from sqlrules.translators import TranslatorRegistry
+from sqlrules_sqlite.json import translate_json_contains, translate_json_has_key
+from sqlrules_sqlite.pattern import translate_pattern
+from sqlrules_sqlite.regexp import register_regexp
+from sqlrules_sqlite.type_check import translate_type_check
+
+__version__ = "1.0.1"
+
+
+class SQLitePlugin:
+    """Register SQLite-specific constraint translators.
+
+    The ``pattern`` and text-shaped ``type_check`` translators emit
+    ``column REGEXP pattern``. Call :func:`register_regexp` on each SQLite
+    connection before executing the resulting SQL.
+    """
+
+    name = "sqlite"
+    api_version = PLUGIN_API_VERSION
+
+    def register(self, registry: TranslatorRegistry) -> None:
+        registry.register_constraint(
+            "pattern",
+            translate_pattern,
+            on_conflict="replace",
+        )
+        registry.register_constraint(
+            "type_check",
+            translate_type_check,
+            on_conflict="replace",
+        )
+        registry.register_constraint(
+            "json_contains",
+            translate_json_contains,
+            on_conflict="replace",
+        )
+        registry.register_constraint(
+            "json_has_key",
+            translate_json_has_key,
+            on_conflict="replace",
+        )
+
+
+__all__ = [
+    "SQLitePlugin",
+    "__version__",
+    "register_regexp",
+    "translate_json_contains",
+    "translate_json_has_key",
+    "translate_pattern",
+    "translate_type_check",
+]

sqlrules_sqlite/json.py

@@ -0,0 +1,94 @@
+from __future__ import annotations
+
+import json
+from typing import Any, cast
+
+from sqlalchemy import String, func, literal, type_coerce
+from sqlalchemy.sql.elements import ColumnElement
+
+from sqlrules.ir import CompilationContext, Constraint
+
+
+def _json_path_for_key(key: Any) -> str:
+    """Build a JSONPath for a single object key (never a full-path escape hatch)."""
+    text = str(key)
+    escaped = text.replace("\\", "\\\\").replace('"', '\\"')
+    return f'$."{escaped}"'
+
+
+def _compact_dumps(value: Any) -> str:
+    return json.dumps(value, separators=(",", ":"))
+
+
+def _extract_equals(
+    column: ColumnElement[Any],
+    path: str,
+    expected: Any,
+) -> ColumnElement[bool]:
+    """Compare ``json_extract`` to ``expected`` using SQLite JSON1 affinities."""
+    extracted = func.json_extract(column, path)
+    if expected is None:
+        return cast(ColumnElement[bool], func.json_type(column, path) == "null")
+    if isinstance(expected, bool):
+        return cast(ColumnElement[bool], extracted == (1 if expected else 0))
+    if isinstance(expected, (dict, list)):
+        compact = _compact_dumps(expected)
+        return cast(
+            ColumnElement[bool],
+            func.json(extracted) == func.json(literal(compact)),
+        )
+    if isinstance(expected, (int, float)):
+        return cast(ColumnElement[bool], extracted == expected)
+    if isinstance(expected, str):
+        return cast(ColumnElement[bool], extracted == expected)
+    compact = _compact_dumps(expected)
+    return cast(
+        ColumnElement[bool],
+        func.json(extracted) == func.json(literal(compact)),
+    )
+
+
+def translate_json_contains(
+    constraint: Constraint,
+    column: ColumnElement[Any],
+    context: CompilationContext,
+) -> ColumnElement[bool]:
+    """Translate ``json_contains`` using SQLite JSON1 ``json_extract``.
+
+    For object payloads, checks that each top-level key extracts to the
+    expected JSON value. This is a deterministic subset of JSON containment
+    suitable for common filter models; nested deep-merge semantics are not
+    emulated.
+    """
+    value = constraint.value
+    if isinstance(value, dict):
+        if not value:
+            # Align with PostgreSQL ``@> '{}'``: require a non-NULL JSON object.
+            return cast(
+                ColumnElement[bool],
+                column.is_not(None) & (func.json_type(column) == "object"),
+            )
+        parts: list[ColumnElement[bool]] = []
+        for key, expected in value.items():
+            parts.append(_extract_equals(column, _json_path_for_key(key), expected))
+        expression = parts[0]
+        for part in parts[1:]:
+            expression = expression & part
+        return cast(ColumnElement[bool], expression)
+
+    # Scalar / array payload: compare whole-document JSON text via json().
+    compact = _compact_dumps(value)
+    return cast(
+        ColumnElement[bool],
+        func.json(type_coerce(column, String)) == func.json(literal(compact)),
+    )
+
+
+def translate_json_has_key(
+    constraint: Constraint,
+    column: ColumnElement[Any],
+    context: CompilationContext,
+) -> ColumnElement[bool]:
+    """Translate ``json_has_key`` via ``json_type(column, path) IS NOT NULL``."""
+    path = _json_path_for_key(constraint.value)
+    return cast(ColumnElement[bool], func.json_type(column, path).is_not(None))

sqlrules_sqlite/pattern.py

@@ -0,0 +1,25 @@
+from __future__ import annotations
+
+from typing import Any, cast
+
+from sqlalchemy.sql.elements import ColumnElement
+
+from sqlrules.constraints import pattern_text
+from sqlrules.ir import CompilationContext, Constraint
+
+
+def translate_pattern(
+    constraint: Constraint,
+    column: ColumnElement[Any],
+    context: CompilationContext,
+) -> ColumnElement[bool]:
+    """Translate ``pattern`` to SQLite ``column REGEXP pattern``.
+
+    Case-insensitive patterns are encoded with a ``(?i)`` prefix so
+    :func:`sqlrules_sqlite.register_regexp` can apply ``re.IGNORECASE``.
+    Callers must enable REGEXP on the SQLite connection before execution.
+    """
+    pattern, ignore_case = pattern_text(constraint.value)
+    if ignore_case and not pattern.startswith("(?i)"):
+        pattern = f"(?i){pattern}"
+    return cast(ColumnElement[bool], column.op("REGEXP")(pattern))

sqlrules_sqlite/regexp.py

@@ -0,0 +1,30 @@
+from __future__ import annotations
+
+import re
+import sqlite3
+
+
+def register_regexp(connection: sqlite3.Connection) -> None:
+    """Register a flag-aware ``REGEXP`` function on a SQLite connection.
+
+    The SQLRules SQLite ``pattern`` translator emits
+    ``column REGEXP pattern``. SQLite does not ship REGEXP by default;
+    call this once per connection before executing compiled SQL.
+
+    The helper interprets an optional ``(?i)`` prefix (inserted by the
+    pattern translator for case-insensitive ``PatternSpec`` values).
+
+    Invalid patterns raise ``re.error`` (surfaced by SQLite as an
+    operational error) instead of silently matching nothing.
+    """
+
+    def regexp(pattern: str | None, value: str | None) -> bool:
+        if pattern is None or value is None:
+            return False
+        flags = 0
+        if pattern.startswith("(?i)"):
+            flags |= re.IGNORECASE
+            pattern = pattern[4:]
+        return re.search(pattern, value, flags) is not None
+
+    connection.create_function("REGEXP", 2, regexp)

sqlrules_sqlite/type_check.py

@@ -0,0 +1,213 @@
+from __future__ import annotations
+
+from datetime import date, datetime, time
+from decimal import Decimal
+from typing import Any, cast
+from uuid import UUID
+
+from sqlalchemy import Boolean, Date, DateTime, Float, Integer, Numeric, String, Time
+from sqlalchemy.sql import func
+from sqlalchemy.sql.elements import ColumnElement
+from sqlalchemy.sql.sqltypes import NullType
+from sqlalchemy.types import TypeEngine
+
+from sqlrules.constraints import type_spec
+from sqlrules.errors import UnsupportedConstraintError
+from sqlrules.ir import CompilationContext, Constraint, TypeSpec
+
+_INT_TEXT = r"^[+-]?(0|[1-9]\d*)$"
+_FLOAT_TEXT = r"^[+-]?(\d+(\.\d*)?|\.\d+)([eE][+-]?\d+)?$"
+_DATE_TEXT = r"^\d{4}-\d{2}-\d{2}$"
+_DATETIME_TEXT = r"^\d{4}-\d{2}-\d{2}[ T]\d{2}:\d{2}:\d{2}(\.\d+)?([+-]\d{2}:?\d{2}|Z)?$"
+_TIME_TEXT = r"^\d{2}:\d{2}:\d{2}(\.\d+)?$"
+_UUID_TEXT = (
+    r"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-"
+    r"[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
+)
+
+
+def _is_type(column: ColumnElement[Any], *bases: type[TypeEngine[Any]]) -> bool:
+    col_type = column.type
+    if isinstance(col_type, NullType):
+        return False
+    return isinstance(col_type, bases)
+
+
+def _regexp(column: ColumnElement[Any], pattern: str) -> ColumnElement[bool]:
+    return cast(ColumnElement[bool], column.op("REGEXP")(pattern))
+
+
+def _wrap_none(
+    column: ColumnElement[Any],
+    predicate: ColumnElement[bool],
+    *,
+    allow_none: bool,
+) -> ColumnElement[bool]:
+    if allow_none:
+        return cast(ColumnElement[bool], column.is_(None) | predicate)
+    return predicate
+
+
+def _unsupported(field: str, spec: TypeSpec, suggestion: str) -> None:
+    raise UnsupportedConstraintError(
+        field=field,
+        operator="type_check",
+        value=spec,
+        suggestion=suggestion,
+    )
+
+
+def _predicate_int(
+    column: ColumnElement[Any],
+    spec: TypeSpec,
+    field: str,
+) -> ColumnElement[bool]:
+    if _is_type(column, Integer):
+        return cast(ColumnElement[bool], column.isnot(None))
+    if spec.strict:
+        # SQLite typeof can distinguish integer storage even on loosely typed columns.
+        return cast(ColumnElement[bool], func.typeof(column) == "integer")
+    if _is_type(column, String):
+        return _regexp(column, _INT_TEXT)
+    if _is_type(column, Float, Numeric):
+        return cast(ColumnElement[bool], column == column.cast(Integer).cast(Float))
+    # Affinity-agnostic: integer typeof OR integer-shaped text.
+    return cast(
+        ColumnElement[bool],
+        (func.typeof(column) == "integer") | _regexp(column, _INT_TEXT),
+    )
+
+
+def _predicate_bool(
+    column: ColumnElement[Any],
+    spec: TypeSpec,
+    field: str,
+) -> ColumnElement[bool]:
+    if spec.strict:
+        if _is_type(column, Boolean, Integer):
+            return cast(ColumnElement[bool], column.in_((True, False, 0, 1)))
+        return cast(
+            ColumnElement[bool],
+            (func.typeof(column) == "integer") & column.in_((0, 1)),
+        )
+    _unsupported(
+        field,
+        spec,
+        "SQLite lax bool type_check is not supported. Use strict=True.",
+    )
+    raise AssertionError("unreachable")
+
+
+def _predicate_str(
+    column: ColumnElement[Any],
+    spec: TypeSpec,
+    field: str,
+) -> ColumnElement[bool]:
+    if _is_type(column, String):
+        return cast(ColumnElement[bool], column.isnot(None))
+    return cast(ColumnElement[bool], func.typeof(column) == "text")
+
+
+def _predicate_float(
+    column: ColumnElement[Any],
+    spec: TypeSpec,
+    field: str,
+) -> ColumnElement[bool]:
+    if _is_type(column, Float, Numeric, Integer):
+        return cast(ColumnElement[bool], column.isnot(None))
+    if spec.strict:
+        return cast(
+            ColumnElement[bool],
+            func.typeof(column).in_(("real", "integer")),
+        )
+    if _is_type(column, String):
+        return _regexp(column, _FLOAT_TEXT)
+    return cast(
+        ColumnElement[bool],
+        func.typeof(column).in_(("real", "integer")) | _regexp(column, _FLOAT_TEXT),
+    )
+
+
+def _predicate_temporal(
+    column: ColumnElement[Any],
+    spec: TypeSpec,
+    field: str,
+    *,
+    sa_types: tuple[type[TypeEngine[Any]], ...],
+    text_pattern: str,
+) -> ColumnElement[bool]:
+    if _is_type(column, *sa_types):
+        return cast(ColumnElement[bool], column.isnot(None))
+    if spec.strict and not _is_type(column, String):
+        type_name = spec.python_type.__name__
+        _unsupported(
+            field,
+            spec,
+            f"SQLite strict {type_name} type_check requires a typed or String column.",
+        )
+    return _regexp(column, text_pattern)
+
+
+def _predicate_uuid(
+    column: ColumnElement[Any],
+    spec: TypeSpec,
+    field: str,
+) -> ColumnElement[bool]:
+    if "uuid" in type(column.type).__name__.lower():
+        return cast(ColumnElement[bool], column.isnot(None))
+    if _is_type(column, String) or not spec.strict:
+        return _regexp(column, _UUID_TEXT)
+    _unsupported(
+        field,
+        spec,
+        "SQLite strict UUID type_check requires a UUID or String column.",
+    )
+    raise AssertionError("unreachable")
+
+
+def _build_predicate(
+    column: ColumnElement[Any],
+    spec: TypeSpec,
+    field: str,
+) -> ColumnElement[bool]:
+    python_type = spec.python_type
+    if python_type is int:
+        return _predicate_int(column, spec, field)
+    if python_type is bool:
+        return _predicate_bool(column, spec, field)
+    if python_type is str:
+        return _predicate_str(column, spec, field)
+    if python_type in {float, Decimal}:
+        return _predicate_float(column, spec, field)
+    if python_type is date:
+        return _predicate_temporal(column, spec, field, sa_types=(Date,), text_pattern=_DATE_TEXT)
+    if python_type is datetime:
+        return _predicate_temporal(
+            column, spec, field, sa_types=(DateTime,), text_pattern=_DATETIME_TEXT
+        )
+    if python_type is time:
+        return _predicate_temporal(column, spec, field, sa_types=(Time,), text_pattern=_TIME_TEXT)
+    if python_type is UUID:
+        return _predicate_uuid(column, spec, field)
+    _unsupported(
+        field,
+        spec,
+        f"SQLite type_check has no translator for {python_type!r}.",
+    )
+    raise AssertionError("unreachable")
+
+
+def translate_type_check(
+    constraint: Constraint,
+    column: ColumnElement[Any],
+    context: CompilationContext,
+) -> ColumnElement[bool]:
+    """Translate ``type_check`` using SQLite ``typeof`` / ``REGEXP``.
+
+    Text-shape checks use ``REGEXP``; call :func:`register_regexp` on the
+    connection before executing the SQL.
+    """
+    del context
+    spec = type_spec(constraint.value)
+    predicate = _build_predicate(column, spec, constraint.field)
+    return _wrap_none(column, predicate, allow_none=spec.allow_none)

sqlrules_sqlite-1.0.1.dist-info/METADATA

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: sqlrules-sqlite
+Version: 1.0.1
+Summary: SQLite dialect plugin for SQLRules (REGEXP helpers and JSON).
+Project-URL: Homepage, https://github.com/eddiethedean/sqlrules
+Project-URL: Repository, https://github.com/eddiethedean/sqlrules
+Project-URL: Issues, https://github.com/eddiethedean/sqlrules/issues
+Author: SQLRules Contributors
+License-Expression: MIT
+License-File: LICENSE
+Keywords: pydantic,sqlalchemy,sqlite,sqlrules
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: sqlalchemy<3,>=2.0
+Requires-Dist: sqlrules<2,>=1
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# sqlrules-sqlite
+
+SQLite dialect plugin for [SQLRules](https://github.com/eddiethedean/sqlrules).
+
+## Install
+
+```bash
+pip install sqlrules-sqlite
+```
+
+## Usage
+
+```python
+import sqlite3
+from typing import Annotated, Any
+
+from pydantic import BaseModel, Field
+from sqlalchemy import Column, MetaData, String, Table, create_engine, text
+
+from sqlrules import Compiler, JsonContains, JsonHasKey
+from sqlrules_sqlite import SQLitePlugin, register_regexp
+
+class RowFilter(BaseModel):
+    name: Annotated[str, Field(pattern=r"^A")]
+    meta: Annotated[dict[str, Any], JsonContains({"active": True}), JsonHasKey("active")]
+
+table = Table(
+    "rows",
+    MetaData(),
+    Column("name", String),
+    Column("meta", String),
+)
+
+compiler = Compiler(plugins=[SQLitePlugin()], dialect="sqlite")
+rules = compiler.compile(RowFilter, table)
+
+engine = create_engine("sqlite://")
+with engine.raw_connection() as conn:
+    # SQLAlchemy 2 may wrap the DBAPI connection; unwrap if needed.
+    dbapi = conn.driver_connection if hasattr(conn, "driver_connection") else conn
+    register_regexp(dbapi)
+```
+
+## Operators
+
+| IR operator | Notes |
+|---|---|
+| `pattern` | `column REGEXP pattern`; call `register_regexp(connection)` |
+| `type_check` | `typeof` / `REGEXP` shape checks; text forms need `register_regexp` |
+| `json_contains` | JSON1 `json_extract` equality for object keys |
+| `json_has_key` | `json_type(column, '$.key') IS NOT NULL` |
+
+Case-insensitive patterns (`re.IGNORECASE` / `PatternSpec.ignore_case`) are
+encoded with a `(?i)` prefix understood by `register_regexp`.
+
+## Security note
+
+`register_regexp` installs a Python `re.search` UDF. Untrusted
+`Field(pattern=...)` values can cause **CPU denial of service** (ReDoS) in
+your process — not SQL injection. Prefer static/allowlisted patterns. See
+[SECURITY](https://sqlrules.readthedocs.io/en/latest/SECURITY.html).

sqlrules_sqlite-1.0.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+sqlrules_sqlite/__init__.py,sha256=oLODNHzgXbK1XjmI5YcpnDKf7JXYJfj0Wr2Gcnc35ds,1575
+sqlrules_sqlite/json.py,sha256=B9QCjD8FR7nja8Ct4O7fb2VzTPhALg3b_ODayBeKHBY,3326
+sqlrules_sqlite/pattern.py,sha256=K1JBoM1bkxYRgWKz_Ti7o_IDFKtIeg9uYplr0ThVJBY,867
+sqlrules_sqlite/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sqlrules_sqlite/regexp.py,sha256=j3c_J3dnbAdXfKkhhb1CxiIPi1QB_ai5Mt30ODrmx3M,1038
+sqlrules_sqlite/type_check.py,sha256=JQXzgdLWmdAnGXOBPza4yMwVhrWWeYyforv-hQSd9k4,6742
+sqlrules_sqlite-1.0.1.dist-info/METADATA,sha256=yCg5Z14W7BSP9IquHzYJFKuu-oUzzHdDooT1R0qKnzU,2694
+sqlrules_sqlite-1.0.1.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+sqlrules_sqlite-1.0.1.dist-info/licenses/LICENSE,sha256=cLMlkCH6RhjWAkXBWR7LazV98TOG0WkPtCKB5zqqkAs,1078
+sqlrules_sqlite-1.0.1.dist-info/RECORD,,

sqlrules_sqlite-1.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any

sqlrules_sqlite-1.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 SQLRules Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.