Merge pull request #571 from phrasmotica/feature/pokemon-form-types

data/v2/build.py

@@ -1964,6 +1964,13 @@ def _build_pokemons():
         (PokemonFormGeneration,), "pokemon_form_generations.csv", csv_record_to_objects
     )
 
+    def csv_record_to_objects(info):
+        yield PokemonFormType(
+            pokemon_form_id=int(info[0]), type_id=int(info[1]), slot=int(info[2])
+        )
+
+    build_generic((PokemonFormType,), "pokemon_form_types.csv", csv_record_to_objects)
+
     def csv_record_to_objects(info):
         yield PokemonGameIndex(
             pokemon_id=int(info[0]), version_id=int(info[1]), game_index=int(info[2])

data/v2/csv/pokemon_form_types.csv

@@ -0,0 +1,36 @@
+pokemon_form_id,type_id,slot
+10041,7,1
+10042,17,1
+10043,16,1
+10044,13,1
+10045,2,1
+10046,10,1
+10047,3,1
+10048,8,1
+10049,12,1
+10050,5,1
+10051,15,1
+10052,4,1
+10053,14,1
+10054,6,1
+10055,9,1
+10056,11,1
+10057,10001,1
+10085,18,1
+10232,2,1
+10233,3,1
+10234,4,1
+10235,5,1
+10236,6,1
+10237,7,1
+10238,8,1
+10239,9,1
+10240,10,1
+10241,11,1
+10242,12,1
+10243,13,1
+10244,14,1
+10245,15,1
+10246,16,1
+10247,17,1
+10248,18,1

pokemon_v2/README.md

@@ -2399,6 +2399,13 @@ Pokémon are the creatures that inhabit the world of the pokemon games. They can
 | slot | The order the pokémon types are listed in | integer |
 | type | The type the referenced pokémon has       | string  |
 
+#### PokemonFormType
+
+| Name | Description | Data Type |
+| ---- | ----------- | --------- |
+| slot | The order the Pokémon form types are listed in | integer |
+| type | The type the referenced Pokémon form has       | string  |
+
 #### PokemonTypePast
 
 | Name | Description | Data Type |
@@ -2460,23 +2467,32 @@ Some pokémon have the ability to take on different forms. At times, these diffe
 
 ```json
 {
-	"id": 413,
-	"name": "wormadam-plant",
-	"order": 503,
-	"form_order": 1,
-	"is_default": true,
+    "id": 10041,
+    "name": "arceus-bug",
+    "order": 631,
+    "form_order": 7,
+    "is_default": false,
     "is_battle_only": false,
     "is_mega": false,
-	"form_name": "plant",
+    "form_name": "bug",
     "pokemon": {
-		"name": "wormadam-plant",
-		"url": "http://pokeapi.co/api/v2/pokemon/413/"
+        "name": "arceus",
+        "url": "https://pokeapi.co/api/v2/pokemon/493/"
     },
     "version_group": {
         "name": "diamond-pearl",
-		"url": "http://pokeapi.co/api/v2/version-group/8/"
+        "url": "https://pokeapi.co/api/v2/version-group/8/"
+    },
+    "types": [
+        {
+            "slot": 1,
+            "type": {
+                "name": "bug",
+                "url": "https://pokeapi.co/api/v2/type/7/"
             }
         }
+    ]
+}
 ```
 
 ###### response models
@@ -2495,6 +2511,7 @@ Some pokémon have the ability to take on different forms. At times, these diffe
 | form_name      | The name of this form                                                                                                                                    | string  |
 | pokemon        | The pokémon that can take on this form                                                                                                                   | [NamedAPIResource](#namedapiresource) ([Pokemon](#pokemon)) |
 | version_group  | The version group this pokémon form was introduced in                                                                                                    | [NamedAPIResource](#namedapiresource) ([VersionGroup](#version-groups)) |
+| types          | A list of details showing types this Pokémon form has, if they differ from the types of the Pokémon that can take on this form                           | list [PokemonFormType](#pokemonformtype) |
 
 
 ## Pokémon Habitats

pokemon_v2/migrations/0010_pokemonformtype.py

@@ -0,0 +1,52 @@
+# Generated by Django 2.1.11 on 2021-02-18 20:45
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("pokemon_v2", "0009_pokemontypepast"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="PokemonFormType",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("slot", models.IntegerField()),
+                (
+                    "pokemon_form",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="pokemonformtype",
+                        to="pokemon_v2.PokemonForm",
+                    ),
+                ),
+                (
+                    "type",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="pokemonformtype",
+                        to="pokemon_v2.Type",
+                    ),
+                ),
+            ],
+            options={
+                "abstract": False,
+            },
+        ),
+    ]

pokemon_v2/models.py

@@ -1872,6 +1872,11 @@ class PokemonType(HasPokemon, HasType):
     slot = models.IntegerField()
 
 
+class PokemonFormType(HasPokemonForm, HasType):
+
+    slot = models.IntegerField()
+
+
 # model for a Pokemon's types that were used until a given generation
 class PokemonTypePast(HasPokemon, HasType, HasGeneration):
 

pokemon_v2/serializers.py

@@ -386,6 +386,16 @@ class PokemonTypeSerializer(serializers.ModelSerializer):
         fields = ("slot", "pokemon", "type")
 
 
+class PokemonFormTypeSerializer(serializers.ModelSerializer):
+
+    pokemon_form = PokemonFormSummarySerializer()
+    type = TypeSummarySerializer()
+
+    class Meta:
+        model = PokemonFormType
+        fields = ("slot", "pokemon_form", "type")
+
+
 class PokemonTypePastSerializer(serializers.ModelSerializer):
 
     generation = GenerationSummarySerializer()
@@ -2466,6 +2476,7 @@ class PokemonFormDetailSerializer(serializers.ModelSerializer):
     sprites = serializers.SerializerMethodField("get_pokemon_form_sprites")
     form_names = serializers.SerializerMethodField("get_pokemon_form_names")
     names = serializers.SerializerMethodField("get_pokemon_form_pokemon_names")
+    types = serializers.SerializerMethodField("get_pokemon_form_types")
 
     class Meta:
         model = PokemonForm
@@ -2483,6 +2494,7 @@ class PokemonFormDetailSerializer(serializers.ModelSerializer):
             "version_group",
             "form_names",
             "names",
+            "types",
         )
 
     def get_pokemon_form_names(self, obj):
@@ -2536,6 +2548,29 @@ class PokemonFormDetailSerializer(serializers.ModelSerializer):
 
         return sprites_data
 
+    def get_pokemon_form_types(self, obj):
+
+        form_type_objects = PokemonFormType.objects.filter(pokemon_form=obj)
+        form_types = PokemonFormTypeSerializer(
+            form_type_objects, many=True, context=self.context
+        ).data
+
+        for form_type in form_types:
+            del form_type["pokemon_form"]
+
+        # defer to parent Pokemon's types if no form-specific types
+        if form_types == []:
+            pokemon_object = Pokemon.objects.get(id=obj.pokemon_id)
+            pokemon_type_objects = PokemonType.objects.filter(pokemon=pokemon_object)
+            form_types = PokemonTypeSerializer(
+                pokemon_type_objects, many=True, context=self.context
+            ).data
+
+            for form_type in form_types:
+                del form_type["pokemon"]
+
+        return form_types
+
 
 #################################
 #  POKEMON HABITAT SERIALIZERS  #

pokemon_v2/tests.py

@@ -1646,6 +1646,16 @@ class APIData:
 
         return pokemon_form_sprites
 
+    @classmethod
+    def setup_pokemon_form_type_data(cls, pokemon_form, type=None, slot=1):
+
+        type = type or cls.setup_type_data(name="tp for pkmn frm")
+
+        form_type = PokemonFormType(pokemon_form=pokemon_form, type=type, slot=slot)
+        form_type.save()
+
+        return form_type
+
     @classmethod
     def setup_pokemon_form_data(
         cls,
@@ -5045,6 +5055,7 @@ class APITests(APIData, APITestCase):
             pokemon=pokemon, name="pkm form for base pkmn"
         )
         pokemon_form_sprites = self.setup_pokemon_form_sprites_data(pokemon_form)
+        pokemon_form_type = self.setup_pokemon_form_type_data(pokemon_form)
 
         sprites_data = json.loads(pokemon_form_sprites.sprites)
 
@@ -5088,6 +5099,15 @@ class APITests(APIData, APITestCase):
             ),
         )
         self.assertEqual(response.data["sprites"]["back_default"], None)
+        # type params
+        self.assertEqual(response.data["types"][0]["slot"], pokemon_form_type.slot)
+        self.assertEqual(
+            response.data["types"][0]["type"]["name"], pokemon_form_type.type.name
+        )
+        self.assertEqual(
+            response.data["types"][0]["type"]["url"],
+            "{}{}/type/{}/".format(TEST_HOST, API_V2, pokemon_form_type.type.pk),
+        )
 
     # Evolution test
     def test_evolution_trigger_api(self):