pokedex/db/tables.py

   1 # encoding: utf8
   2
   3 u"""The Pokédex schema
   4
   5 Columns have a info dictionary with these keys:
   6 - description: The description of the column
   7 - official: True if the values appear in games or official material; False if
   8   they are fan-created or fan-written. This flag is currently only set for
   9   official text columns.
  10 - markup: The format of a text column. Can be one of:
  11   - plaintext: Normal Unicode text (widely used in names)
  12   - markdown: Veekun's Markdown flavor (generally used in effect descriptions)
  13   - gametext: Transcription of in-game text that strives to be both
  14     human-readable and represent the original text exactly.
  15   - identifier: A fan-made identifier in the [-_a-z0-9]* format. Not intended
  16     for translation.
  17   - latex: A formula in LaTeX syntax.
  18 - ripped: True for text that has been ripped from the games, and can be ripped
  19   again for new versions or languages
  20
  21 See `pokedex.db.multilang` for how localizable text columns work.  The session
  22 classes in that module can be used to change the default language.
  23 """
  24 # XXX: Check if "gametext" is set correctly everywhere
  25
  26 import collections
  27 from functools import partial
  28
  29 from sqlalchemy import Column, ForeignKey, MetaData, PrimaryKeyConstraint, Table, UniqueConstraint
  30 from sqlalchemy.ext.declarative import declarative_base, DeclarativeMeta
  31 from sqlalchemy.ext.associationproxy import association_proxy
  32 from sqlalchemy.orm import backref, relation
  33 from sqlalchemy.orm.session import Session
  34 from sqlalchemy.orm.interfaces import AttributeExtension
  35 from sqlalchemy.sql import and_
  36 from sqlalchemy.schema import ColumnDefault
  37 from sqlalchemy.types import *
  38
  39 from pokedex.db import markdown, multilang
  40
  41 class TableSuperclass(object):
  42     """Superclass for declarative tables, to give them some generic niceties
  43     like stringification.
  44     """
  45     def __unicode__(self):
  46         """Be as useful as possible.  Show the primary key, and an identifier
  47         if we've got one.
  48         """
  49         typename = u'.'.join((__name__, type(self).__name__))
  50
  51         pk_constraint = self.__table__.primary_key
  52         if not pk_constraint:
  53             return u"<%s object at %x>" % (typename, id(self))
  54
  55         pk = u', '.join(unicode(getattr(self, column.name))
  56             for column in pk_constraint.columns)
  57         try:
  58             return u"<%s object (%s): %s>" % (typename, pk, self.identifier)
  59         except AttributeError:
  60             return u"<%s object (%s)>" % (typename, pk)
  61
  62     def __str__(self):
  63         return unicode(self).encode('utf8')
  64
  65     def __repr__(self):
  66         return unicode(self).encode('utf8')
  67
  68 mapped_classes = []
  69 class TableMetaclass(DeclarativeMeta):
  70     def __init__(cls, name, bases, attrs):
  71         super(TableMetaclass, cls).__init__(name, bases, attrs)
  72         if hasattr(cls, '__tablename__'):
  73             mapped_classes.append(cls)
  74             cls.translation_classes = []
  75
  76 metadata = MetaData()
  77 TableBase = declarative_base(metadata=metadata, cls=TableSuperclass, metaclass=TableMetaclass)
  78
  79
  80 ### Need Language first, to create the partial() below
  81
  82 class Language(TableBase):
  83     u"""A language the Pokémon games have been translated into
  84     """
  85     __tablename__ = 'languages'
  86     __singlename__ = 'language'
  87     id = Column(Integer, primary_key=True, nullable=False,
  88         info=dict(description="A numeric ID"))
  89     iso639 = Column(Unicode(2), nullable=False,
  90         info=dict(description="The two-letter code of the country where this language is spoken. Note that it is not unique.", format='identifier'))
  91     iso3166 = Column(Unicode(2), nullable=False,
  92         info=dict(description="The two-letter code of the language. Note that it is not unique.", format='identifier'))
  93     identifier = Column(Unicode(16), nullable=False,
  94         info=dict(description="An identifier", format='identifier'))
  95     official = Column(Boolean, nullable=False, index=True,
  96         info=dict(description=u"True iff games are produced in the language."))
  97     order = Column(Integer, nullable=True,
  98         info=dict(description=u"Order for sorting in foreign name lists."))
  99
 100 create_translation_table = partial(multilang.create_translation_table, language_class=Language)
 101
 102 create_translation_table('language_names', Language, 'names',
 103     name = Column(Unicode(16), nullable=False, index=True,
 104         info=dict(description="The name", format='plaintext', official=True)),
 105 )
 106
 107 ### The actual tables
 108
 109 class Ability(TableBase):
 110     u"""An ability a Pokémon can have, such as Static or Pressure.
 111     """
 112     __tablename__ = 'abilities'
 113     __singlename__ = 'ability'
 114     id = Column(Integer, primary_key=True, nullable=False,
 115         info=dict(description="This ability's unique ID; matches the games' internal ID"))
 116     identifier = Column(Unicode(24), nullable=False,
 117         info=dict(description="An identifier", format='identifier'))
 118     generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False,
 119         info=dict(description="The ID of the generation this ability was introduced in", detail=True))
 120
 121 create_translation_table('ability_names', Ability, 'names',
 122     relation_lazy='joined',
 123     name = Column(Unicode(24), nullable=False, index=True,
 124         info=dict(description="The name", format='plaintext', official=True, ripped=True)),
 125 )
 126 create_translation_table('ability_prose', Ability, 'prose',
 127     effect = Column(markdown.MarkdownColumn(5120), nullable=True,
 128         info=dict(description="A detailed description of this ability's effect", format='markdown')),
 129     short_effect = Column(markdown.MarkdownColumn(255), nullable=True,
 130         info=dict(description="A short summary of this ability's effect", format='markdown')),
 131 )
 132
 133 class AbilityChangelog(TableBase):
 134     """History of changes to abilities across main game versions."""
 135     __tablename__ = 'ability_changelog'
 136     __singlename__ = 'ability_changelog'
 137     id = Column(Integer, primary_key=True, nullable=False,
 138         info=dict(description="This change's unique ID"))
 139     ability_id = Column(Integer, ForeignKey('abilities.id'), nullable=False,
 140         info=dict(description="The ID of the ability that changed"))
 141     changed_in_version_group_id = Column(Integer, ForeignKey('version_groups.id'), nullable=False,
 142         info=dict(description="The ID of the version group in which the ability changed"))
 143
 144 create_translation_table('ability_changelog_prose', AbilityChangelog, 'prose',
 145     effect = Column(markdown.MarkdownColumn(255), nullable=False,
 146         info=dict(description="A description of the old behavior", format='markdown'))
 147 )
 148
 149 class AbilityFlavorText(TableBase):
 150     u"""In-game flavor text of an ability
 151     """
 152     __tablename__ = 'ability_flavor_text'
 153     ability_id = Column(Integer, ForeignKey('abilities.id'), primary_key=True, nullable=False, autoincrement=False,
 154         info=dict(description="The ID of the ability"))
 155     version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, autoincrement=False,
 156         info=dict(description="The ID of the version group this flavor text is taken from"))
 157     language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False,
 158         info=dict(description="The language"))
 159     flavor_text = Column(Unicode(64), nullable=False,
 160         info=dict(description="The actual flavor text", official=True, format='gametext'))
 161
 162 class Berry(TableBase):
 163     u"""A Berry, consumable item that grows on trees
 164
 165     For data common to all items, such as the name, see the corresponding item entry.
 166     """
 167     __tablename__ = 'berries'
 168     id = Column(Integer, primary_key=True, nullable=False,
 169         info=dict(description="This Berry's in-game number"))
 170     item_id = Column(Integer, ForeignKey('items.id'), nullable=False,
 171         info=dict(description="The ID of the item that represents this Berry"))
 172     firmness_id = Column(Integer, ForeignKey('berry_firmness.id'), nullable=False,
 173         info=dict(description="The ID of this Berry's firmness category"))
 174     natural_gift_power = Column(Integer, nullable=True,
 175         info=dict(description="Natural Gift's power when used with this Berry"))
 176     natural_gift_type_id = Column(Integer, ForeignKey('types.id'), nullable=True,
 177         info=dict(description="The ID of the Type that Natural Gift has when used with this Berry"))
 178     size = Column(Integer, nullable=False,
 179         info=dict(description=u"The size of this Berry, in millimeters"))
 180     max_harvest = Column(Integer, nullable=False,
 181         info=dict(description="The maximum number of these berries that can grow on one tree in Generation IV"))
 182     growth_time = Column(Integer, nullable=False,
 183         info=dict(description="Time it takes the tree to grow one stage, in hours.  Berry trees go through four of these growth stages before they can be picked."))
 184     soil_dryness = Column(Integer, nullable=False,
 185         info=dict(description="The speed at which this Berry dries out the soil as it grows.  A higher rate means the soil dries more quickly."))
 186     smoothness = Column(Integer, nullable=False,
 187         info=dict(description="The smoothness of this Berry, used in making Pokéblocks or Poffins"))
 188
 189 class BerryFirmness(TableBase):
 190     u"""A Berry firmness, such as "hard" or "very soft".
 191     """
 192     __tablename__ = 'berry_firmness'
 193     __singlename__ = 'berry_firmness'
 194     id = Column(Integer, primary_key=True, nullable=False,
 195         info=dict(description="A unique ID for this firmness"))
 196     identifier = Column(Unicode(10), nullable=False,
 197         info=dict(description="An identifier", format='identifier'))
 198
 199 create_translation_table('berry_firmness_names', BerryFirmness, 'names',
 200     relation_lazy='joined',
 201     name = Column(Unicode(10), nullable=False, index=True,
 202         info=dict(description="The name", format='plaintext', official=True)),
 203 )
 204
 205 class BerryFlavor(TableBase):
 206     u"""A Berry flavor level.
 207     """
 208     __tablename__ = 'berry_flavors'
 209     berry_id = Column(Integer, ForeignKey('berries.id'), primary_key=True, nullable=False, autoincrement=False,
 210         info=dict(description="The ID of the berry"))
 211     contest_type_id = Column(Integer, ForeignKey('contest_types.id'), primary_key=True, nullable=False, autoincrement=False,
 212         info=dict(description="The ID of the flavor"))
 213     flavor = Column(Integer, nullable=False,
 214         info=dict(description="The level of the flavor in the berry"))
 215
 216 class ContestCombo(TableBase):
 217     u"""Combo of two moves in a Contest.
 218     """
 219     __tablename__ = 'contest_combos'
 220     first_move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False,
 221         info=dict(description="The ID of the first move in the combo"))
 222     second_move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False,
 223         info=dict(description="The ID of the second and final move in the combo"))
 224
 225 class ContestEffect(TableBase):
 226     u"""Effect of a move when used in a Contest.
 227     """
 228     __tablename__ = 'contest_effects'
 229     __singlename__ = 'contest_effect'
 230     id = Column(Integer, primary_key=True, nullable=False,
 231         info=dict(description="A unique ID for this effect"))
 232     appeal = Column(SmallInteger, nullable=False,
 233         info=dict(description="The base number of hearts the user of this move gets"))
 234     jam = Column(SmallInteger, nullable=False,
 235         info=dict(description="The base number of hearts the user's opponent loses"))
 236
 237 create_translation_table('contest_effect_prose', ContestEffect, 'prose',
 238     flavor_text = Column(Unicode(64), nullable=True,
 239         info=dict(description="The in-game description of this effect", official=True, format='gametext')),
 240     effect = Column(Unicode(255), nullable=True,
 241         info=dict(description="A detailed description of the effect", format='plaintext')),
 242 )
 243
 244 class ContestType(TableBase):
 245     u"""A Contest type, such as "cool" or "smart", and their associated Berry flavors and Pokéblock colors.
 246     """
 247     __tablename__ = 'contest_types'
 248     __singlename__ = 'contest_type'
 249     id = Column(Integer, primary_key=True, nullable=False,
 250         info=dict(description="A unique ID for this Contest type"))
 251     identifier = Column(Unicode(6), nullable=False,
 252         info=dict(description="An identifier", format='identifier'))
 253
 254 create_translation_table('contest_type_names', ContestType, 'names',
 255     relation_lazy='joined',
 256     name = Column(Unicode(6), nullable=True, index=True,
 257         info=dict(description="The name", format='plaintext', official=True)),
 258     flavor = Column(Unicode(6), nullable=True,
 259         info=dict(description="The name of the corresponding Berry flavor", official=True, format='plaintext')),
 260     color = Column(Unicode(6), nullable=True,
 261         info=dict(description=u"The name of the corresponding Pokéblock color", official=True, format='plaintext')),
 262 )
 263
 264 class EggGroup(TableBase):
 265     u"""An Egg group. Usually, two Pokémon can breed if they share an Egg Group.
 266
 267     (exceptions are the Ditto and No Eggs groups)
 268     """
 269     __tablename__ = 'egg_groups'
 270     __singlename__ = 'egg_group'
 271     id = Column(Integer, primary_key=True, nullable=False,
 272         info=dict(description="A unique ID for this group"))
 273     identifier = Column(Unicode(16), nullable=False,
 274         info=dict(description=u"An identifier.", format='identifier'))
 275
 276 create_translation_table('egg_group_prose', EggGroup, 'names',
 277     relation_lazy='joined',
 278     name = Column(Unicode(16), nullable=False, index=True,
 279         info=dict(description="The name", format='plaintext', official=True)),
 280 )
 281
 282 class Encounter(TableBase):
 283     u"""Encounters with wild Pokémon.
 284
 285     Bear with me, here.
 286
 287     Within a given area in a given game, encounters are differentiated by the
 288     "slot" they are in and the state of the game world.
 289
 290     What the player is doing to get an encounter, such as surfing or walking
 291     through tall grass, is called a method.  Each method has its own set of
 292     encounter slots.
 293
 294     Within a method, slots are defined primarily by rarity.  Each slot can
 295     also be affected by world conditions; for example, the 20% slot for walking
 296     in tall grass is affected by whether a swarm is in effect in that area.
 297     "Is there a swarm?" is a condition; "there is a swarm" and "there is not a
 298     swarm" are the possible values of this condition.
 299
 300     A slot (20% walking in grass) and any appropriate world conditions (no
 301     swarm) are thus enough to define a specific encounter.
 302
 303     Well, okay, almost: each slot actually appears twice.
 304     """
 305
 306     __tablename__ = 'encounters'
 307     id = Column(Integer, primary_key=True, nullable=False,
 308         info=dict(description="A unique ID for this encounter"))
 309     version_id = Column(Integer, ForeignKey('versions.id'), nullable=False, autoincrement=False,
 310         info=dict(description="The ID of the version this applies to"))
 311     location_area_id = Column(Integer, ForeignKey('location_areas.id'), nullable=False, autoincrement=False,
 312         info=dict(description="The ID of the location of this encounter"))
 313     encounter_slot_id = Column(Integer, ForeignKey('encounter_slots.id'), nullable=False, autoincrement=False,
 314         info=dict(description="The ID of the encounter slot, which determines method and rarity"))
 315     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=False, autoincrement=False,
 316         info=dict(description=u"The ID of the encountered Pokémon"))
 317     min_level = Column(Integer, nullable=False, autoincrement=False,
 318         info=dict(description=u"The minimum level of the encountered Pokémon"))
 319     max_level = Column(Integer, nullable=False, autoincrement=False,
 320         info=dict(description=u"The maxmum level of the encountered Pokémon"))
 321
 322 class EncounterCondition(TableBase):
 323     u"""A conditions in the game world that affects Pokémon encounters, such as time of day.
 324     """
 325
 326     __tablename__ = 'encounter_conditions'
 327     __singlename__ = 'encounter_condition'
 328     id = Column(Integer, primary_key=True, nullable=False,
 329         info=dict(description="A unique ID for this condition"))
 330     identifier = Column(Unicode(64), nullable=False,
 331         info=dict(description="An identifier", format='identifier'))
 332
 333 create_translation_table('encounter_condition_prose', EncounterCondition, 'prose',
 334     name = Column(Unicode(64), nullable=False, index=True,
 335         info=dict(description="The name", format='plaintext', official=False)),
 336 )
 337
 338 class EncounterConditionValue(TableBase):
 339     u"""A possible state for a condition; for example, the state of 'swarm' could be 'swarm' or 'no swarm'.
 340     """
 341
 342     __tablename__ = 'encounter_condition_values'
 343     __singlename__ = 'encounter_condition_value'
 344     id = Column(Integer, primary_key=True, nullable=False,
 345         info=dict(description="A numeric ID"))
 346     encounter_condition_id = Column(Integer, ForeignKey('encounter_conditions.id'), primary_key=False, nullable=False, autoincrement=False,
 347         info=dict(description="The ID of the encounter condition this is a value of"))
 348     identifier = Column(Unicode(64), nullable=False,
 349         info=dict(description="An identifier", format='identifier'))
 350     is_default = Column(Boolean, nullable=False,
 351         info=dict(description='Set if this value is the default state for the condition'))
 352
 353 create_translation_table('encounter_condition_value_prose', EncounterConditionValue, 'prose',
 354     name = Column(Unicode(64), nullable=False, index=True,
 355         info=dict(description="The name", format='plaintext', official=False)),
 356 )
 357
 358 class EncounterConditionValueMap(TableBase):
 359     u"""Maps encounters to the specific conditions under which they occur.
 360     """
 361     __tablename__ = 'encounter_condition_value_map'
 362     encounter_id = Column(Integer, ForeignKey('encounters.id'), primary_key=True, nullable=False, autoincrement=False,
 363         info=dict(description="The ID of the encounter"))
 364     encounter_condition_value_id = Column(Integer, ForeignKey('encounter_condition_values.id'), primary_key=True, nullable=False, autoincrement=False,
 365         info=dict(description="The ID of the encounter condition value"))
 366
 367 class EncounterMethod(TableBase):
 368     u"""A way the player can enter a wild encounter, e.g., surfing, fishing, or walking through tall grass.
 369     """
 370
 371     __tablename__ = 'encounter_methods'
 372     __singlename__ = 'encounter_method'
 373     id = Column(Integer, primary_key=True, nullable=False,
 374         info=dict(description="A unique ID for the method"))
 375     identifier = Column(Unicode(16), nullable=False, unique=True,
 376         info=dict(description="An identifier", format='identifier'))
 377
 378 create_translation_table('encounter_method_prose', EncounterMethod, 'prose',
 379     name = Column(Unicode(64), nullable=False, index=True,
 380         info=dict(description="The name", format='plaintext', official=False)),
 381 )
 382
 383 class EncounterSlot(TableBase):
 384     u"""An abstract "slot" within a method, associated with both some set of conditions and a rarity.
 385
 386     Note that there are two encounters per slot, so the rarities will only add
 387     up to 50.
 388     """
 389
 390     __tablename__ = 'encounter_slots'
 391     id = Column(Integer, primary_key=True, nullable=False,
 392         info=dict(description="A unique ID for this slot"))
 393     version_group_id = Column(Integer, ForeignKey('version_groups.id'), nullable=False, autoincrement=False,
 394         info=dict(description="The ID of the version group this slot is in"))
 395     encounter_method_id = Column(Integer, ForeignKey('encounter_methods.id'), primary_key=False, nullable=False, autoincrement=False,
 396         info=dict(description="The ID of the method"))
 397     slot = Column(Integer, nullable=True,
 398         info=dict(description="This slot's order for the location and method"))
 399     rarity = Column(Integer, nullable=True,
 400         info=dict(description="The chance of the encounter as a percentage"))
 401
 402 class EvolutionChain(TableBase):
 403     u"""A family of Pokémon that are linked by evolution
 404     """
 405     __tablename__ = 'evolution_chains'
 406     id = Column(Integer, primary_key=True, nullable=False,
 407         info=dict(description="A numeric ID"))
 408     growth_rate_id = Column(Integer, ForeignKey('growth_rates.id'), nullable=False,
 409         info=dict(description="ID of the growth rate for this family"))
 410     baby_trigger_item_id = Column(Integer, ForeignKey('items.id'), nullable=True,
 411         info=dict(description="Item that a parent must hold while breeding to produce a baby"))
 412
 413 class EvolutionTrigger(TableBase):
 414     u"""An evolution type, such as "level" or "trade".
 415     """
 416     __tablename__ = 'evolution_triggers'
 417     __singlename__ = 'evolution_trigger'
 418     id = Column(Integer, primary_key=True, nullable=False,
 419         info=dict(description="A numeric ID"))
 420     identifier = Column(Unicode(16), nullable=False,
 421         info=dict(description="An identifier", format='identifier'))
 422
 423 create_translation_table('evolution_trigger_prose', EvolutionTrigger, 'prose',
 424     name = Column(Unicode(16), nullable=False, index=True,
 425         info=dict(description="The name", format='plaintext', official=False)),
 426 )
 427
 428 class Experience(TableBase):
 429     u"""EXP needed for a certain level with a certain growth rate
 430     """
 431     __tablename__ = 'experience'
 432     growth_rate_id = Column(Integer, ForeignKey('growth_rates.id'), primary_key=True, nullable=False,
 433         info=dict(description="ID of the growth rate"))
 434     level = Column(Integer, primary_key=True, nullable=False, autoincrement=False,
 435         info=dict(description="The level"))
 436     experience = Column(Integer, nullable=False,
 437         info=dict(description="The number of EXP points needed to get to that level"))
 438
 439 class Generation(TableBase):
 440     u"""A Generation of the Pokémon franchise
 441     """
 442     __tablename__ = 'generations'
 443     __singlename__ = 'generation'
 444     id = Column(Integer, primary_key=True, nullable=False,
 445         info=dict(description="A numeric ID"))
 446     main_region_id = Column(Integer, ForeignKey('regions.id'), nullable=False,
 447         info=dict(description="ID of the region this generation's main games take place in"))
 448     canonical_pokedex_id = Column(Integer, ForeignKey('pokedexes.id'), nullable=False,
 449         info=dict(description=u"ID of the Pokédex this generation's main games use by default"))
 450     identifier = Column(Unicode(16), nullable=False,
 451         info=dict(description=u'An identifier', format='identifier'))
 452
 453 create_translation_table('generation_names', Generation, 'names',
 454     relation_lazy='joined',
 455     name = Column(Unicode(16), nullable=False, index=True,
 456         info=dict(description="The name", format='plaintext', official=True)),
 457 )
 458
 459 class GrowthRate(TableBase):
 460     u"""Growth rate of a Pokémon, i.e. the EXP → level function.
 461     """
 462     __tablename__ = 'growth_rates'
 463     __singlename__ = 'growth_rate'
 464     id = Column(Integer, primary_key=True, nullable=False,
 465         info=dict(description="A numeric ID"))
 466     identifier = Column(Unicode(20), nullable=False,
 467         info=dict(description="An identifier", format='identifier'))
 468     formula = Column(Unicode(500), nullable=False,
 469         info=dict(description="The formula", format='latex'))
 470
 471 create_translation_table('growth_rate_prose', GrowthRate, 'prose',
 472     name = Column(Unicode(20), nullable=False, index=True,
 473         info=dict(description="The name", format='plaintext', official=False)),
 474 )
 475
 476 class Item(TableBase):
 477     u"""An Item from the games, like "Poké Ball" or "Bicycle".
 478     """
 479     __tablename__ = 'items'
 480     __singlename__ = 'item'
 481     id = Column(Integer, primary_key=True, nullable=False,
 482         info=dict(description="A numeric ID"))
 483     identifier = Column(Unicode(20), nullable=False,
 484         info=dict(description="An identifier", format='identifier'))
 485     category_id = Column(Integer, ForeignKey('item_categories.id'), nullable=False,
 486         info=dict(description="ID of a category this item belongs to"))
 487     cost = Column(Integer, nullable=False,
 488         info=dict(description=u"Cost of the item when bought. Items sell for half this price."))
 489     fling_power = Column(Integer, nullable=True,
 490         info=dict(description=u"Power of the move Fling when used with this item."))
 491     fling_effect_id = Column(Integer, ForeignKey('item_fling_effects.id'), nullable=True,
 492         info=dict(description=u"ID of the fling-effect of the move Fling when used with this item. Note that these are different from move effects."))
 493
 494     @property
 495     def appears_underground(self):
 496         u"""True if the item appears underground, as specified by the appropriate flag
 497         """
 498         return any(flag.identifier == u'underground' for flag in self.flags)
 499
 500 create_translation_table('item_names', Item, 'names',
 501     relation_lazy='joined',
 502     name = Column(Unicode(20), nullable=False, index=True,
 503         info=dict(description="The name", format='plaintext', official=True, ripped=True)),
 504 )
 505 create_translation_table('item_prose', Item, 'prose',
 506     short_effect = Column(markdown.MarkdownColumn(256), nullable=True,
 507         info=dict(description="A short summary of the effect", format='markdown')),
 508     effect = Column(markdown.MarkdownColumn(5120), nullable=True,
 509         info=dict(description=u"Detailed description of the item's effect.", format='markdown')),
 510 )
 511 create_translation_table('item_flavor_summaries', Item, 'flavor_summaries',
 512     flavor_summary = Column(Unicode(512), nullable=True,
 513         info=dict(description=u"Text containing facts from all flavor texts, for languages without official game translations", official=False, format='plaintext', ripped=True)),
 514 )
 515
 516 class ItemCategory(TableBase):
 517     u"""An item category
 518     """
 519     # XXX: This is fanon, right?
 520     __tablename__ = 'item_categories'
 521     __singlename__ = 'item_category'
 522     id = Column(Integer, primary_key=True, nullable=False,
 523         info=dict(description="A numeric ID"))
 524     pocket_id = Column(Integer, ForeignKey('item_pockets.id'), nullable=False,
 525         info=dict(description="ID of the pocket these items go to"))
 526     identifier = Column(Unicode(16), nullable=False,
 527         info=dict(description="An identifier", format='identifier'))
 528
 529 create_translation_table('item_category_prose', ItemCategory, 'prose',
 530     relation_lazy='joined',
 531     name = Column(Unicode(16), nullable=False, index=True,
 532         info=dict(description="The name", format='plaintext', official=False)),
 533 )
 534
 535 class ItemFlag(TableBase):
 536     u"""An item attribute such as "consumable" or "holdable".
 537     """
 538     __tablename__ = 'item_flags'
 539     __singlename__ = 'item_flag'
 540     id = Column(Integer, primary_key=True, nullable=False,
 541         info=dict(description="A numeric ID"))
 542     identifier = Column(Unicode(24), nullable=False,
 543         info=dict(description="Identifier of the flag", format='identifier'))
 544
 545 create_translation_table('item_flag_prose', ItemFlag, 'prose',
 546     name = Column(Unicode(24), nullable=True, index=True,
 547         info=dict(description="The name", format='plaintext', official=False)),
 548     description = Column(Unicode(64), nullable=True,
 549         info=dict(description="Short description of the flag", format='plaintext')),
 550 )
 551
 552 class ItemFlagMap(TableBase):
 553     u"""Maps an item flag to its item.
 554     """
 555     __tablename__ = 'item_flag_map'
 556     item_id = Column(Integer, ForeignKey('items.id'), primary_key=True, autoincrement=False, nullable=False,
 557         info=dict(description="The ID of the item"))
 558     item_flag_id = Column(Integer, ForeignKey('item_flags.id'), primary_key=True, autoincrement=False, nullable=False,
 559         info=dict(description="The ID of the item flag"))
 560
 561 class ItemFlavorText(TableBase):
 562     u"""An in-game description of an item
 563     """
 564     __tablename__ = 'item_flavor_text'
 565     __singlename__ = 'item_flavor_text'
 566     summary_column = Item.flavor_summaries_table, 'flavor_summary'
 567     item_id = Column(Integer, ForeignKey('items.id'), primary_key=True, autoincrement=False, nullable=False,
 568         info=dict(description="The ID of the item"))
 569     version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, autoincrement=False, nullable=False,
 570         info=dict(description="ID of the version group that sports this text"))
 571     language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False,
 572         info=dict(description="The language"))
 573     flavor_text = Column(Unicode(255), nullable=False,
 574         info=dict(description="The flavor text itself", official=True, format='gametext'))
 575
 576 class ItemFlingEffect(TableBase):
 577     u"""An effect of the move Fling when used with a specific item
 578     """
 579     __tablename__ = 'item_fling_effects'
 580     __singlename__ = 'item_fling_effect'
 581     id = Column(Integer, primary_key=True, nullable=False,
 582         info=dict(description="A numeric ID"))
 583
 584 create_translation_table('item_fling_effect_prose', ItemFlingEffect, 'prose',
 585     effect = Column(Unicode(255), nullable=False,
 586         info=dict(description="Description of the effect", format='plaintext')),
 587 )
 588
 589 class ItemGameIndex(TableBase):
 590     u"""The internal ID number a game uses for an item
 591     """
 592     __tablename__ = 'item_game_indices'
 593     item_id = Column(Integer, ForeignKey('items.id'), primary_key=True, autoincrement=False, nullable=False,
 594         info=dict(description="The database ID of the item"))
 595     generation_id = Column(Integer, ForeignKey('generations.id'), primary_key=True, autoincrement=False, nullable=False,
 596         info=dict(description="ID of the generation of games"))
 597     game_index = Column(Integer, nullable=False,
 598         info=dict(description="Internal ID of the item in the generation"))
 599
 600 class ItemPocket(TableBase):
 601     u"""A pocket that categorizes items
 602     """
 603     __tablename__ = 'item_pockets'
 604     __singlename__ = 'item_pocket'
 605     id = Column(Integer, primary_key=True, nullable=False,
 606         info=dict(description="A numeric ID"))
 607     identifier = Column(Unicode(16), nullable=False,
 608         info=dict(description="An identifier of this pocket", format='identifier'))
 609
 610 create_translation_table('item_pocket_names', ItemPocket, 'names',
 611     relation_lazy='joined',
 612     name = Column(Unicode(16), nullable=False, index=True,
 613         info=dict(description="The name", format='plaintext', official=True)),
 614 )
 615
 616 class Location(TableBase):
 617     u"""A place in the Pokémon world
 618     """
 619     __tablename__ = 'locations'
 620     __singlename__ = 'location'
 621     id = Column(Integer, primary_key=True, nullable=False,
 622         info=dict(description="A numeric ID"))
 623     region_id = Column(Integer, ForeignKey('regions.id'),
 624         info=dict(description="ID of the region this location is in"))
 625     identifier = Column(Unicode(64), nullable=False,
 626         info=dict(description="An identifier", format='identifier'))
 627
 628 create_translation_table('location_names', Location, 'names',
 629     relation_lazy='joined',
 630     name = Column(Unicode(64), nullable=False, index=True,
 631         info=dict(description="The name", format='plaintext', official=True)),
 632 )
 633
 634 class LocationArea(TableBase):
 635     u"""A sub-area of a location
 636     """
 637     __tablename__ = 'location_areas'
 638     __singlename__ = 'location_area'
 639     id = Column(Integer, primary_key=True, nullable=False,
 640         info=dict(description="A numeric ID"))
 641     location_id = Column(Integer, ForeignKey('locations.id'), nullable=False,
 642         info=dict(description="ID of the location this area is part of"))
 643     game_index = Column(Integer, nullable=False,
 644         info=dict(description="ID the games ude for this area"))
 645     identifier = Column(Unicode(64), nullable=True,
 646         info=dict(description="An identifier", format='identifier'))
 647
 648 create_translation_table('location_area_prose', LocationArea, 'prose',
 649     relation_lazy='joined',
 650     name = Column(Unicode(64), nullable=False, index=True,
 651         info=dict(description="The name", format='plaintext', official=False)),
 652 )
 653
 654 class LocationAreaEncounterRate(TableBase):
 655     # XXX: What's this exactly? Someone add the docstring & revise the descriptions
 656     __tablename__ = 'location_area_encounter_rates'
 657     location_area_id = Column(Integer, ForeignKey('location_areas.id'), primary_key=True, nullable=False, autoincrement=False,
 658         info=dict(description="ID of the area"))
 659     encounter_method_id = Column(Integer, ForeignKey('encounter_methods.id'), primary_key=True, nullable=False, autoincrement=False,
 660         info=dict(description="ID of the method"))
 661     version_id = Column(Integer, ForeignKey('versions.id'), primary_key=True, autoincrement=False,
 662         info=dict(description="ID of the version"))
 663     rate = Column(Integer, nullable=True,
 664         info=dict(description="The encounter rate"))  # units?
 665
 666 class LocationGameIndex(TableBase):
 667     u"""IDs the games use internally for locations
 668     """
 669     __tablename__ = 'location_game_indices'
 670     location_id = Column(Integer, ForeignKey('locations.id'), nullable=False, primary_key=True,
 671         info=dict(description="Database ID of the locaion"))
 672     generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False, primary_key=True,
 673         info=dict(description="ID of the generation this entry to"))
 674     game_index = Column(Integer, nullable=False, primary_key=True, autoincrement=False,
 675         info=dict(description="Internal game ID of the location"))
 676
 677 class Machine(TableBase):
 678     u"""A TM or HM; numbered item that can teach a move to a Pokémon
 679     """
 680     __tablename__ = 'machines'
 681     machine_number = Column(Integer, primary_key=True, nullable=False, autoincrement=False,
 682         info=dict(description="Number of the machine for TMs, or 100 + the munber for HMs"))
 683     version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, autoincrement=False,
 684         info=dict(description="Versions this entry applies to"))
 685     item_id = Column(Integer, ForeignKey('items.id'), nullable=False,
 686         info=dict(description="ID of the corresponding Item"))
 687     move_id = Column(Integer, ForeignKey('moves.id'), nullable=False,
 688         info=dict(description="ID of the taught move"))
 689
 690     @property
 691     def is_hm(self):
 692         u"""True if this machine is a HM, False if it's a TM
 693         """
 694         return self.machine_number >= 100
 695
 696 class Move(TableBase):
 697     u"""A Move: technique or attack a Pokémon can learn to use
 698     """
 699     __tablename__ = 'moves'
 700     __singlename__ = 'move'
 701     id = Column(Integer, primary_key=True, nullable=False,
 702         info=dict(description="A numeric ID"))
 703     identifier = Column(Unicode(24), nullable=False,
 704         info=dict(description="An identifier", format='identifier'))
 705     generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False,
 706         info=dict(description="ID of the generation this move first appeared in"))
 707     type_id = Column(Integer, ForeignKey('types.id'), nullable=False,
 708         info=dict(description="ID of the move's elemental type"))
 709     power = Column(SmallInteger, nullable=False,
 710         info=dict(description="Base power of the move"))
 711     pp = Column(SmallInteger, nullable=True,
 712         info=dict(description="Base PP (Power Points) of the move, nullable if not applicable (e.g. Struggle and Shadow moves)."))
 713     accuracy = Column(SmallInteger, nullable=True,
 714         info=dict(description="Accuracy of the move; NULL means it never misses"))
 715     priority = Column(SmallInteger, nullable=False,
 716         info=dict(description="The move's priority bracket"))
 717     target_id = Column(Integer, ForeignKey('move_targets.id'), nullable=False,
 718         info=dict(description="ID of the target (range) of the move"))
 719     damage_class_id = Column(Integer, ForeignKey('move_damage_classes.id'), nullable=False,
 720         info=dict(description="ID of the damage class (physical/special) of the move"))
 721     effect_id = Column(Integer, ForeignKey('move_effects.id'), nullable=False,
 722         info=dict(description="ID of the move's effect"))
 723     effect_chance = Column(Integer, nullable=True,
 724         info=dict(description="The chance for a secondary effect. What this is a chance of is specified by the move's effect."))
 725     contest_type_id = Column(Integer, ForeignKey('contest_types.id'), nullable=True,
 726         info=dict(description="ID of the move's Contest type (e.g. cool or smart)"))
 727     contest_effect_id = Column(Integer, ForeignKey('contest_effects.id'), nullable=True,
 728         info=dict(description="ID of the move's Contest effect"))
 729     super_contest_effect_id = Column(Integer, ForeignKey('super_contest_effects.id'), nullable=True,
 730         info=dict(description="ID of the move's Super Contest effect"))
 731
 732 create_translation_table('move_names', Move, 'names',
 733     relation_lazy='joined',
 734     name = Column(Unicode(24), nullable=False, index=True,
 735         info=dict(description="The name", format='plaintext', official=True, ripped=True))
 736 )
 737 create_translation_table('move_flavor_summaries', Move, 'flavor_summaries',
 738     flavor_summary = Column(Unicode(512), nullable=True,
 739         info=dict(description=u"Text containing facts from all flavor texts, for languages without official game translations", official=False, format='plaintext', ripped=True)),
 740 )
 741
 742 class MoveBattleStyle(TableBase):
 743     u"""A battle style of a move"""  # XXX: Explain better
 744     __tablename__ = 'move_battle_styles'
 745     __singlename__ = 'move_battle_style'
 746     id = Column(Integer, primary_key=True, nullable=False,
 747         info=dict(description="A numeric ID"))
 748     identifier = Column(Unicode(8), nullable=False,
 749         info=dict(description="An identifier", format='identifier'))
 750
 751 create_translation_table('move_battle_style_prose', MoveBattleStyle, 'prose',
 752     relation_lazy='joined',
 753     name = Column(Unicode(8), nullable=False, index=True,
 754         info=dict(description="The name", format='plaintext', official=False)),
 755 )
 756
 757 class MoveChangelog(TableBase):
 758     """History of changes to moves across main game versions."""
 759     __tablename__ = 'move_changelog'
 760     __singlename__ = 'move_changelog'
 761     move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False,
 762         info=dict(description="ID of the move that changed"))
 763     changed_in_version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False,
 764         info=dict(description="ID of the version group in which the move changed"))
 765     type_id = Column(Integer, ForeignKey('types.id'), nullable=True,
 766         info=dict(description="Prior type of the move, or NULL if unchanged"))
 767     power = Column(SmallInteger, nullable=True,
 768         info=dict(description="Prior base power of the move, or NULL if unchanged"))
 769     pp = Column(SmallInteger, nullable=True,
 770         info=dict(description="Prior base PP of the move, or NULL if unchanged"))
 771     accuracy = Column(SmallInteger, nullable=True,
 772         info=dict(description="Prior accuracy of the move, or NULL if unchanged"))
 773     effect_id = Column(Integer, ForeignKey('move_effects.id'), nullable=True,
 774         info=dict(description="Prior ID of the effect, or NULL if unchanged"))
 775     effect_chance = Column(Integer, nullable=True,
 776         info=dict(description="Prior effect chance, or NULL if unchanged"))
 777
 778 class MoveDamageClass(TableBase):
 779     u"""Any of the damage classes moves can have, i.e. physical, special, or non-damaging.
 780     """
 781     __tablename__ = 'move_damage_classes'
 782     __singlename__ = 'move_damage_class'
 783     id = Column(Integer, primary_key=True, nullable=False,
 784         info=dict(description="A numeric ID"))
 785     identifier = Column(Unicode(16), nullable=False,
 786         info=dict(description="An identifier", format='identifier'))
 787
 788 create_translation_table('move_damage_class_prose', MoveDamageClass, 'prose',
 789     relation_lazy='joined',
 790     name = Column(Unicode(16), nullable=True, index=True,
 791         info=dict(description="The name", format='plaintext', official=False)),
 792     description = Column(Unicode(64), nullable=True,
 793         info=dict(description="A description of the class", format='plaintext')),
 794 )
 795
 796 class MoveEffect(TableBase):
 797     u"""An effect of a move
 798     """
 799     __tablename__ = 'move_effects'
 800     __singlename__ = 'move_effect'
 801     id = Column(Integer, primary_key=True, nullable=False,
 802         info=dict(description="A numeric ID"))
 803
 804 create_translation_table('move_effect_prose', MoveEffect, 'prose',
 805     short_effect = Column(Unicode(256), nullable=True,
 806         info=dict(description="A short summary of the effect", format='plaintext')),
 807     effect = Column(Unicode(5120), nullable=True,
 808         info=dict(description="A detailed description of the effect", format='plaintext')),
 809 )
 810
 811 class MoveEffectChangelog(TableBase):
 812     """History of changes to move effects across main game versions."""
 813     __tablename__ = 'move_effect_changelog'
 814     __singlename__ = 'move_effect_changelog'
 815     id = Column(Integer, primary_key=True, nullable=False,
 816         info=dict(description="A numeric ID"))
 817     effect_id = Column(Integer, ForeignKey('move_effects.id'), nullable=False,
 818         info=dict(description="The ID of the effect that changed"))
 819     changed_in_version_group_id = Column(Integer, ForeignKey('version_groups.id'), nullable=False,
 820         info=dict(description="The ID of the version group in which the effect changed"))
 821
 822     __table_args__ = (
 823         UniqueConstraint(effect_id, changed_in_version_group_id),
 824         {},
 825     )
 826
 827 create_translation_table('move_effect_changelog_prose', MoveEffectChangelog, 'prose',
 828     effect = Column(markdown.MarkdownColumn(512), nullable=False,
 829         info=dict(description="A description of the old behavior", format='markdown')),
 830 )
 831
 832 class MoveFlag(TableBase):
 833     u"""Maps a move flag to a move
 834     """
 835     # XXX: Other flags have a ___Flag class for the actual flag and ___FlagMap for the map,
 836     # these, somewhat confusingly, have MoveFlagType and MoveFlag
 837     __tablename__ = 'move_flags'
 838     move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False,
 839         info=dict(description="ID of the move"))
 840     move_flag_type_id = Column(Integer, ForeignKey('move_flag_types.id'), primary_key=True, nullable=False, autoincrement=False,
 841         info=dict(description="ID of the flag"))
 842
 843 class MoveFlagType(TableBase):
 844     u"""A Move attribute such as "snatchable" or "contact".
 845     """
 846     __tablename__ = 'move_flag_types'
 847     __singlename__ = 'move_flag_type'
 848     id = Column(Integer, primary_key=True, nullable=False,
 849         info=dict(description="A numeric ID"))
 850     identifier = Column(Unicode(32), nullable=False,
 851         info=dict(description="A short identifier for the flag", format='identifier'))
 852
 853 create_translation_table('move_flag_type_prose', MoveFlagType, 'prose',
 854     relation_lazy='joined',
 855     name = Column(Unicode(32), nullable=True, index=True,
 856         info=dict(description="The name", format='plaintext', official=False)),
 857     description = Column(markdown.MarkdownColumn(128), nullable=True,
 858         info=dict(description="A short description of the flag", format='markdown')),
 859 )
 860
 861 class MoveFlavorText(TableBase):
 862     u"""In-game description of a move
 863     """
 864     __tablename__ = 'move_flavor_text'
 865     summary_column = Move.flavor_summaries_table, 'flavor_summary'
 866     move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False,
 867         info=dict(description="ID of the move"))
 868     version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, autoincrement=False,
 869         info=dict(description="ID of the version group this text appears in"))
 870     language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False,
 871         info=dict(description="The language"))
 872     flavor_text = Column(Unicode(255), nullable=False,
 873         info=dict(description="The flavor text", official=True, format='gametext'))
 874
 875 class MoveMeta(TableBase):
 876     u"""Metadata for move effects, sorta-kinda ripped straight from the game"""
 877     __tablename__ = 'move_meta'
 878     move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False,
 879         info=dict(description="A numeric ID"))
 880     meta_category_id = Column(Integer, ForeignKey('move_meta_categories.id'), nullable=False,
 881         info=dict(description="ID of the move category"))
 882     meta_ailment_id = Column(Integer, ForeignKey('move_meta_ailments.id'), nullable=False,
 883         info=dict(description="ID of the caused ailment"))
 884     min_hits = Column(Integer, nullable=True, index=True,
 885         info=dict(description="Minimum number of hits per use"))
 886     max_hits = Column(Integer, nullable=True, index=True,
 887         info=dict(description="Maximum number of hits per use"))
 888     min_turns = Column(Integer, nullable=True, index=True,
 889         info=dict(description="Minimum number of turns the user is forced to use the move"))
 890     max_turns = Column(Integer, nullable=True, index=True,
 891         info=dict(description="Maximum number of turns the user is forced to use the move"))
 892     recoil = Column(Integer, nullable=False, index=True,
 893         info=dict(description="Recoil damage, in percent of damage done"))
 894     healing = Column(Integer, nullable=False, index=True,
 895         info=dict(description="Healing, in percent of user's max HP"))
 896     crit_rate = Column(Integer, nullable=False, index=True,
 897         info=dict(description="Critical hit rate bonus"))
 898     ailment_chance = Column(Integer, nullable=False, index=True,
 899         info=dict(description="Chance to cause an ailment, in percent"))
 900     flinch_chance = Column(Integer, nullable=False, index=True,
 901         info=dict(description="Chance to cause flinching, in percent"))
 902     stat_chance = Column(Integer, nullable=False, index=True,
 903         info=dict(description="Chance to cause a stat change, in percent"))
 904
 905 class MoveMetaAilment(TableBase):
 906     u"""Common status ailments moves can inflict on a single Pokémon, including
 907     major ailments like paralysis and minor ailments like trapping.
 908     """
 909     __tablename__ = 'move_meta_ailments'
 910     __singlename__ = 'move_meta_ailment'
 911     id = Column(Integer, primary_key=True, nullable=False, autoincrement=False,
 912         info=dict(description="A numeric ID"))
 913     identifier = Column(Unicode(24), nullable=False, index=True, unique=True,
 914         info=dict(description="An identifier", format='identifier'))
 915
 916 create_translation_table('move_meta_ailment_names', MoveMetaAilment, 'names',
 917     relation_lazy='joined',
 918     name = Column(Unicode(24), nullable=False, index=True,
 919         info=dict(description="The name", format='plaintext', official=True)),
 920 )
 921
 922 class MoveMetaCategory(TableBase):
 923     u"""Very general categories that loosely group move effects."""
 924     __tablename__ = 'move_meta_categories'
 925     __singlename__ = 'move_meta_category'
 926     id = Column(Integer, primary_key=True, nullable=False,
 927         info=dict(description="A numeric ID"))
 928     identifier = Column(Unicode(32), nullable=False, index=True, unique=True,
 929         info=dict(description="An identifier", format='identifier'))
 930
 931 create_translation_table('move_meta_category_prose', MoveMetaCategory, 'prose',
 932     relation_lazy='joined',
 933     description = Column(Unicode(64), nullable=False,
 934         info=dict(description="A description of the category", format="plaintext", official=False)),
 935 )
 936
 937 class MoveMetaStatChange(TableBase):
 938     u"""Stat changes moves (may) make."""
 939     __tablename__ = 'move_meta_stat_changes'
 940     move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False,
 941         info=dict(description="ID of the move"))
 942     stat_id = Column(Integer, ForeignKey('stats.id'), primary_key=True, nullable=False, autoincrement=False,
 943         info=dict(description="ID of the stat"))
 944     change = Column(Integer, nullable=False, index=True,
 945         info=dict(description="Amount of increase/decrease, in stages"))
 946
 947 class MoveTarget(TableBase):
 948     u"""Targetting or "range" of a move, e.g. "Affects all opponents" or "Affects user".
 949     """
 950     __tablename__ = 'move_targets'
 951     __singlename__ = 'move_target'
 952     id = Column(Integer, primary_key=True, nullable=False,
 953         info=dict(description="A numeric ID"))
 954     identifier = Column(Unicode(32), nullable=False,
 955         info=dict(description="An identifier", format='identifier'))
 956
 957 create_translation_table('move_target_prose', MoveTarget, 'prose',
 958     relation_lazy='joined',
 959     name = Column(Unicode(32), nullable=True, index=True,
 960         info=dict(description="The name", format='plaintext', official=False)),
 961     description = Column(Unicode(128), nullable=True,
 962         info=dict(description="A description", format='plaintext')),
 963 )
 964
 965 class Nature(TableBase):
 966     u"""A nature a Pokémon can have, such as Calm or Brave
 967     """
 968     __tablename__ = 'natures'
 969     __singlename__ = 'nature'
 970     id = Column(Integer, primary_key=True, nullable=False,
 971         info=dict(description="A numeric ID"))
 972     identifier = Column(Unicode(8), nullable=False,
 973         info=dict(description="An identifier", format='identifier'))
 974     decreased_stat_id = Column(Integer, ForeignKey('stats.id'), nullable=False,
 975         info=dict(description="ID of the stat that this nature decreases by 10% (if decreased_stat_id is the same, the effects cancel out)"))
 976     increased_stat_id = Column(Integer, ForeignKey('stats.id'), nullable=False,
 977         info=dict(description="ID of the stat that this nature increases by 10% (if decreased_stat_id is the same, the effects cancel out)"))
 978     hates_flavor_id = Column(Integer, ForeignKey('contest_types.id'), nullable=False,
 979         info=dict(description=u"ID of the Berry flavor the Pokémon hates (if likes_flavor_id is the same, the effects cancel out)"))
 980     likes_flavor_id = Column(Integer, ForeignKey('contest_types.id'), nullable=False,
 981         info=dict(description=u"ID of the Berry flavor the Pokémon likes (if hates_flavor_id is the same, the effects cancel out)"))
 982
 983     @property
 984     def is_neutral(self):
 985         u"""Returns True iff this nature doesn't alter a Pokémon's stats,
 986         bestow taste preferences, etc.
 987         """
 988         return self.increased_stat_id == self.decreased_stat_id
 989
 990 create_translation_table('nature_names', Nature, 'names',
 991     relation_lazy='joined',
 992     name = Column(Unicode(8), nullable=False, index=True,
 993         info=dict(description="The name", format='plaintext', official=True, ripped=True)),
 994 )
 995
 996 class NatureBattleStylePreference(TableBase):
 997     u"""Battle Palace move preference
 998
 999     Specifies how likely a Pokémon with a specific Nature is to use a move of
1000     a particular battl style in Battle Palace or Battle Tent
1001     """
1002     __tablename__ = 'nature_battle_style_preferences'
1003     nature_id = Column(Integer, ForeignKey('natures.id'), primary_key=True, nullable=False,
1004         info=dict(description=u"ID of the Pokémon's nature"))
1005     move_battle_style_id = Column(Integer, ForeignKey('move_battle_styles.id'), primary_key=True, nullable=False,
1006         info=dict(description="ID of the battle style"))
1007     low_hp_preference = Column(Integer, nullable=False,
1008         info=dict(description=u"Chance of using the move, in percent, if HP is under ½"))
1009     high_hp_preference = Column(Integer, nullable=False,
1010         info=dict(description=u"Chance of using the move, in percent, if HP is over ½"))
1011
1012 class NaturePokeathlonStat(TableBase):
1013     u"""Specifies how a Nature affects a Pokéathlon stat
1014     """
1015     __tablename__ = 'nature_pokeathlon_stats'
1016     nature_id = Column(Integer, ForeignKey('natures.id'), primary_key=True, nullable=False,
1017         info=dict(description="ID of the nature"))
1018     pokeathlon_stat_id = Column(Integer, ForeignKey('pokeathlon_stats.id'), primary_key=True, nullable=False,
1019         info=dict(description="ID of the stat"))
1020     max_change = Column(Integer, nullable=False,
1021         info=dict(description="Maximum change"))
1022
1023 class PokeathlonStat(TableBase):
1024     u"""A Pokéathlon stat, such as "Stamina" or "Jump".
1025     """
1026     __tablename__ = 'pokeathlon_stats'
1027     __singlename__ = 'pokeathlon_stat'
1028     id = Column(Integer, primary_key=True, nullable=False,
1029         info=dict(description="A numeric ID"))
1030     identifier = Column(Unicode(8), nullable=False,
1031         info=dict(description="An identifier", format='identifier'))
1032
1033 create_translation_table('pokeathlon_stat_names', PokeathlonStat, 'names',
1034     name = Column(Unicode(8), nullable=False, index=True,
1035         info=dict(description="The name", format='plaintext', official=True)),
1036 )
1037
1038 class Pokedex(TableBase):
1039     u"""A collection of Pokémon species ordered in a particular way
1040     """
1041     __tablename__ = 'pokedexes'
1042     __singlename__ = 'pokedex'
1043     id = Column(Integer, primary_key=True, nullable=False,
1044         info=dict(description="A numeric ID"))
1045     region_id = Column(Integer, ForeignKey('regions.id'), nullable=True,
1046         info=dict(description=u"ID of the region this Pokédex is used in, or None if it's global"))
1047     identifier = Column(Unicode(16), nullable=False,
1048         info=dict(description=u"An identifier", format='identifier'))
1049
1050 create_translation_table('pokedex_prose', Pokedex, 'prose',
1051     relation_lazy='joined',
1052     name = Column(Unicode(16), nullable=True, index=True,
1053         info=dict(description="The name", format='plaintext', official=False)),
1054     description = Column(Unicode(512), nullable=True,
1055         info=dict(description=u"A longer description of the Pokédex", format='plaintext')),
1056 )
1057
1058 class Pokemon(TableBase):
1059     u"""A species of Pokémon.  The core to this whole mess.
1060     """
1061     __tablename__ = 'pokemon'
1062     __singlename__ = 'pokemon'
1063     id = Column(Integer, primary_key=True, nullable=False,
1064         info=dict(description=u"A numeric ID"))
1065     identifier = Column(Unicode(20), nullable=False,
1066         info=dict(description=u"An identifier", format='identifier'))
1067     generation_id = Column(Integer, ForeignKey('generations.id'),
1068         info=dict(description=u"ID of the generation this species first appeared in"))
1069     evolution_chain_id = Column(Integer, ForeignKey('evolution_chains.id'),
1070         info=dict(description=u"ID of the species' evolution chain (a.k.a. family)"))
1071     evolves_from_pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=True,
1072         info=dict(description=u"The Pokémon species from which this one evolves"))
1073     height = Column(Integer, nullable=False,
1074         info=dict(description=u"The height of the Pokémon, in decimeters (tenths of a meter)"))
1075     weight = Column(Integer, nullable=False,
1076         info=dict(description=u"The weight of the Pokémon, in tenths of a kilogram (decigrams)"))
1077     color_id = Column(Integer, ForeignKey('pokemon_colors.id'), nullable=False,
1078         info=dict(description=u"ID of this Pokémon's Pokédex color, as used for a gimmick search function in the games."))
1079     pokemon_shape_id = Column(Integer, ForeignKey('pokemon_shapes.id'), nullable=False,
1080         info=dict(description=u"ID of this Pokémon's body shape, as used for a gimmick search function in the games."))
1081     habitat_id = Column(Integer, ForeignKey('pokemon_habitats.id'), nullable=True,
1082         info=dict(description=u"ID of this Pokémon's habitat, as used for a gimmick search function in the games."))
1083     gender_rate = Column(Integer, nullable=False,
1084         info=dict(description=u"The chance of this Pokémon being female, in eighths; or -1 for genderless"))
1085     capture_rate = Column(Integer, nullable=False,
1086         info=dict(description=u"The base capture rate; up to 255"))
1087     base_experience = Column(Integer, nullable=False,
1088         info=dict(description=u"The base EXP gained when defeating this Pokémon"))  # XXX: Is this correct?
1089     base_happiness = Column(Integer, nullable=False,
1090         info=dict(description=u"The tameness when caught by a normal ball"))
1091     is_baby = Column(Boolean, nullable=False,
1092         info=dict(description=u"True iff the Pokémon is a baby, i.e. a lowest-stage Pokémon that cannot breed but whose evolved form can."))
1093     hatch_counter = Column(Integer, nullable=False,
1094         info=dict(description=u"Initial hatch counter: one must walk 255 × (hatch_counter + 1) steps before this Pokémon's egg hatches, unless utilizing bonuses like Flame Body's"))
1095     has_gender_differences = Column(Boolean, nullable=False,
1096         info=dict(description=u"Set iff the species exhibits enough sexual dimorphism to have separate sets of sprites in Gen IV and beyond."))
1097     order = Column(Integer, nullable=False, index=True,
1098         info=dict(description=u"Order for sorting. Almost national order, except families and forms are grouped together."))
1099
1100     ### Stuff to handle alternate Pokémon forms
1101
1102     @property
1103     def form(self):
1104         u"""Returns the Pokémon's form, using its default form as fallback."""
1105
1106         return self.unique_form or self.default_form
1107
1108     @property
1109     def is_base_form(self):
1110         u"""Returns True iff the Pokémon is the base form for its species,
1111         e.g. Land Shaymin.
1112         """
1113
1114         return self.unique_form is None or self.unique_form.is_default
1115
1116     @property
1117     def form_name(self):
1118         u"""Returns the Pokémon's form name if it represents a particular form
1119         and that form has a name, or None otherwise.
1120         """
1121
1122         # If self.unique_form is None, the short-circuit "and" will go ahead
1123         # and return that.  Otherwise, it'll return the form's name, which may
1124         # also be None.
1125         return self.unique_form and self.unique_form.name
1126
1127     @property
1128     def full_name(self):
1129         u"""Returns the Pokémon's name, including its form if applicable."""
1130
1131         if self.form_name:
1132             return u'%s %s' % (self.form_name, self.name)
1133         else:
1134             return self.name
1135
1136     @property
1137     def normal_form(self):
1138         u"""Returns the normal form for this Pokémon; i.e., this will return
1139         regular Deoxys when called on any Deoxys form.
1140         """
1141
1142         if self.unique_form:
1143             return self.unique_form.form_base_pokemon
1144         return self
1145
1146     ### Not forms!
1147
1148     def stat(self, stat_name):
1149         u"""Returns a PokemonStat record for the given stat name (or Stat row
1150         object).  Uses the normal has-many machinery, so all the stats are
1151         effectively cached.
1152         """
1153         if isinstance(stat_name, Stat):
1154             stat_name = stat_name.name
1155
1156         for pokemon_stat in self.stats:
1157             if pokemon_stat.stat.name == stat_name:
1158                 return pokemon_stat
1159
1160         raise KeyError(u'No stat named %s' % stat_name)
1161
1162     @property
1163     def better_damage_class(self):
1164         u"""Returns the MoveDamageClass that this Pokémon is best suited for,
1165         based on its attack stats.
1166
1167         If the attack stats are about equal (within 5), returns None.  The
1168         value None, not the damage class called 'None'.
1169         """
1170         phys = self.stat(u'Attack')
1171         spec = self.stat(u'Special Attack')
1172
1173         diff = phys.base_stat - spec.base_stat
1174
1175         if diff > 5:
1176             return phys.stat.damage_class
1177         elif diff < -5:
1178             return spec.stat.damage_class
1179         else:
1180             return None
1181
1182 create_translation_table('pokemon_names', Pokemon, 'names',
1183     relation_lazy='joined',
1184     name = Column(Unicode(20), nullable=True, index=True,
1185         info=dict(description="The name", format='plaintext', official=True, ripped=True)),
1186     species = Column(Unicode(16), nullable=True,
1187         info=dict(description=u'The short flavor text, such as "Seed" or "Lizard"; usually affixed with the word "Pokémon"',
1188         official=True, format='plaintext')),
1189 )
1190 create_translation_table('pokemon_flavor_summaries', Pokemon, 'flavor_summaries',
1191     flavor_summary = Column(Unicode(512), nullable=True,
1192         info=dict(description=u"Text containing facts from all flavor texts, for languages without official game translations", official=False, format='plaintext', ripped=True)),
1193 )
1194
1195 class PokemonAbility(TableBase):
1196     u"""Maps an ability to a Pokémon that can have it
1197     """
1198     __tablename__ = 'pokemon_abilities'
1199     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False,
1200         info=dict(description=u"ID of the Pokémon"))
1201     ability_id = Column(Integer, ForeignKey('abilities.id'), nullable=False,
1202         info=dict(description=u"ID of the ability"))
1203     # XXX having both a method and a slot is kind of gross.  "slot" is a
1204     # misnomer, anyway: duplicate abilities don't appear in slot 2.
1205     # Probably should replace that with "order".
1206     is_dream = Column(Boolean, nullable=False, index=True,
1207         info=dict(description=u"Whether this is a Dream World ability"))
1208     slot = Column(Integer, primary_key=True, nullable=False, autoincrement=False,
1209         info=dict(description=u"The ability slot, i.e. 1 or 2 for gen. IV"))
1210
1211 class PokemonColor(TableBase):
1212     u"""The "Pokédex color" of a Pokémon species. Usually based on the Pokémon's color.
1213     """
1214     __tablename__ = 'pokemon_colors'
1215     __singlename__ = 'pokemon_color'
1216     id = Column(Integer, primary_key=True, nullable=False, autoincrement=False,
1217         info=dict(description=u"ID of the Pokémon"))
1218     identifier = Column(Unicode(6), nullable=False,
1219         info=dict(description=u"An identifier", format='identifier'))
1220
1221 create_translation_table('pokemon_color_names', PokemonColor, 'names',
1222     relation_lazy='joined',
1223     name = Column(Unicode(6), nullable=False, index=True,
1224         info=dict(description="The name", format='plaintext', official=True)),
1225 )
1226
1227 class PokemonDexNumber(TableBase):
1228     u"""The number of a Pokémon in a particular Pokédex (e.g. Jigglypuff is #138 in Hoenn's 'dex)
1229     """
1230     __tablename__ = 'pokemon_dex_numbers'
1231     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False,
1232         info=dict(description=u"ID of the Pokémon"))
1233     pokedex_id = Column(Integer, ForeignKey('pokedexes.id'), primary_key=True, nullable=False, autoincrement=False,
1234         info=dict(description=u"ID of the Pokédex"))
1235     pokedex_number = Column(Integer, nullable=False,
1236         info=dict(description=u"Number of the Pokémon in that the Pokédex"))
1237
1238 class PokemonEggGroup(TableBase):
1239     u"""Maps an Egg group to a Pokémon; each Pokémon belongs to one or two egg groups
1240     """
1241     __tablename__ = 'pokemon_egg_groups'
1242     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False,
1243         info=dict(description=u"ID of the Pokémon"))
1244     egg_group_id = Column(Integer, ForeignKey('egg_groups.id'), primary_key=True, nullable=False, autoincrement=False,
1245         info=dict(description=u"ID of the egg group"))
1246
1247 class PokemonEvolution(TableBase):
1248     u"""A required action ("trigger") and the conditions under which the trigger
1249     must occur to cause a Pokémon to evolve.
1250
1251     Any condition may be null if it does not apply for a particular Pokémon.
1252     """
1253     __tablename__ = 'pokemon_evolution'
1254     id = Column(Integer, primary_key=True, nullable=False)
1255     evolved_pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=False,
1256         info=dict(description=u"The ID of the post-evolution Pokémon."))
1257     evolution_trigger_id = Column(Integer, ForeignKey('evolution_triggers.id'), nullable=False,
1258         info=dict(description=u"The ID of the evolution trigger."))
1259     trigger_item_id = Column(Integer, ForeignKey('items.id'), nullable=True,
1260         info=dict(description=u"The ID of the item that must be used on the Pokémon."))
1261     minimum_level = Column(Integer, nullable=True,
1262         info=dict(description=u"The minimum level for the Pokémon."))
1263     gender = Column(Enum('male', 'female', name='pokemon_evolution_gender'), nullable=True,
1264         info=dict(description=u"The Pokémon's required gender, or None if gender doesn't matter"))
1265     location_id = Column(Integer, ForeignKey('locations.id'), nullable=True,
1266         info=dict(description=u"The ID of the location the evolution must be triggered at."))
1267     held_item_id = Column(Integer, ForeignKey('items.id'), nullable=True,
1268         info=dict(description=u"The ID of the item the Pokémon must hold."))
1269     time_of_day = Column(Enum('day', 'night', name='pokemon_evolution_time_of_day'), nullable=True,
1270         info=dict(description=u"The required time of day."))
1271     known_move_id = Column(Integer, ForeignKey('moves.id'), nullable=True,
1272         info=dict(description=u"The ID of the move the Pokémon must know."))
1273     minimum_happiness = Column(Integer, nullable=True,
1274         info=dict(description=u"The minimum happiness value the Pokémon must have."))
1275     minimum_beauty = Column(Integer, nullable=True,
1276         info=dict(description=u"The minimum Beauty value the Pokémon must have."))
1277     relative_physical_stats = Column(Integer, nullable=True,
1278         info=dict(description=u"The required relation between the Pokémon's Attack and Defense stats, as sgn(atk-def)."))
1279     party_pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=True,
1280         info=dict(description=u"The ID of the Pokémon that must be present in the party."))
1281     trade_pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=True,
1282         info=dict(description=u"The ID of the Pokémon for which this Pokémon must be traded."))
1283
1284 class PokemonFlavorText(TableBase):
1285     u"""In-game Pokédex descrption of a Pokémon.
1286     """
1287     __tablename__ = 'pokemon_flavor_text'
1288     summary_column = Pokemon.flavor_summaries_table, 'flavor_summary'
1289     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False,
1290         info=dict(description=u"ID of the Pokémon"))
1291     version_id = Column(Integer, ForeignKey('versions.id'), primary_key=True, nullable=False, autoincrement=False,
1292         info=dict(description=u"ID of the version that has this flavor text"))
1293     language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False,
1294         info=dict(description="The language"))
1295     flavor_text = Column(Unicode(255), nullable=False,
1296         info=dict(description=u"The flavor text", official=True, format='gametext'))
1297
1298 class PokemonForm(TableBase):
1299     u"""An individual form of a Pokémon.
1300
1301     Pokémon that do not have separate forms are still given a single row to
1302     represent their single form.
1303     """
1304     __tablename__ = 'pokemon_forms'
1305     __singlename__ = 'pokemon_form'
1306     id = Column(Integer, primary_key=True, nullable=False,
1307         info=dict(description=u'A unique ID for this form.'))
1308     identifier = Column(Unicode(16), nullable=True,
1309         info=dict(description=u"An identifier", format='identifier'))
1310     form_base_pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=False, autoincrement=False,
1311         info=dict(description=u'The ID of the base Pokémon for this form.'))
1312     unique_pokemon_id = Column(Integer, ForeignKey('pokemon.id'), autoincrement=False,
1313         info=dict(description=u'The ID of a Pokémon that represents specifically this form, for Pokémon with functionally-different forms like Wormadam.'))
1314     introduced_in_version_group_id = Column(Integer, ForeignKey('version_groups.id'), autoincrement=False,
1315         info=dict(description=u'The ID of the version group in which this form first appeared.'))
1316     is_default = Column(Boolean, nullable=False,
1317         info=dict(description=u'Set for exactly one form used as the default for each species.'))
1318     order = Column(Integer, nullable=False, autoincrement=False,
1319         info=dict(description=u'The order in which forms should be sorted.  Multiple forms may have equal order, in which case they should fall back on sorting by name.'))
1320
1321     @property
1322     def pokemon(self):
1323         u"""Returns the Pokémon for this form, using the form base as fallback.
1324         """
1325
1326         return self.unique_pokemon or self.form_base_pokemon
1327
1328     @property
1329     def full_name(self):
1330         u"""Returns the full name of this form, e.g. "Plant Cloak"."""
1331
1332         if not self.name:
1333             return None
1334         elif self.form_group and self.form_group.term:
1335             return u'%s %s' % (self.name, self.form_group.term)
1336         else:
1337             return self.name
1338
1339     @property
1340     def pokemon_name(self):
1341         u"""Returns the name of this Pokémon with this form, e.g. "Plant
1342         Burmy".
1343         """
1344
1345         if self.name:
1346             return u'%s %s' % (self.name, self.form_base_pokemon.name)
1347         else:
1348             return self.form_base_pokemon.name
1349
1350 create_translation_table('pokemon_form_names', PokemonForm, 'names',
1351     relation_lazy='joined',
1352     name = Column(Unicode(16), nullable=False, index=True,
1353         info=dict(description="The name", format='plaintext', official=True)),
1354 )
1355
1356 class PokemonFormGroup(TableBase):
1357     u"""Information about a Pokémon's forms as a group."""
1358     __tablename__ = 'pokemon_form_groups'
1359     __singlename__ = 'pokemon_form_group'
1360     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False,
1361         info=dict(description=u"ID of the base form Pokémon"))
1362     is_battle_only = Column(Boolean, nullable=False,
1363         info=dict(description=u"Set iff the forms only change in battle"))
1364 # FIXME remooove
1365 PokemonFormGroup.id = PokemonFormGroup.pokemon_id
1366
1367 create_translation_table('pokemon_form_group_prose', PokemonFormGroup, 'prose',
1368     term = Column(Unicode(16), nullable=True,
1369         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')),
1370     description = Column(markdown.MarkdownColumn(1024), nullable=True,
1371         info=dict(description=u"Description of how the forms work", format='markdown')),
1372 )
1373
1374 class PokemonFormPokeathlonStat(TableBase):
1375     u"""A Pokémon form's performance in one Pokéathlon stat."""
1376     __tablename__ = 'pokemon_form_pokeathlon_stats'
1377     pokemon_form_id = Column(Integer, ForeignKey('pokemon_forms.id'), primary_key=True, nullable=False, autoincrement=False,
1378         info=dict(description=u'The ID of the Pokémon form.'))
1379     pokeathlon_stat_id = Column(Integer, ForeignKey('pokeathlon_stats.id'), primary_key=True, nullable=False, autoincrement=False,
1380         info=dict(description=u'The ID of the Pokéathlon stat.'))
1381     minimum_stat = Column(Integer, nullable=False, autoincrement=False,
1382         info=dict(description=u'The minimum value for this stat for this Pokémon form.'))
1383     base_stat = Column(Integer, nullable=False, autoincrement=False,
1384         info=dict(description=u'The default value for this stat for this Pokémon form.'))
1385     maximum_stat = Column(Integer, nullable=False, autoincrement=False,
1386         info=dict(description=u'The maximum value for this stat for this Pokémon form.'))
1387
1388 class PokemonGameIndex(TableBase):
1389     u"""The number of a Pokémon a game uses internally
1390     """
1391     __tablename__ = 'pokemon_game_indices'
1392     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, autoincrement=False, nullable=False,
1393         info=dict(description=u"Database ID of the Pokémon"))
1394     generation_id = Column(Integer, ForeignKey('generations.id'), primary_key=True, autoincrement=False, nullable=False,
1395         info=dict(description=u"Database ID of the generation"))
1396     game_index = Column(Integer, nullable=False,
1397         info=dict(description=u"Internal ID the generation's games use for the Pokémon"))
1398
1399 class PokemonHabitat(TableBase):
1400     u"""The habitat of a Pokémon, as given in the FireRed/LeafGreen version Pokédex
1401     """
1402     __tablename__ = 'pokemon_habitats'
1403     __singlename__ = 'pokemon_habitat'
1404     id = Column(Integer, primary_key=True, nullable=False, autoincrement=False,
1405         info=dict(description=u"A numeric ID"))
1406     identifier = Column(Unicode(16), nullable=False,
1407         info=dict(description=u"An identifier", format='identifier'))
1408
1409 create_translation_table('pokemon_habitat_names', PokemonHabitat, 'names',
1410     relation_lazy='joined',
1411     name = Column(Unicode(16), nullable=False, index=True,
1412         info=dict(description="The name", format='plaintext', official=True)),
1413 )
1414
1415 class PokemonItem(TableBase):
1416     u"""Record of an item a Pokémon can hold in the wild
1417     """
1418     __tablename__ = 'pokemon_items'
1419     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False,
1420         info=dict(description=u"ID of the Pokémon"))
1421     version_id = Column(Integer, ForeignKey('versions.id'), primary_key=True, nullable=False, autoincrement=False,
1422         info=dict(description=u"ID of the version this applies to"))
1423     item_id = Column(Integer, ForeignKey('items.id'), primary_key=True, nullable=False, autoincrement=False,
1424         info=dict(description=u"ID of the item"))
1425     rarity = Column(Integer, nullable=False,
1426         info=dict(description=u"Chance of the Pokémon holding the item, in percent"))
1427
1428 class PokemonMove(TableBase):
1429     u"""Record of a move a Pokémon can learn
1430     """
1431     __tablename__ = 'pokemon_moves'
1432     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=False, index=True,
1433         info=dict(description=u"ID of the Pokémon"))
1434     version_group_id = Column(Integer, ForeignKey('version_groups.id'), nullable=False, index=True,
1435         info=dict(description=u"ID of the version group this applies to"))
1436     move_id = Column(Integer, ForeignKey('moves.id'), nullable=False, index=True,
1437         info=dict(description=u"ID of the move"))
1438     pokemon_move_method_id = Column(Integer, ForeignKey('pokemon_move_methods.id'), nullable=False, index=True,
1439         info=dict(description=u"ID of the method this move is learned by"))
1440     level = Column(Integer, nullable=True, index=True,
1441         info=dict(description=u"Level the move is learned at, if applicable"))
1442     order = Column(Integer, nullable=True,
1443         info=dict(description=u"A sort key to produce the correct ordering when all else is equal"))  # XXX: This needs a better description
1444
1445     __table_args__ = (
1446         PrimaryKeyConstraint('pokemon_id', 'version_group_id', 'move_id', 'pokemon_move_method_id', 'level'),
1447         {},
1448     )
1449
1450 class PokemonMoveMethod(TableBase):
1451     u"""A method a move can be learned by, such as "Level up" or "Tutor".
1452     """
1453     __tablename__ = 'pokemon_move_methods'
1454     __singlename__ = 'pokemon_move_method'
1455     id = Column(Integer, primary_key=True, nullable=False, autoincrement=False,
1456         info=dict(description=u"A numeric ID"))
1457     identifier = Column(Unicode(64), nullable=False,
1458         info=dict(description=u"An identifier", format='identifier'))
1459
1460 create_translation_table('pokemon_move_method_prose', PokemonMoveMethod, 'prose',
1461     relation_lazy='joined',
1462     name = Column(Unicode(64), nullable=True, index=True,
1463         info=dict(description="The name", format='plaintext', official=False)),
1464     description = Column(Unicode(255), nullable=True,
1465         info=dict(description=u"A detailed description of how the method works", format='plaintext')),
1466 )
1467
1468 class PokemonShape(TableBase):
1469     u"""The shape of a Pokémon's body, as used in generation IV Pokédexes.
1470     """
1471     __tablename__ = 'pokemon_shapes'
1472     __singlename__ = 'pokemon_shape'
1473     id = Column(Integer, primary_key=True, nullable=False,
1474         info=dict(description=u"A numeric ID"))
1475     identifier = Column(Unicode(24), nullable=False,
1476         info=dict(description=u"An identifier", format='identifier'))
1477
1478 create_translation_table('pokemon_shape_prose', PokemonShape, 'prose',
1479     relation_lazy='joined',
1480     name = Column(Unicode(24), nullable=True, index=True,
1481         info=dict(description="The name", format='plaintext', official=False)),
1482     awesome_name = Column(Unicode(16), nullable=True,
1483         info=dict(description=u"A splendiferous name of the body shape", format='plaintext')),
1484 )
1485
1486 class PokemonStat(TableBase):
1487     u"""A stat value of a Pokémon
1488     """
1489     __tablename__ = 'pokemon_stats'
1490     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False,
1491         info=dict(description=u"ID of the Pokémon"))
1492     stat_id = Column(Integer, ForeignKey('stats.id'), primary_key=True, nullable=False, autoincrement=False,
1493         info=dict(description=u"ID of the stat"))
1494     base_stat = Column(Integer, nullable=False,
1495         info=dict(description=u"The base stat"))
1496     effort = Column(Integer, nullable=False,
1497         info=dict(description=u"The effort increase in this stat gained when this Pokémon is defeated"))
1498
1499 class PokemonType(TableBase):
1500     u"""Maps a type to a Pokémon. Each Pokémon has 1 or 2 types.
1501     """
1502     __tablename__ = 'pokemon_types'
1503     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False,
1504         info=dict(description=u"ID of the Pokémon"))
1505     type_id = Column(Integer, ForeignKey('types.id'), nullable=False,
1506         info=dict(description=u"ID of the type"))
1507     slot = Column(Integer, primary_key=True, nullable=False, autoincrement=False,
1508         info=dict(description=u"The type's slot, 1 or 2, used to sort types if there are two of them"))
1509
1510 class Region(TableBase):
1511     u"""Major areas of the world: Kanto, Johto, etc.
1512     """
1513     __tablename__ = 'regions'
1514     __singlename__ = 'region'
1515     id = Column(Integer, primary_key=True, nullable=False,
1516         info=dict(description=u"A numeric ID"))
1517     identifier = Column(Unicode(16), nullable=False,
1518         info=dict(description=u"An identifier", format='identifier'))
1519
1520 create_translation_table('region_names', Region, 'names',
1521     relation_lazy='joined',
1522     name = Column(Unicode(16), nullable=False, index=True,
1523         info=dict(description="The name", format='plaintext', official=True)),
1524 )
1525
1526 class Stat(TableBase):
1527     u"""A Stat, such as Attack or Speed
1528     """
1529     __tablename__ = 'stats'
1530     __singlename__ = 'stat'
1531     id = Column(Integer, primary_key=True, nullable=False,
1532         info=dict(description=u"A numeric ID"))
1533     damage_class_id = Column(Integer, ForeignKey('move_damage_classes.id'), nullable=True,
1534         info=dict(description=u"For offensive and defensive stats, the damage this stat relates to; otherwise None (the NULL value)"))
1535     identifier = Column(Unicode(16), nullable=False,
1536         info=dict(description=u"An identifier", format='identifier'))
1537     is_battle_only = Column(Boolean, nullable=False,
1538         info=dict(description=u"Whether this stat only exists within a battle"))
1539
1540 create_translation_table('stat_names', Stat, 'names',
1541     relation_lazy='joined',
1542     name = Column(Unicode(16), nullable=False, index=True,
1543         info=dict(description="The name", format='plaintext', official=True)),
1544 )
1545
1546 class StatHint(TableBase):
1547     u"""Flavor text for genes that appears in a Pokémon's summary.  Sometimes
1548     called "characteristics".
1549     """
1550     __tablename__ = 'stat_hints'
1551     __singlename__ = 'stat_hint'
1552     id = Column(Integer, primary_key=True, nullable=False,
1553         info=dict(description=u"A numeric ID"))
1554     stat_id = Column(Integer, ForeignKey('stats.id'), nullable=False,
1555         info=dict(description=u"ID of the highest stat"))
1556     gene_mod_5 = Column(Integer, nullable=False, index=True,
1557         info=dict(description=u"Value of the highest stat modulo 5"))
1558
1559 create_translation_table('stat_hint_names', StatHint, 'names',
1560     relation_lazy='joined',
1561     message = Column(Unicode(24), nullable=False, index=True,
1562         info=dict(description=u"The text displayed", official=True, format='plaintext')),
1563 )
1564
1565 class SuperContestCombo(TableBase):
1566     u"""Combo of two moves in a Super Contest.
1567     """
1568     __tablename__ = 'super_contest_combos'
1569     first_move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False,
1570         info=dict(description=u"The ID of the first move in the combo."))
1571     second_move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False,
1572         info=dict(description=u"The ID of the second and last move."))
1573
1574 class SuperContestEffect(TableBase):
1575     u"""An effect a move can have when used in the Super Contest
1576     """
1577     __tablename__ = 'super_contest_effects'
1578     __singlename__ = 'super_contest_effect'
1579     id = Column(Integer, primary_key=True, nullable=False,
1580         info=dict(description=u"This effect's unique ID."))
1581     appeal = Column(SmallInteger, nullable=False,
1582         info=dict(description=u"The number of hearts the user gains."))
1583
1584 create_translation_table('super_contest_effect_prose', SuperContestEffect, 'prose',
1585     flavor_text = Column(Unicode(64), nullable=False,
1586         info=dict(description=u"A description of the effect.", format='plaintext', official=True)),
1587 )
1588
1589 class Type(TableBase):
1590     u"""Any of the elemental types Pokémon and moves can have."""
1591     __tablename__ = 'types'
1592     __singlename__ = 'type'
1593     id = Column(Integer, primary_key=True, nullable=False,
1594         info=dict(description=u"A unique ID for this type."))
1595     identifier = Column(Unicode(12), nullable=False,
1596         info=dict(description=u"An identifier", format='identifier'))
1597     generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False,
1598         info=dict(description=u"The ID of the generation this type first appeared in."))
1599     damage_class_id = Column(Integer, ForeignKey('move_damage_classes.id'), nullable=True,
1600         info=dict(description=u"The ID of the damage class this type's moves had before Generation IV, null if not applicable (e.g. ???)."))
1601
1602 create_translation_table('type_names', Type, 'names',
1603     relation_lazy='joined',
1604     name = Column(Unicode(12), nullable=False, index=True,
1605         info=dict(description="The name", format='plaintext', official=True)),
1606 )
1607
1608 class TypeEfficacy(TableBase):
1609     u"""The damage multiplier used when a move of a particular type damages a
1610     Pokémon of a particular other type.
1611     """
1612     __tablename__ = 'type_efficacy'
1613     damage_type_id = Column(Integer, ForeignKey('types.id'), primary_key=True, nullable=False, autoincrement=False,
1614         info=dict(description=u"The ID of the damaging type."))
1615     target_type_id = Column(Integer, ForeignKey('types.id'), primary_key=True, nullable=False, autoincrement=False,
1616         info=dict(description=u"The ID of the defending Pokémon's type."))
1617     damage_factor = Column(Integer, nullable=False,
1618         info=dict(description=u"The multiplier, as a percentage of damage inflicted."))
1619
1620 class Version(TableBase):
1621     u"""An individual main-series Pokémon game."""
1622     __tablename__ = 'versions'
1623     __singlename__ = 'version'
1624     id = Column(Integer, primary_key=True, nullable=False,
1625         info=dict(description=u"A unique ID for this version."))
1626     version_group_id = Column(Integer, ForeignKey('version_groups.id'), nullable=False,
1627         info=dict(description=u"The ID of the version group this game belongs to."))
1628     identifier = Column(Unicode(32), nullable=False,
1629         info=dict(description=u'And identifier', format='identifier'))
1630
1631 create_translation_table('version_names', Version, 'names',
1632     relation_lazy='joined',
1633     name = Column(Unicode(32), nullable=False, index=True,
1634         info=dict(description="The name", format='plaintext', official=True)),
1635 )
1636
1637 class VersionGroup(TableBase):
1638     u"""A group of versions, containing either two paired versions (such as Red
1639     and Blue) or a single game (such as Yellow.)
1640     """
1641     __tablename__ = 'version_groups'
1642     id = Column(Integer, primary_key=True, nullable=False,
1643         info=dict(description=u"This version group's unique ID."))
1644     generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False,
1645         info=dict(description=u"The ID of the generation the games in this group belong to."))
1646     pokedex_id = Column(Integer, ForeignKey('pokedexes.id'), nullable=False,
1647         info=dict(description=u"The ID of the regional Pokédex used in this version group."))
1648
1649 class VersionGroupRegion(TableBase):
1650     u"""Maps a version group to a region that appears in it."""
1651     __tablename__ = 'version_group_regions'
1652     version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False,
1653         info=dict(description=u"The ID of the version group."))
1654     region_id = Column(Integer, ForeignKey('regions.id'), primary_key=True, nullable=False,
1655         info=dict(description=u"The ID of the region."))
1656
1657
1658 ### Relations down here, to avoid dependency ordering problems
1659
1660 Ability.changelog = relation(AbilityChangelog,
1661     order_by=AbilityChangelog.changed_in_version_group_id.desc(),
1662     backref=backref('ability', innerjoin=True, lazy='joined'))
1663 Ability.flavor_text = relation(AbilityFlavorText,
1664     order_by=AbilityFlavorText.version_group_id,
1665     backref=backref('ability', innerjoin=True, lazy='joined'))
1666 Ability.generation = relation(Generation,
1667     innerjoin=True,
1668     backref='abilities')
1669
1670 AbilityChangelog.changed_in = relation(VersionGroup,
1671     innerjoin=True, lazy='joined',
1672     backref='ability_changelog')
1673
1674 AbilityFlavorText.version_group = relation(VersionGroup,
1675     innerjoin=True)
1676 AbilityFlavorText.language = relation(Language,
1677     innerjoin=True, lazy='joined')
1678
1679
1680 Berry.berry_firmness = relation(BerryFirmness,
1681     innerjoin=True,
1682     backref='berries')
1683 Berry.firmness = association_proxy('berry_firmness', 'name')
1684 Berry.flavors = relation(BerryFlavor,
1685     order_by=BerryFlavor.contest_type_id,
1686     backref=backref('berry', innerjoin=True))
1687 Berry.natural_gift_type = relation(Type, innerjoin=True)
1688
1689 BerryFlavor.contest_type = relation(ContestType, innerjoin=True)
1690
1691
1692 ContestCombo.first = relation(Move,
1693     primaryjoin=ContestCombo.first_move_id==Move.id,
1694     innerjoin=True, lazy='joined',
1695     backref='contest_combo_first')
1696 ContestCombo.second = relation(Move,
1697     primaryjoin=ContestCombo.second_move_id==Move.id,
1698     innerjoin=True, lazy='joined',
1699     backref='contest_combo_second')
1700
1701
1702 Encounter.condition_value_map = relation(EncounterConditionValueMap,
1703     backref='encounter')
1704 Encounter.condition_values = association_proxy('condition_value_map', 'condition_value')
1705 Encounter.location_area = relation(LocationArea,
1706     innerjoin=True, lazy='joined',
1707     backref='encounters')
1708 Encounter.pokemon = relation(Pokemon,
1709     innerjoin=True, lazy='joined',
1710     backref='encounters')
1711 Encounter.version = relation(Version,
1712     innerjoin=True, lazy='joined',
1713     backref='encounters')
1714 Encounter.slot = relation(EncounterSlot,
1715     innerjoin=True, lazy='joined',
1716     backref='encounters')
1717
1718 EncounterConditionValue.condition = relation(EncounterCondition,
1719     innerjoin=True, lazy='joined',
1720     backref='values')
1721 EncounterConditionValueMap.condition_value = relation(EncounterConditionValue,
1722     innerjoin=True, lazy='joined',
1723     backref='encounter_map')
1724
1725 EncounterSlot.method = relation(EncounterMethod,
1726     innerjoin=True, lazy='joined',
1727     backref='slots')
1728 EncounterSlot.version_group = relation(VersionGroup, innerjoin=True)
1729
1730
1731 EvolutionChain.growth_rate = relation(GrowthRate,
1732     innerjoin=True,
1733     backref='evolution_chains')
1734 EvolutionChain.baby_trigger_item = relation(Item,
1735     backref='evolution_chains')
1736
1737
1738 Experience.growth_rate = relation(GrowthRate,
1739     innerjoin=True, lazy='joined',
1740     backref='experience_table')
1741
1742
1743 Generation.canonical_pokedex = relation(Pokedex,
1744     backref='canonical_for_generation')
1745 Generation.versions = relation(Version,
1746     secondary=VersionGroup.__table__,
1747     innerjoin=True)
1748 Generation.main_region = relation(Region, innerjoin=True)
1749
1750
1751 GrowthRate.max_experience_obj = relation(Experience,
1752     primaryjoin=and_(
1753         Experience.growth_rate_id == GrowthRate.id,
1754         Experience.level == 100),
1755     uselist=False, innerjoin=True)
1756 GrowthRate.max_experience = association_proxy('max_experience_obj', 'experience')
1757
1758
1759 Item.berry = relation(Berry,
1760     uselist=False,
1761     backref='item')
1762 Item.flags = relation(ItemFlag,
1763     secondary=ItemFlagMap.__table__)
1764 Item.flavor_text = relation(ItemFlavorText,
1765     order_by=ItemFlavorText.version_group_id.asc(),
1766     backref=backref('item', innerjoin=True, lazy='joined'))
1767 Item.fling_effect = relation(ItemFlingEffect,
1768     backref='items')
1769 Item.machines = relation(Machine,
1770     order_by=Machine.version_group_id.asc())
1771 Item.category = relation(ItemCategory,
1772     innerjoin=True,
1773     backref=backref('items', order_by=Item.identifier.asc()))
1774 Item.pocket = association_proxy('category', 'pocket')
1775
1776 ItemCategory.pocket = relation(ItemPocket, innerjoin=True)
1777
1778 ItemFlavorText.version_group = relation(VersionGroup,
1779     innerjoin=True, lazy='joined')
1780 ItemFlavorText.language = relation(Language,
1781     innerjoin=True, lazy='joined')
1782
1783 ItemGameIndex.item = relation(Item,
1784     innerjoin=True, lazy='joined',
1785     backref='game_indices')
1786 ItemGameIndex.generation = relation(Generation,
1787     innerjoin=True, lazy='joined')
1788
1789 ItemPocket.categories = relation(ItemCategory,
1790     innerjoin=True,
1791     order_by=ItemCategory.identifier.asc())
1792
1793
1794 Location.region = relation(Region,
1795     innerjoin=True,
1796     backref='locations')
1797
1798 LocationArea.location = relation(Location,
1799     innerjoin=True, lazy='joined',
1800     backref='areas')
1801
1802 LocationAreaEncounterRate.location_area = relation(LocationArea,
1803     innerjoin=True,
1804     backref='encounter_rates')
1805 LocationAreaEncounterRate.method = relation(EncounterMethod,
1806     innerjoin=True)
1807
1808 LocationGameIndex.location = relation(Location,
1809     innerjoin=True, lazy='joined',
1810     backref='game_indices')
1811 LocationGameIndex.generation = relation(Generation,
1812     innerjoin=True, lazy='joined')
1813
1814
1815 Machine.item = relation(Item)
1816 Machine.version_group = relation(VersionGroup,
1817     innerjoin=True, lazy='joined')
1818
1819
1820 Move.changelog = relation(MoveChangelog,
1821     order_by=MoveChangelog.changed_in_version_group_id.desc(),
1822     backref=backref('move', innerjoin=True, lazy='joined'))
1823 Move.contest_effect = relation(ContestEffect,
1824     backref='moves')
1825 Move.contest_combo_next = association_proxy('contest_combo_first', 'second')
1826 Move.contest_combo_prev = association_proxy('contest_combo_second', 'first')
1827 Move.contest_type = relation(ContestType,
1828     backref='moves')
1829 Move.damage_class = relation(MoveDamageClass,
1830     innerjoin=True,
1831     backref='moves')
1832 Move.flags = association_proxy('move_flags', 'flag')
1833 Move.flavor_text = relation(MoveFlavorText,
1834     order_by=MoveFlavorText.version_group_id, backref='move')
1835 Move.generation = relation(Generation,
1836     innerjoin=True,
1837     backref='moves')
1838 Move.machines = relation(Machine,
1839     backref='move')
1840 Move.meta = relation(MoveMeta,
1841     uselist=False, innerjoin=True,
1842     backref='move')
1843 Move.meta_stat_changes = relation(MoveMetaStatChange)
1844 Move.move_effect = relation(MoveEffect,
1845     innerjoin=True,
1846     backref='moves')
1847 Move.move_flags = relation(MoveFlag,
1848     backref='move')
1849 Move.super_contest_effect = relation(SuperContestEffect,
1850     backref='moves')
1851 Move.super_contest_combo_next = association_proxy('super_contest_combo_first', 'second')
1852 Move.super_contest_combo_prev = association_proxy('super_contest_combo_second', 'first')
1853 Move.target = relation(MoveTarget,
1854     innerjoin=True,
1855     backref='moves')
1856 Move.type = relation(Type,
1857     innerjoin=True,
1858     backref='moves')
1859
1860 Move.effect = markdown.MoveEffectProperty('effect')
1861 Move.effect_map = markdown.MoveEffectPropertyMap('effect_map')
1862 Move.short_effect = markdown.MoveEffectProperty('short_effect')
1863 Move.short_effect_map = markdown.MoveEffectPropertyMap('short_effect_map')
1864
1865 MoveChangelog.changed_in = relation(VersionGroup,
1866     innerjoin=True, lazy='joined',
1867     backref='move_changelog')
1868 MoveChangelog.move_effect = relation(MoveEffect,
1869     backref='move_changelog')
1870 MoveChangelog.type = relation(Type,
1871     backref='move_changelog')
1872
1873 MoveChangelog.effect = markdown.MoveEffectProperty('effect')
1874 MoveChangelog.effect_map = markdown.MoveEffectPropertyMap('effect_map')
1875 MoveChangelog.short_effect = markdown.MoveEffectProperty('short_effect')
1876 MoveChangelog.short_effect_map = markdown.MoveEffectPropertyMap('short_effect_map')
1877
1878 MoveEffect.changelog = relation(MoveEffectChangelog,
1879     order_by=MoveEffectChangelog.changed_in_version_group_id.desc(),
1880     backref='move_effect')
1881
1882 MoveEffectChangelog.changed_in = relation(VersionGroup,
1883     innerjoin=True, lazy='joined',
1884     backref='move_effect_changelog')
1885
1886 MoveFlag.flag = relation(MoveFlagType, innerjoin=True, lazy='joined')
1887
1888 MoveFlavorText.version_group = relation(VersionGroup,
1889     innerjoin=True, lazy='joined')
1890 MoveFlavorText.language = relation(Language,
1891     innerjoin=True, lazy='joined')
1892
1893 MoveMeta.category = relation(MoveMetaCategory,
1894     innerjoin=True, lazy='joined',
1895     backref='move_meta')
1896 MoveMeta.ailment = relation(MoveMetaAilment,
1897     innerjoin=True, lazy='joined',
1898     backref='move_meta')
1899
1900 MoveMetaStatChange.stat = relation(Stat,
1901     innerjoin=True, lazy='joined',
1902     backref='move_meta_stat_changes')
1903
1904
1905 Nature.decreased_stat = relation(Stat,
1906     primaryjoin=Nature.decreased_stat_id==Stat.id,
1907     innerjoin=True,
1908     backref='decreasing_natures')
1909 Nature.increased_stat = relation(Stat,
1910     primaryjoin=Nature.increased_stat_id==Stat.id,
1911     innerjoin=True,
1912     backref='increasing_natures')
1913 Nature.hates_flavor = relation(ContestType,
1914     primaryjoin=Nature.hates_flavor_id==ContestType.id,
1915     innerjoin=True,
1916     backref='hating_natures')
1917 Nature.likes_flavor = relation(ContestType,
1918     primaryjoin=Nature.likes_flavor_id==ContestType.id,
1919     innerjoin=True,
1920     backref='liking_natures')
1921 Nature.battle_style_preferences = relation(NatureBattleStylePreference,
1922     order_by=NatureBattleStylePreference.move_battle_style_id.asc(),
1923     backref='nature')
1924 Nature.pokeathlon_effects = relation(NaturePokeathlonStat,
1925     order_by=NaturePokeathlonStat.pokeathlon_stat_id.asc())
1926
1927 NatureBattleStylePreference.battle_style = relation(MoveBattleStyle,
1928     innerjoin=True, lazy='joined',
1929     backref='nature_preferences')
1930
1931 NaturePokeathlonStat.pokeathlon_stat = relation(PokeathlonStat,
1932     innerjoin=True, lazy='joined',
1933     backref='nature_effects')
1934
1935
1936 Pokedex.region = relation(Region,
1937     innerjoin=True,
1938     backref='pokedexes')
1939 Pokedex.version_groups = relation(VersionGroup,
1940     innerjoin=True,
1941     order_by=VersionGroup.id.asc(),
1942     backref='pokedex')
1943
1944
1945 Pokemon.all_abilities = relation(Ability,
1946     secondary=PokemonAbility.__table__,
1947     order_by=PokemonAbility.slot.asc(),
1948     innerjoin=True,
1949     backref=backref('all_pokemon',
1950         order_by=Pokemon.order.asc(),
1951     ),
1952 )
1953 Pokemon.abilities = relation(Ability,
1954     secondary=PokemonAbility.__table__,
1955     primaryjoin=and_(
1956         Pokemon.id == PokemonAbility.pokemon_id,
1957         PokemonAbility.is_dream == False,
1958     ),
1959     innerjoin=True,
1960     order_by=PokemonAbility.slot.asc(),
1961     backref=backref('pokemon',
1962         order_by=Pokemon.order.asc(),
1963     ),
1964 )
1965 Pokemon.dream_ability = relation(Ability,
1966     secondary=PokemonAbility.__table__,
1967     primaryjoin=and_(
1968         Pokemon.id == PokemonAbility.pokemon_id,
1969         PokemonAbility.is_dream == True,
1970     ),
1971     uselist=False,
1972     backref=backref('dream_pokemon',
1973         order_by=Pokemon.order,
1974     ),
1975 )
1976 Pokemon.pokemon_color = relation(PokemonColor,
1977     innerjoin=True,
1978     backref='pokemon')
1979 Pokemon.color = association_proxy('pokemon_color', 'name')
1980 Pokemon.dex_numbers = relation(PokemonDexNumber,
1981     innerjoin=True,
1982     order_by=PokemonDexNumber.pokedex_id.asc(),
1983     backref='pokemon')
1984 Pokemon.egg_groups = relation(EggGroup,
1985     secondary=PokemonEggGroup.__table__,
1986     innerjoin=True,
1987     order_by=PokemonEggGroup.egg_group_id.asc(),
1988     backref=backref('pokemon', order_by=Pokemon.order.asc()))
1989 Pokemon.evolution_chain = relation(EvolutionChain,
1990     innerjoin=True,
1991     backref=backref('pokemon', order_by=Pokemon.order.asc()))
1992 Pokemon.parent_pokemon = relation(Pokemon,
1993     primaryjoin=Pokemon.evolves_from_pokemon_id==Pokemon.id,
1994     remote_side=[Pokemon.id],
1995     backref='child_pokemon')
1996 Pokemon.evolutions = relation(PokemonEvolution,
1997     primaryjoin=Pokemon.id==PokemonEvolution.evolved_pokemon_id,
1998     backref=backref('evolved_pokemon', innerjoin=True, lazy='joined'))
1999 Pokemon.flavor_text = relation(PokemonFlavorText,
2000     order_by=PokemonFlavorText.version_id.asc(),
2001     backref='pokemon')
2002 Pokemon.forms = relation(PokemonForm,
2003     primaryjoin=Pokemon.id==PokemonForm.form_base_pokemon_id,
2004     order_by=(PokemonForm.order.asc(), PokemonForm.identifier.asc()))
2005 Pokemon.default_form = relation(PokemonForm,
2006     primaryjoin=and_(
2007         Pokemon.id==PokemonForm.form_base_pokemon_id,
2008         PokemonForm.is_default==True),
2009     uselist=False)
2010 Pokemon.pokemon_habitat = relation(PokemonHabitat,
2011     backref='pokemon')
2012 Pokemon.habitat = association_proxy('pokemon_habitat', 'name')
2013 Pokemon.items = relation(PokemonItem,
2014     backref='pokemon')
2015 Pokemon.generation = relation(Generation,
2016     innerjoin=True,
2017     backref='pokemon')
2018 Pokemon.shape = relation(PokemonShape,
2019     innerjoin=True,
2020     backref='pokemon')
2021 Pokemon.stats = relation(PokemonStat,
2022     innerjoin=True,
2023     order_by=PokemonStat.stat_id.asc(),
2024     backref='pokemon')
2025 Pokemon.types = relation(Type,
2026     secondary=PokemonType.__table__,
2027     innerjoin=True,
2028     order_by=PokemonType.slot.asc(),
2029     backref=backref('pokemon', order_by=Pokemon.order))
2030
2031 PokemonDexNumber.pokedex = relation(Pokedex,
2032     innerjoin=True, lazy='joined')
2033
2034 PokemonEvolution.trigger = relation(EvolutionTrigger,
2035     innerjoin=True, lazy='joined',
2036     backref='evolutions')
2037 PokemonEvolution.trigger_item = relation(Item,
2038     primaryjoin=PokemonEvolution.trigger_item_id==Item.id,
2039     backref='triggered_evolutions')
2040 PokemonEvolution.held_item = relation(Item,
2041     primaryjoin=PokemonEvolution.held_item_id==Item.id,
2042     backref='required_for_evolutions')
2043 PokemonEvolution.location = relation(Location,
2044     backref='triggered_evolutions')
2045 PokemonEvolution.known_move = relation(Move,
2046     backref='triggered_evolutions')
2047 PokemonEvolution.party_pokemon = relation(Pokemon,
2048     primaryjoin=PokemonEvolution.party_pokemon_id==Pokemon.id,
2049     backref='triggered_evolutions')
2050 PokemonEvolution.trade_pokemon = relation(Pokemon,
2051     primaryjoin=PokemonEvolution.trade_pokemon_id==Pokemon.id)
2052
2053 PokemonFlavorText.version = relation(Version, innerjoin=True, lazy='joined')
2054 PokemonFlavorText.language = relation(Language, innerjoin=True, lazy='joined')
2055
2056 PokemonForm.form_base_pokemon = relation(Pokemon,
2057     primaryjoin=PokemonForm.form_base_pokemon_id==Pokemon.id,
2058     innerjoin=True)
2059 PokemonForm.unique_pokemon = relation(Pokemon,
2060     primaryjoin=PokemonForm.unique_pokemon_id==Pokemon.id,
2061     backref=backref('unique_form', uselist=False))
2062 PokemonForm.version_group = relation(VersionGroup,
2063     innerjoin=True)
2064 PokemonForm.form_group = association_proxy('form_base_pokemon', 'form_group')
2065 PokemonForm.pokeathlon_stats = relation(PokemonFormPokeathlonStat,
2066     order_by=PokemonFormPokeathlonStat.pokeathlon_stat_id,
2067     backref='pokemon_form')
2068
2069 PokemonFormGroup.pokemon = relation(Pokemon,
2070     innerjoin=True,
2071     backref=backref('form_group', uselist=False))
2072
2073 PokemonFormPokeathlonStat.pokeathlon_stat = relation(PokeathlonStat,
2074     innerjoin=True, lazy='joined')
2075
2076 PokemonItem.item = relation(Item,
2077     innerjoin=True, lazy='joined',
2078     backref='pokemon')
2079 PokemonItem.version = relation(Version,
2080     innerjoin=True, lazy='joined')
2081
2082 PokemonMove.pokemon = relation(Pokemon,
2083     innerjoin=True, lazy='joined',
2084     backref='pokemon_moves')
2085 PokemonMove.version_group = relation(VersionGroup,
2086     innerjoin=True, lazy='joined')
2087 PokemonMove.machine = relation(Machine,
2088     primaryjoin=and_(
2089         Machine.version_group_id==PokemonMove.version_group_id,
2090         Machine.move_id==PokemonMove.move_id),
2091     foreign_keys=[Machine.version_group_id, Machine.move_id],
2092     uselist=False,
2093     backref='pokemon_moves')
2094 PokemonMove.move = relation(Move,
2095     innerjoin=True, lazy='joined',
2096     backref='pokemon_moves')
2097 PokemonMove.method = relation(PokemonMoveMethod,
2098     innerjoin=True, lazy='joined')
2099
2100 PokemonStat.stat = relation(Stat,
2101     innerjoin=True, lazy='joined')
2102
2103
2104 Region.generation = relation(Generation, uselist=False)
2105 Region.version_group_regions = relation(VersionGroupRegion,
2106     order_by=VersionGroupRegion.version_group_id.asc(),
2107     backref='region')
2108 Region.version_groups = association_proxy('version_group_regions', 'version_group')
2109
2110
2111 Stat.damage_class = relation(MoveDamageClass,
2112     backref='stats')
2113
2114 StatHint.stat = relation(Stat,
2115     innerjoin=True,
2116     backref='hints')
2117
2118
2119 SuperContestCombo.first = relation(Move,
2120     primaryjoin=SuperContestCombo.first_move_id==Move.id,
2121     innerjoin=True, lazy='joined',
2122     backref='super_contest_combo_first')
2123 SuperContestCombo.second = relation(Move,
2124     primaryjoin=SuperContestCombo.second_move_id==Move.id,
2125     innerjoin=True, lazy='joined',
2126     backref='super_contest_combo_second')
2127
2128
2129 Type.damage_efficacies = relation(TypeEfficacy,
2130     primaryjoin=Type.id==TypeEfficacy.damage_type_id,
2131     backref=backref('damage_type', innerjoin=True, lazy='joined'))
2132 Type.target_efficacies = relation(TypeEfficacy,
2133     primaryjoin=Type.id==TypeEfficacy.target_type_id,
2134     backref=backref('target_type', innerjoin=True, lazy='joined'))
2135
2136 Type.generation = relation(Generation,
2137     innerjoin=True,
2138     backref='types')
2139 Type.damage_class = relation(MoveDamageClass,
2140     backref='types')
2141
2142
2143 Version.generation = association_proxy('version_group', 'generation')
2144
2145 VersionGroup.versions = relation(Version,
2146     innerjoin=True,
2147     order_by=Version.id,
2148     backref=backref('version_group', lazy='joined'))
2149 VersionGroup.generation = relation(Generation,
2150     innerjoin=True, lazy='joined',
2151     backref='version_groups')
2152 VersionGroup.version_group_regions = relation(VersionGroupRegion,
2153     backref='version_group')
2154 VersionGroup.regions = association_proxy('version_group_regions', 'region')