feat: new Product.ecoscore_grade field (#247)

alembic/versions/20240309_1254_7055fe5b4775_add_product_ecoscore_grade_field.py

@@ -0,0 +1,30 @@
+"""Add Product ecoscore_grade field
+
+Revision ID: 7055fe5b4775
+Revises: d98171064c5a
+Create Date: 2024-03-09 12:54:14.104481
+
+"""
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "7055fe5b4775"
+down_revision: Union[str, None] = "d98171064c5a"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column("products", sa.Column("ecoscore_grade", sa.String(), nullable=True))
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("products", "ecoscore_grade")
+    # ### end Alembic commands ###

app/models.py

@@ -68,6 +68,7 @@ class Product(Base):
     image_url: Mapped[str | None]
 
     nutriscore_grade: Mapped[str | None]
+    ecoscore_grade: Mapped[str | None]
     unique_scans_n = mapped_column(Integer, nullable=False, server_default="0")
 
     prices: Mapped[list["Price"]] = relationship(back_populates="product")

app/schemas.py

@@ -95,7 +95,10 @@ class ProductFull(ProductCreate):
         ],
     )
     nutriscore_grade: str | None = Field(
-        description="Nutriscore grade.", examples=["a", "unknown"]
+        description="Nutriscore grade.", examples=["a", "unknown", "not-applicable"]
+    )
+    ecoscore_grade: str | None = Field(
+        description="Ecoscore grade.", examples=["a", "unknown", "not-applicable"]
     )
     unique_scans_n: int = Field(
         description="number of unique scans of the product on Open Food Facts.",
@@ -456,6 +459,7 @@ class ProductFilter(Filter):
     labels_tags__contains: Optional[str] | None = None
     brands__like: Optional[str] | None = None
     nutriscore_grade: Optional[str] | None = None
+    ecoscore_grade: Optional[str] | None = None
     unique_scans_n__gte: Optional[int] | None = None
     price_count: Optional[int] | None = None
     price_count__gte: Optional[int] | None = None

app/utils.py

@@ -50,6 +50,7 @@ def init_sentry(
     "labels_tags",
     "image_url",
     "nutriscore_grade",
+    "ecoscore_grade",
     "unique_scans_n",
 ]
 

tests/integration/test_api.py

@@ -55,6 +55,7 @@ def override_get_db():
     brands_tags=["clement-faugier"],
     labels_tags=[],
     nutriscore_grade="d",
+    ecoscore_grade="b",
     unique_scans_n=20,
 )
 PRODUCT_2 = ProductCreate(
@@ -68,6 +69,7 @@ def override_get_db():
     brands_tags=["clement-faugier"],
     labels_tags=[],
     nutriscore_grade="d",
+    ecoscore_grade="c",
     unique_scans_n=10,
 )
 PRODUCT_3 = ProductCreate(
@@ -81,6 +83,7 @@ def override_get_db():
     brands_tags=["paysans-d-ici", "ethiquable"],
     labels_tags=["en:fair-trade", "en:organic", "en:made-in-france"],
     nutriscore_grade="c",
+    ecoscore_grade="b",
     unique_scans_n=0,
 )
 LOCATION = LocationFull(