Update the pokedex.db.tables docs.

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

diff --git a/pokedex/db/tables.py b/pokedex/db/tables.py
index 1c1db60..4865363 100644 (file)
--- a/pokedex/db/tables.py
+++ b/pokedex/db/tables.py
@@ -16,13 +16,8 @@ Columns have a info dictionary with these keys:
     for translation.
   - latex: A formula in LaTeX syntax.
 
     for translation.
   - latex: A formula in LaTeX syntax.
 

-A localizable text column is visible as two properties:
-The plural-name property (e.g. Pokemon.names) is a language-to-name dictionary:
-  bulbasaur.names['en'] == "Bulbasaur" and bulbasaur.names['de'] == "Bisasam".
-  You can use Pokemon.names['en'] to filter a query.
-The singular-name property returns the name in the default language, English.
-  For example bulbasaur.name == "Bulbasaur"
-  Setting pokedex.db.tables.default_lang changes the default language.
+See `pokedex.db.multilang` for how localizable text columns work.  The session
+classes in that module can be used to change the default language.

 """
 # XXX: Check if "gametext" is set correctly everywhere
 
 """
 # XXX: Check if "gametext" is set correctly everywhere
 


@@ -72,7 +67,7 @@ TableBase = declarative_base(metadata=metadata, cls=TableSuperclass)
 ### Need Language first, to create the partial() below
 
 class Language(TableBase):
 ### Need Language first, to create the partial() below
 
 class Language(TableBase):

-    u"""A language the Pokémon games have been transleted into
+    u"""A language the Pokémon games have been translated into

     """
     __tablename__ = 'languages'
     __singlename__ = 'language'
     """
     __tablename__ = 'languages'
     __singlename__ = 'language'


@@ -111,6 +106,7 @@ class Ability(TableBase):
         info=dict(description="The ID of the generation this ability was introduced in", detail=True))
 
 create_translation_table('ability_names', Ability, 'names',
         info=dict(description="The ID of the generation this ability was introduced in", detail=True))
 
 create_translation_table('ability_names', Ability, 'names',

+    relation_lazy='joined',

     name = Column(Unicode(24), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
     name = Column(Unicode(24), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )


@@ -188,6 +184,7 @@ class BerryFirmness(TableBase):
         info=dict(description="An identifier", format='identifier'))
 
 create_translation_table('berry_firmness_names', BerryFirmness, 'names',
         info=dict(description="An identifier", format='identifier'))
 
 create_translation_table('berry_firmness_names', BerryFirmness, 'names',

+    relation_lazy='joined',

     name = Column(Unicode(10), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
     name = Column(Unicode(10), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )


@@ -242,6 +239,7 @@ class ContestType(TableBase):
         info=dict(description="An identifier", format='identifier'))
 
 create_translation_table('contest_type_names', ContestType, 'names',
         info=dict(description="An identifier", format='identifier'))
 
 create_translation_table('contest_type_names', ContestType, 'names',

+    relation_lazy='joined',

     name = Column(Unicode(6), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
     flavor = Column(Unicode(6), nullable=False,
     name = Column(Unicode(6), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
     flavor = Column(Unicode(6), nullable=False,


@@ -263,6 +261,7 @@ class EggGroup(TableBase):
         info=dict(description=u"An identifier.", format='identifier'))
 
 create_translation_table('egg_group_prose', EggGroup, 'names',
         info=dict(description=u"An identifier.", format='identifier'))
 
 create_translation_table('egg_group_prose', EggGroup, 'names',

+    relation_lazy='joined',

     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )


@@ -439,6 +438,7 @@ class Generation(TableBase):
         info=dict(description=u'An identifier', format='identifier'))
 
 create_translation_table('generation_names', Generation, 'names',
         info=dict(description=u'An identifier', format='identifier'))
 
 create_translation_table('generation_names', Generation, 'names',

+    relation_lazy='joined',

     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )


@@ -485,6 +485,7 @@ class Item(TableBase):
         return any(flag.identifier == u'underground' for flag in self.flags)
 
 create_translation_table('item_names', Item, 'names',
         return any(flag.identifier == u'underground' for flag in self.flags)
 
 create_translation_table('item_names', Item, 'names',

+    relation_lazy='joined',

     name = Column(Unicode(20), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
     name = Column(Unicode(20), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )


@@ -509,6 +510,7 @@ class ItemCategory(TableBase):
         info=dict(description="An identifier", format='identifier'))
 
 create_translation_table('item_category_prose', ItemCategory, 'prose',
         info=dict(description="An identifier", format='identifier'))
 
 create_translation_table('item_category_prose', ItemCategory, 'prose',

+    relation_lazy='joined',

     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
 )
     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
 )


@@ -588,6 +590,7 @@ class ItemPocket(TableBase):
         info=dict(description="An identifier of this pocket", format='identifier'))
 
 create_translation_table('item_pocket_names', ItemPocket, 'names',
         info=dict(description="An identifier of this pocket", format='identifier'))
 
 create_translation_table('item_pocket_names', ItemPocket, 'names',

+    relation_lazy='joined',

     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )


@@ -605,6 +608,7 @@ class Location(TableBase):
         info=dict(description="An identifier", format='identifier'))
 
 create_translation_table('location_names', Location, 'names',
         info=dict(description="An identifier", format='identifier'))
 
 create_translation_table('location_names', Location, 'names',

+    relation_lazy='joined',

     name = Column(Unicode(64), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
     name = Column(Unicode(64), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )


@@ -624,6 +628,7 @@ class LocationArea(TableBase):
         info=dict(description="An identifier", format='identifier'))
 
 create_translation_table('location_area_prose', LocationArea, 'prose',
         info=dict(description="An identifier", format='identifier'))
 
 create_translation_table('location_area_prose', LocationArea, 'prose',

+    relation_lazy='joined',

     name = Column(Unicode(64), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
 )
     name = Column(Unicode(64), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
 )


@@ -680,6 +685,7 @@ class MoveBattleStyle(TableBase):
         info=dict(description="An identifier", format='identifier'))
 
 create_translation_table('move_battle_style_prose', MoveBattleStyle, 'prose',
         info=dict(description="An identifier", format='identifier'))
 
 create_translation_table('move_battle_style_prose', MoveBattleStyle, 'prose',

+    relation_lazy='joined',

     name = Column(Unicode(8), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
 )
     name = Column(Unicode(8), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
 )


@@ -723,6 +729,7 @@ class MoveDamageClass(TableBase):
         info=dict(description="An identifier", format='identifier'))
 
 create_translation_table('move_damage_class_prose', MoveDamageClass, 'prose',
         info=dict(description="An identifier", format='identifier'))
 
 create_translation_table('move_damage_class_prose', MoveDamageClass, 'prose',

+    relation_lazy='joined',

     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
     description = Column(Unicode(64), nullable=False,
     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
     description = Column(Unicode(64), nullable=False,


@@ -787,6 +794,7 @@ class MoveFlagType(TableBase):
         info=dict(description="A short identifier for the flag", format='identifier'))
 
 create_translation_table('move_flag_type_prose', MoveFlagType, 'prose',
         info=dict(description="A short identifier for the flag", format='identifier'))
 
 create_translation_table('move_flag_type_prose', MoveFlagType, 'prose',

+    relation_lazy='joined',

     name = Column(Unicode(32), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
     description = Column(markdown.MarkdownColumn(128), nullable=False,
     name = Column(Unicode(32), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
     description = Column(markdown.MarkdownColumn(128), nullable=False,


@@ -848,6 +856,7 @@ class MoveMetaAilment(TableBase):
         info=dict(description="An identifier", format='identifier'))
 
 create_translation_table('move_meta_ailment_names', MoveMetaAilment, 'names',
         info=dict(description="An identifier", format='identifier'))
 
 create_translation_table('move_meta_ailment_names', MoveMetaAilment, 'names',

+    relation_lazy='joined',

     name = Column(Unicode(24), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
     name = Column(Unicode(24), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )


@@ -860,6 +869,7 @@ class MoveMetaCategory(TableBase):
         info=dict(description="A numeric ID"))
 
 create_translation_table('move_meta_category_prose', MoveMetaCategory, 'prose',
         info=dict(description="A numeric ID"))
 
 create_translation_table('move_meta_category_prose', MoveMetaCategory, 'prose',

+    relation_lazy='joined',

     description = Column(Unicode(64), nullable=False,
         info=dict(description="A description of the category")),
 )
     description = Column(Unicode(64), nullable=False,
         info=dict(description="A description of the category")),
 )


@@ -885,6 +895,7 @@ class MoveTarget(TableBase):
         info=dict(description="An identifier", format='identifier'))
 
 create_translation_table('move_target_prose', MoveTarget, 'prose',
         info=dict(description="An identifier", format='identifier'))
 
 create_translation_table('move_target_prose', MoveTarget, 'prose',

+    relation_lazy='joined',

     name = Column(Unicode(32), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
     description = Column(Unicode(128), nullable=False,
     name = Column(Unicode(32), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
     description = Column(Unicode(128), nullable=False,


@@ -928,6 +939,7 @@ class Move(TableBase):
         info=dict(description="ID of the move's Super Contest effect"))
 
 create_translation_table('move_names', Move, 'names',
         info=dict(description="ID of the move's Super Contest effect"))
 
 create_translation_table('move_names', Move, 'names',

+    relation_lazy='joined',

     name = Column(Unicode(24), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True))
 )
     name = Column(Unicode(24), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True))
 )


@@ -980,6 +992,7 @@ class Nature(TableBase):
         return self.increased_stat_id == self.decreased_stat_id
 
 create_translation_table('nature_names', Nature, 'names',
         return self.increased_stat_id == self.decreased_stat_id
 
 create_translation_table('nature_names', Nature, 'names',

+    relation_lazy='joined',

     name = Column(Unicode(8), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
     name = Column(Unicode(8), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )


@@ -1039,6 +1052,7 @@ class Pokedex(TableBase):
         info=dict(description=u"An identifier", format='identifier'))
 
 create_translation_table('pokedex_prose', Pokedex, 'prose',
         info=dict(description=u"An identifier", format='identifier'))
 
 create_translation_table('pokedex_prose', Pokedex, 'prose',

+    relation_lazy='joined',

     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
     description = Column(Unicode(512), nullable=False,
     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
     description = Column(Unicode(512), nullable=False,


@@ -1168,6 +1182,7 @@ class Pokemon(TableBase):
             return None
 
 create_translation_table('pokemon_names', Pokemon, 'names',
             return None
 
 create_translation_table('pokemon_names', Pokemon, 'names',

+    relation_lazy='joined',

     name = Column(Unicode(20), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
     species = Column(Unicode(16), nullable=False,
     name = Column(Unicode(20), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
     species = Column(Unicode(16), nullable=False,


@@ -1202,6 +1217,7 @@ class PokemonColor(TableBase):
         info=dict(description=u"An identifier", format='identifier'))
 
 create_translation_table('pokemon_color_names', PokemonColor, 'names',
         info=dict(description=u"An identifier", format='identifier'))
 
 create_translation_table('pokemon_color_names', PokemonColor, 'names',

+    relation_lazy='joined',

     name = Column(Unicode(6), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
     name = Column(Unicode(6), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )


@@ -1330,6 +1346,7 @@ class PokemonForm(TableBase):
             return self.form_base_pokemon.name
 
 create_translation_table('pokemon_form_names', PokemonForm, 'names',
             return self.form_base_pokemon.name
 
 create_translation_table('pokemon_form_names', PokemonForm, 'names',

+    relation_lazy='joined',

     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )


@@ -1377,6 +1394,7 @@ class PokemonHabitat(TableBase):
         info=dict(description=u"An identifier", format='identifier'))
 
 create_translation_table('pokemon_habitat_names', PokemonHabitat, 'names',
         info=dict(description=u"An identifier", format='identifier'))
 
 create_translation_table('pokemon_habitat_names', PokemonHabitat, 'names',

+    relation_lazy='joined',

     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )


@@ -1438,6 +1456,7 @@ class PokemonMoveMethod(TableBase):
         info=dict(description=u"An identifier", format='identifier'))
 
 create_translation_table('pokemon_move_method_prose', PokemonMoveMethod, 'prose',
         info=dict(description=u"An identifier", format='identifier'))
 
 create_translation_table('pokemon_move_method_prose', PokemonMoveMethod, 'prose',

+    relation_lazy='joined',

     name = Column(Unicode(64), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
     description = Column(Unicode(255), nullable=False,
     name = Column(Unicode(64), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
     description = Column(Unicode(255), nullable=False,


@@ -1456,6 +1475,7 @@ class PokemonShape(TableBase):
         info=dict(description=u"An identifier", format='identifier'))
 
 create_translation_table('pokemon_shape_prose', PokemonShape, 'prose',
         info=dict(description=u"An identifier", format='identifier'))
 
 create_translation_table('pokemon_shape_prose', PokemonShape, 'prose',

+    relation_lazy='joined',

     name = Column(Unicode(24), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
     awesome_name = Column(Unicode(16), nullable=False,
     name = Column(Unicode(24), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
     awesome_name = Column(Unicode(16), nullable=False,


@@ -1497,6 +1517,7 @@ class Region(TableBase):
         info=dict(description=u"An identifier", format='identifier'))
 
 create_translation_table('region_names', Region, 'names',
         info=dict(description=u"An identifier", format='identifier'))
 
 create_translation_table('region_names', Region, 'names',

+    relation_lazy='joined',

     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )


@@ -1514,6 +1535,7 @@ class Stat(TableBase):
         info=dict(description=u"An identifier", format='identifier'))
 
 create_translation_table('stat_names', Stat, 'names',
         info=dict(description=u"An identifier", format='identifier'))
 
 create_translation_table('stat_names', Stat, 'names',

+    relation_lazy='joined',

     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
     name = Column(Unicode(16), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )


@@ -1532,6 +1554,7 @@ class StatHint(TableBase):
         info=dict(description=u"Value of the highest stat modulo 5"))
 
 create_translation_table('stat_hint_names', StatHint, 'names',
         info=dict(description=u"Value of the highest stat modulo 5"))
 
 create_translation_table('stat_hint_names', StatHint, 'names',

+    relation_lazy='joined',

     message = Column(Unicode(24), nullable=False, index=True,
         info=dict(description=u"The text displayed", official=True, format='plaintext')),
 )
     message = Column(Unicode(24), nullable=False, index=True,
         info=dict(description=u"The text displayed", official=True, format='plaintext')),
 )


@@ -1587,6 +1610,7 @@ class Type(TableBase):
         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_names', Type, 'names',
         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_names', Type, 'names',

+    relation_lazy='joined',

     name = Column(Unicode(12), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
     name = Column(Unicode(12), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )


@@ -1623,6 +1647,7 @@ class Version(TableBase):
         info=dict(description=u'And identifier', format='identifier'))
 
 create_translation_table('version_names', Version, 'names',
         info=dict(description=u'And identifier', format='identifier'))
 
 create_translation_table('version_names', Version, 'names',

+    relation_lazy='joined',

     name = Column(Unicode(32), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )
     name = Column(Unicode(32), nullable=False, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
 )