formatting and typing

pietro convalle · pietro convalle · commit 365aa2b0d566 · 2022-11-10T11:19:19.000Z
diff --git a/answerking_app/models/serializers.py b/answerking_app/models/serializers.py
@@ -145,7 +145,7 @@ def create(self, validated_data: dict) -> Order:
             )
             for order_item in order_items_data:
                 item_data: ItemType = order_item.pop("item")
-                item: Item = Item.objects.get(pk=item_data["id"])
+                item: Item = Item.objects.get(pk=item_data["id"])  # type: ignore[reportTypedDictNotRequiredAccess]
                 OrderLine.objects.create(order=order, item=item, **order_item)
         order.calculate_total()
         return order
diff --git a/answerking_app/tests/test_categories.py b/answerking_app/tests/test_categories.py
@@ -4,8 +4,11 @@
 
 from answerking_app.models.models import Category, Item
 from answerking_app.utils.ErrorType import ErrorMessage
-from answerking_app.utils.model_types import (CategoryType, DetailError,
-                                              ItemType)
+from answerking_app.utils.model_types import (
+    CategoryType,
+    DetailError,
+    ItemType,
+)
 
 client = Client()
 
diff --git a/answerking_app/tests/test_orderlines.py b/answerking_app/tests/test_orderlines.py
@@ -1,8 +1,11 @@
 from django.test import Client, TestCase
 
 from answerking_app.models.models import Item, Order, Status
-from answerking_app.utils.ErrorType import ErrorMessage
-from answerking_app.utils.model_types import DetailError, OrderType
+from answerking_app.utils.model_types import (
+    DetailError,
+    OrderItemType,
+    OrderType,
+)
 
 client = Client()
 
@@ -78,7 +81,7 @@ def test_add_new_orderline_valid_returns_ok(self):
             ],
             "total": "6.50",
         }
-        post_data: OrderType = {"quantity": 1}
+        post_data: OrderItemType = {"quantity": 1}
 
         # Act
         response = client.put(
@@ -109,7 +112,7 @@ def test_update_existing_orderline_valid_returns_ok(self):
             ],
             "total": "2.50",
         }
-        post_data: OrderType = {"quantity": 1}
+        post_data: OrderItemType = {"quantity": 1}
 
         # Act
         response = client.put(
@@ -132,7 +135,7 @@ def test_update_existing_orderline_zero_quantity_returns_ok(self):
             "order_items": [],
             "total": "0.00",
         }
-        post_data: OrderType = {"quantity": 0}
+        post_data: OrderItemType = {"quantity": 0}
 
         # Act
         response = client.put(
diff --git a/answerking_app/tests/test_orders.py b/answerking_app/tests/test_orders.py
@@ -4,8 +4,11 @@
 
 from answerking_app.models.models import Item, Order, OrderLine, Status
 from answerking_app.utils.ErrorType import ErrorMessage
-from answerking_app.utils.model_types import (DetailError, OrderItemType,
-                                              OrderType)
+from answerking_app.utils.model_types import (
+    DetailError,
+    OrderItemType,
+    OrderType,
+)
 
 client = Client()
 
@@ -202,7 +205,7 @@ def test_post_valid_with_empty_items_returns_ok(self):
         # Arrange
         old_list = client.get("/api/orders").json()
 
-        post_data: NewOrderType = {
+        post_data: OrderType = {
             "address": "test street 123",
             "order_items": [],
         }
diff --git a/answerking_app/utils/mixins/NotFoundDetailMixins.py b/answerking_app/utils/mixins/NotFoundDetailMixins.py
@@ -1,5 +1,6 @@
 from django.core.exceptions import ObjectDoesNotExist
 from django.http import Http404
+from rest_framework import status
 from rest_framework.mixins import RetrieveModelMixin, UpdateModelMixin
 from rest_framework.request import Request
 from rest_framework.response import Response
@@ -10,17 +11,19 @@
 def NotFoundErrorDetailed(exc: Http404 | ObjectDoesNotExist):
     if isinstance(exc, ObjectDoesNotExist):
         return HttpErrorResponse(
-            status=404,
+            status=status.HTTP_404_NOT_FOUND,
             detail="Object was not Found",
             title="Resource not found",
             extensions={"errors": exc.args},
         )
-    if isinstance(exc, Http404):
+    elif isinstance(exc, Http404):
         return HttpErrorResponse(
-            status=404,
+            status=status.HTTP_404_NOT_FOUND,
             detail="Not Found",
             title="Resource not found",
         )
+    else:
+        return HttpErrorResponse(status=status.HTTP_500_INTERNAL_SERVER_ERROR)
 
 
 class GetNotFoundDetailMixin(RetrieveModelMixin):
diff --git a/answerking_app/utils/mixins/OrderItemMixins.py b/answerking_app/utils/mixins/OrderItemMixins.py
@@ -6,8 +6,10 @@
 from rest_framework.utils.serializer_helpers import ReturnDict
 
 from answerking_app.models.models import Item, Order
-from answerking_app.models.serializers import (OrderLineSerializer,
-                                               OrderSerializer)
+from answerking_app.models.serializers import (
+    OrderLineSerializer,
+    OrderSerializer,
+)
 from answerking_app.utils.mixins.ApiExceptions import HttpErrorResponse
 
 
diff --git a/answerking_app/utils/mixins/SerializeErrorDetailRFCMixins.py b/answerking_app/utils/mixins/SerializeErrorDetailRFCMixins.py
@@ -1,3 +1,4 @@
+from rest_framework import status
 from rest_framework.exceptions import ParseError
 from rest_framework.mixins import CreateModelMixin, UpdateModelMixin
 from rest_framework.request import Request
@@ -10,18 +11,20 @@
 def ValidationErrorDetailed(exc: ValidationError | ParseError):
     if isinstance(exc, ValidationError):
         return HttpErrorResponse(
-            status=400,
+            status=status.HTTP_404_NOT_FOUND,
             detail="Validation Error",
             title="Invalid input.",
             extensions={"errors": exc.detail},
         )
     elif isinstance(exc, ParseError):
         return HttpErrorResponse(
-            status=400,
+            status=status.HTTP_404_NOT_FOUND,
             detail="Parsing JSON Error",
             title="Invalid input json.",
             extensions={"errors": exc.detail},
         )
+    else:
+        return HttpErrorResponse(status=status.HTTP_500_INTERNAL_SERVER_ERROR)
 
 
 class CreateErrorDetailMixin(CreateModelMixin):
diff --git a/answerking_app/utils/model_types.py b/answerking_app/utils/model_types.py
@@ -1,7 +1,9 @@
 from typing import Any
 
 from typing_extensions import (  # for Python <3.11 with (Not)Required
-    NotRequired, TypedDict)
+    NotRequired,
+    TypedDict,
+)
 
 
 class ItemType(TypedDict):
@@ -16,20 +18,21 @@ class ItemType(TypedDict):
 class CategoryType(TypedDict):
     id: NotRequired[int]
     name: NotRequired[str]
-    items: "NotRequired[list[ItemType]]"
+    items: NotRequired["list[ItemType]"]
 
 
 class OrderItemType(TypedDict):
-    id: int
+    id: NotRequired[int]
     name: NotRequired[str]
     price: NotRequired[str]
     quantity: int
     sub_total: NotRequired[str]
 
 
 class OrderType(TypedDict):
+    id: NotRequired[int]
     address: NotRequired[str]
-    order_items: "NotRequired[list[OrderItemType]]"
+    order_items: NotRequired["list[OrderItemType]"]
     status: NotRequired[str]
     total: NotRequired[str]
 
@@ -39,6 +42,6 @@ class DetailError(TypedDict):
     type: str
     title: str
     instance: NotRequired[str]
-    errors: "NotRequired[str | list[Any] | dict[Any, Any]]"
+    errors: NotRequired["str | list[Any] | dict[Any, Any]"]
     status: NotRequired[int]
     traceID: NotRequired[str]
diff --git a/answerking_app/views/category_views.py b/answerking_app/views/category_views.py
@@ -7,13 +7,21 @@
 from answerking_app.models.models import Category
 from answerking_app.models.serializers import CategorySerializer
 from answerking_app.utils.mixins.CategoryItemMixins import (
-    CategoryItemRemoveMixin, CategoryItemUpdateMixin)
+    CategoryItemRemoveMixin,
+    CategoryItemUpdateMixin,
+)
 from answerking_app.utils.mixins.IntegrityHandlerMixins import (
-    CreateIntegrityHandlerMixin, UpdateIntegrityHandlerMixin)
+    CreateIntegrityHandlerMixin,
+    UpdateIntegrityHandlerMixin,
+)
 from answerking_app.utils.mixins.NotFoundDetailMixins import (
-    GetNotFoundDetailMixin, UpdateNotFoundDetailMixin)
+    GetNotFoundDetailMixin,
+    UpdateNotFoundDetailMixin,
+)
 from answerking_app.utils.mixins.SerializeErrorDetailRFCMixins import (
-    CreateErrorDetailMixin, UpdateErrorDetailMixin)
+    CreateErrorDetailMixin,
+    UpdateErrorDetailMixin,
+)
 
 
 class CategoryListView(
diff --git a/answerking_app/views/item_views.py b/answerking_app/views/item_views.py
@@ -6,12 +6,18 @@
 from answerking_app.models.models import Item
 from answerking_app.models.serializers import ItemSerializer
 from answerking_app.utils.mixins.IntegrityHandlerMixins import (
-    CreateIntegrityHandlerMixin, UpdateIntegrityHandlerMixin)
+    CreateIntegrityHandlerMixin,
+    UpdateIntegrityHandlerMixin,
+)
 from answerking_app.utils.mixins.ItemMixins import DestroyItemMixin
 from answerking_app.utils.mixins.NotFoundDetailMixins import (
-    GetNotFoundDetailMixin, UpdateNotFoundDetailMixin)
+    GetNotFoundDetailMixin,
+    UpdateNotFoundDetailMixin,
+)
 from answerking_app.utils.mixins.SerializeErrorDetailRFCMixins import (
-    CreateErrorDetailMixin, UpdateErrorDetailMixin)
+    CreateErrorDetailMixin,
+    UpdateErrorDetailMixin,
+)
 
 
 class ItemListView(
diff --git a/answerking_app/views/order_views.py b/answerking_app/views/order_views.py
@@ -10,11 +10,17 @@
 from answerking_app.models.serializers import OrderSerializer
 from answerking_app.utils.ErrorType import ErrorMessage
 from answerking_app.utils.mixins.NotFoundDetailMixins import (
-    GetNotFoundDetailMixin, UpdateNotFoundDetailMixin)
-from answerking_app.utils.mixins.OrderItemMixins import (OrderItemRemoveMixin,
-                                                         OrderItemUpdateMixin)
+    GetNotFoundDetailMixin,
+    UpdateNotFoundDetailMixin,
+)
+from answerking_app.utils.mixins.OrderItemMixins import (
+    OrderItemRemoveMixin,
+    OrderItemUpdateMixin,
+)
 from answerking_app.utils.mixins.SerializeErrorDetailRFCMixins import (
-    CreateErrorDetailMixin, UpdateErrorDetailMixin)
+    CreateErrorDetailMixin,
+    UpdateErrorDetailMixin,
+)
 
 
 class OrderListView(

Original file line number	Diff line number	Diff line change
`@@ -145,7 +145,7 @@ def create(self, validated_data: dict) -> Order:`
`145`	`145`	`)`
`146`	`146`	`for order_item in order_items_data:`
`147`	`147`	`item_data: ItemType = order_item.pop("item")`
`148`		`- item: Item = Item.objects.get(pk=item_data["id"])`
	`148`	`+ item: Item = Item.objects.get(pk=item_data["id"]) # type: ignore[reportTypedDictNotRequiredAccess]`
`149`	`149`	`OrderLine.objects.create(order=order, item=item, **order_item)`
`150`	`150`	`order.calculate_total()`
`151`	`151`	`return order`