feat: add advanced filtering on GET /prices (#29)

* Add fastapi-filter package

* Replace existing filters with new library

app/api.py

@@ -1,6 +1,5 @@
 import asyncio
 import uuid
-from datetime import date
 from pathlib import Path
 from typing import Annotated
 
@@ -9,7 +8,6 @@
     Depends,
     FastAPI,
     HTTPException,
-    Query,
     Request,
     Response,
     UploadFile,
@@ -18,6 +16,7 @@
 from fastapi.responses import HTMLResponse, PlainTextResponse
 from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestForm
 from fastapi.templating import Jinja2Templates
+from fastapi_filter import FilterDepends
 from fastapi_pagination import Page, add_pagination
 from fastapi_pagination.ext.sqlalchemy import paginate
 from openfoodfacts.utils import get_logger
@@ -133,16 +132,7 @@ async def authentication(
 
 
 @app.get("/prices", response_model=Page[schemas.PriceBase])
-async def get_price(
-    product_code: str | None = None,
-    location_osm_id: int | None = None,
-    date: date | None = None,
-):
-    filters = {
-        "product_code": product_code,
-        "location_osm_id": location_osm_id,
-        "date": date,
-    }
+async def get_price(filters: schemas.PriceFilter = FilterDepends(schemas.PriceFilter)):
     return paginate(db, crud.get_prices_query(filters=filters))
 
 

app/crud.py

@@ -9,7 +9,7 @@
 
 from app import config
 from app.models import Price, Proof, User
-from app.schemas import PriceCreate, ProofBase, UserBase
+from app.schemas import PriceCreate, PriceFilter, UserBase
 
 
 def get_user(db: Session, user_id: str):
@@ -56,20 +56,15 @@ def delete_user(db: Session, user_id: UserBase):
     return False
 
 
-def get_prices_query(filters: dict | None = None):
+def get_prices_query(filters: PriceFilter | None = None):
     """Useful for pagination."""
     query = select(Price)
     if filters:
-        if filters.get("product_code", None):
-            query = query.filter(Price.product_code == filters["product_code"])
-        if filters.get("location_osm_id", None):
-            query = query.filter(Price.location_osm_id == filters["location_osm_id"])
-        if filters.get("date", None):
-            query = query.filter(Price.date == filters["date"])
+        query = filters.filter(query)
     return query
 
 
-def get_prices(db: Session, filters: dict | None = None):
+def get_prices(db: Session, filters: PriceFilter | None = None):
     return db.execute(get_prices_query(filters=filters)).all()
 
 

app/schemas.py

@@ -1,9 +1,12 @@
 from datetime import date, datetime
+from typing import Optional
 
+from fastapi_filter.contrib.sqlalchemy import Filter
 from pydantic import BaseModel, ConfigDict, Field, field_serializer, field_validator
 from sqlalchemy_utils import Currency
 
 from app.enums import PriceLocationOSMType
+from app.models import Price
 
 
 class UserBase(BaseModel):
@@ -54,3 +57,23 @@ class ProofBase(ProofCreate):
     id: int
     owner: str
     created: datetime
+
+
+class PriceFilter(Filter):
+    product_code: Optional[str] | None = None
+    location_osm_id: Optional[int] | None = None
+    location_osm_type: Optional[PriceLocationOSMType] | None = None
+    price: Optional[int] | None = None
+    currency: Optional[str] | None = None
+    price__gt: Optional[int] | None = None
+    price__gte: Optional[int] | None = None
+    price__lt: Optional[int] | None = None
+    price__lte: Optional[int] | None = None
+    date: Optional[str] | None = None
+    date__gt: Optional[str] | None = None
+    date__gte: Optional[str] | None = None
+    date__lt: Optional[str] | None = None
+    date__lte: Optional[str] | None = None
+
+    class Constants(Filter.Constants):
+        model = Price

pyproject.toml

@@ -22,6 +22,7 @@ sqlalchemy = "~2.0.23"
 sqlalchemy-utils = "~0.41.1"
 uvicorn = "~0.23.2"
 fastapi-pagination = "^0.12.12"
+fastapi-filter = "^1.0.0"
 
 
 [tool.poetry.group.dev.dependencies]
@@ -44,5 +45,8 @@ exclude = '''
 )/
 '''
 
+[tool.isort]
+profile = "black"
+
 [tool.mypy]
-ignore_missing_imports = true
+ignore_missing_imports = true