Added identifiers for move meta categories.

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

diff --git a/pokedex/db/tables.py b/pokedex/db/tables.py
index 8e4ca42..08a9809 100644 (file)
--- a/pokedex/db/tables.py
+++ b/pokedex/db/tables.py
@@ -62,6 +62,9 @@ class TableSuperclass(object):
     def __str__(self):
         return unicode(self).encode('utf8')
 
+    def __repr__(self):
+        return unicode(self).encode('utf8')
+
 mapped_classes = []
 class TableMetaclass(DeclarativeMeta):
     def __init__(cls, name, bases, attrs):
@@ -121,9 +124,9 @@ create_translation_table('ability_names', Ability, 'names',
         info=dict(description="The name", format='plaintext', official=True, ripped=True)),
 )
 create_translation_table('ability_prose', Ability, 'prose',
-    effect = Column(markdown.MarkdownColumn(5120), nullable=False,
+    effect = Column(markdown.MarkdownColumn(5120), nullable=True,
         info=dict(description="A detailed description of this ability's effect", format='markdown')),
-    short_effect = Column(markdown.MarkdownColumn(255), nullable=False,
+    short_effect = Column(markdown.MarkdownColumn(255), nullable=True,
         info=dict(description="A short summary of this ability's effect", format='markdown')),
 )
 
@@ -232,9 +235,9 @@ class ContestEffect(TableBase):
         info=dict(description="The base number of hearts the user's opponent loses"))
 
 create_translation_table('contest_effect_prose', ContestEffect, 'prose',
-    flavor_text = Column(Unicode(64), nullable=False,
+    flavor_text = Column(Unicode(64), nullable=True,
         info=dict(description="The in-game description of this effect", official=True, format='gametext')),
-    effect = Column(Unicode(255), nullable=False,
+    effect = Column(Unicode(255), nullable=True,
         info=dict(description="A detailed description of the effect", format='plaintext')),
 )
 
@@ -250,11 +253,11 @@ class ContestType(TableBase):
 
 create_translation_table('contest_type_names', ContestType, 'names',
     relation_lazy='joined',
-    name = Column(Unicode(6), nullable=False, index=True,
+    name = Column(Unicode(6), nullable=True, index=True,
         info=dict(description="The name", format='plaintext', official=True)),
-    flavor = Column(Unicode(6), nullable=False,
+    flavor = Column(Unicode(6), nullable=True,
         info=dict(description="The name of the corresponding Berry flavor", official=True, format='plaintext')),
-    color = Column(Unicode(6), nullable=False,
+    color = Column(Unicode(6), nullable=True,
         info=dict(description=u"The name of the corresponding Pokéblock color", official=True, format='plaintext')),
 )
 
@@ -285,10 +288,10 @@ class Encounter(TableBase):
     "slot" they are in and the state of the game world.
 
     What the player is doing to get an encounter, such as surfing or walking
-    through tall grass, is called terrain.  Each terrain has its own set of
+    through tall grass, is called a method.  Each method has its own set of
     encounter slots.
 
-    Within a terrain, slots are defined primarily by rarity.  Each slot can
+    Within a method, slots are defined primarily by rarity.  Each slot can
     also be affected by world conditions; for example, the 20% slot for walking
     in tall grass is affected by whether a swarm is in effect in that area.
     "Is there a swarm?" is a condition; "there is a swarm" and "there is not a
@@ -308,7 +311,7 @@ class Encounter(TableBase):
     location_area_id = Column(Integer, ForeignKey('location_areas.id'), nullable=False, autoincrement=False,
         info=dict(description="The ID of the location of this encounter"))
     encounter_slot_id = Column(Integer, ForeignKey('encounter_slots.id'), nullable=False, autoincrement=False,
-        info=dict(description="The ID of the encounter slot, which determines terrain and rarity"))
+        info=dict(description="The ID of the encounter slot, which determines method and rarity"))
     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=False, autoincrement=False,
         info=dict(description=u"The ID of the encountered Pokémon"))
     min_level = Column(Integer, nullable=False, autoincrement=False,
@@ -361,8 +364,24 @@ class EncounterConditionValueMap(TableBase):
     encounter_condition_value_id = Column(Integer, ForeignKey('encounter_condition_values.id'), primary_key=True, nullable=False, autoincrement=False,
         info=dict(description="The ID of the encounter condition value"))
 
+class EncounterMethod(TableBase):
+    u"""A way the player can enter a wild encounter, e.g., surfing, fishing, or walking through tall grass.
+    """
+
+    __tablename__ = 'encounter_methods'
+    __singlename__ = 'encounter_method'
+    id = Column(Integer, primary_key=True, nullable=False,
+        info=dict(description="A unique ID for the method"))
+    identifier = Column(Unicode(16), nullable=False, unique=True,
+        info=dict(description="An identifier", format='identifier'))
+
+create_translation_table('encounter_method_prose', EncounterMethod, 'prose',
+    name = Column(Unicode(64), nullable=False, index=True,
+        info=dict(description="The name", format='plaintext', official=False)),
+)
+
 class EncounterSlot(TableBase):
-    u"""An abstract "slot" within a terrain, associated with both some set of conditions and a rarity.
+    u"""An abstract "slot" within a method, associated with both some set of conditions and a rarity.
 
     Note that there are two encounters per slot, so the rarities will only add
     up to 50.
@@ -373,29 +392,13 @@ class EncounterSlot(TableBase):
         info=dict(description="A unique ID for this slot"))
     version_group_id = Column(Integer, ForeignKey('version_groups.id'), nullable=False, autoincrement=False,
         info=dict(description="The ID of the version group this slot is in"))
-    encounter_terrain_id = Column(Integer, ForeignKey('encounter_terrain.id'), primary_key=False, nullable=False, autoincrement=False,
-        info=dict(description="The ID of the terrain"))
+    encounter_method_id = Column(Integer, ForeignKey('encounter_methods.id'), primary_key=False, nullable=False, autoincrement=False,
+        info=dict(description="The ID of the method"))
     slot = Column(Integer, nullable=True,
-        info=dict(description="This slot's order for the location and terrain"))
-    rarity = Column(Integer, nullable=False,
+        info=dict(description="This slot's order for the location and method"))
+    rarity = Column(Integer, nullable=True,
         info=dict(description="The chance of the encounter as a percentage"))
 
-class EncounterTerrain(TableBase):
-    u"""A way the player can enter a wild encounter, e.g., surfing, fishing, or walking through tall grass.
-    """
-
-    __tablename__ = 'encounter_terrain'
-    __singlename__ = __tablename__
-    id = Column(Integer, primary_key=True, nullable=False,
-        info=dict(description="A unique ID for the terrain"))
-    identifier = Column(Unicode(64), nullable=False,
-        info=dict(description="An identifier", format='identifier'))
-
-create_translation_table('encounter_terrain_prose', EncounterTerrain, 'prose',
-    name = Column(Unicode(64), nullable=False, index=True,
-        info=dict(description="The name", format='plaintext', official=False)),
-)
-
 class EvolutionChain(TableBase):
     u"""A family of Pokémon that are linked by evolution
     """
@@ -500,9 +503,9 @@ create_translation_table('item_names', Item, 'names',
         info=dict(description="The name", format='plaintext', official=True, ripped=True)),
 )
 create_translation_table('item_prose', Item, 'prose',
-    short_effect = Column(markdown.MarkdownColumn(256), nullable=False,
-        info=dict(description="A short summary of the effect", format='plaintext')),
-    effect = Column(markdown.MarkdownColumn(5120), nullable=False,
+    short_effect = Column(markdown.MarkdownColumn(256), nullable=True,
+        info=dict(description="A short summary of the effect", format='markdown')),
+    effect = Column(markdown.MarkdownColumn(5120), nullable=True,
         info=dict(description=u"Detailed description of the item's effect.", format='markdown')),
 )
 create_translation_table('item_flavor_summaries', Item, 'flavor_summaries',
@@ -540,9 +543,9 @@ class ItemFlag(TableBase):
         info=dict(description="Identifier of the flag", format='identifier'))
 
 create_translation_table('item_flag_prose', ItemFlag, 'prose',
-    name = Column(Unicode(24), nullable=False, index=True,
+    name = Column(Unicode(24), nullable=True, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
-    description = Column(Unicode(64), nullable=False,
+    description = Column(Unicode(64), nullable=True,
         info=dict(description="Short description of the flag", format='plaintext')),
 )
 
@@ -653,8 +656,8 @@ class LocationAreaEncounterRate(TableBase):
     __tablename__ = 'location_area_encounter_rates'
     location_area_id = Column(Integer, ForeignKey('location_areas.id'), primary_key=True, nullable=False, autoincrement=False,
         info=dict(description="ID of the area"))
-    encounter_terrain_id = Column(Integer, ForeignKey('encounter_terrain.id'), primary_key=True, nullable=False, autoincrement=False,
-        info=dict(description="ID of the terrain"))
+    encounter_method_id = Column(Integer, ForeignKey('encounter_methods.id'), primary_key=True, nullable=False, autoincrement=False,
+        info=dict(description="ID of the method"))
     version_id = Column(Integer, ForeignKey('versions.id'), primary_key=True, autoincrement=False,
         info=dict(description="ID of the version"))
     rate = Column(Integer, nullable=True,
@@ -784,9 +787,9 @@ class MoveDamageClass(TableBase):
 
 create_translation_table('move_damage_class_prose', MoveDamageClass, 'prose',
     relation_lazy='joined',
-    name = Column(Unicode(16), nullable=False, index=True,
+    name = Column(Unicode(16), nullable=True, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
-    description = Column(Unicode(64), nullable=False,
+    description = Column(Unicode(64), nullable=True,
         info=dict(description="A description of the class", format='plaintext')),
 )
 
@@ -799,9 +802,9 @@ class MoveEffect(TableBase):
         info=dict(description="A numeric ID"))
 
 create_translation_table('move_effect_prose', MoveEffect, 'prose',
-    short_effect = Column(Unicode(256), nullable=False,
+    short_effect = Column(Unicode(256), nullable=True,
         info=dict(description="A short summary of the effect", format='plaintext')),
-    effect = Column(Unicode(5120), nullable=False,
+    effect = Column(Unicode(5120), nullable=True,
         info=dict(description="A detailed description of the effect", format='plaintext')),
 )
 
@@ -877,9 +880,9 @@ class MoveFlagType(TableBase):
 
 create_translation_table('move_flag_type_prose', MoveFlagType, 'prose',
     relation_lazy='joined',
-    name = Column(Unicode(32), nullable=False, index=True,
+    name = Column(Unicode(32), nullable=True, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
-    description = Column(markdown.MarkdownColumn(128), nullable=False,
+    description = Column(markdown.MarkdownColumn(128), nullable=True,
         info=dict(description="A short description of the flag", format='markdown')),
 )
 
@@ -935,7 +938,7 @@ class MoveMetaAilment(TableBase):
     __singlename__ = 'move_meta_ailment'
     id = Column(Integer, primary_key=True, nullable=False, autoincrement=False,
         info=dict(description="A numeric ID"))
-    identifier = Column(Unicode(24), nullable=False,
+    identifier = Column(Unicode(24), nullable=False, index=True, unique=True,
         info=dict(description="An identifier", format='identifier'))
 
 create_translation_table('move_meta_ailment_names', MoveMetaAilment, 'names',
@@ -950,6 +953,8 @@ class MoveMetaCategory(TableBase):
     __singlename__ = 'move_meta_category'
     id = Column(Integer, primary_key=True, nullable=False,
         info=dict(description="A numeric ID"))
+    identifier = Column(Unicode(32), nullable=False, index=True, unique=True,
+        info=dict(description="An identifier", format='identifier'))
 
 create_translation_table('move_meta_category_prose', MoveMetaCategory, 'prose',
     relation_lazy='joined',
@@ -979,9 +984,9 @@ class MoveTarget(TableBase):
 
 create_translation_table('move_target_prose', MoveTarget, 'prose',
     relation_lazy='joined',
-    name = Column(Unicode(32), nullable=False, index=True,
+    name = Column(Unicode(32), nullable=True, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
-    description = Column(Unicode(128), nullable=False,
+    description = Column(Unicode(128), nullable=True,
         info=dict(description="A description", format='plaintext')),
 )
 
@@ -1072,9 +1077,9 @@ class Pokedex(TableBase):
 
 create_translation_table('pokedex_prose', Pokedex, 'prose',
     relation_lazy='joined',
-    name = Column(Unicode(16), nullable=False, index=True,
+    name = Column(Unicode(16), nullable=True, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
-    description = Column(Unicode(512), nullable=False,
+    description = Column(Unicode(512), nullable=True,
         info=dict(description=u"A longer description of the Pokédex", format='plaintext')),
 )
 
@@ -1202,9 +1207,9 @@ class Pokemon(TableBase):
 
 create_translation_table('pokemon_names', Pokemon, 'names',
     relation_lazy='joined',
-    name = Column(Unicode(20), nullable=False, index=True,
+    name = Column(Unicode(20), nullable=True, index=True,
         info=dict(description="The name", format='plaintext', official=True, ripped=True)),
-    species = Column(Unicode(16), nullable=False,
+    species = Column(Unicode(16), nullable=True,
         info=dict(description=u'The short flavor text, such as "Seed" or "Lizard"; usually affixed with the word "Pokémon"',
         official=True, format='plaintext')),
 )
@@ -1389,7 +1394,7 @@ PokemonFormGroup.id = PokemonFormGroup.pokemon_id
 create_translation_table('pokemon_form_group_prose', PokemonFormGroup, 'prose',
     term = Column(Unicode(16), nullable=True,
         info=dict(description=u"The term for this Pokémon's forms, e.g. \"Cloak\" for Burmy or \"Forme\" for Deoxys.", official=True, format='plaintext')),
-    description = Column(markdown.MarkdownColumn(1024), nullable=False,
+    description = Column(markdown.MarkdownColumn(1024), nullable=True,
         info=dict(description=u"Description of how the forms work", format='markdown')),
 )
 
@@ -1481,9 +1486,9 @@ class PokemonMoveMethod(TableBase):
 
 create_translation_table('pokemon_move_method_prose', PokemonMoveMethod, 'prose',
     relation_lazy='joined',
-    name = Column(Unicode(64), nullable=False, index=True,
+    name = Column(Unicode(64), nullable=True, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
-    description = Column(Unicode(255), nullable=False,
+    description = Column(Unicode(255), nullable=True,
         info=dict(description=u"A detailed description of how the method works", format='plaintext')),
 )
 
@@ -1499,9 +1504,9 @@ class PokemonShape(TableBase):
 
 create_translation_table('pokemon_shape_prose', PokemonShape, 'prose',
     relation_lazy='joined',
-    name = Column(Unicode(24), nullable=False, index=True,
+    name = Column(Unicode(24), nullable=True, index=True,
         info=dict(description="The name", format='plaintext', official=False)),
-    awesome_name = Column(Unicode(16), nullable=False,
+    awesome_name = Column(Unicode(16), nullable=True,
         info=dict(description=u"A splendiferous name of the body shape", format='plaintext')),
 )
 
@@ -1744,7 +1749,7 @@ EncounterConditionValueMap.condition_value = relation(EncounterConditionValue,
     innerjoin=True, lazy='joined',
     backref='encounter_map')
 
-EncounterSlot.terrain = relation(EncounterTerrain,
+EncounterSlot.method = relation(EncounterMethod,
     innerjoin=True, lazy='joined',
     backref='slots')
 EncounterSlot.version_group = relation(VersionGroup, innerjoin=True)
@@ -1821,6 +1826,12 @@ LocationArea.location = relation(Location,
     innerjoin=True, lazy='joined',
     backref='areas')
 
+LocationAreaEncounterRate.location_area = relation(LocationArea,
+    innerjoin=True,
+    backref='encounter_rates')
+LocationAreaEncounterRate.method = relation(EncounterMethod,
+    innerjoin=True)
+
 LocationGameIndex.location = relation(Location,
     innerjoin=True, lazy='joined',
     backref='game_indices')