Allow lookup() callers to pass in their own whoosh indices.

[zzz-pokedex.git] / pokedex / db / tables.py

diff --git a/pokedex/db/tables.py b/pokedex/db/tables.py
index 49d9c17..57207dd 100644 (file)
--- a/pokedex/db/tables.py
+++ b/pokedex/db/tables.py
@@ -2,6 +2,7 @@
 
 from sqlalchemy import Column, ForeignKey, MetaData, Table
 from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.ext.associationproxy import association_proxy
 from sqlalchemy.orm import backref, relation
 from sqlalchemy.types import *
 from sqlalchemy.databases.mysql import *
@@ -127,10 +128,16 @@ class Generation(TableBase):
     main_region = Column(Unicode(16), nullable=False)
 
 class GrowthRate(TableBase):
+    """`formula` is written in LaTeX math notation."""
     __tablename__ = 'growth_rates'
     id = Column(Integer, primary_key=True, nullable=False)
+    name = Column(Unicode(20), nullable=False)
+    formula = Column(Unicode(500), nullable=False)
+
+class Item(TableBase):
+    __tablename__ = 'items'
+    id = Column(Integer, primary_key=True, nullable=False)
     name = Column(Unicode(16), nullable=False)
-    formula = Column(Unicode(255), nullable=False)
 
 class Language(TableBase):
     __tablename__ = 'languages'
@@ -150,6 +157,12 @@ class LocationArea(TableBase):
     internal_id = Column(Integer, nullable=False)
     name = Column(Unicode(64), nullable=True)
 
+class Machine(TableBase):
+    __tablename__ = 'machines'
+    machine_number = Column(Integer, primary_key=True, nullable=False, autoincrement=False)
+    generation_id = Column(Integer, ForeignKey('generations.id'), primary_key=True, nullable=False, autoincrement=False)
+    move_id = Column(Integer, ForeignKey('moves.id'), nullable=False)
+
 class MoveEffect(TableBase):
     __tablename__ = 'move_effects'
     id = Column(Integer, primary_key=True, nullable=False)
@@ -167,6 +180,7 @@ class Move(TableBase):
     __tablename__ = 'moves'
     id = Column(Integer, primary_key=True, nullable=False)
     name = Column(Unicode(12), nullable=False)
+    generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False)
     type_id = Column(Integer, ForeignKey('types.id'), nullable=False)
     power = Column(SmallInteger)
     pp = Column(SmallInteger, nullable=False)
@@ -176,10 +190,18 @@ class Move(TableBase):
     effect_id = Column(Integer, ForeignKey('move_effects.id'), nullable=False)
     effect_chance = Column(Integer)
     contest_type = Column(Unicode(8), nullable=False)
-    contest_effect_id = Column(Integer, ForeignKey('contest_effects.id'), nullable=False)
+    contest_effect_id = Column(Integer, ForeignKey('contest_effects.id'), nullable=True)
     super_contest_effect_id = Column(Integer, nullable=False)
 
 class Pokemon(TableBase):
+    """The core to this whole mess.
+
+    Note that I use both 'forme' and 'form' in both code and the database.  I
+    only use 'forme' when specifically referring to Pokémon that have multiple
+    distinct species as forms—i.e., different stats or movesets.  'Form' is a
+    more general term referring to any variation within a species, including
+    purely cosmetic forms like Unown.
+    """
     __tablename__ = 'pokemon'
     id = Column(Integer, primary_key=True, nullable=False)
     name = Column(Unicode(20), nullable=False)
@@ -225,6 +247,17 @@ class Pokemon(TableBase):
             return "%s %s" % (self.forme_name.capitalize(), self.name)
         return self.name
 
+    @property
+    def normal_form(self):
+        """Returns the normal form for this Pokémon; i.e., this will return
+        regular Deoxys when called on any Deoxys form.
+        """
+
+        if self.forme_base_pokemon:
+            return self.forme_base_pokemon
+
+        return self
+
 class PokemonAbility(TableBase):
     __tablename__ = 'pokemon_abilities'
     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
@@ -251,7 +284,7 @@ class PokemonFlavorText(TableBase):
 class PokemonFormGroup(TableBase):
     __tablename__ = 'pokemon_form_groups'
     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
-    description = Column(Unicode(255), nullable=False)
+    description = Column(Unicode(512), nullable=False)
 
 class PokemonFormSprite(TableBase):
     __tablename__ = 'pokemon_form_sprites'
@@ -259,6 +292,28 @@ class PokemonFormSprite(TableBase):
     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
     name = Column(Unicode(16), nullable=True)
 
+class PokemonItem(TableBase):
+    __tablename__ = 'pokemon_items'
+    pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
+    version_id = Column(Integer, ForeignKey('versions.id'), primary_key=True, nullable=False, autoincrement=False)
+    item_id = Column(Integer, ForeignKey('items.id'), primary_key=True, nullable=False, autoincrement=False)
+    rarity = Column(Integer, nullable=False)
+
+class PokemonMove(TableBase):
+    __tablename__ = 'pokemon_moves'
+    pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
+    version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, autoincrement=False)
+    move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False, index=True)
+    pokemon_move_method_id = Column(Integer, ForeignKey('pokemon_move_methods.id'), primary_key=True, nullable=False, autoincrement=False)
+    level = Column(Integer, primary_key=True, nullable=True, autoincrement=False)
+    order = Column(Integer, nullable=True)
+
+class PokemonMoveMethod(TableBase):
+    __tablename__ = 'pokemon_move_methods'
+    id = Column(Integer, primary_key=True, nullable=False, autoincrement=False)
+    name = Column(Unicode(64), nullable=False)
+    description = Column(Unicode(255), nullable=False)
+
 class PokemonName(TableBase):
     __tablename__ = 'pokemon_names'
     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
@@ -312,6 +367,8 @@ class Version(TableBase):
     version_group_id = Column(Integer, ForeignKey('version_groups.id'), nullable=False)
     name = Column(Unicode(32), nullable=False)
 
+    generation = association_proxy('version_group', 'generation')
+
 
 ### Relations down here, to avoid ordering problems
 Encounter.pokemon = relation(Pokemon, backref='encounters')
@@ -327,11 +384,24 @@ EncounterTypeSlot.type = relation(EncounterType, backref='slots')
 
 EvolutionChain.growth_rate = relation(GrowthRate, backref='evolution_chains')
 
+Generation.versions = relation(Version, secondary=VersionGroup.__table__)
+
 LocationArea.location = relation(Location, backref='areas')
 
+Machine.generation = relation(Generation)
+
+Move.type = relation(Type, backref='moves')
+Move.generation = relation(Generation, backref='moves')
+Move.target = relation(MoveTarget, backref='moves')
+Move.effect = relation(MoveEffect, backref='moves')
+Move.machines = relation(Machine, backref='move')
+
 Pokemon.abilities = relation(Ability, secondary=PokemonAbility.__table__,
                                       order_by=PokemonAbility.slot,
                                       backref='pokemon')
+Pokemon.formes = relation(Pokemon, primaryjoin=Pokemon.id==Pokemon.forme_base_pokemon_id,
+                                               backref=backref('forme_base_pokemon',
+                                                               remote_side=[Pokemon.id]))
 Pokemon.dex_numbers = relation(PokemonDexNumber, backref='pokemon')
 Pokemon.egg_groups = relation(EggGroup, secondary=PokemonEggGroup.__table__,
                                         order_by=PokemonEggGroup.egg_group_id,
@@ -343,6 +413,7 @@ Pokemon.evolution_children = relation(Pokemon, primaryjoin=Pokemon.id==Pokemon.e
                                                                remote_side=[Pokemon.id]))
 Pokemon.flavor_text = relation(PokemonFlavorText, backref='pokemon')
 Pokemon.foreign_names = relation(PokemonName, backref='pokemon')
+Pokemon.items = relation(PokemonItem)
 Pokemon.generation = relation(Generation, backref='pokemon')
 Pokemon.shape = relation(PokemonShape, backref='pokemon')
 Pokemon.stats = relation(PokemonStat, backref='pokemon')
@@ -352,10 +423,18 @@ PokemonDexNumber.generation = relation(Generation)
 
 PokemonFlavorText.version = relation(Version)
 
+PokemonItem.item = relation(Item, backref='pokemon')
+PokemonItem.version = relation(Version)
+
 PokemonFormGroup.pokemon = relation(Pokemon, backref=backref('form_group',
                                                              uselist=False))
 PokemonFormSprite.pokemon = relation(Pokemon, backref='form_sprites')
 
+PokemonMove.pokemon = relation(Pokemon, backref='pokemon_moves')
+PokemonMove.version_group = relation(VersionGroup)
+PokemonMove.move = relation(Move, backref='pokemon_moves')
+PokemonMove.method = relation(PokemonMoveMethod)
+
 PokemonName.language = relation(Language)
 
 PokemonStat.stat = relation(Stat)
@@ -369,5 +448,6 @@ Type.target_efficacies = relation(TypeEfficacy,
                                       ==TypeEfficacy.target_type_id,
                                   backref='target_type')
 
-Version.generation = relation(Generation, secondary=VersionGroup.__table__,
-                              backref='versions')
+Version.version_group = relation(VersionGroup, backref='versions')
+
+VersionGroup.generation = relation(Generation, backref='version_groups')