Metadata-Version: 2.4
Name: querymodelling
Version: 0.0.18
Summary: build consistent api query models for fastapi
Author: George Haddad
Author-email: George Haddad <georgeh87@live.de>
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: pydantic>=2.10.5
Dynamic: author
Dynamic: license-file

# querymodelling
build consistent api query models for fastapi

## Requirements
At least you will need to have the pydantic package installed. Of course it make sense to have some kind of service supporting query models like fast api. Currently sql models are implemented - but feel free to create new ones.

## Installation

## Example


### Typed SQL query models

`SqlQueryModel` generates a fully typed query model (incl. JSON schema)
with `joins`, `fields`, `where`, `group_by` and subqueries, which is compiled
into a SQLAlchemy select statement. Only the registered models can be
queried.

```python
from sqlmodel import Session
from querymodelling.sql_query import SqlQueryModel

BookQuery = SqlQueryModel(Book, models=[Author, Review])

query = BookQuery.model_validate({
    "joins": [
        {
            "model": "author",
            "type": "left",
            "on": {"eq": [
                {"model": "book", "field": "author_id"},
                {"model": "author", "field": "id"}
            ]}
        }
    ],
    "fields": [
        {"model": "book", "field": "id"},
        {"model": "author", "field": "id", "alias": "author_id"},
        {"lower": {"model": "author", "field": "name"}, "alias": "author_name"}
    ],
    "where": {"and": [
        {"eq": [{"model": "book", "field": "id"}, 123]},
        {"startswith": [{"model": "author", "field": "name"}, "M"]}
    ]}
})
statement = query.to_select()      # SQLAlchemy select with labeled columns
rows = query.fetch(session)        # list of typed result rows
RowModel = query.result_model()    # typed row, without executing the query
```

```sql
SELECT book.id AS id, author.id AS author_id, lower(author.name) AS author_name
FROM book LEFT OUTER JOIN author ON book.author_id = author.id
WHERE book.id = 123 AND author.name LIKE 'M' || '%'
```

**One rule:** a plain JSON value (string, number, boolean) is always a
constant, an object is an expression identified by its keys:

| Object | Expression |
|---|---|
| `{"model": "book", "field": "id"}` | field (`"as"` selects a joined instance) |
| `{"model": "review", "fields": [...], "where": ...}` | subquery (no `field`) |
| `{"lower": ...}`, `{"eq": [...]}` | function (its only key besides `alias`) |
| `{"ref": "author_name"}` | alias of `fields` (`group_by` only) |

* **Query**: `model` (defaults to the base model), `as`, `joins`, `fields`
  (all fields of the queried model if not set), `where`, `group_by`.
  Subqueries have the same structure.
* **Joins**: `{"model", "as", "type", "on"}` with `type` `inner` (default),
  `left` or `full`. `on` may reference the queried model and the previous
  joins. A model joined twice needs `as`, it is referenced by
  `{"model": "author", "as": "reviewer", "field": "name"}`. Fields of the
  outer side of an outer join are `Optional` in the result model.
* **Conditions** (`where`, `on`) are functions returning `bool`:
  `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `between`, `in`, `not_in`
  (`{"in": [x, [1, 2]]}` or `{"in": [x, <subquery>]}`), `contains`,
  `icontains`, `startswith`, `istartswith`, `endswith`, `iendswith`, `like`,
  `not_like`, `ilike`, `is_null`, `is_not_null`, `and`, `or`, `not` and
  `exists` (`{"exists": <subquery>}`).
* **Functions**: `lower`, `upper`, `trim`, `length`, `concat`, `substring`,
  `replace`, `abs`, `round`, `ceil`, `floor`, `add`, `sub`, `mul`, `div`,
  `date`, `year`, `month`, `day`, `hour`, `minute`, `coalesce`, `nullif`,
  `cast` (`{"cast": [x, "string"]}`) and the aggregates `count`
  (`{"count": "*"}` counts all rows), `count_distinct`, `sum`, `avg`, `min`,
  `max`.
* **Subqueries** used as value or in `in` return exactly one field, its type
  is the type of the expression. Subqueries may reference the models of the
  outer queries, inner models shadow outer ones with the same name (use
  `as`).
* **Typing**: all expressions are typed per result type, e.g.
  `{"lower": <int field>}` or `{"eq": [<int field>, "x"]}` are rejected by
  the JSON schema and the validation.
* **Grouping**: fields outside of aggregate functions must be part of
  `group_by`, aggregates must not be nested and are not allowed in `where`,
  `on` and `group_by`. An empty `group_by` means no grouping.
* **Limits**: `max_joins` (default 5) per (sub)query and `max_depth`
  (default 3) of nested subqueries.

```json
{
  "joins": [{"model": "author", "type": "left", "on": {"eq": [
    {"model": "book", "field": "author_id"}, {"model": "author", "field": "id"}
  ]}}],
  "fields": [
    {"lower": {"model": "author", "field": "name"}, "alias": "author_name"},
    {"count": "*", "alias": "books"},
    {"model": "review", "fields": [{"avg": {"model": "review", "field": "rating"}}],
     "where": {"eq": [{"model": "review", "field": "book_id"}, {"model": "book", "field": "id"}]},
     "alias": "avg_rating"}
  ],
  "where": {"exists": {"model": "review", "where": {"eq": [
    {"model": "review", "field": "book_id"}, {"model": "book", "field": "id"}
  ]}}},
  "group_by": [{"ref": "author_name"}, {"model": "book", "field": "id"}]
}
```

Models are registered by their table name (`models=[Author]`) or explicitly
(`models={"writer": Author}`). `sources` overrides the table of a model,
`include_fields` / `exclude_fields` restrict the fields (a list for the base
model or a mapping of model names to lists).

Functions and conditions are provided by generators `(annotation) ->
Iterable[SqlExpressionFunction]` which are called for every known type:

```python
from sqlalchemy import Integer, func
from querymodelling.sql_filter import without
from querymodelling.sql_query import (
    Expr, SqlExpressionFunction, default_sql_expression_mapping
)

def instr(annotation):
    if annotation is str:
        yield SqlExpressionFunction(
            "instr", int, (Expr(str), Expr(str)),
            lambda value, search: func.instr(value, search, type_=Integer()))

mapping = default_sql_expression_mapping()
mapping.function_generators = [
    without(generator, "cast") for generator in mapping.function_generators
]
mapping.add_functions(instr)

BookQuery = SqlQueryModel(Book, models=[Author], mapping=mapping)
```

Argument placeholders are `Expr(*types)` (an expression of the types, any
type if empty), `Many(type)` (a list or a subquery, see `in`) and `Query()`
(a subquery, see `exists`). Referenceable fields are provided by reference
generators (`reference_generators=...`, e.g. virtual fields based on SQL
expressions).

#### Result schema

The result of a validated query is known without executing it:
`query.result_model()` is the typed model of a result row,
`query.result_schema()` the JSON schema of the result rows
(`result_schema(many=False)` of a single row).

* Fields copy the information of their source field: type, `title`,
  `description`, `examples`, `json_schema_extra`, `deprecated` and the
  constraints (`max_length`, `ge`, ...). They may be `NULL` if their field is
  optional or on the outer side of an outer join.
* Constants are of their type and never `NULL`.
* Functions define their result: `result_type`, `nullable` and
  `result_field`:
  * `nullable` (`Nullability`): `PROPAGATE` (default, `NULL` if any argument
    may be `NULL`), `COALESCE` (if all arguments may be), `ALWAYS` (e.g.
    `sum`, `avg`, `min`, `max`, `nullif`, `div`) or `NEVER` (e.g. `count`,
    `is_null`, `exists`), `True` / `False` for always / never.
  * `result_field`: field information from the arguments, `inherit()` (all
    of the argument, e.g. `min`, `max`, `nullif`) or `describe()` (only its
    title and description, e.g. `lower`, `round`, `avg`, `coalesce`).
    Without a rule the result has no field information.
* Subqueries are the result of their single field, `NULL` if they may return
  no row (an aggregate without `group_by` always returns one row).

```python
SqlExpressionFunction(
    "initials", str, (Expr(str),), lambda value: func.substr(value, 1, 1),
    nullable=Nullability.PROPAGATE, result_field=describe(),
)
```

#### Access rules

Models and fields can be restricted per access context - any object of the
application, e.g. the user. Without rules everything is allowed. Rules are
fixed values or callables `(context) -> flags | bool` receiving the context
directly, `None` if no context is given. The declarations are generic in the
type of the context (`None` if not given, `SqlFieldAccess[User]`,
`SqlQueryFactory[User]`), `SqlModelAccess` also in the model of the rows
rule (`SqlModelAccess[User, Self]` within the class body, the model defaults
to `Any`).

```python
from typing import Annotated, Self
from querymodelling.sql_query import (
    INVISIBLE, FieldUsage, ModelUsage, SqlFieldAccess, SqlModelAccess,
    SqlQueryFactory
)

class Book(SQLModel, table=True):
    __sql_access__ = SqlModelAccess[User, Self](
        # rows of the user's tenant only - in every position
        rows=lambda user, book: book.tenant_id == user.tenant_id,
    )
    id: int | None = Field(default=None, primary_key=True)
    title: str
    cost: Annotated[float, SqlFieldAccess[User](lambda user: (
        FieldUsage.ALL if user.is_admin else FieldUsage.AGGREGATE))]
    tenant_id: Annotated[int, SqlFieldAccess(INVISIBLE)]

class Salary(SQLModel, table=True):
    __sql_access__ = SqlModelAccess[User](usage=lambda user: user.is_admin)
    ...

queries = SqlQueryFactory[User](Book, models=[Author, Salary])
queries.schema(user)                   # JSON schema of the user
query = queries.validate(data, user)   # validated for the user
query.fetch(session)                   # rows rules applied for the user
```

* Fields: `FieldUsage.SELECT` (`fields`), `FILTER` (`where`, `on`), `GROUP`
  (`group_by`), `AGGREGATE` (within aggregate functions), `ALL` / `NONE`
  (`VISIBLE` / `INVISIBLE`), declared by `Annotated[..., SqlFieldAccess(rule)]`
  or `SqlModelAccess(fields={"name": rule})`.
* Models: `ModelUsage.QUERY` (queried model), `JOIN`, `SUBQUERY`, declared
  by `__sql_access__ = SqlModelAccess(usage=rule)`.
* `rows`: `(context, entity) -> condition` restricts the rows of a model
  wherever it is used (queried model, joins incl. outer joins, subqueries),
  the model is replaced by a derived table of the permitted rows.
* `SqlQueryModel(..., access={"book": SqlModelAccess(...)})` overrides the
  declared rules, `SqlQueryModel(..., context=user)` evaluates them for a
  context.
* Models and fields without any access are removed from the query model and
  its JSON schema (and are reported as unknown), partial access is checked
  by the validation. `SqlQueryFactory` caches the query models per
  permission signature: contexts with the same permissions share them.
* Partial access may still reveal values: `FILTER` by comparisons,
  `AGGREGATE` by `min` / `max` of a single row.
