Rename internal_id to game_index.
[zzz-pokedex.git] / pokedex / db / tables.py
index 7d1cd5c..aaa2fcb 100644 (file)
@@ -49,15 +49,6 @@ from inspect import isclass
 
 from pokedex.db import markdown, multilang
 
-# A list of all table classes will live in table_classes
-table_classes = []
-
-class TableMetaclass(DeclarativeMeta):
-    def __init__(cls, name, bases, attrs):
-        super(TableMetaclass, cls).__init__(name, bases, attrs)
-        if hasattr(cls, '__tablename__'):
-            table_classes.append(cls)
-
 class TableSuperclass(object):
     """Superclass for declarative tables, to give them some generic niceties
     like stringification.
@@ -83,15 +74,7 @@ class TableSuperclass(object):
         return unicode(self).encode('utf8')
 
 metadata = MetaData()
-TableBase = declarative_base(metadata=metadata, cls=TableSuperclass, metaclass=TableMetaclass)
-
-### Helper classes
-class LanguageSpecific(object):
-    """Mixin for prose and text tables"""
-    @declared_attr
-    def language_id(cls):
-        return Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False,
-            info=dict(description="The language"))
+TableBase = declarative_base(metadata=metadata, cls=TableSuperclass)
 
 
 ### Need Language first, to create the partial() below
@@ -116,7 +99,7 @@ class Language(TableBase):
 
 create_translation_table = partial(multilang.create_translation_table, language_class=Language)
 
-create_translation_table('language_texts', Language, 'names',
+create_translation_table('language_names', Language, 'names',
     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
@@ -135,7 +118,7 @@ class Ability(TableBase):
     generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False,
         info=dict(description="The ID of the generation this ability was introduced in", detail=True))
 
-create_translation_table('ability_texts', Ability, 'names',
+create_translation_table('ability_names', Ability, 'names',
     name = Column(Unicode(24), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
@@ -162,7 +145,7 @@ create_translation_table('ability_changelog_prose', AbilityChangelog, 'prose',
         info=dict(description="A description of the old behavior", format='markdown'))
 )
 
-class AbilityFlavorText(TableBase, LanguageSpecific):
+class AbilityFlavorText(TableBase):
     u"""In-game flavor text of an ability
     """
     __tablename__ = 'ability_flavor_text'
@@ -170,6 +153,8 @@ class AbilityFlavorText(TableBase, LanguageSpecific):
         info=dict(description="The ID of the ability"))
     version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, autoincrement=False,
         info=dict(description="The ID of the version group this flavor text is taken from"))
+    language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False,
+        info=dict(description="The language"))
     flavor_text = Column(Unicode(64), nullable=False,
         info=dict(description="The actual flavor text", official=True, format='gametext'))
 
@@ -210,7 +195,7 @@ class BerryFirmness(TableBase):
     identifier = Column(Unicode(10), nullable=False,
         info=dict(description="An identifier", format='identifier'))
 
-create_translation_table('berry_firmness_texts', BerryFirmness, 'names',
+create_translation_table('berry_firmness_names', BerryFirmness, 'names',
     name = Column(Unicode(10), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
@@ -248,10 +233,10 @@ class ContestEffect(TableBase):
         info=dict(description="The base number of hearts the user's opponent loses"))
 
 create_translation_table('contest_effect_prose', ContestEffect, 'prose',
-    effect = Column(Unicode(255), nullable=False,
-        info=dict(description="A detailed description of the effect", format='plaintext')),
     flavor_text = Column(Unicode(64), nullable=False,
         info=dict(description="The in-game description of this effect", official=True, format='gametext')),
+    effect = Column(Unicode(255), nullable=False,
+        info=dict(description="A detailed description of the effect", format='plaintext')),
 )
 
 class ContestType(TableBase):
@@ -264,13 +249,13 @@ class ContestType(TableBase):
     identifier = Column(Unicode(6), nullable=False,
         info=dict(description="An identifier", format='identifier'))
 
-create_translation_table('contest_type_texts', ContestType, 'names',
+create_translation_table('contest_type_names', ContestType, 'names',
+    name = Column(Unicode(6), nullable=False, index=True,
+        info=dict(description="The name", format='plaintext', official=True)),
     flavor = Column(Unicode(6), nullable=False,
         info=dict(description="The name of the corresponding Berry flavor", official=True, format='plaintext')),
     color = Column(Unicode(6), nullable=False,
         info=dict(description=u"The name of the corresponding Pokéblock color", official=True, format='plaintext')),
-    name = Column(Unicode(6), nullable=False, index=True,
-        info=dict(description="The name", format='plaintext', official=True)),
 )
 
 class EggGroup(TableBase):
@@ -461,7 +446,7 @@ class Generation(TableBase):
     identifier = Column(Unicode(16), nullable=False,
         info=dict(description=u'An identifier', format='identifier'))
 
-create_translation_table('generation_texts', Generation, 'names',
+create_translation_table('generation_names', Generation, 'names',
     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
@@ -507,7 +492,7 @@ class Item(TableBase):
         """
         return any(flag.identifier == u'underground' for flag in self.flags)
 
-create_translation_table('item_texts', Item, 'names',
+create_translation_table('item_names', Item, 'names',
     name = Column(Unicode(20), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
@@ -562,7 +547,7 @@ class ItemFlagMap(TableBase):
     item_flag_id = Column(Integer, ForeignKey('item_flags.id'), primary_key=True, autoincrement=False, nullable=False,
         info=dict(description="The ID of the item flag"))
 
-class ItemFlavorText(TableBase, LanguageSpecific):
+class ItemFlavorText(TableBase):
     u"""An in-game description of an item
     """
     __tablename__ = 'item_flavor_text'
@@ -571,6 +556,8 @@ class ItemFlavorText(TableBase, LanguageSpecific):
         info=dict(description="The ID of the item"))
     version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, autoincrement=False, nullable=False,
         info=dict(description="ID of the version group that sports this text"))
+    language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False,
+        info=dict(description="The language"))
     flavor_text = Column(Unicode(255), nullable=False,
         info=dict(description="The flavor text itself", official=True, format='gametext'))
 
@@ -587,15 +574,15 @@ create_translation_table('item_fling_effect_prose', ItemFlingEffect, 'prose',
         info=dict(description="Description of the effect", format='plaintext')),
 )
 
-class ItemInternalID(TableBase):
+class ItemGameIndex(TableBase):
     u"""The internal ID number a game uses for an item
     """
-    __tablename__ = 'item_internal_ids'
+    __tablename__ = 'item_game_indices'
     item_id = Column(Integer, ForeignKey('items.id'), primary_key=True, autoincrement=False, nullable=False,
         info=dict(description="The database ID of the item"))
     generation_id = Column(Integer, ForeignKey('generations.id'), primary_key=True, autoincrement=False, nullable=False,
         info=dict(description="ID of the generation of games"))
-    internal_id = Column(Integer, nullable=False,
+    game_index = Column(Integer, nullable=False,
         info=dict(description="Internal ID of the item in the generation"))
 
 class ItemPocket(TableBase):
@@ -608,7 +595,7 @@ class ItemPocket(TableBase):
     identifier = Column(Unicode(16), nullable=False,
         info=dict(description="An identifier of this pocket", format='identifier'))
 
-create_translation_table('item_pocket_texts', ItemPocket, 'names',
+create_translation_table('item_pocket_names', ItemPocket, 'names',
     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
@@ -625,7 +612,7 @@ class Location(TableBase):
     identifier = Column(Unicode(64), nullable=False,
         info=dict(description="An identifier", format='identifier'))
 
-create_translation_table('location_texts', Location, 'names',
+create_translation_table('location_names', Location, 'names',
     name = Column(Unicode(64), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
@@ -639,7 +626,7 @@ class LocationArea(TableBase):
         info=dict(description="A numeric ID"))
     location_id = Column(Integer, ForeignKey('locations.id'), nullable=False,
         info=dict(description="ID of the location this area is part of"))
-    internal_id = Column(Integer, nullable=False,
+    game_index = Column(Integer, nullable=False,
         info=dict(description="ID the games ude for this area"))
     identifier = Column(Unicode(64), nullable=True,
         info=dict(description="An identifier", format='identifier'))
@@ -661,15 +648,15 @@ class LocationAreaEncounterRate(TableBase):
     rate = Column(Integer, nullable=True,
         info=dict(description="The encounter rate"))  # units?
 
-class LocationInternalID(TableBase):
+class LocationGameIndex(TableBase):
     u"""IDs the games use internally for locations
     """
-    __tablename__ = 'location_internal_ids'
+    __tablename__ = 'location_game_indices'
     location_id = Column(Integer, ForeignKey('locations.id'), nullable=False, primary_key=True,
         info=dict(description="Database ID of the locaion"))
     generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False, primary_key=True,
         info=dict(description="ID of the generation this entry to"))
-    internal_id = Column(Integer, nullable=False,
+    game_index = Column(Integer, nullable=False,
         info=dict(description="Internal game ID of the location"))
 
 class Machine(TableBase):
@@ -814,7 +801,7 @@ create_translation_table('move_flag_type_prose', MoveFlagType, 'prose',
         info=dict(description="A short description of the flag", format='markdown')),
 )
 
-class MoveFlavorText(TableBase, LanguageSpecific):
+class MoveFlavorText(TableBase):
     u"""In-game description of a move
     """
     __tablename__ = 'move_flavor_text'
@@ -822,6 +809,8 @@ class MoveFlavorText(TableBase, LanguageSpecific):
         info=dict(description="ID of the move"))
     version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, autoincrement=False,
         info=dict(description="ID of the version group this text appears in"))
+    language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False,
+        info=dict(description="The language"))
     flavor_text = Column(Unicode(255), nullable=False,
         info=dict(description="The flavor text", official=True, format='gametext'))
 
@@ -866,7 +855,7 @@ class MoveMetaAilment(TableBase):
     identifier = Column(Unicode(24), nullable=False,
         info=dict(description="An identifier", format='identifier'))
 
-create_translation_table('move_meta_ailment_texts', MoveMetaAilment, 'names',
+create_translation_table('move_meta_ailment_names', MoveMetaAilment, 'names',
     name = Column(Unicode(24), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
@@ -946,7 +935,7 @@ class Move(TableBase):
     super_contest_effect_id = Column(Integer, ForeignKey('super_contest_effects.id'), nullable=True,
         info=dict(description="ID of the move's Super Contest effect"))
 
-create_translation_table('move_texts', Move, 'names',
+create_translation_table('move_names', Move, 'names',
     name = Column(Unicode(24), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True))
 )
@@ -998,7 +987,7 @@ class Nature(TableBase):
         """
         return self.increased_stat_id == self.decreased_stat_id
 
-create_translation_table('nature_texts', Nature, 'names',
+create_translation_table('nature_names', Nature, 'names',
     name = Column(Unicode(8), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
@@ -1040,7 +1029,7 @@ class PokeathlonStat(TableBase):
     identifier = Column(Unicode(8), nullable=False,
         info=dict(description="An identifier", format='identifier'))
 
-create_translation_table('pokeathlon_stat_texts', PokeathlonStat, 'names',
+create_translation_table('pokeathlon_stat_names', PokeathlonStat, 'names',
     name = Column(Unicode(8), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
@@ -1186,7 +1175,7 @@ class Pokemon(TableBase):
         else:
             return None
 
-create_translation_table('pokemon_texts', Pokemon, 'names',
+create_translation_table('pokemon_names', Pokemon, 'names',
     name = Column(Unicode(20), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
     species = Column(Unicode(16), nullable=False,
@@ -1220,7 +1209,7 @@ class PokemonColor(TableBase):
     identifier = Column(Unicode(6), nullable=False,
         info=dict(description=u"An identifier", format='identifier'))
 
-create_translation_table('pokemon_color_texts', PokemonColor, 'names',
+create_translation_table('pokemon_color_names', PokemonColor, 'names',
     name = Column(Unicode(6), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
@@ -1283,7 +1272,7 @@ class PokemonEvolution(TableBase):
     trade_pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=True,
         info=dict(description=u"The ID of the Pokémon for which this Pokémon must be traded."))
 
-class PokemonFlavorText(TableBase, LanguageSpecific):
+class PokemonFlavorText(TableBase):
     u"""In-game Pokédex descrption of a Pokémon.
     """
     __tablename__ = 'pokemon_flavor_text'
@@ -1291,6 +1280,8 @@ class PokemonFlavorText(TableBase, LanguageSpecific):
         info=dict(description=u"ID of the Pokémon"))
     version_id = Column(Integer, ForeignKey('versions.id'), primary_key=True, nullable=False, autoincrement=False,
         info=dict(description=u"ID of the version that has this flavor text"))
+    language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False,
+        info=dict(description="The language"))
     flavor_text = Column(Unicode(255), nullable=False,
         info=dict(description=u"ID of the version that has this flavor text", official=True, format='gametext'))
 
@@ -1346,7 +1337,7 @@ class PokemonForm(TableBase):
         else:
             return self.form_base_pokemon.name
 
-create_translation_table('pokemon_form_texts', PokemonForm, 'names',
+create_translation_table('pokemon_form_names', PokemonForm, 'names',
     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
@@ -1393,20 +1384,20 @@ class PokemonHabitat(TableBase):
     identifier = Column(Unicode(16), nullable=False,
         info=dict(description=u"An identifier", format='identifier'))
 
-create_translation_table('pokemon_habitat_texts', PokemonHabitat, 'names',
+create_translation_table('pokemon_habitat_names', PokemonHabitat, 'names',
     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
 
-class PokemonInternalID(TableBase):
+class PokemonGameIndex(TableBase):
     u"""The number of a Pokémon a game uses internally
     """
-    __tablename__ = 'pokemon_internal_ids'
+    __tablename__ = 'pokemon_game_indices'
     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, autoincrement=False, nullable=False,
         info=dict(description=u"Database ID of the Pokémon"))
     generation_id = Column(Integer, ForeignKey('generations.id'), primary_key=True, autoincrement=False, nullable=False,
         info=dict(description=u"Database ID of the generation"))
-    internal_id = Column(Integer, nullable=False,
+    game_index = Column(Integer, nullable=False,
         info=dict(description=u"Internal ID the generation's games use for the Pokémon"))
 
 class PokemonItem(TableBase):
@@ -1473,10 +1464,10 @@ class PokemonShape(TableBase):
         info=dict(description=u"An identifier", format='identifier'))
 
 create_translation_table('pokemon_shape_prose', PokemonShape, 'prose',
-    awesome_name = Column(Unicode(16), nullable=False,
-        info=dict(description=u"A splendiferous name of the body shape", format='plaintext')),
     name = Column(Unicode(24), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
+    awesome_name = Column(Unicode(16), nullable=False,
+        info=dict(description=u"A splendiferous name of the body shape", format='plaintext')),
 )
 
 class PokemonStat(TableBase):
@@ -1513,7 +1504,7 @@ class Region(TableBase):
     identifier = Column(Unicode(16), nullable=False,
         info=dict(description=u"An identifier", format='identifier'))
 
-create_translation_table('region_texts', Region, 'names',
+create_translation_table('region_names', Region, 'names',
     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
@@ -1530,7 +1521,7 @@ class Stat(TableBase):
     identifier = Column(Unicode(16), nullable=False,
         info=dict(description=u"An identifier", format='identifier'))
 
-create_translation_table('stat_texts', Stat, 'names',
+create_translation_table('stat_names', Stat, 'names',
     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
@@ -1548,7 +1539,7 @@ class StatHint(TableBase):
     gene_mod_5 = Column(Integer, nullable=False, index=True,
         info=dict(description=u"Value of the highest stat modulo 5"))
 
-create_translation_table('stat_hint_texts', StatHint, 'names',
+create_translation_table('stat_hint_names', StatHint, 'names',
     message = Column(Unicode(24), nullable=False, index=True,
         info=dict(description=u"The text displayed", official=True, format='plaintext')),
 )
@@ -1603,7 +1594,7 @@ class Type(TableBase):
     damage_class_id = Column(Integer, ForeignKey('move_damage_classes.id'), nullable=True,
         info=dict(description=u"The ID of the damage class this type's moves had before Generation IV, null if not applicable (e.g. ???)."))
 
-create_translation_table('type_texts', Type, 'names',
+create_translation_table('type_names', Type, 'names',
     name = Column(Unicode(12), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
@@ -1639,7 +1630,7 @@ class Version(TableBase):
     identifier = Column(Unicode(32), nullable=False,
         info=dict(description=u'And identifier', format='identifier'))
 
-create_translation_table('version_texts', Version, 'names',
+create_translation_table('version_names', Version, 'names',
     name = Column(Unicode(32), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
@@ -1679,6 +1670,7 @@ Ability.dream_pokemon = relation(Pokemon,
 AbilityChangelog.changed_in = relation(VersionGroup, backref='ability_changelog')
 
 AbilityFlavorText.version_group = relation(VersionGroup)
+AbilityFlavorText.language = relation(Language)
 
 Berry.berry_firmness = relation(BerryFirmness, backref='berries')
 Berry.firmness = association_proxy('berry_firmness', 'name')
@@ -1732,9 +1724,10 @@ ItemCategory.items = relation(Item, order_by=Item.identifier)
 ItemCategory.pocket = relation(ItemPocket)
 
 ItemFlavorText.version_group = relation(VersionGroup)
+ItemFlavorText.language = relation(Language)
 
-ItemInternalID.item = relation(Item, backref='internal_ids')
-ItemInternalID.generation = relation(Generation)
+ItemGameIndex.item = relation(Item, backref='game_indices')
+ItemGameIndex.generation = relation(Generation)
 
 ItemPocket.categories = relation(ItemCategory, order_by=ItemCategory.identifier)
 
@@ -1742,8 +1735,8 @@ Location.region = relation(Region, backref='locations')
 
 LocationArea.location = relation(Location, backref='areas')
 
-LocationInternalID.location = relation(Location, backref='internal_ids')
-LocationInternalID.generation = relation(Generation)
+LocationGameIndex.location = relation(Location, backref='game_indices')
+LocationGameIndex.generation = relation(Generation)
 
 Machine.item = relation(Item)
 Machine.version_group = relation(VersionGroup)
@@ -1788,6 +1781,7 @@ MoveEffectChangelog.changed_in = relation(VersionGroup, backref='move_effect_cha
 MoveFlag.flag = relation(MoveFlagType)
 
 MoveFlavorText.version_group = relation(VersionGroup)
+MoveFlavorText.language = relation(Language)
 
 MoveMeta.category = relation(MoveMetaCategory, backref='move_meta')
 MoveMeta.ailment = relation(MoveMetaAilment, backref='move_meta')
@@ -1902,6 +1896,7 @@ PokemonEvolution.trade_pokemon = relation(Pokemon,
 )
 
 PokemonFlavorText.version = relation(Version)
+PokemonFlavorText.language = relation(Language)
 
 PokemonForm.form_base_pokemon = relation(Pokemon, primaryjoin=PokemonForm.form_base_pokemon_id==Pokemon.id)
 PokemonForm.unique_pokemon = relation(Pokemon, backref=backref('unique_form', uselist=False),
@@ -1972,12 +1967,6 @@ VersionGroup.version_group_regions = relation(VersionGroupRegion, backref='versi
 VersionGroup.regions = association_proxy('version_group_regions', 'region')
 VersionGroup.pokedex = relation(Pokedex, back_populates='version_groups')
 
-
-### Add language relations
-for table in list(table_classes):
-    if issubclass(table, LanguageSpecific):
-        table.language = relation(Language, primaryjoin=table.language_id == Language.id)
-
 Move.effect = markdown.MoveEffectProperty('effect')
 Move.effect_map = markdown.MoveEffectProperty('effect_map')
 Move.short_effect = markdown.MoveEffectProperty('short_effect')