fastapi-query-filters 0.0.1a0__tar.gz

fastapi_query_filters-0.0.1a0/.env.example

@@ -0,0 +1,6 @@
+# Postgres Database
+POSTGRES_HOSTNAME=localhost
+POSTGRES_PORT=5432
+POSTGRES_PASSWORD=postgres
+POSTGRES_USER=postgres
+POSTGRES_DB=postgres

fastapi_query_filters-0.0.1a0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

fastapi_query_filters-0.0.1a0/.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+default_language_version:
+  python: python3.11
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-toml
+      - id: check-yaml
+        args: [ --unsafe ]
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.15.12
+    hooks:
+      # Run the linter.
+      - id: ruff-check
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format

fastapi_query_filters-0.0.1a0/LICENSE

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

fastapi_query_filters-0.0.1a0/PKG-INFO

@@ -0,0 +1,297 @@
+Metadata-Version: 2.4
+Name: fastapi-query-filters
+Version: 0.0.1a0
+Summary: Dynamic and declarative query filters for FastAPI, powered by Pydantic v2 and ready for multiple ORMs.
+Author: Ezequiel Parziale
+License: MIT
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: fastapi>=0.110.0
+Requires-Dist: pydantic[email]>=2.0.0
+Requires-Dist: sqlalchemy>=2.0.0
+Provides-Extra: dev
+Requires-Dist: httpx; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: types-setuptools; extra == 'dev'
+Requires-Dist: uvicorn; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# :rocket: fastapi-query-filters
+
+Dynamic and declarative query filters for FastAPI, powered by Pydantic v2 and ready for multiple ORMs.
+
+## Features
+
+- 🔍 **Dynamic Filtering**: Generate powerful query filters from Pydantic models automatically
+- 🎯 **Declarative API**: Clean, intuitive syntax for defining filters
+- 🔌 **Multi-ORM Support**: Built-in support for SQLAlchemy with extensibility for other ORMs
+- 📦 **Pydantic v2**: Full integration with Pydantic v2 for robust data validation
+- ⚡ **FastAPI Native**: Seamlessly integrates with FastAPI dependencies
+- 🔤 **Search & Sort**: Support for text search and custom sorting operators
+- 🧪 **Type Safe**: Full type hints and mypy strict mode support
+
+## Installation
+
+```bash
+pip install git+https://github.com/ezeparziale/fastapi-query-filters.git
+```
+
+## Requirements
+
+- Python >= 3.11
+- FastAPI >= 0.110.0
+- Pydantic >= 2.0.0
+- SQLAlchemy >= 2.0.0
+
+## Quick Start
+
+### 1. Define Your Schema
+
+```python
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, EmailStr, Field
+
+class UserOut(BaseModel):
+    id: int = Field(json_schema_extra={"filters": ["eq"]})
+    email: EmailStr = Field(json_schema_extra={"filters": ["eq", "icontains"]})
+
+    model_config = ConfigDict(from_attributes=True)
+
+class PostOut(BaseModel):
+    id: int = Field(json_schema_extra={"filters": ["eq", "gte", "lte", "in"]})
+    title: str = Field(json_schema_extra={"filters": ["eq", "icontains"]})
+    created_at: datetime = Field(json_schema_extra={"filters": ["gte", "lte"]})
+    is_active: bool = Field(json_schema_extra={"filters": ["eq"]})
+    user_id: int = Field(json_schema_extra={"filters": ["eq"]})
+    author: UserOut
+
+    model_config = ConfigDict(from_attributes=True)
+
+    class FilterConfig:
+        search_field = "q"
+        sort_field = "sort_by"
+        enable_sort = True
+        enable_search = True
+        prefix = ""
+        search_columns = ["title", "description"]
+```
+
+### 2. Use in Your Endpoint
+
+```python
+from fastapi import Depends, FastAPI
+from fastapi_query_filters import FilterDep, FilterValues
+from fastapi_query_filters.orm.sqlalchemy import apply_filters
+
+app = FastAPI()
+
+@app.get("/posts")
+def list_posts(
+    db: Session = Depends(get_db),
+    filters: FilterValues = FilterDep(PostOut)
+):
+    stmt = select(Post)
+    stmt = apply_filters(stmt, Post, filters)
+    return db.execute(stmt).scalars().all()
+```
+
+### 3. Query Your API
+
+```bash
+# Filter by field with eq operator
+GET /posts?id__eq=1
+
+# Multiple values for in operator
+GET /posts?id__in=1&id__in=2&id__in=3
+
+# Use in operator with comma-separated values
+GET /posts?id__in=1,2,3
+
+# Filter by field with icontains operator
+GET /posts?title__icontains=python
+
+# Multiple filters
+GET /posts?published__eq=true&title__icontains=api
+
+# Search across fields
+GET /posts?q=fastapi
+
+# Sort results
+GET /posts?sort_by=-created_at,title
+
+# Combine filters and search
+GET /posts?id__in=1,2,3&is_active__eq=true&q=fastapi&sort_by=-created_at
+```
+
+## Supported Operators
+
+The library supports the following filter operators for different field types:
+
+| Operator | Description | Example | Types |
+|----------|-------------|---------|-------|
+| `eq` | Equal | `id__eq=1` | all |
+| `ne` | Not equal | `status__ne=inactive` | all |
+| `gt` | Greater than | `age__gt=18` | int, datetime |
+| `lt` | Less than | `age__lt=65` | int, datetime |
+| `gte` | Greater than or equal | `created_at__gte=2024-01-01` | int, datetime |
+| `lte` | Less than or equal | `price__lte=100` | int, datetime |
+| `in` | In list | `id__in=1,2,3` | all |
+| `not_in` | Not in list | `status__not_in=deleted,archived` | all |
+| `like` | SQL LIKE pattern | `name__like=%john%` | str |
+| `ilike` | SQL ILIKE (case-insensitive) | `email__ilike=%gmail%` | str |
+| `icontains` | Case-insensitive contains | `title__icontains=python` | str |
+
+## FilterConfig Configuration
+
+Customize filter behavior using the `FilterConfig` nested class in your schema:
+
+```python
+class PostOut(BaseModel):
+    # ... fields ...
+
+    class FilterConfig:
+        # Query parameter name for global search (default: "q")
+        search_field = "q"
+        
+        # Query parameter name for sorting (default: "sort_by")
+        sort_field = "sort_by"
+        
+        # Global prefix for all filter parameters (default: "")
+        prefix = ""
+        
+        # Enable/disable global search functionality (default: True)
+        enable_search = True
+        
+        # Enable/disable sorting functionality (default: True)
+        enable_sort = True
+        
+        # Columns to search when using global search query
+        search_columns = ["title", "description", "content"]
+        
+        # Optional: Pydantic model with virtual/extra filter fields
+        extra_filters = PostFilterExtra
+```
+
+### FilterConfig Parameters Explained
+
+- **search_field**: The query parameter name used for global search across multiple columns
+- **sort_field**: The query parameter name used to specify sorting order
+- **prefix**: A prefix prepended to all filter parameter names (e.g., `f_id__eq=1`)
+- **enable_search**: Toggle global search functionality on/off
+- **enable_sort**: Toggle dynamic sorting functionality on/off
+- **search_columns**: List of database columns to search when using the search_field parameter
+- **extra_filters**: A Pydantic model containing additional filter fields from the database that are not included in the main schema output
+
+## Advanced Features
+
+### Nested Relationship Filtering
+
+Filter by nested relationship fields using double underscore notation:
+
+```python
+# Filter posts by author's email
+GET /posts?author__email__icontains=example.com
+
+# Filter posts by author's age range
+GET /posts?author__age__gte=18&author__age__lte=65
+```
+
+### Dynamic Sorting
+
+Sort by multiple fields with ascending/descending order:
+
+```bash
+# Sort by created_at (descending), then by title (ascending)
+GET /posts?sort_by=-created_at,title
+
+# Sort by multiple fields
+GET /posts?sort_by=-updated_at,id,name
+```
+
+### Field Aliases
+
+Use `filter_alias` in `json_schema_extra` to map query parameters to different field names:
+
+```python
+class PostOut(BaseModel):
+    title: str = Field(
+        alias="post_title",
+        json_schema_extra={
+            "filters": ["eq", "icontains"],
+            "filter_alias": "post_title",
+        },
+    )
+
+# Query using the alias
+GET /posts?post_title__icontains=python
+```
+
+### Multiple Query Parameter Values
+
+Multiple values can be passed in different ways:
+
+```bash
+# Multiple eq operators
+GET /posts?id__eq=1&id__eq=2&id__eq=3
+
+# Comma-separated values with in operator
+GET /posts?id__in=1,2,3
+
+# Combined search and filters
+GET /posts?q=fastapi&is_active__eq=true&author__id__in=1,2,3
+```
+
+### Global Prefix
+
+Add a global prefix to all filter parameters for namespace isolation:
+
+```python
+class FilterConfig:
+    prefix = "f_"
+    
+# Query with prefix
+GET /posts?f_id__eq=1&f_title__icontains=api
+```
+
+### Extra Filters (Virtual Fields)
+
+Define additional filter fields that exist in the database but are not included in your main response schema:
+
+```python
+class PostFilterExtra(BaseModel):
+    # Database column available for filtering but not in PostOut response
+    author__age: int | None = Field(
+        default=None,
+        json_schema_extra={"filters": ["gte", "lte", "in"]}
+    )
+    # Another database field not exposed in the API response
+    status: str | None = Field(
+        default=None,
+        json_schema_extra={"filters": ["eq", "in"]}
+    )
+
+class PostOut(BaseModel):
+    # ... fields exposed in response ...
+    
+    class FilterConfig:
+        extra_filters = PostFilterExtra
+        
+# Query using extra filter fields
+GET /posts?author__age__gte=18
+GET /posts?status__eq=draft
+```
+
+## Documentation
+
+For detailed documentation and examples, see the [examples/](./examples/) directory.
+
+## License
+
+MIT License - see [LICENSE](./LICENSE) file for details.
+
+## Author
+
+Ezequiel Parziale