564 standardize approach to weight across all of v2 similar to distance (open5e#720)

* Adding weight.

* Adding weight fields.

* Adding weight unit to documents.

* Specifying lb

* Adding to item.

* Resolving tests.

Author: augustjohnson

api_v2/migrations/0035_document_weight_unit.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.2 on 2025-04-29 23:41
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0034_rename_racetrait_speciestrait_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='document',
+            name='weight_unit',
+            field=models.CharField(blank=True, choices=[('feet', 'feet'), ('miles', 'miles')], help_text='What distance unit the relevant field uses.', max_length=20, null=True),
+        ),
+    ]

api_v2/models/abstracts.py

@@ -5,7 +5,7 @@
 from django.core.validators import MaxValueValidator, MinValueValidator
 
 from .enums import MODIFICATION_TYPES, DIE_TYPES
-from .enums import DISTANCE_UNIT_TYPES
+from .enums import DISTANCE_UNIT_TYPES, WEIGHT_UNIT_TYPES
 from .enums import ABILITY_SCORE_MAXIMUM
 from .enums import SAVING_THROW_MAXIMUM, SAVING_THROW_MINIMUM
 from .enums import SKILL_BONUS_MINIMUM, SKILL_BONUS_MAXIMUM
@@ -66,6 +66,15 @@ def distance_unit_field():
         help_text='What distance unit the relevant field uses.'
     )
 
+def weight_unit_field():
+    return models.CharField(
+        null=True,
+        blank=True,
+        max_length=20,
+        choices=WEIGHT_UNIT_TYPES,
+        help_text='What weight unit the relevant field uses.'
+    )
+
 # Define a field representing an ability score
 def ability_score_field(help_text):
     return models.SmallIntegerField(

api_v2/models/document.py

@@ -39,6 +39,7 @@ class Document(HasName, HasDescription):
     )
 
     distance_unit = distance_unit_field()
+    weight_unit = distance_unit_field()
 
     @property
     def stats(self):

api_v2/models/enums.py

@@ -11,7 +11,12 @@
 
 DISTANCE_UNIT_TYPES = [
     ("feet","feet"),
-    ("miles","miles")
+    ("miles","miles"),
+]
+
+WEIGHT_UNIT_TYPES = [
+    ("lb","lb"),
+    ("kg","kg")
 ]
 
 ABILITY_SCORE_MAXIMUM = 50

api_v2/models/object.py

@@ -13,7 +13,7 @@ class Object(HasName):
     """
     This is the definition of the Object abstract base class.
 
-    The Object class will be inherited from by Item, Weapon, Character, etc.
+    The Object class will be inherited from by Item, and Creature.
     Basically it describes any sort of matter in the 5e world.
     """
 
@@ -80,6 +80,11 @@ class Object(HasName):
         default=False,
         help_text='If the {} is immune to nonmagical attacks.'.format(__name__)
     )
+
+    def get_weight_unit(self):
+        '''Returns document level weight unit.'''
+        return self.document.weight_unit
+
     class Meta:
         abstract = True
         ordering = ['pk']

api_v2/serializers/item.py

@@ -86,12 +86,18 @@ class ItemSerializer(GameContentSerializer):
     rarity = ItemRaritySerializer()
     damage_immunities = DamageTypeSummarySerializer(many=True)
     size = SizeSummarySerializer()
-        
+    weight_unit = serializers.SerializerMethodField()
+    
+    @extend_schema_field(OpenApiTypes.STR)
+    def get_weight_unit(self, item):
+        return item.get_weight_unit()
+
     class Meta:
         model = models.Item
         fields = '__all__'
 
 
+
 class ItemSetSerializer(GameContentSerializer):
     key = serializers.ReadOnlyField()
     items = ItemSerializer(many=True, read_only=True, context={'request':{}})

api_v2/tests/responses/TestObjects.test_document_example.approved.json

@@ -28,5 +28,6 @@
         "name": "Wizards of the Coast",
         "url": "http://localhost:8000/v2/publishers/wizards-of-the-coast/"
     },
-    "url": "http://localhost:8000/v2/documents/srd/"
+    "url": "http://localhost:8000/v2/documents/srd/",
+    "weight_unit": "lb"
 }

api_v2/tests/responses/TestObjects.test_item_armor_example.approved.json

@@ -65,5 +65,6 @@
     },
     "url": "http://localhost:8000/v2/items/srd_splint-armor/",
     "weapon": null,
-    "weight": "60.000"
+    "weight": "60.000",
+    "weight_unit": "lb"
 }

api_v2/tests/responses/TestObjects.test_item_example.approved.json

@@ -59,5 +59,6 @@
     },
     "url": "http://localhost:8000/v2/items/srd_apparatus-of-the-crab/",
     "weapon": null,
-    "weight": "0.000"
+    "weight": "0.000",
+    "weight_unit": "lb"
 }

api_v2/tests/responses/TestObjects.test_item_melee_weapon_example.approved.json

@@ -54,5 +54,6 @@
     },
     "url": "http://localhost:8000/v2/items/srd_shortsword/",
     "weapon": "http://localhost:8000/v2/weapons/srd_shortsword/",
-    "weight": "2.000"
+    "weight": "2.000",
+    "weight_unit": "lb"
 }