676 add monster illustrations as a field to creature objects (open5e#767)

* Implementing HasIllustration

* Bit of cleanup for whitespace/comments.

* PEP8 and adding HasIllustration to Creature.

* Adding illustration to database.

* merging a couple of conflicts.

* Adding open5e custom image objects.

* Adding illustration field to data.

* Ordering fields.

* Adding illustration fields to creature documents.

* Adding in pks

* Exposing the field.

* Fixing creature illustrations.

---------

Co-authored-by: calum <[email protected]>

Author: augustjohnson

api_v2/migrations/0050_creature_illustration.py

@@ -0,0 +1,19 @@
+# Generated by Django 5.2.1 on 2025-06-08 12:24
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0049_add_document_display_name'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='creature',
+            name='illustration',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to='api_v2.image'),
+        ),
+    ]

api_v2/migrations/0052_merge_20250615_2121.py

@@ -0,0 +1,14 @@
+# Generated by Django 5.2.1 on 2025-06-15 21:21
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0050_creature_illustration'),
+        ('api_v2', '0051_merge_20250615_2056'),
+    ]
+
+    operations = [
+    ]

api_v2/models/__init__.py

@@ -60,6 +60,6 @@
 
 from .rule import Rule, RuleSet
 
-from .image import Image
+from .image import Image, HasIcon, HasIllustration
 
 from .service import Service

api_v2/models/creature.py

@@ -1,4 +1,6 @@
 """The model for a creature."""
+import decimal
+
 from fractions import Fraction
 
 from django.db import models
@@ -9,21 +11,21 @@
 from .abstracts import damage_die_count_field, damage_die_type_field
 from .abstracts import damage_bonus_field, key_field
 from .abstracts import distance_field, distance_unit_field
+from .image import HasIllustration
 from .object import Object
 from .condition import Condition
 from .damagetype import DamageType
 from .document import FromDocument
 from .environment import Environment
 from .speed import HasSpeed
 from .enums import CREATURE_ATTACK_TYPES, CREATURE_USES_TYPES, ACTION_TYPES
-import decimal
 
 
 class CreatureType(HasName, HasDescription, FromDocument):
     """The Type of creature, such as Aberration."""
 
 
-class Creature(Object, HasAbilities, HasSenses, HasLanguage, HasSpeed, FromDocument):
+class Creature(Object, HasAbilities, HasSenses, HasLanguage, HasSpeed, HasIllustration, FromDocument):
     """
     This is the model for a Creature, per the 5e gamesystem.
 
@@ -151,7 +153,7 @@ def search_result_extra_fields(self):
             "type": self.type.name,
             "size": self.size.name,   
         }
-        
+
     @property
     def challenge_rating_text(self):
         '''Challenge rating as text string representation of a fraction or integer. '''
@@ -204,6 +206,7 @@ def experience_points(self):
             except:
                 return None
 
+
 class CreatureAction(HasName, HasDescription):
     """Describes an action available to a creature."""
     key = key_field()
@@ -266,6 +269,7 @@ def as_text(self):
 
         return text
 
+
 class CreatureActionAttack(HasName):
     """Describes an attack action used by a creature."""
     key = key_field()
@@ -337,7 +341,7 @@ class CreatureTrait(Modification):
     """
     key = key_field()
     parent = models.ForeignKey(Creature, on_delete=models.CASCADE, related_name="traits")
-    
+
 
 class CreatureSet(HasName, FromDocument):
     """Set that the creature belongs to."""

api_v2/models/image.py

@@ -1,4 +1,4 @@
-"""The model for an image with metadata."""
+"""The model for an image with metadata. Includes abstracts."""
 
 
 from django.db import models
@@ -32,19 +32,31 @@ class Image(HasName, FromDocument):
     )
 
     def __str__(self):
-        return (self.document.name + " - " + self.name)
+        return self.document.name + " - " + self.name
 
     @property
     def file_url(self)->str:
+        """Returns a relative path to the related file."""
         return static(self.file_path)
-    
+
     class Meta:
         ordering = ['key']
 
 
 class HasIcon(models.Model):
     """The model inherited for defining an icon for another object type."""
-    icon = models.ForeignKey(Image, 
+    icon = models.ForeignKey(Image,
+                            blank=True,
+                            null=True,
+                            on_delete=models.CASCADE)
+
+    class Meta:
+        abstract = True
+
+
+class HasIllustration(models.Model):
+    """The model inherited for defining an illustration for another object type."""
+    illustration = models.ForeignKey(Image,
                             blank=True,
                             null=True,
                             on_delete=models.CASCADE)

api_v2/serializers/creature.py

@@ -13,6 +13,7 @@
 from .language import LanguageSummarySerializer
 from .environment import EnvironmentSummarySerializer
 from .size import SizeSummarySerializer
+from .image import ImageSummarySerializer
 from drf_spectacular.utils import extend_schema_field, inline_serializer
 from drf_spectacular.types import OpenApiTypes
 
@@ -157,6 +158,8 @@ class CreatureSerializer(GameContentSerializer):
     languages = CreatureLanguageSerializer(source='*')
     environments = EnvironmentSummarySerializer(many=True)
     initiative_bonus = serializers.SerializerMethodField()
+    illustration = ImageSummarySerializer()
+
 
     class Meta:
         '''Serializer meta options.'''
@@ -199,7 +202,8 @@ class Meta:
             'actions',
             'traits',
             'creaturesets',
-            'environments'
+            'environments',
+            'illustration'
         ]
 
     @extend_schema_field(inline_serializer(

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

@@ -212,6 +212,7 @@
     "experience_points": 62000,
     "hit_dice": "28d20+252",
     "hit_points": 546,
+    "illustration": null,
     "initiative_bonus": 0,
     "key": "srd_ancient-red-dragon",
     "languages": {

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

@@ -170,6 +170,7 @@
     "experience_points": 50,
     "hit_dice": "2d6",
     "hit_points": 7,
+    "illustration": null,
     "initiative_bonus": 2,
     "key": "srd_goblin",
     "languages": {

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

@@ -129,6 +129,7 @@
     "experience_points": 25,
     "hit_dice": "2d8+2",
     "hit_points": 11,
+    "illustration": null,
     "initiative_bonus": 1,
     "key": "srd_guard",
     "languages": {

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

@@ -86,6 +86,7 @@
             "experience_points": 25,
             "hit_dice": "2d10+4",
             "hit_points": 15,
+            "illustration": null,
             "initiative_bonus": -1,
             "key": "srd_camel",
             "languages": {
@@ -241,6 +242,7 @@
             "experience_points": 0,
             "hit_dice": null,
             "hit_points": 11,
+            "illustration": null,
             "initiative_bonus": 0,
             "key": "srd_donkey",
             "languages": {
@@ -436,6 +438,7 @@
             "experience_points": 50,
             "hit_dice": "3d10+3",
             "hit_points": 19,
+            "illustration": null,
             "initiative_bonus": 0,
             "key": "srd_draft-horse",
             "languages": {
@@ -674,6 +677,7 @@
             "experience_points": 1100,
             "hit_dice": "8d12+24",
             "hit_points": 76,
+            "illustration": null,
             "initiative_bonus": -1,
             "key": "srd_elephant",
             "languages": {
@@ -884,6 +888,7 @@
             "experience_points": 25,
             "hit_dice": "1d8+1",
             "hit_points": 5,
+            "illustration": null,
             "initiative_bonus": 2,
             "key": "srd_mastiff",
             "languages": {
@@ -1094,6 +1099,7 @@
             "experience_points": 25,
             "hit_dice": "2d8+2",
             "hit_points": 11,
+            "illustration": null,
             "initiative_bonus": 0,
             "key": "srd_mule",
             "languages": {
@@ -1303,6 +1309,7 @@
             "experience_points": 25,
             "hit_dice": "2d8+2",
             "hit_points": 11,
+            "illustration": null,
             "initiative_bonus": 0,
             "key": "srd_pony",
             "languages": {
@@ -1503,6 +1510,7 @@
             "experience_points": 50,
             "hit_dice": "2d10+2",
             "hit_points": 13,
+            "illustration": null,
             "initiative_bonus": 0,
             "key": "srd_riding-horse",
             "languages": {
@@ -1698,6 +1706,7 @@
             "experience_points": 100,
             "hit_dice": "3d10+3",
             "hit_points": 19,
+            "illustration": null,
             "initiative_bonus": 1,
             "key": "srd_warhorse",
             "languages": {