Added gen 4 location internal ids and some pseudo-locations.
[zzz-pokedex.git] / pokedex / db / tables.py
index 8033879..b771dab 100644 (file)
@@ -8,7 +8,7 @@ from sqlalchemy.orm.session import Session
 from sqlalchemy.sql import and_
 from sqlalchemy.types import *
 
-from pokedex.db import rst
+from pokedex.db import markdown
 
 metadata = MetaData()
 TableBase = declarative_base(metadata=metadata)
@@ -19,8 +19,8 @@ class Ability(TableBase):
     id = Column(Integer, primary_key=True, nullable=False)
     name = Column(Unicode(24), nullable=False)
     generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False)
-    effect = Column(rst.RstTextColumn(5120), nullable=False)
-    short_effect = Column(rst.RstTextColumn(255), nullable=False)
+    effect = Column(markdown.MarkdownColumn(5120), nullable=False)
+    short_effect = Column(markdown.MarkdownColumn(255), nullable=False)
 
 class AbilityFlavorText(TableBase):
     __tablename__ = 'ability_flavor_text'
@@ -177,7 +177,6 @@ class EvolutionChain(TableBase):
     __tablename__ = 'evolution_chains'
     id = Column(Integer, primary_key=True, nullable=False)
     growth_rate_id = Column(Integer, ForeignKey('growth_rates.id'), nullable=False)
-    steps_to_hatch = Column(Integer, nullable=False)
     baby_trigger_item = Column(Unicode(12))
 
 class EvolutionTrigger(TableBase):
@@ -214,7 +213,7 @@ class Item(TableBase):
     cost = Column(Integer, nullable=False)
     fling_power = Column(Integer, nullable=True)
     fling_effect_id = Column(Integer, ForeignKey('item_fling_effects.id'), nullable=True)
-    effect = Column(rst.RstTextColumn(5120), nullable=False)
+    effect = Column(markdown.MarkdownColumn(5120), nullable=False)
 
     @property
     def appears_underground(self):
@@ -254,6 +253,12 @@ class ItemInternalID(TableBase):
     generation_id = Column(Integer, ForeignKey('generations.id'), primary_key=True, autoincrement=False, nullable=False)
     internal_id = Column(Integer, nullable=False)
 
+class ItemName(TableBase):
+    __tablename__ = 'item_names'
+    item_id = Column(Integer, ForeignKey('items.id'), primary_key=True, nullable=False, autoincrement=False)
+    language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, autoincrement=False)
+    name = Column(Unicode(16), nullable=False)
+
 class ItemPocket(TableBase):
     __tablename__ = 'item_pockets'
     id = Column(Integer, primary_key=True, nullable=False)
@@ -288,6 +293,12 @@ class LocationAreaEncounterRate(TableBase):
     version_id = Column(Integer, ForeignKey('versions.id'), primary_key=True, autoincrement=False)
     rate = Column(Integer, nullable=True)
 
+class LocationInternalID(TableBase):
+    __tablename__ = 'location_internal_ids'
+    location_id = Column(Integer, ForeignKey('locations.id'), nullable=False, primary_key=True)
+    generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False, primary_key=True)
+    internal_id = Column(Integer, nullable=False)
+
 class Machine(TableBase):
     __tablename__ = 'machines'
     machine_number = Column(Integer, primary_key=True, nullable=False, autoincrement=False)
@@ -337,8 +348,9 @@ class MoveFlag(TableBase):
 class MoveFlagType(TableBase):
     __tablename__ = 'move_flag_types'
     id = Column(Integer, primary_key=True, nullable=False)
+    identifier = Column(Unicode(16), nullable=False)
     name = Column(Unicode(32), nullable=False)
-    description = Column(rst.RstTextColumn(128), nullable=False)
+    description = Column(markdown.MarkdownColumn(128), nullable=False)
 
 class MoveFlavorText(TableBase):
     __tablename__ = 'move_flavor_text'
@@ -393,6 +405,12 @@ class NatureBattleStylePreference(TableBase):
     low_hp_preference = Column(Integer, nullable=False)
     high_hp_preference = Column(Integer, nullable=False)
 
+class NatureName(TableBase):
+    __tablename__ = 'nature_names'
+    nature_id = Column(Integer, ForeignKey('natures.id'), primary_key=True, nullable=False, autoincrement=False)
+    language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, autoincrement=False)
+    name = Column(Unicode(8), nullable=False)
+
 class NaturePokeathlonStat(TableBase):
     __tablename__ = 'nature_pokeathlon_stats'
     nature_id = Column(Integer, ForeignKey('natures.id'), primary_key=True, nullable=False)
@@ -444,6 +462,7 @@ class Pokemon(TableBase):
     base_experience = Column(Integer, nullable=False)
     base_happiness = Column(Integer, nullable=False)
     is_baby = Column(Boolean, nullable=False)
+    hatch_counter = Column(Integer, nullable=False)
     has_gen4_fem_sprite = Column(Boolean, nullable=False)
     has_gen4_fem_back_sprite = Column(Boolean, nullable=False)
 
@@ -492,7 +511,27 @@ class Pokemon(TableBase):
             if pokemon_stat.stat.name == stat_name:
                 return pokemon_stat
 
-        return None
+        raise KeyError(u'No stat named %s' % stat_name)
+
+    @property
+    def better_damage_class(self):
+        u"""Returns the MoveDamageClass that this Pokémon is best suited for,
+        based on its attack stats.
+
+        If the attack stats are about equal (within 5), returns None.  The
+        value None, not the damage class called 'None'.
+        """
+        phys = self.stat(u'Attack')
+        spec = self.stat(u'Special Attack')
+
+        diff = phys.base_stat - spec.base_stat
+
+        if diff > 5:
+            return phys.stat.damage_class
+        elif diff < -5:
+            return spec.stat.damage_class
+        else:
+            return None
 
 class PokemonAbility(TableBase):
     __tablename__ = 'pokemon_abilities'
@@ -543,7 +582,7 @@ class PokemonFormGroup(TableBase):
     __tablename__ = 'pokemon_form_groups'
     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
     is_battle_only = Column(Boolean, nullable=False)
-    description = Column(Unicode(512), nullable=False)
+    description = Column(markdown.MarkdownColumn(1024), nullable=False)
 
 class PokemonFormSprite(TableBase):
     __tablename__ = 'pokemon_form_sprites'
@@ -558,6 +597,12 @@ class PokemonHabitat(TableBase):
     id = Column(Integer, primary_key=True, nullable=False, autoincrement=False)
     name = Column(Unicode(16), nullable=False)
 
+class PokemonInternalID(TableBase):
+    __tablename__ = 'pokemon_internal_ids'
+    pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, autoincrement=False, nullable=False)
+    generation_id = Column(Integer, ForeignKey('generations.id'), primary_key=True, autoincrement=False, nullable=False)
+    internal_id = Column(Integer, nullable=False)
+
 class PokemonItem(TableBase):
     __tablename__ = 'pokemon_items'
     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
@@ -571,8 +616,8 @@ class PokemonMove(TableBase):
     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)
+    level = Column(Integer, primary_key=True, nullable=True, autoincrement=False, index=True)
+    order = Column(Integer, nullable=True, index=True)
 
 class PokemonMoveMethod(TableBase):
     __tablename__ = 'pokemon_move_methods'
@@ -614,6 +659,7 @@ class Region(TableBase):
 class Stat(TableBase):
     __tablename__ = 'stats'
     id = Column(Integer, primary_key=True, nullable=False)
+    damage_class_id = Column(Integer, ForeignKey('move_damage_classes.id'), nullable=True)
     name = Column(Unicode(16), nullable=False)
 
 class SuperContestCombo(TableBase):
@@ -714,6 +760,7 @@ Item.berry = relation(Berry, uselist=False, backref='item')
 Item.flags = relation(ItemFlag, secondary=ItemFlagMap.__table__)
 Item.flavor_text = relation(ItemFlavorText, order_by=ItemFlavorText.version_group_id.asc(), backref='item')
 Item.fling_effect = relation(ItemFlingEffect, backref='items')
+Item.foreign_names = relation(ItemName, backref='item')
 Item.machines = relation(Machine, order_by=Machine.version_group_id.asc())
 Item.category = relation(ItemCategory)
 Item.pocket = association_proxy('category', 'pocket')
@@ -723,12 +770,20 @@ ItemCategory.pocket = relation(ItemPocket)
 
 ItemFlavorText.version_group = relation(VersionGroup)
 
+ItemInternalID.item = relation(Item, backref='internal_ids')
+ItemInternalID.generation = relation(Generation)
+
+ItemName.language = relation(Language)
+
 ItemPocket.categories = relation(ItemCategory, order_by=ItemCategory.name)
 
 Location.region = relation(Region, backref='locations')
 
 LocationArea.location = relation(Location, backref='areas')
 
+LocationInternalID.location = relation(Location, backref='internal_ids')
+LocationInternalID.generation = relation(Generation)
+
 Machine.item = relation(Item)
 Machine.version_group = relation(VersionGroup)
 
@@ -750,9 +805,9 @@ Move.super_contest_combo_prev = association_proxy('super_contest_combo_second',
 Move.target = relation(MoveTarget, backref='moves')
 Move.type = relation(Type, backref='moves')
 
-Move.effect = rst.MoveEffectProperty('effect')
+Move.effect = markdown.MoveEffectProperty('effect')
 Move.priority = association_proxy('move_effect', 'priority')
-Move.short_effect = rst.MoveEffectProperty('short_effect')
+Move.short_effect = markdown.MoveEffectProperty('short_effect')
 
 MoveEffect.category_map = relation(MoveEffectCategoryMap)
 MoveEffect.categories = association_proxy('category_map', 'category')
@@ -764,6 +819,7 @@ MoveFlavorText.version_group = relation(VersionGroup)
 
 MoveName.language = relation(Language)
 
+Nature.foreign_names = relation(NatureName, backref='nature')
 Nature.decreased_stat = relation(Stat, primaryjoin=Nature.decreased_stat_id==Stat.id,
                                        backref='decreasing_natures')
 Nature.increased_stat = relation(Stat, primaryjoin=Nature.increased_stat_id==Stat.id,
@@ -779,6 +835,8 @@ Nature.pokeathlon_effects = relation(NaturePokeathlonStat, order_by=NaturePokeat
 
 NatureBattleStylePreference.battle_style = relation(MoveBattleStyle, backref='nature_preferences')
 
+NatureName.language = relation(Language)
+
 NaturePokeathlonStat.pokeathlon_stat = relation(PokeathlonStat, backref='nature_effects')
 
 Pokedex.region = relation(Region, backref='pokedexes')
@@ -792,7 +850,7 @@ Pokemon.formes = relation(Pokemon, primaryjoin=Pokemon.id==Pokemon.forme_base_po
                                                                remote_side=[Pokemon.id]))
 Pokemon.pokemon_color = relation(PokemonColor, backref='pokemon')
 Pokemon.color = association_proxy('pokemon_color', 'name')
-Pokemon.dex_numbers = relation(PokemonDexNumber, backref='pokemon')
+Pokemon.dex_numbers = relation(PokemonDexNumber, order_by=PokemonDexNumber.pokedex_id.asc(), backref='pokemon')
 Pokemon.default_form_sprite = relation(PokemonFormSprite,
                                        primaryjoin=and_(
                                             Pokemon.id==PokemonFormSprite.pokemon_id,
@@ -883,6 +941,8 @@ Region.version_group_regions = relation(VersionGroupRegion, backref='region',
                                         order_by='VersionGroupRegion.version_group_id')
 Region.version_groups = association_proxy('version_group_regions', 'version_group')
 
+Stat.damage_class = relation(MoveDamageClass, backref='stats')
+
 SuperContestCombo.first = relation(Move, primaryjoin=SuperContestCombo.first_move_id==Move.id,
                                         backref='super_contest_combo_first')
 SuperContestCombo.second = relation(Move, primaryjoin=SuperContestCombo.second_move_id==Move.id,