chore: Some refactorings, resolve issues and update to newer viur-core syntax

Author: sveneberth

src/viur/shop/modules/abstract.py

@@ -58,11 +58,7 @@ def session(self) -> dict:
         if session is None:
             logger.warning(f"Session is None!")
             return None
-        # TODO: custom session name
-        # TODO: Implement .setdefault() in viur.core.Session
-        if "shop" not in session:
-            session["shop"] = {}
-        session_shop = session["shop"]
+        session_shop = session.setdefault("shop", {})
         if self.moduleName not in session_shop:
             session_shop[self.moduleName] = {}
             session.markChanged()

src/viur/shop/modules/cart.py

@@ -138,9 +138,6 @@ def listRootNodes(self, *args, **kwargs) -> t.Any:
 
         :returns: The rendered representation of the available root-nodes.
         """
-        if utils.string.is_prefix(self.render.kind, "json"):
-            # TODO: add in viur-core
-            current.request.get().response.headers["Content-Type"] = "application/json"
         return self.render.listRootNodes([
             self.render.renderSkelValues(skel)
             for skel in self.getAvailableRootNodes(*args, **kwargs)

src/viur/shop/modules/order.py

@@ -241,12 +241,10 @@ def _order_set_values(
                 raise e.InvalidArgumentException("customer_key")
             skel.setBoneValue("customer", customer_key)
 
-        # TODO(discussion): Do we really want to set this by the frontend?
-        #  Or what are the pre conditions?
         if state_ordered != SENTINEL or state_paid != SENTINEL or state_rts != SENTINEL:
             # any of these values should be set
             if not self.canEdit(skel):
-                raise core_errors.Forbidden("You are not allowed to change a sate")
+                raise core_errors.Forbidden("You are not allowed to change a state")
             logger.debug("Can change states")
         if state_ordered is not SENTINEL:
             skel["state_ordered"] = state_ordered

src/viur/shop/shop.py

@@ -29,12 +29,6 @@
 
 
 class Shop(InstancedModule, Module):
-    @exposed
-    def hello(self):
-        # logger.debug(f"{SHOP_INSTANCE.get().render=}")
-        # logger.debug(f"{SHOP_INSTANCE_VI.get().render=}")
-        return f"Welcome to the {self.name} Shop!"
-
     def __init__(
         self,
         *,

src/viur/shop/skeletons/article.py

@@ -100,16 +100,15 @@ def shop_is_low_price(self) -> BooleanBone:
     def shop_price_(self) -> Price:
         return Price.get_or_create(self)
 
-    shop_price = RawBone(  # FIXME: JsonBone doesn't work (https://github.com/viur-framework/viur-core/issues/1092)
+    shop_price = JsonBone(
         compute=Compute(lambda skel: skel.shop_price_.to_dict(), ComputeInterval(ComputeMethod.Always))
     )
-    shop_price.type = JsonBone.type
-    shop_shipping = RawBone(  # FIXME: JsonBone doesn't work (https://github.com/viur-framework/viur-core/issues/1092)
+
+    shop_shipping = JsonBone(
         compute=Compute(
             lambda skel: make_json_dumpable(SHOP_INSTANCE.get().shipping.choose_shipping_skel_for_article(skel)),
             ComputeInterval(ComputeMethod.Always)),
     )
-    shop_shipping.type = JsonBone.type
     """Calculated, cheapest shipping for this article"""
 
     @classmethod

src/viur/shop/types/price.py

@@ -2,10 +2,9 @@
 import json
 import typing as t  # noqa
 
+from viur import toolkit
 from viur.core import current, db, utils
 from viur.core.skeleton import SkeletonInstance
-
-from viur import toolkit
 from .enums import ApplicationDomain, ConditionOperator, DiscountType
 from ..globals import SHOP_INSTANCE, SHOP_LOGGER
 from ..types import ConfigurationError
@@ -15,10 +14,13 @@
 
 logger = SHOP_LOGGER.getChild(__name__)
 
-
 # TODO: Use decimal package instead of floats?
 #       -> decimal mode in NumericBone?
 
+PRICE_PRECISION: t.Final[int] = 2
+"""Precision, how many digits are used to round prices"""
+
+
 class Price:
     cart_discounts: list[SkeletonInstance] = []
     article_discount: SkeletonInstance = None
@@ -60,30 +62,30 @@ def retail(self) -> float:
 
     @property
     def retail_net(self) -> float:
-        return toolkit.round_decimal(self.gross_to_net(self.retail, self.vat_rate_percentage), 2)
+        return toolkit.round_decimal(self.gross_to_net(self.retail, self.vat_rate_percentage), PRICE_PRECISION)
 
     @property
     def recommended(self) -> float:
         return self.article_skel["shop_price_recommended"]
 
     @property
     def recommended_net(self) -> float:
-        return toolkit.round_decimal(self.gross_to_net(self.recommended, self.vat_rate_percentage), 2)
+        return toolkit.round_decimal(self.gross_to_net(self.recommended, self.vat_rate_percentage), PRICE_PRECISION)
 
     @property
     def saved(self) -> float:
         if self.retail is None or self.current is None:
             return 0
-        return toolkit.round_decimal(self.retail - self.current, 2)
+        return toolkit.round_decimal(self.retail - self.current, PRICE_PRECISION)
 
     @property
     def saved_net(self) -> float:
-        return toolkit.round_decimal(self.gross_to_net(self.saved, self.vat_rate_percentage), 2)
+        return toolkit.round_decimal(self.gross_to_net(self.saved, self.vat_rate_percentage), PRICE_PRECISION)
 
     @property
     def saved_percentage(self) -> float:
         try:
-            return toolkit.round_decimal(self.saved / self.current, 2 or 4)  # TODO
+            return toolkit.round_decimal(self.saved / self.current, PRICE_PRECISION)
         except (ZeroDivisionError, TypeError):  # One value is None
             return 0.0
 
@@ -92,21 +94,21 @@ def saved_percentage(self) -> float:
     def current(self) -> float:
         if (not self.is_in_cart or not self.cart_discounts) and self.article_discount:
             # only the article_discount is applicable
-            return toolkit.round_decimal(self.apply_discount(self.article_discount, self.retail), 2)
+            return toolkit.round_decimal(self.apply_discount(self.article_discount, self.retail), PRICE_PRECISION)
         if self.is_in_cart and self.cart_discounts:
             # TODO: if self.article_discount:
             best_price, best_discounts = self.choose_best_discount_set()
-            return toolkit.round_decimal(best_price, 2)
+            return toolkit.round_decimal(best_price, PRICE_PRECISION)
         return self.retail
 
     @property
     def current_net(self) -> float:
-        return toolkit.round_decimal(self.gross_to_net(self.current, self.vat_rate_percentage), 2)
+        return toolkit.round_decimal(self.gross_to_net(self.current, self.vat_rate_percentage), PRICE_PRECISION)
 
     def shop_current_discount(self, article_skel: SkeletonInstance) -> None | tuple[float, "SkeletonInstance"]:
         """Best permanent discount campaign for article"""
         best_discount = None
-        article_price = self.retail or 0.0  # FIXME: how to handle None prices?
+        article_price = self.retail or 0.0  # FIXME(discuss): how to handle None prices?
         if not article_price:
             return None
         discount_module: "Discount" = SHOP_INSTANCE.get().discount
@@ -186,7 +188,7 @@ def vat_rate_percentage(self) -> float:
     def vat_included(self) -> float:
         """Calculate the included vat value based on current price and vat rate"""
         try:
-            return toolkit.round_decimal(self.gross_to_vat(self.current, self.vat_rate_percentage), 2)
+            return toolkit.round_decimal(self.gross_to_vat(self.current, self.vat_rate_percentage), PRICE_PRECISION)
         except TypeError:  # One value is None
             return 0.0