merged from 'staging'

Author: calumbell

api_v2/serializers/abstracts.py

@@ -84,65 +84,22 @@ def get_dynamic_params(self):
             return self.parent._context.get("dynamic_params", {})
         return self._context.get("dynamic_params", {})
 
-    def handle_depth_serialization(self, instance, representation):
-        """
-        Handles the serialization of fields based on the current depth 
-        compared to the maximum allowed depth. This function modifies 
-        the representation to include only URLs for nested serializers 
-        when the maximum depth is reached.
-        """
-        max_depth = self._context.get("max_depth", 0)
-        current_depth = self._context.get("current_depth", 0)
-
-        # if we reach the maximum depth, nested serializers return their pk (url)
-        if current_depth >= max_depth:
-            for field_name, field in self.fields.items():
-                if isinstance(field, serializers.HyperlinkedModelSerializer):
-                    nested_representation = representation.get(field_name)
-                    if nested_representation and "url" in nested_representation:
-                        representation[field_name] = nested_representation["url"]
-            return representation
-        
-        # otherwise, pass depth to children serializers
-        for field_name, field in self.fields.items():
-            # Guard clause: make sure the child is a GameContentSerializer
-            if not isinstance(field, GameContentSerializer):
-                continue
-
-            nested_instance = getattr(instance, field_name)
-            nested_serializer = field.__class__(nested_instance, context={
-                **self._context,
-                "current_depth": current_depth + 1,
-                "max_depth": max_depth,
-            })
-
-            # Ensure dynamic params are specific to the child serializer
-            child_dynamic_params = self.get_or_create_dynamic_params(field_name)
-            nested_serializer._context['dynamic_params'] = child_dynamic_params
-            representation[field_name] = nested_serializer.data
-        return representation
-        
-
     def __init__(self, *args, **kwargs):
         request = kwargs.get("context", {}).get("request")
         super().__init__(*args, **kwargs)
 
+        # Request is only present on root serializer
         if request:
-            self._context["max_depth"] = int(request.query_params.get("depth", 0))
             dynamic_params = self.get_dynamic_params_for_root(request)
             self._context.update({"dynamic_params": dynamic_params})
 
     def to_representation(self, instance):
+        # if dynamic params are present, rmv requested fields and pass params 
+        # to child serializers
         if dynamic_params := self.get_dynamic_params().copy():
             self.remove_unwanted_fields(dynamic_params)
             self.set_dynamic_params_for_children(dynamic_params)
-
-        representation = super().to_representation(instance)
-
-        representation = self.handle_depth_serialization(instance, representation)
-
-        return representation
-
+        return super().to_representation(instance)
 
     class Meta:
         abstract = True

api_v2/serializers/background.py

@@ -7,7 +7,7 @@
 from .abstracts import GameContentSerializer
 from .document import DocumentSummarySerializer
 
-class BackgroundBenefitSerializer(serializers.ModelSerializer):
+class BackgroundBenefitSerializer(GameContentSerializer):
     class Meta:
         model = models.BackgroundBenefit
         fields = ['name','desc','type']

api_v2/serializers/characterclass.py

@@ -69,7 +69,7 @@ class Meta:
             'feature_items'
         ]
 
-class CharacterClassSummarySerializer(serializers.ModelSerializer):
+class CharacterClassSummarySerializer(GameContentSerializer):
     '''
     A slimmer CharacterClassSerializer, designed to serialize Class FKs on
     other serializers. ie. The `subclass_of` field on the 

api_v2/serializers/creature.py

@@ -16,9 +16,10 @@
 from drf_spectacular.utils import extend_schema_field, inline_serializer
 from drf_spectacular.types import OpenApiTypes
 
-class CreatureActionAttackSerializer(serializers.ModelSerializer):
-
+class CreatureActionAttackSerializer(GameContentSerializer):
     distance_unit = serializers.SerializerMethodField()
+    damage_type = DamageTypeSummarySerializer()
+    extra_damage_type = DamageTypeSummarySerializer()
 
     class Meta:
         model = models.CreatureActionAttack
@@ -46,7 +47,7 @@ class Meta:
     def get_distance_unit(self, CreatureActionAttack):
         return CreatureActionAttack.get_distance_unit
 
-class CreatureActionSerializer(serializers.ModelSerializer):
+class CreatureActionSerializer(GameContentSerializer):
     attacks = CreatureActionAttackSerializer(many=True, read_only=True)
     usage_limits = serializers.SerializerMethodField()
 
@@ -85,7 +86,7 @@ class Meta:
         model = models.CreatureType
         fields = '__all__'
 
-class CreatureTypeSummarySerializer(serializers.ModelSerializer):
+class CreatureTypeSummarySerializer(GameContentSerializer):
     '''
     A slimmer CreatureTypeSerializer, designed to serialize CreatureType FKs on
     other serializers . Not intended to be used directly with in a ModelViewset.

api_v2/serializers/damagetype.py

@@ -13,7 +13,7 @@ class Meta:
         model = models.DamageType
         fields = '__all__'
 
-class DamageTypeSummarySerializer(serializers.ModelSerializer):
+class DamageTypeSummarySerializer(GameContentSerializer):
     '''
     A slimmer DamageTypeSerializer, designed to serialize DamageType FKs on
     other serializers. Not intended to be used directly with in a ModelViewset.

api_v2/serializers/document.py

@@ -44,7 +44,7 @@ class Meta:
         model = models.Publisher
         fields = '__all__'
 
-class PublisherSummarySerializer(serializers.ModelSerializer):
+class PublisherSummarySerializer(GameContentSerializer):
     '''
     A slimmer PublisherSerializer, designed to serialize Publisher FKs on other
     serializers. Not intended to be used directly with in a ModelViewset.

api_v2/serializers/item.py

@@ -16,12 +16,13 @@ class ArmorSerializer(GameContentSerializer):
     key = serializers.ReadOnlyField()
     ac_display = serializers.ReadOnlyField()
     category = serializers.ReadOnlyField()
+    document = DocumentSummarySerializer()
 
     class Meta:
         model = models.Armor
         fields = '__all__'
 
-class ArmorSummarySerializer(serializers.ModelSerializer):
+class ArmorSummarySerializer(GameContentSerializer):
     '''
     A slightly slimmer ArmorSerializer, designed to serialize Armor FKs on
     other serializers. ie. The `armor` field on the ItemSerializer. Not 
@@ -44,6 +45,7 @@ class Meta:
 
 class WeaponSerializer(GameContentSerializer):
     key = serializers.ReadOnlyField()
+    document = DocumentSummarySerializer()
     damage_type = DamageTypeSummarySerializer()
     is_versatile = serializers.ReadOnlyField()
     is_martial = serializers.ReadOnlyField()
@@ -63,26 +65,84 @@ class Meta:
     def get_distance_unit(self, Weapon):
         return Weapon.get_distance_unit
 
+class WeaponSummarySerializer(GameContentSerializer):
+    '''
+    A (slightly) more slender version of the WeaponSerializer. Designed for 
+    serializing FKs to the Weapons table in other serializers – ie. the 
+    `"weapon"` field on the ItemSerializer
+    '''
+    damage_type = DamageTypeSummarySerializer()
+    is_versatile = serializers.ReadOnlyField()
+    is_martial = serializers.ReadOnlyField()
+    is_melee = serializers.ReadOnlyField()
+    is_finesse = serializers.ReadOnlyField()
+    ranged_attack_possible = serializers.ReadOnlyField()
+    range_melee = serializers.ReadOnlyField()
+    is_reach = serializers.ReadOnlyField()
+    properties = serializers.ReadOnlyField()
+    distance_unit = serializers.SerializerMethodField()
+
+    class Meta:
+        model = models.Weapon
+        fields = [
+            'name',
+            'key',
+            'url',
+            'damage_type',
+            'damage_dice',
+            'versatile_dice',
+            'is_versatile',
+            'reach',
+            'is_reach',
+            'is_finesse',
+            'range',
+            'range_melee',
+            'long_range',
+            'ranged_attack_possible',
+            'is_thrown',
+            'is_two_handed',
+            'requires_ammunition',
+            'requires_loading',
+            'is_heavy',
+            'is_light',
+            'is_lance',
+            'is_net',
+            'is_melee',
+            'is_simple',
+            'is_martial',
+            'is_improvised',
+            'properties',
+            'distance_unit',
+        ]
+    
+    @extend_schema_field(OpenApiTypes.STR)
+    def get_distance_unit(self, Weapon):
+        return Weapon.get_distance_unit
 
-class ItemRaritySerializer(serializers.ModelSerializer):
+class ItemRaritySerializer(GameContentSerializer):
     class Meta:
         model = models.ItemRarity
         fields = ['name', 'url', 'key', 'rank']
 
-class ItemCategorySerializer(serializers.ModelSerializer):
+class ItemCategorySerializer(GameContentSerializer):
     key = serializers.ReadOnlyField()
+    document = DocumentSummarySerializer()
+    class Meta:
+        model = models.ItemCategory
+        fields = '__all__'
 
+class ItemCategorySummarySerializer(GameContentSerializer):
     class Meta:
         model = models.ItemCategory
-        fields = "__all__"
+        fields = ['name', 'key', 'url']
 
 class ItemSerializer(GameContentSerializer):
     key = serializers.ReadOnlyField()
     is_magic_item = serializers.ReadOnlyField()
-    weapon = WeaponSerializer()
+    weapon = WeaponSummarySerializer()
     armor = ArmorSummarySerializer()
     document = DocumentSummarySerializer()
-    category = ItemCategorySerializer()
+    category = ItemCategorySummarySerializer()
     rarity = ItemRaritySerializer()
     damage_immunities = DamageTypeSummarySerializer(many=True)
     size = SizeSummarySerializer()
@@ -96,11 +156,16 @@ class Meta:
         model = models.Item
         fields = '__all__'
 
+class ItemSummarySerializer(GameContentSerializer):
+    class Meta:
+        model = models.Item
+        fields = ['name', 'key', 'url']
+
 
 
 class ItemSetSerializer(GameContentSerializer):
     key = serializers.ReadOnlyField()
-    items = ItemSerializer(many=True, read_only=True, context={'request':{}})
+    items = ItemSummarySerializer(many=True, read_only=True)
 
     class Meta:
         model = models.ItemSet

api_v2/serializers/size.py

@@ -24,7 +24,7 @@ class Meta:
     def get_distance_unit(self, Size):
         return Size.get_distance_unit
 
-class SizeSummarySerializer(serializers.ModelSerializer):
+class SizeSummarySerializer(GameContentSerializer):
     '''
     A slimmer SizeSerializer, designed to serialize Size FKs on other
     serializers. ie. The `size` field on the CreatureSerializer. Not intended

api_v2/serializers/species.py

@@ -7,7 +7,7 @@
 from .abstracts import GameContentSerializer
 from .document import DocumentSummarySerializer
 
-class SpeciesTraitSerializer(serializers.ModelSerializer):
+class SpeciesTraitSerializer(GameContentSerializer):
 
     class Meta:
         model = models.SpeciesTrait

api_v2/serializers/spell.py

@@ -16,7 +16,7 @@ class Meta:
         model = models.SpellSchool
         fields='__all__'
 
-class SpellSchoolSummarySerializer(serializers.ModelSerializer):
+class SpellSchoolSummarySerializer(GameContentSerializer):
     '''
     A slimmer SpellSchoolSerializer, designed to serialize Spell School FKs on 
     other serializers. ie. The `school` field on the SpellSerializer. Not