Improve typing

Author: TomBursch

backend/app/controller/household/household_controller.py

@@ -111,7 +111,7 @@ def updateHousehold(args, household_id):
 @household.route("/<int:household_id>", methods=["DELETE"])
 @jwt_required()
 @authorize_household(required=RequiredRights.ADMIN)
-def deleteHouseholdById(household_id):
+def deleteHouseholdById(household_id: int):
     hms = HouseholdMember.find_by_household(household_id)
     for hm in hms:
         db.session.delete(hm)
@@ -124,7 +124,7 @@ def deleteHouseholdById(household_id):
 @jwt_required()
 @authorize_household(required=RequiredRights.ADMIN)
 @validate_args(UpdateHouseholdMember)
-def putHouseholdMember(args, household_id, user_id):
+def putHouseholdMember(args, household_id: int, user_id: int):
     hm = HouseholdMember.find_by_ids(household_id, user_id)
     if not hm:
         household = Household.find_by_id(household_id)
@@ -145,7 +145,7 @@ def putHouseholdMember(args, household_id, user_id):
 @household.route("/<int:household_id>/member/<int:user_id>", methods=["DELETE"])
 @jwt_required()
 @authorize_household(required=RequiredRights.ADMIN_OR_SELF)
-def deleteHouseholdMember(household_id, user_id):
+def deleteHouseholdMember(household_id: int, user_id: int):
     hm = HouseholdMember.find_by_ids(household_id, user_id)
     if hm:
         hm.delete()

backend/app/models/association.py

@@ -41,7 +41,14 @@ class Association(Model):
     )
 
     @classmethod
-    def create(cls, antecedent_id, consequent_id, support, confidence, lift):
+    def create(
+        cls,
+        antecedent_id: int,
+        consequent_id: int,
+        support: float,
+        confidence: float,
+        lift: float,
+    ) -> Self:
         return cls(
             antecedent_id=antecedent_id,
             consequent_id=consequent_id,
@@ -51,7 +58,7 @@ def create(cls, antecedent_id, consequent_id, support, confidence, lift):
         ).save()
 
     @classmethod
-    def find_by_antecedent(cls, antecedent_id):
+    def find_by_antecedent(cls, antecedent_id: int):
         return cls.query.filter(cls.antecedent_id == antecedent_id).order_by(
             cls.lift.desc()
         )

backend/app/models/category.py

@@ -1,5 +1,5 @@
 from __future__ import annotations
-from typing import Self, List, TYPE_CHECKING, cast
+from typing import Any, Self, List, TYPE_CHECKING, cast
 from app import db
 from app.helpers import DbModelAuthorizeMixin
 from sqlalchemy.orm import Mapped
@@ -39,8 +39,8 @@ class Category(Model, DbModelAuthorizeMixin):
         ),
     )
 
-    def obj_to_full_dict(self) -> dict:
-        res = super().obj_to_dict()
+    def obj_to_full_dict(self) -> dict[str, Any]:
+        res = self.obj_to_dict()
         return res
 
     @classmethod
@@ -55,7 +55,7 @@ def all_by_ordering(cls, household_id: int):
     def create_by_name(
         cls,
         household_id: int,
-        name,
+        name: str,
         default: bool = False,
         default_key: str | None = None,
     ) -> Self:

backend/app/models/expense.py

@@ -1,5 +1,5 @@
-from datetime import datetime
-from typing import Optional, Self, List, TYPE_CHECKING, cast
+from datetime import datetime, timezone
+from typing import Any, Optional, Self, List, TYPE_CHECKING, cast
 from app import db
 from app.helpers import DbModelAuthorizeMixin
 from sqlalchemy.orm import Mapped
@@ -20,7 +20,7 @@ class Expense(Model, DbModelAuthorizeMixin):
     amount: Mapped[float] = db.Column(db.Float())
     description: Mapped[str] = db.Column(db.String)
     date: Mapped[datetime] = db.Column(
-        db.DateTime, default=datetime.utcnow, nullable=False
+        db.DateTime, default=lambda: datetime.now(timezone.utc), nullable=False
     )
     category_id: Mapped[int | None] = db.Column(
         db.Integer, db.ForeignKey("expense_category.id")
@@ -72,13 +72,13 @@ def obj_to_dict(
         self,
         skip_columns: list[str] | None = None,
         include_columns: list[str] | None = None,
-    ) -> dict:
+    ) -> dict[str, Any]:
         res = super().obj_to_dict(skip_columns, include_columns)
         if self.photo_file:
             res["photo_hash"] = self.photo_file.blur_hash
         return res
 
-    def obj_to_full_dict(self) -> dict:
+    def obj_to_full_dict(self) -> dict[str, Any]:
         res = self.obj_to_dict()
         paidFor = (
             ExpensePaidFor.query.filter(ExpensePaidFor.expense_id == self.id)
@@ -91,8 +91,8 @@ def obj_to_full_dict(self) -> dict:
             res["category"] = self.category.obj_to_full_dict()
         return res
 
-    def obj_to_export_dict(self) -> dict:
-        res = {
+    def obj_to_export_dict(self) -> dict[str, Any]:
+        res: dict[str, Any] = {
             "name": self.name,
             "amount": self.amount,
             "date": self.date,
@@ -107,11 +107,11 @@ def obj_to_export_dict(self) -> dict:
         return res
 
     @classmethod
-    def find_by_name(cls, name) -> Self | None:
+    def find_by_name(cls, name: str) -> Self | None:
         return cls.query.filter(cls.name == name).first()
 
     @classmethod
-    def find_by_id(cls, id) -> Self | None:
+    def find_by_id(cls, id: int) -> Self | None:
         return (
             cls.query.filter(cls.id == id).join(Expense.category, isouter=True).first()
         )
@@ -143,15 +143,15 @@ class ExpensePaidFor(Model):
         ),
     )
 
-    def obj_to_user_dict(self):
+    def obj_to_user_dict(self) -> dict[str, Any]:
         res = self.user.obj_to_dict()
         res["factor"] = getattr(self, "factor")
         res["created_at"] = getattr(self, "created_at")
         res["updated_at"] = getattr(self, "updated_at")
         return res
 
     @classmethod
-    def find_by_ids(cls, expense_id, user_id) -> Self | None:
+    def find_by_ids(cls, expense_id: int, user_id: int) -> Self | None:
         return cls.query.filter(
             cls.expense_id == expense_id, cls.user_id == user_id
         ).first()

backend/app/models/expense_category.py

@@ -1,5 +1,5 @@
 from __future__ import annotations
-from typing import Self, List, TYPE_CHECKING, cast
+from typing import Any, Self, List, TYPE_CHECKING, cast
 from app import db
 from app.helpers import DbModelAuthorizeMixin
 from sqlalchemy.orm import Mapped
@@ -38,11 +38,11 @@ class ExpenseCategory(Model, DbModelAuthorizeMixin):
         ),
     )
 
-    def obj_to_full_dict(self) -> dict:
+    def obj_to_full_dict(self) -> dict[str, Any]:
         res = super().obj_to_dict()
         return res
 
-    def obj_to_export_dict(self) -> dict:
+    def obj_to_export_dict(self) -> dict[str, Any]:
         return {
             "name": self.name,
             "color": self.color,

backend/app/models/file.py

@@ -82,7 +82,9 @@ def isUnused(self) -> bool:
             and not self.profile_picture
         )
 
-    def checkAuthorized(self, requires_admin=False, household_id: int | None = None):
+    def checkAuthorized(
+        self, requires_admin: bool = False, household_id: int | None = None
+    ):
         if self.created_by and current_user and self.created_by == current_user.id:
             pass  # created by user can access his pictures
         elif self.profile_picture:

backend/app/models/history.py

@@ -1,4 +1,4 @@
-from typing import Self, TYPE_CHECKING, cast
+from typing import Any, Self, TYPE_CHECKING, cast
 from app import db
 from .shoppinglist import ShoppinglistItems
 from sqlalchemy import func
@@ -50,7 +50,9 @@ class History(Model):
     description: Mapped[str] = db.Column("description", db.String())
 
     @classmethod
-    def create_added_without_save(cls, shoppinglist, item, description="") -> Self:
+    def create_added_without_save(
+        cls, shoppinglist, item, description: str = ""
+    ) -> Self:
         return cls(
             shoppinglist_id=shoppinglist.id,
             item_id=item.id,
@@ -59,12 +61,12 @@ def create_added_without_save(cls, shoppinglist, item, description="") -> Self:
         )
 
     @classmethod
-    def create_added(cls, shoppinglist, item, description="") -> Self:
+    def create_added(cls, shoppinglist, item, description: str = "") -> Self:
         return cls.create_added_without_save(shoppinglist, item, description).save()
 
     @classmethod
     def create_dropped(
-        cls, shoppinglist, item, description="", created_at=None
+        cls, shoppinglist, item, description: str = "", created_at=None
     ) -> Self:
         return cls(
             shoppinglist_id=shoppinglist.id,
@@ -74,7 +76,7 @@ def create_dropped(
             created_at=created_at,
         ).save()
 
-    def obj_to_item_dict(self) -> dict:
+    def obj_to_item_dict(self) -> dict[str, Any]:
         res = self.item.obj_to_dict()
         res["timestamp"] = getattr(self, "created_at")
         return res

backend/app/models/household.py

@@ -1,4 +1,4 @@
-from typing import Self, List, TYPE_CHECKING, cast
+from typing import Any, Self, List, TYPE_CHECKING, cast
 from app import db
 from app.helpers.db_list_type import DbListType
 from sqlalchemy.orm import Mapped
@@ -35,7 +35,7 @@ class Household(Model):
         db.Boolean(), nullable=False, default=True
     )
 
-    view_ordering: Mapped[List] = db.Column(DbListType(), default=list())
+    view_ordering: Mapped[List[str]] = db.Column(DbListType(), default=list())
 
     items: Mapped[List["Item"]] = cast(
         Mapped[List["Item"]],
@@ -114,21 +114,21 @@ def obj_to_dict(
         self,
         skip_columns: list[str] | None = None,
         include_columns: list[str] | None = None,
-    ) -> dict:
+    ) -> dict[str, Any]:
         res = super().obj_to_dict(skip_columns, include_columns)
         res["member"] = [m.obj_to_user_dict() for m in getattr(self, "member")]
         res["default_shopping_list"] = self.shoppinglists[0].obj_to_dict()
         if self.photo_file:
             res["photo_hash"] = self.photo_file.blur_hash
         return res
 
-    def obj_to_public_dict(self) -> dict:
+    def obj_to_public_dict(self) -> dict[str, Any]:
         res = super().obj_to_dict(include_columns=["id", "name", "photo", "language"])
         if self.photo_file:
             res["photo_hash"] = self.photo_file.blur_hash
         return res
 
-    def obj_to_export_dict(self) -> dict:
+    def obj_to_export_dict(self) -> dict[str, Any]:
         return {
             "name": self.name,
             "language": self.language,
@@ -173,7 +173,7 @@ class HouseholdMember(Model):
         ),
     )
 
-    def obj_to_user_dict(self) -> dict:
+    def obj_to_user_dict(self) -> dict[str, Any]:
         res = self.user.obj_to_dict()
         res["owner"] = getattr(self, "owner")
         res["admin"] = getattr(self, "admin")

backend/app/models/item.py

@@ -1,5 +1,5 @@
 from __future__ import annotations
-from typing import Optional, Self, List, TYPE_CHECKING, cast
+from typing import Any, Optional, Self, List, TYPE_CHECKING, cast
 
 from sqlalchemy import func
 from app import db
@@ -87,14 +87,14 @@ def obj_to_dict(
         self,
         skip_columns: list[str] | None = None,
         include_columns: list[str] | None = None,
-    ) -> dict:
+    ) -> dict[str, Any]:
         res = super().obj_to_dict(skip_columns, include_columns)
         if self.category_id:
             category = cast(Category, Category.find_by_id(self.category_id))
             res["category"] = category.obj_to_dict()
         return res
 
-    def obj_to_export_dict(self) -> dict:
+    def obj_to_export_dict(self) -> dict[str, Any]:
         res = {
             "name": self.name,
         }
@@ -104,7 +104,7 @@ def obj_to_export_dict(self) -> dict:
             res["category"] = self.category.name
         return res
 
-    def save(self, keepDefault=False) -> Self:
+    def save(self, keepDefault: bool = False) -> Self:
         if not keepDefault:
             self.default = False
         return super().save()
@@ -219,7 +219,7 @@ def search_name(cls, name: str, household_id: int) -> list[Self]:
                 .all()
             )
 
-        found = []
+        found: list[Self] = []
 
         # name is a regex
         if "*" in name or "?" in name or "%" in name or "_" in name:
@@ -237,7 +237,7 @@ def search_name(cls, name: str, household_id: int) -> list[Self]:
         # name is no regex
         starts_with = "{0}%".format(name)
         contains = "%{0}%".format(name)
-        one_error = []
+        one_error: List[str] = []
         for index in range(len(name)):
             name_one_error = name[:index] + "_" + name[index + 1 :]
             one_error.append("%{0}%".format(name_one_error))

backend/app/models/planner.py

@@ -1,5 +1,5 @@
 from __future__ import annotations
-from typing import Self, TYPE_CHECKING, cast
+from typing import Any, Self, TYPE_CHECKING, cast
 from app import db
 from app.helpers import DbModelAuthorizeMixin
 from sqlalchemy.orm import Mapped
@@ -41,7 +41,7 @@ class Planner(Model, DbModelAuthorizeMixin):
         ),
     )
 
-    def obj_to_full_dict(self) -> dict:
+    def obj_to_full_dict(self) -> dict[str, Any]:
         res = self.obj_to_dict()
         res["recipe"] = self.recipe.obj_to_full_dict()
         return res