Merge pull request open5e#715 from calumbell/703/sundry-summary-serializers

Summary Serializers

Author: augustjohnson

api_v2/serializers/ability.py

@@ -23,6 +23,11 @@ class Meta:
         fields = '__all__'
 
 class AbilitySummarySerializer(GameContentSerializer):
+    '''
+    A slimmer AbilitySerializer, designed to serialize Ability FKs on other 
+    serializers. ie. The `saving_throws` field on CharacterClassSerializer. Not
+    intended to be used directly with in a ModelViewset.
+    '''
     class Meta:
         model = models.Ability
         fields = ['name', 'url']

api_v2/serializers/characterclass.py

@@ -70,6 +70,12 @@ class Meta:
         ]
 
 class CharacterClassSummarySerializer(serializers.ModelSerializer):
+    '''
+    A slimmer CharacterClassSerializer, designed to serialize Class FKs on
+    other serializers. ie. The `subclass_of` field on the 
+    CharacterClassSerializer serializer. Not intended to be used directly in a
+    ModelViewset.
+    '''
     class Meta:
         model = models.CharacterClass
         fields = ['name', 'key', 'url']

api_v2/serializers/condition.py

@@ -16,3 +16,13 @@ class ConditionSerializer(GameContentSerializer):
     class Meta:
         model = models.Condition
         fields = '__all__'
+
+class ConditionSummarySerializer(GameContentSerializer):
+    '''
+    A slimmer ConditionSerializer, designed to serialize Condition FKs on
+    other serializers. ie. The `condition_immunities` field on the Creature
+    serializer. Not intended to be used directly with in a ModelViewset.
+    '''
+    class Meta:
+        model = models.Condition
+        fields = ['name', 'key', 'url']

api_v2/serializers/creature.py

@@ -7,12 +7,12 @@
 from api_v2 import models
 
 from .abstracts import GameContentSerializer
-from .damagetype import DamageTypeSerializer
-from .condition import ConditionSerializer
+from .damagetype import DamageTypeSummarySerializer
+from .condition import ConditionSummarySerializer
 from .document import DocumentSummarySerializer
 from .language import LanguageSummarySerializer
-from .environment import EnvironmentSerializer
-from .size import SizeSerializer
+from .environment import EnvironmentSummarySerializer
+from .size import SizeSummarySerializer
 from drf_spectacular.utils import extend_schema_field, inline_serializer
 from drf_spectacular.types import OpenApiTypes
 
@@ -47,6 +47,15 @@ class Meta:
         model = models.CreatureType
         fields = '__all__'
 
+class CreatureTypeSummarySerializer(serializers.ModelSerializer):
+    '''
+    A slimmer CreatureTypeSerializer, designed to serialize CreatureType FKs on
+    other serializers . Not intended to be used directly with in a ModelViewset.
+    '''
+    class Meta:
+        model = models.CreatureType
+        fields = ['name', 'key', 'url']
+
 
 class CreatureTraitSerializer(GameContentSerializer):
     '''Serializer for the Creature Trait object'''
@@ -74,45 +83,45 @@ class CreatureSerializer(GameContentSerializer):
     saving_throws_all = serializers.SerializerMethodField()
     skill_bonuses = serializers.SerializerMethodField()
     skill_bonuses_all = serializers.SerializerMethodField()
-    damage_immunities = DamageTypeSerializer(many=True)
-    damage_resistances = DamageTypeSerializer(many=True)
-    damage_vulnerabilities = DamageTypeSerializer(many=True)
-    condition_immunities = ConditionSerializer(many=True)
+    damage_immunities = DamageTypeSummarySerializer(many=True)
+    damage_resistances = DamageTypeSummarySerializer(many=True)
+    damage_vulnerabilities = DamageTypeSummarySerializer(many=True)
+    condition_immunities = ConditionSummarySerializer(many=True)
     actions = CreatureActionSerializer(many=True)
     traits = CreatureTraitSerializer(many=True, read_only=True)
     speed = serializers.SerializerMethodField()
     speed_all = serializers.SerializerMethodField()
     challenge_rating_text = serializers.SerializerMethodField()
     experience_points = serializers.SerializerMethodField()
     document = DocumentSummarySerializer()
-    type = CreatureTypeSerializer()
-    size = SizeSerializer()
+    type = CreatureTypeSummarySerializer()
+    size = SizeSummarySerializer()
     languages = CreatureLanguageSerializer(source='*')
-    environments = EnvironmentSerializer(many=True)
+    environments = EnvironmentSummarySerializer(many=True)
     initiative_bonus = serializers.SerializerMethodField()
 
     class Meta:
         '''Serializer meta options.'''
         model = models.Creature
         fields = [
             'url',
-            'document',
             'key',
             'name',
+            'document',
+            'type',
             'size',
+            'challenge_rating_decimal',
+            'challenge_rating_text',
             'speed',
             'speed_all',
             'category',
             'subcategory',
-            'type',
             'alignment',
             'languages',
             'armor_class',
             'armor_detail',
             'hit_points',
             'hit_dice',
-            'challenge_rating_decimal',
-            'challenge_rating_text',
             'experience_points',
             'ability_scores',
             'modifiers',

api_v2/serializers/damagetype.py

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

api_v2/serializers/document.py

@@ -12,6 +12,10 @@ class Meta:
         fields = '__all__'
 
 class GameSystemSummarySerializer(serializers.ModelSerializer):
+    '''
+    A slimmer GameSystemSerializer, designed to serialize GameSystem FKs on 
+    other serializers. Not intended to be used directly with in a ModelViewset.
+    '''
     class Meta:
         model = models.GameSystem
         fields = ['name', 'key', 'url']
@@ -25,7 +29,10 @@ class Meta:
         fields = '__all__'
 
 class LicenseSummarySerializer(GameContentSerializer):
-    key = serializers.ReadOnlyField()
+    '''
+    A slimmer LicenseSerializer, designed to serialize License FKs on other 
+    serializers. Not intended to be used directly with in a ModelViewset.
+    '''
     class Meta:
         model = models.License
         fields = ['name', 'key', 'url']
@@ -38,7 +45,10 @@ class Meta:
         fields = '__all__'
 
 class PublisherSummarySerializer(serializers.ModelSerializer):
-    key = serializers.ReadOnlyField()
+    '''
+    A slimmer PublisherSerializer, designed to serialize Publisher FKs on other
+    serializers. Not intended to be used directly with in a ModelViewset.
+    '''
     class Meta:
         model = models.Publisher
         fields = ['name', 'key', 'url']
@@ -54,9 +64,13 @@ class Meta:
         fields = '__all__'
 
 class DocumentSummarySerializer(GameContentSerializer):
-    key = serializers.ReadOnlyField()
+    '''
+    A slimmer DocumentSerializer, designed to serialize Documents FKs on other
+    serializers. Not intended to be used directly with in a ModelViewset.
+    '''
     publisher = PublisherSummarySerializer()
-    gamesystem = GameSystemSummarySerializer() 
+    gamesystem = GameSystemSummarySerializer()
+
     class Meta:
         model = models.Document
         fields = ['name', 'key', 'publisher', 'gamesystem', 'permalink']

api_v2/serializers/environment.py

@@ -12,3 +12,13 @@ class EnvironmentSerializer(GameContentSerializer):
     class Meta:
         model = models.Environment
         fields = '__all__'
+
+class EnvironmentSummarySerializer(GameContentSerializer):
+    '''
+    A slimmer EnvironmentSerializer, designed to serialize Enviroment FKs on
+    other serializers. ie. The `environments` field on the CreatureSerializer.
+    Not intended to be used directly in a ModelViewset.
+    '''
+    class Meta:
+        model = models.Environment
+        fields = ['name', 'key', 'url']

api_v2/serializers/item.py

@@ -5,8 +5,9 @@
 from api_v2 import models
 
 from .abstracts import GameContentSerializer
-from .size import SizeSerializer
+from .damagetype import DamageTypeSummarySerializer
 from .document import DocumentSummarySerializer
+from .size import SizeSummarySerializer
 from drf_spectacular.utils import extend_schema_field
 from drf_spectacular.types import OpenApiTypes
 
@@ -20,8 +21,30 @@ class Meta:
         model = models.Armor
         fields = '__all__'
 
+class ArmorSummarySerializer(serializers.ModelSerializer):
+    '''
+    A slightly slimmer ArmorSerializer, designed to serialize Armor FKs on
+    other serializers. ie. The `armor` field on the ItemSerializer. Not 
+    intended to be used directly in a ModelViewset.
+    '''
+    class Meta:
+        model = models.Armor
+        fields = [
+            'name',
+            'key',
+            'url',
+            'category',
+            'ac_base',
+            'ac_display',
+            'ac_add_dexmod',
+            'ac_cap_dexmod',
+            'grants_stealth_disadvantage',
+            'strength_score_required',
+        ]
+
 class WeaponSerializer(GameContentSerializer):
     key = serializers.ReadOnlyField()
+    damage_type = DamageTypeSummarySerializer()
     is_versatile = serializers.ReadOnlyField()
     is_martial = serializers.ReadOnlyField()
     is_melee = serializers.ReadOnlyField()
@@ -41,14 +64,12 @@ def get_distance_unit(self, Weapon):
         return Weapon.get_distance_unit
 
 
-class ItemRaritySerializer(GameContentSerializer):
-    key=serializers.ReadOnlyField()
-
+class ItemRaritySerializer(serializers.ModelSerializer):
     class Meta:
         model = models.ItemRarity
-        fields = '__all__'
+        fields = ['name', 'url', 'key', 'rank']
 
-class ItemCategorySerializer(GameContentSerializer):
+class ItemCategorySerializer(serializers.ModelSerializer):
     key = serializers.ReadOnlyField()
 
     class Meta:
@@ -58,21 +79,14 @@ class Meta:
 class ItemSerializer(GameContentSerializer):
     key = serializers.ReadOnlyField()
     is_magic_item = serializers.ReadOnlyField()
-    weapon = WeaponSerializer(read_only=True, context={'request':{}})
-    armor = ArmorSerializer(read_only=True, context={'request':{}})
+    weapon = WeaponSerializer()
+    armor = ArmorSummarySerializer()
     document = DocumentSummarySerializer()
     category = ItemCategorySerializer()
     rarity = ItemRaritySerializer()
-    
-    def to_representation(self, instance):
-        """Ensures weapon/armor remain null instead of empty objects at depth>0."""
-        data = super().to_representation(instance)
-
-        for field in ["weapon", "armor"]:
-            if getattr(instance, field, None) is None:
-                data[field] = None
-        return data
-    
+    damage_immunities = DamageTypeSummarySerializer(many=True)
+    size = SizeSummarySerializer()
+        
     class Meta:
         model = models.Item
         fields = '__all__'

api_v2/serializers/size.py

@@ -23,3 +23,13 @@ class Meta:
     @extend_schema_field(OpenApiTypes.STR)
     def get_distance_unit(self, Size):
         return Size.get_distance_unit
+
+class SizeSummarySerializer(serializers.ModelSerializer):
+    '''
+    A slimmer SizeSerializer, designed to serialize Size FKs on other
+    serializers. ie. The `size` field on the CreatureSerializer. Not intended
+    to be used directly in a ModelViewset.
+    '''
+    class Meta:
+        model = models.Size
+        fields = ['name', 'key', 'url']

api_v2/serializers/spell.py

@@ -16,6 +16,15 @@ class Meta:
         model = models.SpellSchool
         fields='__all__'
 
+class SpellSchoolSummarySerializer(serializers.ModelSerializer):
+    '''
+    A slimmer SpellSchoolSerializer, designed to serialize Spell School FKs on 
+    other serializers. ie. The `school` field on the SpellSerializer. Not
+    intended to be used directly in a ModelViewset.
+    '''
+    class Meta:
+        model = models.SpellSchool
+        fields = ['name', 'key', 'url']
 
 class SpellCastingOptionSerializer(serializers.ModelSerializer):
     class Meta:
@@ -27,7 +36,7 @@ class SpellSerializer(GameContentSerializer):
     document = DocumentSummarySerializer()
     key = serializers.ReadOnlyField()
     casting_options = SpellCastingOptionSerializer(many=True)
-    school = SpellSchoolSerializer()
+    school = SpellSchoolSummarySerializer()
     classes = CharacterClassSummarySerializer(many=True)
 
     range_unit = serializers.SerializerMethodField()