AxiomQuery 0.1.0__py3-none-any.whl

axiom_query/parser.py

@@ -0,0 +1,102 @@
+"""Parse frontend JSON domain expressions into QuerySpec AST nodes."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from axiom_query.ast import And, Bool, Condition, Not, Or, QuerySpec
+from axiom_query.operators import Op
+
+
+def parse_domain(raw: Any) -> QuerySpec:
+    """Parse a frontend domain expression into a QuerySpec AST."""
+    from axiom_query.errors import QueryError
+
+    if raw is None:
+        return Bool(True)
+    if isinstance(raw, list):
+        return _parse_list(raw)
+    if isinstance(raw, dict):
+        return _parse_dict(raw)
+    raise QueryError(
+        "INVALID_DOMAIN",
+        f"Domain must be a list or dict, got {type(raw).__name__}",
+    )
+
+
+def _parse_list(items: list) -> QuerySpec:
+    if not items:
+        return Bool(True)
+
+    specs = [_parse_item(item) for item in items]
+    result = specs[0]
+    for s in specs[1:]:
+        result = And(left=result, right=s)
+    return result
+
+
+def _parse_item(item: Any) -> QuerySpec:
+    from axiom_query.errors import QueryError
+
+    if isinstance(item, (list, tuple)) and len(item) == 3:
+        field_path, op_str, value = item
+        if not isinstance(field_path, str):
+            raise QueryError(
+                "INVALID_DOMAIN",
+                f"Field path must be a string, got {type(field_path).__name__}",
+            )
+        try:
+            op = Op.from_str(str(op_str))
+        except ValueError:
+            raise QueryError("INVALID_DOMAIN", f"Unknown operator: {op_str!r}")
+        return Condition(field_path=field_path, operator=op, value=value)
+
+    if isinstance(item, dict):
+        return _parse_dict(item)
+
+    raise QueryError(
+        "INVALID_DOMAIN",
+        f"Each condition must be [field, op, value] or a logical dict, got {type(item).__name__}",
+    )
+
+
+def _parse_dict(d: dict) -> QuerySpec:
+    from axiom_query.errors import QueryError
+
+    if len(d) != 1:
+        raise QueryError(
+            "INVALID_DOMAIN",
+            "Logical dict must have exactly one key: 'and', 'or', or 'not'",
+        )
+    key = next(iter(d))
+    val = d[key]
+
+    if key == "and":
+        if not isinstance(val, list) or len(val) < 2:
+            raise QueryError(
+                "INVALID_DOMAIN", "'and' requires a list of at least 2 items"
+            )
+        specs = [_parse_item(item) for item in val]
+        result = specs[0]
+        for s in specs[1:]:
+            result = And(left=result, right=s)
+        return result
+
+    if key == "or":
+        if not isinstance(val, list) or len(val) < 2:
+            raise QueryError(
+                "INVALID_DOMAIN", "'or' requires a list of at least 2 items"
+            )
+        specs = [_parse_item(item) for item in val]
+        result = specs[0]
+        for s in specs[1:]:
+            result = Or(left=result, right=s)
+        return result
+
+    if key == "not":
+        return Not(operand=_parse_item(val))
+
+    raise QueryError(
+        "INVALID_DOMAIN",
+        f"Unknown logical key: {key!r}. Use 'and', 'or', or 'not'.",
+    )

axiom_query/schema.py

@@ -0,0 +1,55 @@
+"""ModelSchema — derives table/column/child metadata from SA ORM models via inspect()."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from sqlalchemy import Column, Table
+from sqlalchemy import inspect as sa_inspect
+from sqlalchemy.orm import RelationshipDirection
+
+
+@dataclass
+class ChildSchema:
+    name: str
+    table: Table
+    fk_field: str
+    columns: dict[str, Column]
+
+
+@dataclass
+class ModelSchema:
+    model_class: type
+    table: Table
+    columns: dict[str, Column]
+    children: dict[str, ChildSchema] = field(default_factory=dict)
+
+
+def derive_schema(model_class: type) -> ModelSchema:
+    """Derive a ModelSchema from a SA ORM model class using inspect()."""
+    mapper = sa_inspect(model_class)
+    table = mapper.local_table
+    columns = {col.key: col for col in mapper.columns}
+
+    children: dict[str, ChildSchema] = {}
+    for rel_name, rel in mapper.relationships.items():
+        if rel.direction == RelationshipDirection.ONETOMANY:
+            child_table = rel.mapper.local_table
+            child_columns = {col.key: col for col in rel.mapper.columns}
+            # Find the FK column on the child table via synchronize_pairs
+            # synchronize_pairs: list of (parent_col, child_col) tuples
+            _, child_fk_col = next(iter(rel.synchronize_pairs))
+            fk_field = child_fk_col.key
+            children[rel_name] = ChildSchema(
+                name=rel_name,
+                table=child_table,
+                fk_field=fk_field,
+                columns=child_columns,
+            )
+
+    return ModelSchema(
+        model_class=model_class,
+        table=table,
+        columns=columns,
+        children=children,
+    )

axiomquery-0.1.0.dist-info/METADATA

@@ -0,0 +1,232 @@
+Metadata-Version: 2.4
+Name: AxiomQuery
+Version: 0.1.0
+Summary: Specification-based query and aggregation engine for SQLAlchemy 2.0 ORM models
+Project-URL: Source Code, https://github.com/Axiom-Dev-Labs/AxiomQuery
+Project-URL: Bug Tracker, https://github.com/Axiom-Dev-Labs/AxiomQuery/issues
+Project-URL: Changelog, https://github.com/Axiom-Dev-Labs/AxiomQuery/blob/main/CHANGELOG.md
+Author: Axiom Contributors
+License: MIT License
+        
+        Copyright (c) 2026 Axiom 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.
+License-File: LICENSE
+Keywords: domain,filter,groupby,orm,query,specification,sqlalchemy
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: sqlalchemy>=2.0
+Description-Content-Type: text/markdown
+
+# AxiomQuery
+
+Specification-based query and aggregation engine for SQLAlchemy 2.0 ORM models.
+
+Define filters as composable data — JSON lists, dicts, or Python AST nodes — and execute them against any ORM model without writing raw SQL.
+
+---
+
+## Install
+
+```bash
+pip install AxiomQuery
+```
+
+Requires Python 3.12+ and SQLAlchemy 2.0+.
+
+---
+
+## Quick start
+
+```python
+from axiom_query import QueryEngine
+
+engine = QueryEngine(Order)   # inspect() once — no DB connection at construction
+
+with Session(db) as session:
+    # list
+    records = engine.list(session, domain=[["status", "=", "CONFIRMED"]])
+
+    # read_group
+    groups, total = engine.read_group(
+        session,
+        groupby=["status"],
+        aggregates=["__count", "total:sum"],
+    )
+```
+
+---
+
+## Domain filter syntax
+
+A **domain** is a JSON-serialisable expression compiled to a WHERE clause at query time.
+
+### Condition tuple
+
+```python
+[field_path, operator, value]
+```
+
+| Operator | Meaning |
+|----------|---------|
+| `=` `!=` `>` `<` `>=` `<=` | Comparison |
+| `in` `not in` | Membership (value is a list) |
+| `like` `ilike` | Pattern match (`%` wildcard) |
+| `is_null` | Null check (value is `True`/`False`) |
+
+### Logical composition
+
+```python
+# AND — list of conditions (implicit)
+[["status", "=", "CONFIRMED"], ["total", ">", 100]]
+
+# AND — explicit
+{"and": [["status", "=", "CONFIRMED"], ["total", ">", 100]]}
+
+# OR
+{"or": [["status", "=", "DRAFT"], ["status", "=", "CANCELLED"]]}
+
+# NOT
+{"not": ["status", "=", "CANCELLED"]}
+
+# Combined — list mixes plain conditions with logical dicts
+[
+    {"or": [["status", "=", "CONFIRMED"], ["status", "=", "DRAFT"]]},
+    {"not": ["total", "=", 0]},
+]
+```
+
+### Child field (EXISTS subquery)
+
+Filter parent records by a child relationship field using dot notation. O2M relationships are automatically detected via `inspect()`.
+
+```python
+# Orders that have at least one line with quantity > 2
+engine.list(session, domain=[["lines.quantity", ">", 2]])
+```
+
+---
+
+## `list()` — filtered records
+
+```python
+records = engine.list(
+    session,
+    domain=None,          # domain expression or None (all records)
+    limit=None,           # max records to return
+    offset=None,          # records to skip
+    order_by=None,        # [["field", "asc|desc"], ...]
+)
+# returns list[ORM model instances]
+```
+
+---
+
+## `read_group()` — grouped aggregation
+
+```python
+groups, total = engine.read_group(
+    session,
+    groupby=["status", "created_at:month"],   # field or field:granularity
+    aggregates=["__count", "total:sum"],       # __count or field:func
+    domain=None,                              # WHERE filter
+    having=None,                              # HAVING filter on aggregate aliases
+    order_by=None,                            # [["alias", "asc|desc"], ...]
+    limit=None,
+    offset=None,
+)
+# returns (list[dict], int)  — each dict includes a __domain key
+```
+
+**Aggregate functions:** `count` `sum` `avg` `min` `max`
+
+**Date granularities:** `day` `week` `month` `quarter` `year`
+
+**Child aggregate** (LEFT JOIN):
+
+```python
+engine.read_group(session, groupby=["status"], aggregates=["lines.quantity:sum"])
+```
+
+**`__domain` drill-down** — each group result includes a `__domain` ready to pass back to `list()`:
+
+```python
+groups, _ = engine.read_group(session, groupby=["status"], aggregates=["__count"])
+for group in groups:
+    records = engine.list(session, domain=group["__domain"])
+```
+
+---
+
+## Async API
+
+Prefix any method with `a` and pass an `AsyncSession`:
+
+```python
+engine = QueryEngine(Order)
+
+async with AsyncSession(db) as session:
+    records = await engine.alist(session, domain=[["status", "=", "CONFIRMED"]])
+    groups, total = await engine.aread_group(session, groupby=["status"], aggregates=["__count"])
+```
+
+---
+
+## Schema derivation
+
+`QueryEngine` derives its schema from `inspect(model_class)` at construction time — no separate descriptor needed:
+
+- **Columns** → from `mapper.columns`
+- **Child relations** → O2M relationships (`RelationshipDirection.ONETOMANY`) become filterable child entities
+- **FK column** → resolved from `rel.synchronize_pairs`
+
+---
+
+## Error handling
+
+Invalid field paths and unsupported operators raise `QueryError` before hitting the database:
+
+```python
+from axiom_query import QueryError
+
+try:
+    engine.list(session, domain=[["unknown_field", "=", "x"]])
+except QueryError as e:
+    print(e.code, e.message)   # INVALID_FILTER_FIELD  No field 'unknown_field' ...
+```
+
+---
+
+## Examples
+
+Self-contained runnable examples in [`examples/`](examples/):
+
+```bash
+python examples/example_sync.py
+python examples/example_async.py
+```
+
+Both cover: simple filters, AND / OR / NOT, combined nesting, child EXISTS filtering, pagination, `read_group` with domain / date granularity / child aggregation / HAVING, and `__domain` drill-down.

axiomquery-0.1.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+axiom_query/__init__.py,sha256=Pe09GG6TA3lCwVxzkUfiracTrdRzwQ3FlDnS2fiEa9E,512
+axiom_query/aggregation.py,sha256=vCYhKXjxg8aHe43SJamZewV-GbyCYDWNElR8-G9mskc,2816
+axiom_query/aggregation_parser.py,sha256=6mtt72Cr8UlmemO6PDELdRpBJMtNI0N0XNpNXfXQx4w,5930
+axiom_query/ast.py,sha256=KWaI5QD9WlW-A7GinIH-KkSaz2vEST4Vx2Kf80GJYj4,1211
+axiom_query/compiler.py,sha256=jfhctH64i0fIVBdtde97-dLOgp39Miuh_mp57uX_g6Y,7326
+axiom_query/compiler_aggregate.py,sha256=ksmnO8PypGDc08OdNM7N_1s4aL5E_ePH6eniqKqvJFw,11965
+axiom_query/engine.py,sha256=NWPVqgbolCpXgjBhJVZzpIfFPqD_u86WkQVPHVZ_j54,6765
+axiom_query/errors.py,sha256=OeID6aSz11fr4cPdy6w46vj0Kf8wDC4g7yTd0pT9_dY,312
+axiom_query/operators.py,sha256=iUryrmDXscvt9tmKaD9A9y6kAONu8RxLbi577csmlyQ,684
+axiom_query/parser.py,sha256=IcWPmePL2O9zKTpMJp07XFueVFmFQ60bHz3oAXk7TfQ,3008
+axiom_query/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+axiom_query/schema.py,sha256=BFsWa2smz0mLeKDjqv-tapTW0nLO8gDJw1gHEOq3am8,1703
+axiomquery-0.1.0.dist-info/METADATA,sha256=VAahceYfepjBmZPu8eWZmg8GrBl8Tdcd5q0_OG4-MSE,7057
+axiomquery-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+axiomquery-0.1.0.dist-info/licenses/LICENSE,sha256=zZPLjk0vKhf5_He43a8zvG1zbw0fbB_A7R2tdWaMLyo,1075
+axiomquery-0.1.0.dist-info/RECORD,,

axiomquery-0.1.0.dist-info/WHEEL

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

axiomquery-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Axiom 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.