X-Git-Url: http://git.veekun.com/zzz-pokedex.git/blobdiff_plain/31634e7159d8c385b5382ed47037972e88478358..2a8dec47ae303c6b011d8b71e8e096a602518e23:/pokedex/db/tables.py diff --git a/pokedex/db/tables.py b/pokedex/db/tables.py index 8ea9586..5670da9 100644 --- a/pokedex/db/tables.py +++ b/pokedex/db/tables.py @@ -15,101 +15,135 @@ Columns have a info dictionary with these keys: - identifier: A fan-made identifier in the [-_a-z0-9]* format. Not intended for translation. - latex: A formula in LaTeX syntax. +- ripped: True for text that has been ripped from the games, and can be ripped + again for new versions or languages + +See `pokedex.db.multilang` for how localizable text columns work. The session +classes in that module can be used to change the default language. """ # XXX: Check if "gametext" is set correctly everywhere -from sqlalchemy import Column, ForeignKey, MetaData, PrimaryKeyConstraint, Table -from sqlalchemy.ext.declarative import declarative_base, declared_attr +import collections +from functools import partial + +from sqlalchemy import Column, ForeignKey, MetaData, PrimaryKeyConstraint, Table, UniqueConstraint +from sqlalchemy.ext.declarative import declarative_base, DeclarativeMeta from sqlalchemy.ext.associationproxy import association_proxy -from sqlalchemy.orm import backref, eagerload_all, relation, class_mapper +from sqlalchemy.orm import backref, relation from sqlalchemy.orm.session import Session -from sqlalchemy.orm.collections import attribute_mapped_collection +from sqlalchemy.orm.interfaces import AttributeExtension from sqlalchemy.sql import and_ +from sqlalchemy.schema import ColumnDefault from sqlalchemy.types import * -from inspect import isclass -from pokedex.db import markdown - -metadata = MetaData() -TableBase = declarative_base(metadata=metadata) +from pokedex.db import markdown, multilang -### Helper classes -class Named(object): - """Mixin for objects that have names""" +class TableSuperclass(object): + """Superclass for declarative tables, to give them some generic niceties + like stringification. + """ def __unicode__(self): + """Be as useful as possible. Show the primary key, and an identifier + if we've got one. + """ + typename = u'.'.join((__name__, type(self).__name__)) + + pk_constraint = self.__table__.primary_key + if not pk_constraint: + return u"<%s object at %x>" % (typename, id(self)) + + pk = u', '.join(unicode(getattr(self, column.name)) + for column in pk_constraint.columns) try: - return '<%s: %s>' % (type(self).__name__, self.identifier) + return u"<%s object (%s): %s>" % (typename, pk, self.identifier) except AttributeError: - return '<%s>' % type(self).__name__ + return u"<%s object (%s)>" % (typename, pk) def __str__(self): - return unicode(self).encode('utf-8') + return unicode(self).encode('utf8') - def __repr__(self): - return str(self) +mapped_classes = [] +class TableMetaclass(DeclarativeMeta): + def __init__(cls, name, bases, attrs): + super(TableMetaclass, cls).__init__(name, bases, attrs) + if hasattr(cls, '__tablename__'): + mapped_classes.append(cls) + cls.translation_classes = [] -class OfficiallyNamed(Named): - """Mixin for stuff with official names""" - -class UnofficiallyNamed(Named): - """Mixin for stuff with unofficial names""" - -class LanguageSpecific(object): - """Mixin for prose and text tables""" - @declared_attr - def language_id(cls): - return Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, - info=dict(description="The language")) +metadata = MetaData() +TableBase = declarative_base(metadata=metadata, cls=TableSuperclass, metaclass=TableMetaclass) -class LanguageSpecificColumn(object): - """A column that will not appear in the table it's defined in, but in a related one""" - def __init__(self, *args, **kwargs): - self.args = args - self.plural = kwargs.pop('plural') - self.kwargs = kwargs - def makeSAColumn(self): - return Column(*self.args, **self.kwargs) +### Need Language first, to create the partial() below -class ProseColumn(LanguageSpecificColumn): - """A column that will appear in the corresponding _prose table""" +class Language(TableBase): + u"""A language the Pokémon games have been translated into + """ + __tablename__ = 'languages' + __singlename__ = 'language' + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, + info=dict(description="A numeric ID")) + iso639 = Column(Unicode(2), nullable=False, + info=dict(description="The two-letter code of the country where this language is spoken. Note that it is not unique.", format='identifier')) + iso3166 = Column(Unicode(2), nullable=False, + info=dict(description="The two-letter code of the language. Note that it is not unique.", format='identifier')) + identifier = Column(Unicode(16), nullable=False, + info=dict(description="An identifier", format='identifier')) + official = Column(Boolean, nullable=False, index=True, + info=dict(description=u"True iff games are produced in the language.")) + order = Column(Integer, nullable=True, + info=dict(description=u"Order for sorting in foreign name lists.")) -class TextColumn(LanguageSpecificColumn): - """A column that will appear in the corresponding _text table""" +create_translation_table = partial(multilang.create_translation_table, language_class=Language) +create_translation_table('language_names', Language, 'names', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) ### The actual tables -class Ability(TableBase, OfficiallyNamed): +class Ability(TableBase): u"""An ability a Pokémon can have, such as Static or Pressure. """ __tablename__ = 'abilities' __singlename__ = 'ability' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="This ability's unique ID; matches the games' internal ID")) identifier = Column(Unicode(24), nullable=False, info=dict(description="An identifier", format='identifier')) generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False, info=dict(description="The ID of the generation this ability was introduced in", detail=True)) - effect = ProseColumn(markdown.MarkdownColumn(5120), plural='effects', nullable=False, - info=dict(description="A detailed description of this ability's effect", format='markdown')) - short_effect = ProseColumn(markdown.MarkdownColumn(255), plural='short_effects', nullable=False, - info=dict(description="A short summary of this ability's effect", format='markdown')) + +create_translation_table('ability_names', Ability, 'names', + relation_lazy='joined', + name = Column(Unicode(24), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True, ripped=True)), +) +create_translation_table('ability_prose', Ability, 'prose', + effect = Column(markdown.MarkdownColumn(5120), nullable=True, + info=dict(description="A detailed description of this ability's effect", format='markdown')), + short_effect = Column(markdown.MarkdownColumn(255), nullable=True, + info=dict(description="A short summary of this ability's effect", format='markdown')), +) class AbilityChangelog(TableBase): """History of changes to abilities across main game versions.""" __tablename__ = 'ability_changelog' __singlename__ = 'ability_changelog' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="This change's unique ID")) ability_id = Column(Integer, ForeignKey('abilities.id'), nullable=False, info=dict(description="The ID of the ability that changed")) changed_in_version_group_id = Column(Integer, ForeignKey('version_groups.id'), nullable=False, info=dict(description="The ID of the version group in which the ability changed")) - effect = ProseColumn(markdown.MarkdownColumn(255), plural='effects', nullable=False, + +create_translation_table('ability_changelog_prose', AbilityChangelog, 'prose', + effect = Column(markdown.MarkdownColumn(255), nullable=False, info=dict(description="A description of the old behavior", format='markdown')) +) -class AbilityFlavorText(TableBase, LanguageSpecific): +class AbilityFlavorText(TableBase): u"""In-game flavor text of an ability """ __tablename__ = 'ability_flavor_text' @@ -117,6 +151,8 @@ class AbilityFlavorText(TableBase, LanguageSpecific): info=dict(description="The ID of the ability")) version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description="The ID of the version group this flavor text is taken from")) + language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, autoincrement=False, + info=dict(description="The language")) flavor_text = Column(Unicode(64), nullable=False, info=dict(description="The actual flavor text", official=True, format='gametext')) @@ -126,7 +162,7 @@ class Berry(TableBase): For data common to all items, such as the name, see the corresponding item entry. """ __tablename__ = 'berries' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="This Berry's in-game number")) item_id = Column(Integer, ForeignKey('items.id'), nullable=False, info=dict(description="The ID of the item that represents this Berry")) @@ -147,16 +183,22 @@ class Berry(TableBase): smoothness = Column(Integer, nullable=False, info=dict(description="The smoothness of this Berry, used in making Pokéblocks or Poffins")) -class BerryFirmness(TableBase, OfficiallyNamed): +class BerryFirmness(TableBase): u"""A Berry firmness, such as "hard" or "very soft". """ __tablename__ = 'berry_firmness' __singlename__ = 'berry_firmness' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A unique ID for this firmness")) identifier = Column(Unicode(10), nullable=False, info=dict(description="An identifier", format='identifier')) +create_translation_table('berry_firmness_names', BerryFirmness, 'names', + relation_lazy='joined', + name = Column(Unicode(10), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) + class BerryFlavor(TableBase): u"""A Berry flavor level. """ @@ -182,43 +224,58 @@ class ContestEffect(TableBase): """ __tablename__ = 'contest_effects' __singlename__ = 'contest_effect' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A unique ID for this effect")) appeal = Column(SmallInteger, nullable=False, info=dict(description="The base number of hearts the user of this move gets")) jam = Column(SmallInteger, nullable=False, info=dict(description="The base number of hearts the user's opponent loses")) - flavor_text = ProseColumn(Unicode(64), plural='flavor_texts', nullable=False, - info=dict(description="The in-game description of this effect", official=True, format='gametext')) - effect = ProseColumn(Unicode(255), plural='effects', nullable=False, - info=dict(description="A detailed description of the effect", format='plaintext')) -class ContestType(TableBase, OfficiallyNamed): +create_translation_table('contest_effect_prose', ContestEffect, 'prose', + flavor_text = Column(Unicode(64), nullable=True, + info=dict(description="The in-game description of this effect", official=True, format='gametext')), + effect = Column(Unicode(255), nullable=True, + info=dict(description="A detailed description of the effect", format='plaintext')), +) + +class ContestType(TableBase): u"""A Contest type, such as "cool" or "smart", and their associated Berry flavors and Pokéblock colors. """ __tablename__ = 'contest_types' __singlename__ = 'contest_type' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A unique ID for this Contest type")) identifier = Column(Unicode(6), nullable=False, info=dict(description="An identifier", format='identifier')) - flavor = TextColumn(Unicode(6), nullable=False, plural='flavors', - info=dict(description="The name of the corresponding Berry flavor", official=True, format='plaintext')) - color = TextColumn(Unicode(6), nullable=False, plural='colors', - info=dict(description=u"The name of the corresponding Pokéblock color", official=True, format='plaintext')) -class EggGroup(TableBase, UnofficiallyNamed): +create_translation_table('contest_type_names', ContestType, 'names', + relation_lazy='joined', + name = Column(Unicode(6), nullable=True, index=True, + info=dict(description="The name", format='plaintext', official=True)), + flavor = Column(Unicode(6), nullable=True, + info=dict(description="The name of the corresponding Berry flavor", official=True, format='plaintext')), + color = Column(Unicode(6), nullable=True, + info=dict(description=u"The name of the corresponding Pokéblock color", official=True, format='plaintext')), +) + +class EggGroup(TableBase): u"""An Egg group. Usually, two Pokémon can breed if they share an Egg Group. (exceptions are the Ditto and No Eggs groups) """ __tablename__ = 'egg_groups' __singlename__ = 'egg_group' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A unique ID for this group")) identifier = Column(Unicode(16), nullable=False, info=dict(description=u"An identifier.", format='identifier')) +create_translation_table('egg_group_prose', EggGroup, 'names', + relation_lazy='joined', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) + class Encounter(TableBase): u"""Encounters with wild Pokémon. @@ -244,7 +301,7 @@ class Encounter(TableBase): """ __tablename__ = 'encounters' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A unique ID for this encounter")) version_id = Column(Integer, ForeignKey('versions.id'), nullable=False, autoincrement=False, info=dict(description="The ID of the version this applies to")) @@ -259,24 +316,29 @@ class Encounter(TableBase): max_level = Column(Integer, nullable=False, autoincrement=False, info=dict(description=u"The maxmum level of the encountered Pokémon")) -class EncounterCondition(TableBase, UnofficiallyNamed): +class EncounterCondition(TableBase): u"""A conditions in the game world that affects Pokémon encounters, such as time of day. """ __tablename__ = 'encounter_conditions' __singlename__ = 'encounter_condition' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A unique ID for this condition")) identifier = Column(Unicode(64), nullable=False, info=dict(description="An identifier", format='identifier')) -class EncounterConditionValue(TableBase, UnofficiallyNamed): +create_translation_table('encounter_condition_prose', EncounterCondition, 'prose', + name = Column(Unicode(64), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), +) + +class EncounterConditionValue(TableBase): u"""A possible state for a condition; for example, the state of 'swarm' could be 'swarm' or 'no swarm'. """ __tablename__ = 'encounter_condition_values' __singlename__ = 'encounter_condition_value' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) encounter_condition_id = Column(Integer, ForeignKey('encounter_conditions.id'), primary_key=False, nullable=False, autoincrement=False, info=dict(description="The ID of the encounter condition this is a value of")) @@ -285,6 +347,11 @@ class EncounterConditionValue(TableBase, UnofficiallyNamed): is_default = Column(Boolean, nullable=False, info=dict(description='Set if this value is the default state for the condition')) +create_translation_table('encounter_condition_value_prose', EncounterConditionValue, 'prose', + name = Column(Unicode(64), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), +) + class EncounterConditionValueMap(TableBase): u"""Maps encounters to the specific conditions under which they occur. """ @@ -294,17 +361,6 @@ class EncounterConditionValueMap(TableBase): encounter_condition_value_id = Column(Integer, ForeignKey('encounter_condition_values.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description="The ID of the encounter condition value")) -class EncounterTerrain(TableBase, UnofficiallyNamed): - u"""A way the player can enter a wild encounter, e.g., surfing, fishing, or walking through tall grass. - """ - - __tablename__ = 'encounter_terrain' - __singlename__ = __tablename__ - id = Column(Integer, primary_key=True, nullable=False, - info=dict(description="A unique ID for the terrain")) - identifier = Column(Unicode(64), nullable=False, - info=dict(description="An identifier", format='identifier')) - class EncounterSlot(TableBase): u"""An abstract "slot" within a terrain, associated with both some set of conditions and a rarity. @@ -313,7 +369,7 @@ class EncounterSlot(TableBase): """ __tablename__ = 'encounter_slots' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A unique ID for this slot")) version_group_id = Column(Integer, ForeignKey('version_groups.id'), nullable=False, autoincrement=False, info=dict(description="The ID of the version group this slot is in")) @@ -324,70 +380,102 @@ class EncounterSlot(TableBase): rarity = Column(Integer, nullable=False, info=dict(description="The chance of the encounter as a percentage")) +class EncounterTerrain(TableBase): + u"""A way the player can enter a wild encounter, e.g., surfing, fishing, or walking through tall grass. + """ + + __tablename__ = 'encounter_terrain' + __singlename__ = __tablename__ + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, + info=dict(description="A unique ID for the terrain")) + identifier = Column(Unicode(64), nullable=False, + info=dict(description="An identifier", format='identifier')) + +create_translation_table('encounter_terrain_prose', EncounterTerrain, 'prose', + name = Column(Unicode(64), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), +) + class EvolutionChain(TableBase): u"""A family of Pokémon that are linked by evolution """ __tablename__ = 'evolution_chains' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) growth_rate_id = Column(Integer, ForeignKey('growth_rates.id'), nullable=False, info=dict(description="ID of the growth rate for this family")) baby_trigger_item_id = Column(Integer, ForeignKey('items.id'), nullable=True, info=dict(description="Item that a parent must hold while breeding to produce a baby")) -class EvolutionTrigger(TableBase, UnofficiallyNamed): +class EvolutionTrigger(TableBase): u"""An evolution type, such as "level" or "trade". """ __tablename__ = 'evolution_triggers' __singlename__ = 'evolution_trigger' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) identifier = Column(Unicode(16), nullable=False, info=dict(description="An identifier", format='identifier')) +create_translation_table('evolution_trigger_prose', EvolutionTrigger, 'prose', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), +) + class Experience(TableBase): u"""EXP needed for a certain level with a certain growth rate """ __tablename__ = 'experience' - growth_rate_id = Column(Integer, ForeignKey('growth_rates.id'), primary_key=True, nullable=False, + growth_rate_id = Column(Integer, ForeignKey('growth_rates.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description="ID of the growth rate")) level = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="The level")) experience = Column(Integer, nullable=False, info=dict(description="The number of EXP points needed to get to that level")) -class Generation(TableBase, OfficiallyNamed): +class Generation(TableBase): u"""A Generation of the Pokémon franchise """ __tablename__ = 'generations' __singlename__ = 'generation' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) - main_region_id = Column(Integer, ForeignKey('regions.id'), + main_region_id = Column(Integer, ForeignKey('regions.id'), nullable=False, info=dict(description="ID of the region this generation's main games take place in")) - canonical_pokedex_id = Column(Integer, ForeignKey('pokedexes.id'), + canonical_pokedex_id = Column(Integer, ForeignKey('pokedexes.id'), nullable=False, info=dict(description=u"ID of the Pokédex this generation's main games use by default")) identifier = Column(Unicode(16), nullable=False, info=dict(description=u'An identifier', format='identifier')) -class GrowthRate(TableBase, UnofficiallyNamed): +create_translation_table('generation_names', Generation, 'names', + relation_lazy='joined', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) + +class GrowthRate(TableBase): u"""Growth rate of a Pokémon, i.e. the EXP → level function. """ __tablename__ = 'growth_rates' __singlename__ = 'growth_rate' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) identifier = Column(Unicode(20), nullable=False, info=dict(description="An identifier", format='identifier')) formula = Column(Unicode(500), nullable=False, info=dict(description="The formula", format='latex')) -class Item(TableBase, OfficiallyNamed): +create_translation_table('growth_rate_prose', GrowthRate, 'prose', + name = Column(Unicode(20), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), +) + +class Item(TableBase): u"""An Item from the games, like "Poké Ball" or "Bicycle". """ __tablename__ = 'items' __singlename__ = 'item' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) identifier = Column(Unicode(20), nullable=False, info=dict(description="An identifier", format='identifier')) @@ -399,10 +487,6 @@ class Item(TableBase, OfficiallyNamed): info=dict(description=u"Power of the move Fling when used with this item.")) fling_effect_id = Column(Integer, ForeignKey('item_fling_effects.id'), nullable=True, 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.")) - short_effect = ProseColumn(Unicode(256), plural='short_effects', nullable=False, - info=dict(description="A short summary of the effect", format='plaintext')) - effect = ProseColumn(markdown.MarkdownColumn(5120), plural='effects', nullable=False, - info=dict(description=u"Detailed description of the item's effect.", format='markdown')) @property def appears_underground(self): @@ -410,30 +494,57 @@ class Item(TableBase, OfficiallyNamed): """ return any(flag.identifier == u'underground' for flag in self.flags) -class ItemCategory(TableBase, UnofficiallyNamed): +create_translation_table('item_names', Item, 'names', + relation_lazy='joined', + name = Column(Unicode(20), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True, ripped=True)), +) +create_translation_table('item_prose', Item, 'prose', + short_effect = Column(markdown.MarkdownColumn(256), nullable=True, + info=dict(description="A short summary of the effect", format='markdown')), + effect = Column(markdown.MarkdownColumn(5120), nullable=True, + info=dict(description=u"Detailed description of the item's effect.", format='markdown')), +) +create_translation_table('item_flavor_summaries', Item, 'flavor_summaries', + flavor_summary = Column(Unicode(512), nullable=True, + info=dict(description=u"Text containing facts from all flavor texts, for languages without official game translations", official=False, format='plaintext', ripped=True)), +) + +class ItemCategory(TableBase): u"""An item category """ # XXX: This is fanon, right? __tablename__ = 'item_categories' __singlename__ = 'item_category' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) pocket_id = Column(Integer, ForeignKey('item_pockets.id'), nullable=False, info=dict(description="ID of the pocket these items go to")) identifier = Column(Unicode(16), nullable=False, info=dict(description="An identifier", format='identifier')) -class ItemFlag(TableBase, UnofficiallyNamed): +create_translation_table('item_category_prose', ItemCategory, 'prose', + relation_lazy='joined', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), +) + +class ItemFlag(TableBase): u"""An item attribute such as "consumable" or "holdable". """ __tablename__ = 'item_flags' __singlename__ = 'item_flag' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) identifier = Column(Unicode(24), nullable=False, info=dict(description="Identifier of the flag", format='identifier')) - description = ProseColumn(Unicode(64), plural='descriptions', nullable=False, - info=dict(description="Short description of the flag", format='plaintext')) + +create_translation_table('item_flag_prose', ItemFlag, 'prose', + name = Column(Unicode(24), nullable=True, index=True, + info=dict(description="The name", format='plaintext', official=False)), + description = Column(Unicode(64), nullable=True, + info=dict(description="Short description of the flag", format='plaintext')), +) class ItemFlagMap(TableBase): u"""Maps an item flag to its item. @@ -444,15 +555,18 @@ class ItemFlagMap(TableBase): item_flag_id = Column(Integer, ForeignKey('item_flags.id'), primary_key=True, autoincrement=False, nullable=False, info=dict(description="The ID of the item flag")) -class ItemFlavorText(TableBase, LanguageSpecific): +class ItemFlavorText(TableBase): u"""An in-game description of an item """ __tablename__ = 'item_flavor_text' __singlename__ = 'item_flavor_text' + summary_column = Item.flavor_summaries_table, 'flavor_summary' item_id = Column(Integer, ForeignKey('items.id'), primary_key=True, autoincrement=False, nullable=False, info=dict(description="The ID of the item")) version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, autoincrement=False, nullable=False, info=dict(description="ID of the version group that sports this text")) + language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, autoincrement=False, + info=dict(description="The language")) flavor_text = Column(Unicode(255), nullable=False, info=dict(description="The flavor text itself", official=True, format='gametext')) @@ -461,94 +575,79 @@ class ItemFlingEffect(TableBase): """ __tablename__ = 'item_fling_effects' __singlename__ = 'item_fling_effect' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) - effect = ProseColumn(Unicode(255), plural='effects', nullable=False, - info=dict(description="Description of the effect", format='plaintext')) -class ItemInternalID(TableBase): +create_translation_table('item_fling_effect_prose', ItemFlingEffect, 'prose', + effect = Column(Unicode(255), nullable=False, + info=dict(description="Description of the effect", format='plaintext')), +) + +class ItemGameIndex(TableBase): u"""The internal ID number a game uses for an item """ - __tablename__ = 'item_internal_ids' + __tablename__ = 'item_game_indices' item_id = Column(Integer, ForeignKey('items.id'), primary_key=True, autoincrement=False, nullable=False, info=dict(description="The database ID of the item")) generation_id = Column(Integer, ForeignKey('generations.id'), primary_key=True, autoincrement=False, nullable=False, info=dict(description="ID of the generation of games")) - internal_id = Column(Integer, nullable=False, + game_index = Column(Integer, nullable=False, info=dict(description="Internal ID of the item in the generation")) -class ItemPocket(TableBase, OfficiallyNamed): +class ItemPocket(TableBase): u"""A pocket that categorizes items """ __tablename__ = 'item_pockets' __singlename__ = 'item_pocket' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) identifier = Column(Unicode(16), nullable=False, info=dict(description="An identifier of this pocket", format='identifier')) -class Language(TableBase, OfficiallyNamed): - u"""A language the Pokémon games have been transleted into - """ - __tablename__ = 'languages' - __singlename__ = 'language' - id = Column(Integer, primary_key=True, nullable=False, - info=dict(description="A numeric ID")) - iso639 = Column(Unicode(2), nullable=False, - info=dict(description="The two-letter code of the country where this language is spoken. Note that it is not unique.", format='identifier')) - iso3166 = Column(Unicode(2), nullable=False, - info=dict(description="The two-letter code of the language. Note that it is not unique.", format='identifier')) - identifier = Column(Unicode(16), nullable=False, - info=dict(description="An identifier", format='identifier')) - official = Column(Boolean, nullable=False, index=True, - info=dict(description=u"True iff games are produced in the language.")) - order = Column(Integer, nullable=True, - info=dict(description=u"Order for sorting in foreign name lists.")) - - # Languages compare equal to its identifier, so a dictionary of - # translations, with a Language as the key, can be indexed by the identifier - def __eq__(self, other): - try: - return ( - self is other or - self.identifier == other or - self.identifier == other.identifier - ) - except AttributeError: - return NotImplemented - - def __ne__(self, other): - return not (self == other) - - def __hash__(self): - return hash(self.identifier) +create_translation_table('item_pocket_names', ItemPocket, 'names', + relation_lazy='joined', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) -class Location(TableBase, OfficiallyNamed): +class Location(TableBase): u"""A place in the Pokémon world """ __tablename__ = 'locations' __singlename__ = 'location' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) region_id = Column(Integer, ForeignKey('regions.id'), info=dict(description="ID of the region this location is in")) identifier = Column(Unicode(64), nullable=False, info=dict(description="An identifier", format='identifier')) -class LocationArea(TableBase, UnofficiallyNamed): +create_translation_table('location_names', Location, 'names', + relation_lazy='joined', + name = Column(Unicode(64), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) + +class LocationArea(TableBase): u"""A sub-area of a location """ __tablename__ = 'location_areas' __singlename__ = 'location_area' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) location_id = Column(Integer, ForeignKey('locations.id'), nullable=False, info=dict(description="ID of the location this area is part of")) - internal_id = Column(Integer, nullable=False, + game_index = Column(Integer, nullable=False, info=dict(description="ID the games ude for this area")) identifier = Column(Unicode(64), nullable=True, info=dict(description="An identifier", format='identifier')) +create_translation_table('location_area_prose', LocationArea, 'prose', + relation_lazy='joined', + name = Column(Unicode(64), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), +) + class LocationAreaEncounterRate(TableBase): # XXX: What's this exactly? Someone add the docstring & revise the descriptions __tablename__ = 'location_area_encounter_rates' @@ -561,15 +660,15 @@ class LocationAreaEncounterRate(TableBase): rate = Column(Integer, nullable=True, info=dict(description="The encounter rate")) # units? -class LocationInternalID(TableBase): +class LocationGameIndex(TableBase): u"""IDs the games use internally for locations """ - __tablename__ = 'location_internal_ids' - location_id = Column(Integer, ForeignKey('locations.id'), nullable=False, primary_key=True, + __tablename__ = 'location_game_indices' + location_id = Column(Integer, ForeignKey('locations.id'), nullable=False, primary_key=True, autoincrement=False, info=dict(description="Database ID of the locaion")) - generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False, primary_key=True, + generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False, primary_key=True, autoincrement=False, info=dict(description="ID of the generation this entry to")) - internal_id = Column(Integer, nullable=False, + game_index = Column(Integer, nullable=False, info=dict(description="Internal game ID of the location")) class Machine(TableBase): @@ -591,74 +690,169 @@ class Machine(TableBase): """ return self.machine_number >= 100 -class MoveBattleStyle(TableBase, UnofficiallyNamed): +class Move(TableBase): + u"""A Move: technique or attack a Pokémon can learn to use + """ + __tablename__ = 'moves' + __singlename__ = 'move' + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, + info=dict(description="A numeric ID")) + identifier = Column(Unicode(24), nullable=False, + info=dict(description="An identifier", format='identifier')) + generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False, + info=dict(description="ID of the generation this move first appeared in")) + type_id = Column(Integer, ForeignKey('types.id'), nullable=False, + info=dict(description="ID of the move's elemental type")) + power = Column(SmallInteger, nullable=False, + info=dict(description="Base power of the move")) + pp = Column(SmallInteger, nullable=True, + info=dict(description="Base PP (Power Points) of the move, nullable if not applicable (e.g. Struggle and Shadow moves).")) + accuracy = Column(SmallInteger, nullable=True, + info=dict(description="Accuracy of the move; NULL means it never misses")) + priority = Column(SmallInteger, nullable=False, + info=dict(description="The move's priority bracket")) + target_id = Column(Integer, ForeignKey('move_targets.id'), nullable=False, + info=dict(description="ID of the target (range) of the move")) + damage_class_id = Column(Integer, ForeignKey('move_damage_classes.id'), nullable=False, + info=dict(description="ID of the damage class (physical/special) of the move")) + effect_id = Column(Integer, ForeignKey('move_effects.id'), nullable=False, + info=dict(description="ID of the move's effect")) + effect_chance = Column(Integer, nullable=True, + info=dict(description="The chance for a secondary effect. What this is a chance of is specified by the move's effect.")) + contest_type_id = Column(Integer, ForeignKey('contest_types.id'), nullable=True, + info=dict(description="ID of the move's Contest type (e.g. cool or smart)")) + contest_effect_id = Column(Integer, ForeignKey('contest_effects.id'), nullable=True, + info=dict(description="ID of the move's Contest effect")) + super_contest_effect_id = Column(Integer, ForeignKey('super_contest_effects.id'), nullable=True, + info=dict(description="ID of the move's Super Contest effect")) + +create_translation_table('move_names', Move, 'names', + relation_lazy='joined', + name = Column(Unicode(24), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True, ripped=True)) +) +create_translation_table('move_flavor_summaries', Move, 'flavor_summaries', + flavor_summary = Column(Unicode(512), nullable=True, + info=dict(description=u"Text containing facts from all flavor texts, for languages without official game translations", official=False, format='plaintext', ripped=True)), +) + +class MoveBattleStyle(TableBase): u"""A battle style of a move""" # XXX: Explain better __tablename__ = 'move_battle_styles' __singlename__ = 'move_battle_style' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) identifier = Column(Unicode(8), nullable=False, info=dict(description="An identifier", format='identifier')) -class MoveEffectCategory(TableBase, UnofficiallyNamed): +create_translation_table('move_battle_style_prose', MoveBattleStyle, 'prose', + relation_lazy='joined', + name = Column(Unicode(8), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), +) + +class MoveChangelog(TableBase): + """History of changes to moves across main game versions.""" + __tablename__ = 'move_changelog' + __singlename__ = 'move_changelog' + move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False, + info=dict(description="ID of the move that changed")) + changed_in_version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, autoincrement=False, + info=dict(description="ID of the version group in which the move changed")) + type_id = Column(Integer, ForeignKey('types.id'), nullable=True, + info=dict(description="Prior type of the move, or NULL if unchanged")) + power = Column(SmallInteger, nullable=True, + info=dict(description="Prior base power of the move, or NULL if unchanged")) + pp = Column(SmallInteger, nullable=True, + info=dict(description="Prior base PP of the move, or NULL if unchanged")) + accuracy = Column(SmallInteger, nullable=True, + info=dict(description="Prior accuracy of the move, or NULL if unchanged")) + effect_id = Column(Integer, ForeignKey('move_effects.id'), nullable=True, + info=dict(description="Prior ID of the effect, or NULL if unchanged")) + effect_chance = Column(Integer, nullable=True, + info=dict(description="Prior effect chance, or NULL if unchanged")) + +class MoveDamageClass(TableBase): + u"""Any of the damage classes moves can have, i.e. physical, special, or non-damaging. + """ + __tablename__ = 'move_damage_classes' + __singlename__ = 'move_damage_class' + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, + info=dict(description="A numeric ID")) + identifier = Column(Unicode(16), nullable=False, + info=dict(description="An identifier", format='identifier')) + +create_translation_table('move_damage_class_prose', MoveDamageClass, 'prose', + relation_lazy='joined', + name = Column(Unicode(16), nullable=True, index=True, + info=dict(description="The name", format='plaintext', official=False)), + description = Column(Unicode(64), nullable=True, + info=dict(description="A description of the class", format='plaintext')), +) + +class MoveEffect(TableBase): + u"""An effect of a move + """ + __tablename__ = 'move_effects' + __singlename__ = 'move_effect' + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, + info=dict(description="A numeric ID")) + +create_translation_table('move_effect_prose', MoveEffect, 'prose', + short_effect = Column(Unicode(256), nullable=True, + info=dict(description="A short summary of the effect", format='plaintext')), + effect = Column(Unicode(5120), nullable=True, + info=dict(description="A detailed description of the effect", format='plaintext')), +) + +class MoveEffectCategory(TableBase): u"""Category of a move effect """ __tablename__ = 'move_effect_categories' __singlename__ = 'move_effect_category' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) identifier = Column(Unicode(64), nullable=False, info=dict(description="An identifier", format='identifier')) can_affect_user = Column(Boolean, nullable=False, info=dict(description="Set if the user can be affected")) +create_translation_table('move_effect_category_prose', MoveEffectCategory, 'prose', + name = Column(Unicode(64), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), +) + class MoveEffectCategoryMap(TableBase): u"""Maps a move effect category to a move effect """ __tablename__ = 'move_effect_category_map' - move_effect_id = Column(Integer, ForeignKey('move_effects.id'), primary_key=True, nullable=False, + move_effect_id = Column(Integer, ForeignKey('move_effects.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description="ID of the move effect")) - move_effect_category_id = Column(Integer, ForeignKey('move_effect_categories.id'), primary_key=True, nullable=False, + move_effect_category_id = Column(Integer, ForeignKey('move_effect_categories.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description="ID of the category")) - affects_user = Column(Boolean, primary_key=True, nullable=False, + affects_user = Column(Boolean, primary_key=True, nullable=False, autoincrement=False, info=dict(description="Set if the user is affected")) -class MoveDamageClass(TableBase, UnofficiallyNamed): - u"""Any of the damage classes moves can have, i.e. physical, special, or non-damaging. - """ - __tablename__ = 'move_damage_classes' - __singlename__ = 'move_damage_class' - id = Column(Integer, primary_key=True, nullable=False, - info=dict(description="A numeric ID")) - identifier = Column(Unicode(16), nullable=False, - info=dict(description="An identifier", format='identifier')) - description = ProseColumn(Unicode(64), plural='descriptions', nullable=False, - info=dict(description="A description of the class", format='plaintext')) - -class MoveEffect(TableBase): - u"""An effect of a move - """ - __tablename__ = 'move_effects' - __singlename__ = 'move_effect' - id = Column(Integer, primary_key=True, nullable=False, - info=dict(description="A numeric ID")) - short_effect = ProseColumn(Unicode(256), plural='short_effects', nullable=False, - info=dict(description="A short summary of the effect", format='plaintext')) - effect = ProseColumn(Unicode(5120), plural='effects', nullable=False, - info=dict(description="A detailed description of the effect", format='plaintext')) - class MoveEffectChangelog(TableBase): """History of changes to move effects across main game versions.""" __tablename__ = 'move_effect_changelog' __singlename__ = 'move_effect_changelog' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) - effect_id = Column(Integer, ForeignKey('move_effects.id'), primary_key=True, nullable=False, + effect_id = Column(Integer, ForeignKey('move_effects.id'), nullable=False, info=dict(description="The ID of the effect that changed")) - changed_in_version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, + changed_in_version_group_id = Column(Integer, ForeignKey('version_groups.id'), nullable=False, info=dict(description="The ID of the version group in which the effect changed")) - effect = ProseColumn(markdown.MarkdownColumn(512), plural='effects', nullable=False, - info=dict(description="A description of the old behavior", format='markdown')) + + __table_args__ = ( + UniqueConstraint(effect_id, changed_in_version_group_id), + {}, + ) + +create_translation_table('move_effect_changelog_prose', MoveEffectChangelog, 'prose', + effect = Column(markdown.MarkdownColumn(512), nullable=False, + info=dict(description="A description of the old behavior", format='markdown')), +) class MoveFlag(TableBase): u"""Maps a move flag to a move @@ -671,144 +865,132 @@ class MoveFlag(TableBase): move_flag_type_id = Column(Integer, ForeignKey('move_flag_types.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description="ID of the flag")) -class MoveFlagType(TableBase, UnofficiallyNamed): +class MoveFlagType(TableBase): u"""A Move attribute such as "snatchable" or "contact". """ __tablename__ = 'move_flag_types' __singlename__ = 'move_flag_type' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) identifier = Column(Unicode(32), nullable=False, info=dict(description="A short identifier for the flag", format='identifier')) - description = ProseColumn(markdown.MarkdownColumn(128), plural='descriptions', nullable=False, - info=dict(description="A short description of the flag", format='markdown')) -class MoveFlavorText(TableBase, LanguageSpecific): +create_translation_table('move_flag_type_prose', MoveFlagType, 'prose', + relation_lazy='joined', + name = Column(Unicode(32), nullable=True, index=True, + info=dict(description="The name", format='plaintext', official=False)), + description = Column(markdown.MarkdownColumn(128), nullable=True, + info=dict(description="A short description of the flag", format='markdown')), +) + +class MoveFlavorText(TableBase): u"""In-game description of a move """ __tablename__ = 'move_flavor_text' + summary_column = Move.flavor_summaries_table, 'flavor_summary' move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description="ID of the move")) version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description="ID of the version group this text appears in")) + language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, autoincrement=False, + info=dict(description="The language")) flavor_text = Column(Unicode(255), nullable=False, info=dict(description="The flavor text", official=True, format='gametext')) class MoveMeta(TableBase): u"""Metadata for move effects, sorta-kinda ripped straight from the game""" __tablename__ = 'move_meta' - move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False) - meta_category_id = Column(Integer, ForeignKey('move_meta_categories.id'), nullable=False) - meta_ailment_id = Column(Integer, ForeignKey('move_meta_ailments.id'), nullable=False) - min_hits = Column(Integer, nullable=True, index=True) - max_hits = Column(Integer, nullable=True, index=True) - min_turns = Column(Integer, nullable=True, index=True) - max_turns = Column(Integer, nullable=True, index=True) - recoil = Column(Integer, nullable=False, index=True) - healing = Column(Integer, nullable=False, index=True) - crit_rate = Column(Integer, nullable=False, index=True) - ailment_chance = Column(Integer, nullable=False, index=True) - flinch_chance = Column(Integer, nullable=False, index=True) - stat_chance = Column(Integer, nullable=False, index=True) - -class MoveMetaAilment(TableBase, OfficiallyNamed): + move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False, + info=dict(description="A numeric ID")) + meta_category_id = Column(Integer, ForeignKey('move_meta_categories.id'), nullable=False, + info=dict(description="ID of the move category")) + meta_ailment_id = Column(Integer, ForeignKey('move_meta_ailments.id'), nullable=False, + info=dict(description="ID of the caused ailment")) + min_hits = Column(Integer, nullable=True, index=True, + info=dict(description="Minimum number of hits per use")) + max_hits = Column(Integer, nullable=True, index=True, + info=dict(description="Maximum number of hits per use")) + min_turns = Column(Integer, nullable=True, index=True, + info=dict(description="Minimum number of turns the user is forced to use the move")) + max_turns = Column(Integer, nullable=True, index=True, + info=dict(description="Maximum number of turns the user is forced to use the move")) + recoil = Column(Integer, nullable=False, index=True, + info=dict(description="Recoil damage, in percent of damage done")) + healing = Column(Integer, nullable=False, index=True, + info=dict(description="Healing, in percent of user's max HP")) + crit_rate = Column(Integer, nullable=False, index=True, + info=dict(description="Critical hit rate bonus")) + ailment_chance = Column(Integer, nullable=False, index=True, + info=dict(description="Chance to cause an ailment, in percent")) + flinch_chance = Column(Integer, nullable=False, index=True, + info=dict(description="Chance to cause flinching, in percent")) + stat_chance = Column(Integer, nullable=False, index=True, + info=dict(description="Chance to cause a stat change, in percent")) + +class MoveMetaAilment(TableBase): u"""Common status ailments moves can inflict on a single Pokémon, including major ailments like paralysis and minor ailments like trapping. """ __tablename__ = 'move_meta_ailments' __singlename__ = 'move_meta_ailment' - id = Column(Integer, primary_key=True, nullable=False) - identifier = Column(Unicode(24), nullable=False) + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, + info=dict(description="A numeric ID")) + identifier = Column(Unicode(24), nullable=False, + info=dict(description="An identifier", format='identifier')) + +create_translation_table('move_meta_ailment_names', MoveMetaAilment, 'names', + relation_lazy='joined', + name = Column(Unicode(24), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) class MoveMetaCategory(TableBase): u"""Very general categories that loosely group move effects.""" __tablename__ = 'move_meta_categories' __singlename__ = 'move_meta_category' - id = Column(Integer, primary_key=True, nullable=False) - description = ProseColumn(Unicode(64), plural='descriptions', nullable=False) + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, + info=dict(description="A numeric ID")) + +create_translation_table('move_meta_category_prose', MoveMetaCategory, 'prose', + relation_lazy='joined', + description = Column(Unicode(64), nullable=False, + info=dict(description="A description of the category", format="plaintext", official=False)), +) class MoveMetaStatChange(TableBase): u"""Stat changes moves (may) make.""" __tablename__ = 'move_meta_stat_changes' - move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False) - stat_id = Column(Integer, ForeignKey('stats.id'), primary_key=True, nullable=False, autoincrement=False) - change = Column(Integer, nullable=False, index=True) + move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False, + info=dict(description="ID of the move")) + stat_id = Column(Integer, ForeignKey('stats.id'), primary_key=True, nullable=False, autoincrement=False, + info=dict(description="ID of the stat")) + change = Column(Integer, nullable=False, index=True, + info=dict(description="Amount of increase/decrease, in stages")) -class MoveTarget(TableBase, UnofficiallyNamed): +class MoveTarget(TableBase): u"""Targetting or "range" of a move, e.g. "Affects all opponents" or "Affects user". """ __tablename__ = 'move_targets' __singlename__ = 'move_target' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) identifier = Column(Unicode(32), nullable=False, info=dict(description="An identifier", format='identifier')) - description = ProseColumn(Unicode(128), plural='descriptions', nullable=False, - info=dict(description="A description", format='plaintext')) -class Move(TableBase, OfficiallyNamed): - u"""A Move: technique or attack a Pokémon can learn to use - """ - __tablename__ = 'moves' - __singlename__ = 'move' - id = Column(Integer, primary_key=True, nullable=False, - info=dict(description="A numeric ID")) - identifier = Column(Unicode(24), nullable=False, - info=dict(description="An identifier", format='identifier')) - generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False, - info=dict(description="ID of the generation this move first appeared in")) - type_id = Column(Integer, ForeignKey('types.id'), nullable=False, - info=dict(description="ID of the move's elemental type")) - power = Column(SmallInteger, nullable=False, - info=dict(description="Base power of the move")) - pp = Column(SmallInteger, nullable=True, - info=dict(description="Base PP (Power Points) of the move, nullable if not applicable (e.g. Struggle and Shadow moves).")) - accuracy = Column(SmallInteger, nullable=True, - info=dict(description="Accuracy of the move; NULL means it never misses")) - priority = Column(SmallInteger, nullable=False, - info=dict(description="The move's priority bracket")) - target_id = Column(Integer, ForeignKey('move_targets.id'), nullable=False, - info=dict(description="ID of the target (range) of the move")) - damage_class_id = Column(Integer, ForeignKey('move_damage_classes.id'), nullable=False, - info=dict(description="ID of the damage class (physical/special) of the move")) - effect_id = Column(Integer, ForeignKey('move_effects.id'), nullable=False, - info=dict(description="ID of the move's effect")) - effect_chance = Column(Integer, nullable=True, - info=dict(description="The chance for a secondary effect. What this is a chance of is specified by the move's effect.")) - contest_type_id = Column(Integer, ForeignKey('contest_types.id'), nullable=True, - info=dict(description="ID of the move's Contest type (e.g. cool or smart)")) - contest_effect_id = Column(Integer, ForeignKey('contest_effects.id'), nullable=True, - info=dict(description="ID of the move's Contest effect")) - super_contest_effect_id = Column(Integer, ForeignKey('super_contest_effects.id'), nullable=True, - info=dict(description="ID of the move's Super Contest effect")) - -class MoveChangelog(TableBase): - """History of changes to moves across main game versions.""" - __tablename__ = 'move_changelog' - __singlename__ = 'move_changelog' - move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, - info=dict(description="ID of the move that changed")) - changed_in_version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, - info=dict(description="ID of the version group in which the move changed")) - type_id = Column(Integer, ForeignKey('types.id'), nullable=True, - info=dict(description="Prior type of the move, or NULL if unchanged")) - power = Column(SmallInteger, nullable=True, - info=dict(description="Prior base power of the move, or NULL if unchanged")) - pp = Column(SmallInteger, nullable=True, - info=dict(description="Prior base PP of the move, or NULL if unchanged")) - accuracy = Column(SmallInteger, nullable=True, - info=dict(description="Prior accuracy of the move, or NULL if unchanged")) - effect_id = Column(Integer, ForeignKey('move_effects.id'), nullable=True, - info=dict(description="Prior ID of the effect, or NULL if unchanged")) - effect_chance = Column(Integer, nullable=True, - info=dict(description="Prior effect chance, or NULL if unchanged")) +create_translation_table('move_target_prose', MoveTarget, 'prose', + relation_lazy='joined', + name = Column(Unicode(32), nullable=True, index=True, + info=dict(description="The name", format='plaintext', official=False)), + description = Column(Unicode(128), nullable=True, + info=dict(description="A description", format='plaintext')), +) -class Nature(TableBase, OfficiallyNamed): +class Nature(TableBase): u"""A nature a Pokémon can have, such as Calm or Brave """ __tablename__ = 'natures' __singlename__ = 'nature' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) identifier = Column(Unicode(8), nullable=False, info=dict(description="An identifier", format='identifier')) @@ -828,6 +1010,12 @@ class Nature(TableBase, OfficiallyNamed): """ return self.increased_stat_id == self.decreased_stat_id +create_translation_table('nature_names', Nature, 'names', + relation_lazy='joined', + name = Column(Unicode(8), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True, ripped=True)), +) + class NatureBattleStylePreference(TableBase): u"""Battle Palace move preference @@ -835,9 +1023,9 @@ class NatureBattleStylePreference(TableBase): a particular battl style in Battle Palace or Battle Tent """ __tablename__ = 'nature_battle_style_preferences' - nature_id = Column(Integer, ForeignKey('natures.id'), primary_key=True, nullable=False, + nature_id = Column(Integer, ForeignKey('natures.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description=u"ID of the Pokémon's nature")) - move_battle_style_id = Column(Integer, ForeignKey('move_battle_styles.id'), primary_key=True, nullable=False, + move_battle_style_id = Column(Integer, ForeignKey('move_battle_styles.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description="ID of the battle style")) low_hp_preference = Column(Integer, nullable=False, info=dict(description=u"Chance of using the move, in percent, if HP is under ½")) @@ -848,43 +1036,54 @@ class NaturePokeathlonStat(TableBase): u"""Specifies how a Nature affects a Pokéathlon stat """ __tablename__ = 'nature_pokeathlon_stats' - nature_id = Column(Integer, ForeignKey('natures.id'), primary_key=True, nullable=False, + nature_id = Column(Integer, ForeignKey('natures.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description="ID of the nature")) - pokeathlon_stat_id = Column(Integer, ForeignKey('pokeathlon_stats.id'), primary_key=True, nullable=False, + pokeathlon_stat_id = Column(Integer, ForeignKey('pokeathlon_stats.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description="ID of the stat")) max_change = Column(Integer, nullable=False, info=dict(description="Maximum change")) -class PokeathlonStat(TableBase, OfficiallyNamed): +class PokeathlonStat(TableBase): u"""A Pokéathlon stat, such as "Stamina" or "Jump". """ __tablename__ = 'pokeathlon_stats' __singlename__ = 'pokeathlon_stat' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) identifier = Column(Unicode(8), nullable=False, info=dict(description="An identifier", format='identifier')) -class Pokedex(TableBase, UnofficiallyNamed): +create_translation_table('pokeathlon_stat_names', PokeathlonStat, 'names', + name = Column(Unicode(8), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) + +class Pokedex(TableBase): u"""A collection of Pokémon species ordered in a particular way """ __tablename__ = 'pokedexes' __singlename__ = 'pokedex' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) region_id = Column(Integer, ForeignKey('regions.id'), nullable=True, info=dict(description=u"ID of the region this Pokédex is used in, or None if it's global")) identifier = Column(Unicode(16), nullable=False, info=dict(description=u"An identifier", format='identifier')) - description = ProseColumn(Unicode(512), plural='descriptions', nullable=False, - info=dict(description=u"A longer description of the Pokédex", format='plaintext')) -class Pokemon(TableBase, OfficiallyNamed): +create_translation_table('pokedex_prose', Pokedex, 'prose', + relation_lazy='joined', + name = Column(Unicode(16), nullable=True, index=True, + info=dict(description="The name", format='plaintext', official=False)), + description = Column(Unicode(512), nullable=True, + info=dict(description=u"A longer description of the Pokédex", format='plaintext')), +) + +class Pokemon(TableBase): u"""A species of Pokémon. The core to this whole mess. """ __tablename__ = 'pokemon' __singlename__ = 'pokemon' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description=u"A numeric ID")) identifier = Column(Unicode(20), nullable=False, info=dict(description=u"An identifier", format='identifier')) @@ -896,12 +1095,9 @@ class Pokemon(TableBase, OfficiallyNamed): info=dict(description=u"The height of the Pokémon, in decimeters (tenths of a meter)")) weight = Column(Integer, nullable=False, info=dict(description=u"The weight of the Pokémon, in tenths of a kilogram (decigrams)")) - species = TextColumn(Unicode(16), nullable=False, plural='species_names', - info=dict(description=u'The short flavor text, such as "Seed" or "Lizard"; usually affixed with the word "Pokémon"', - official=True, format='plaintext')) color_id = Column(Integer, ForeignKey('pokemon_colors.id'), nullable=False, info=dict(description=u"ID of this Pokémon's Pokédex color, as used for a gimmick search function in the games.")) - pokemon_shape_id = Column(Integer, ForeignKey('pokemon_shapes.id'), nullable=True, + pokemon_shape_id = Column(Integer, ForeignKey('pokemon_shapes.id'), nullable=False, info=dict(description=u"ID of this Pokémon's body shape, as used for a gimmick search function in the games.")) habitat_id = Column(Integer, ForeignKey('pokemon_habitats.id'), nullable=True, info=dict(description=u"ID of this Pokémon's habitat, as used for a gimmick search function in the games.")) @@ -1004,6 +1200,19 @@ class Pokemon(TableBase, OfficiallyNamed): else: return None +create_translation_table('pokemon_names', Pokemon, 'names', + relation_lazy='joined', + name = Column(Unicode(20), nullable=True, index=True, + info=dict(description="The name", format='plaintext', official=True, ripped=True)), + species = Column(Unicode(16), nullable=True, + info=dict(description=u'The short flavor text, such as "Seed" or "Lizard"; usually affixed with the word "Pokémon"', + official=True, format='plaintext')), +) +create_translation_table('pokemon_flavor_summaries', Pokemon, 'flavor_summaries', + flavor_summary = Column(Unicode(512), nullable=True, + info=dict(description=u"Text containing facts from all flavor texts, for languages without official game translations", official=False, format='plaintext', ripped=True)), +) + class PokemonAbility(TableBase): u"""Maps an ability to a Pokémon that can have it """ @@ -1020,7 +1229,7 @@ class PokemonAbility(TableBase): slot = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description=u"The ability slot, i.e. 1 or 2 for gen. IV")) -class PokemonColor(TableBase, OfficiallyNamed): +class PokemonColor(TableBase): u"""The "Pokédex color" of a Pokémon species. Usually based on the Pokémon's color. """ __tablename__ = 'pokemon_colors' @@ -1030,6 +1239,12 @@ class PokemonColor(TableBase, OfficiallyNamed): identifier = Column(Unicode(6), nullable=False, info=dict(description=u"An identifier", format='identifier')) +create_translation_table('pokemon_color_names', PokemonColor, 'names', + relation_lazy='joined', + name = Column(Unicode(6), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) + class PokemonDexNumber(TableBase): u"""The number of a Pokémon in a particular Pokédex (e.g. Jigglypuff is #138 in Hoenn's 'dex) """ @@ -1088,18 +1303,21 @@ class PokemonEvolution(TableBase): trade_pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=True, info=dict(description=u"The ID of the Pokémon for which this Pokémon must be traded.")) -class PokemonFlavorText(TableBase, LanguageSpecific): +class PokemonFlavorText(TableBase): u"""In-game Pokédex descrption of a Pokémon. """ __tablename__ = 'pokemon_flavor_text' + summary_column = Pokemon.flavor_summaries_table, 'flavor_summary' pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description=u"ID of the Pokémon")) version_id = Column(Integer, ForeignKey('versions.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description=u"ID of the version that has this flavor text")) + language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, autoincrement=False, + info=dict(description="The language")) flavor_text = Column(Unicode(255), nullable=False, - info=dict(description=u"ID of the version that has this flavor text", official=True, format='gametext')) + info=dict(description=u"The flavor text", official=True, format='gametext')) -class PokemonForm(TableBase, OfficiallyNamed): +class PokemonForm(TableBase): u"""An individual form of a Pokémon. Pokémon that do not have separate forms are still given a single row to @@ -1107,7 +1325,7 @@ class PokemonForm(TableBase, OfficiallyNamed): """ __tablename__ = 'pokemon_forms' __singlename__ = 'pokemon_form' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description=u'A unique ID for this form.')) identifier = Column(Unicode(16), nullable=True, info=dict(description=u"An identifier", format='identifier')) @@ -1151,20 +1369,30 @@ class PokemonForm(TableBase, OfficiallyNamed): else: return self.form_base_pokemon.name +create_translation_table('pokemon_form_names', PokemonForm, 'names', + relation_lazy='joined', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) + class PokemonFormGroup(TableBase): u"""Information about a Pokémon's forms as a group.""" __tablename__ = 'pokemon_form_groups' __singlename__ = 'pokemon_form_group' pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description=u"ID of the base form Pokémon")) - term = ProseColumn(Unicode(16), plural='terms', nullable=True, - info=dict(description=u"The term for this Pokémon's forms, e.g. \"Cloak\" for Burmy or \"Forme\" for Deoxys.", official=True, format='plaintext')) is_battle_only = Column(Boolean, nullable=False, info=dict(description=u"Set iff the forms only change in battle")) - description = ProseColumn(markdown.MarkdownColumn(1024), plural='descriptions', nullable=False, - info=dict(description=u"Description of how the forms work", format='markdown')) +# FIXME remooove PokemonFormGroup.id = PokemonFormGroup.pokemon_id +create_translation_table('pokemon_form_group_prose', PokemonFormGroup, 'prose', + term = Column(Unicode(16), nullable=True, + info=dict(description=u"The term for this Pokémon's forms, e.g. \"Cloak\" for Burmy or \"Forme\" for Deoxys.", official=True, format='plaintext')), + description = Column(markdown.MarkdownColumn(1024), nullable=True, + info=dict(description=u"Description of how the forms work", format='markdown')), +) + class PokemonFormPokeathlonStat(TableBase): u"""A Pokémon form's performance in one Pokéathlon stat.""" __tablename__ = 'pokemon_form_pokeathlon_stats' @@ -1179,7 +1407,18 @@ class PokemonFormPokeathlonStat(TableBase): maximum_stat = Column(Integer, nullable=False, autoincrement=False, info=dict(description=u'The maximum value for this stat for this Pokémon form.')) -class PokemonHabitat(TableBase, OfficiallyNamed): +class PokemonGameIndex(TableBase): + u"""The number of a Pokémon a game uses internally + """ + __tablename__ = 'pokemon_game_indices' + pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, autoincrement=False, nullable=False, + info=dict(description=u"Database ID of the Pokémon")) + generation_id = Column(Integer, ForeignKey('generations.id'), primary_key=True, autoincrement=False, nullable=False, + info=dict(description=u"Database ID of the generation")) + game_index = Column(Integer, nullable=False, + info=dict(description=u"Internal ID the generation's games use for the Pokémon")) + +class PokemonHabitat(TableBase): u"""The habitat of a Pokémon, as given in the FireRed/LeafGreen version Pokédex """ __tablename__ = 'pokemon_habitats' @@ -1189,16 +1428,11 @@ class PokemonHabitat(TableBase, OfficiallyNamed): identifier = Column(Unicode(16), nullable=False, info=dict(description=u"An identifier", format='identifier')) -class PokemonInternalID(TableBase): - u"""The number of a Pokémon a game uses internally - """ - __tablename__ = 'pokemon_internal_ids' - pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, autoincrement=False, nullable=False, - info=dict(description=u"Database ID of the Pokémon")) - generation_id = Column(Integer, ForeignKey('generations.id'), primary_key=True, autoincrement=False, nullable=False, - info=dict(description=u"Database ID of the generation")) - internal_id = Column(Integer, nullable=False, - info=dict(description=u"Internal ID the generation's games use for the Pokémon")) +create_translation_table('pokemon_habitat_names', PokemonHabitat, 'names', + relation_lazy='joined', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) class PokemonItem(TableBase): u"""Record of an item a Pokémon can hold in the wild @@ -1235,7 +1469,7 @@ class PokemonMove(TableBase): {}, ) -class PokemonMoveMethod(TableBase, UnofficiallyNamed): +class PokemonMoveMethod(TableBase): u"""A method a move can be learned by, such as "Level up" or "Tutor". """ __tablename__ = 'pokemon_move_methods' @@ -1244,20 +1478,32 @@ class PokemonMoveMethod(TableBase, UnofficiallyNamed): info=dict(description=u"A numeric ID")) identifier = Column(Unicode(64), nullable=False, info=dict(description=u"An identifier", format='identifier')) - description = ProseColumn(Unicode(255), plural='descriptions', nullable=False, - info=dict(description=u"A detailed description of how the method works", format='plaintext')) -class PokemonShape(TableBase, UnofficiallyNamed): +create_translation_table('pokemon_move_method_prose', PokemonMoveMethod, 'prose', + relation_lazy='joined', + name = Column(Unicode(64), nullable=True, index=True, + info=dict(description="The name", format='plaintext', official=False)), + description = Column(Unicode(255), nullable=True, + info=dict(description=u"A detailed description of how the method works", format='plaintext')), +) + +class PokemonShape(TableBase): u"""The shape of a Pokémon's body, as used in generation IV Pokédexes. """ __tablename__ = 'pokemon_shapes' __singlename__ = 'pokemon_shape' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description=u"A numeric ID")) identifier = Column(Unicode(24), nullable=False, info=dict(description=u"An identifier", format='identifier')) - awesome_name = ProseColumn(Unicode(16), plural='awesome_names', nullable=False, - info=dict(description=u"A splendiferous name of the body shape", format='plaintext')) + +create_translation_table('pokemon_shape_prose', PokemonShape, 'prose', + relation_lazy='joined', + name = Column(Unicode(24), nullable=True, index=True, + info=dict(description="The name", format='plaintext', official=False)), + awesome_name = Column(Unicode(16), nullable=True, + info=dict(description=u"A splendiferous name of the body shape", format='plaintext')), +) class PokemonStat(TableBase): u"""A stat value of a Pokémon @@ -1283,27 +1529,41 @@ class PokemonType(TableBase): slot = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description=u"The type's slot, 1 or 2, used to sort types if there are two of them")) -class Region(TableBase, OfficiallyNamed): +class Region(TableBase): u"""Major areas of the world: Kanto, Johto, etc. """ __tablename__ = 'regions' __singlename__ = 'region' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description=u"A numeric ID")) identifier = Column(Unicode(16), nullable=False, info=dict(description=u"An identifier", format='identifier')) -class Stat(TableBase, OfficiallyNamed): +create_translation_table('region_names', Region, 'names', + relation_lazy='joined', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) + +class Stat(TableBase): u"""A Stat, such as Attack or Speed """ __tablename__ = 'stats' __singlename__ = 'stat' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description=u"A numeric ID")) damage_class_id = Column(Integer, ForeignKey('move_damage_classes.id'), nullable=True, info=dict(description=u"For offensive and defensive stats, the damage this stat relates to; otherwise None (the NULL value)")) identifier = Column(Unicode(16), nullable=False, info=dict(description=u"An identifier", format='identifier')) + is_battle_only = Column(Boolean, nullable=False, + info=dict(description=u"Whether this stat only exists within a battle")) + +create_translation_table('stat_names', Stat, 'names', + relation_lazy='joined', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) class StatHint(TableBase): u"""Flavor text for genes that appears in a Pokémon's summary. Sometimes @@ -1311,11 +1571,18 @@ class StatHint(TableBase): """ __tablename__ = 'stat_hints' __singlename__ = 'stat_hint' - id = Column(Integer, primary_key=True, nullable=False) - stat_id = Column(Integer, ForeignKey('stats.id'), nullable=False) - gene_mod_5 = Column(Integer, nullable=False, index=True) - text = TextColumn(Unicode(24), plural='texts', nullable=False, index=True, unique=True, - info=dict(description=u"The English text displayed", official=True, format='plaintext')) + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, + info=dict(description=u"A numeric ID")) + stat_id = Column(Integer, ForeignKey('stats.id'), nullable=False, + info=dict(description=u"ID of the highest stat")) + gene_mod_5 = Column(Integer, nullable=False, index=True, + info=dict(description=u"Value of the highest stat modulo 5")) + +create_translation_table('stat_hint_names', StatHint, 'names', + relation_lazy='joined', + message = Column(Unicode(24), nullable=False, index=True, + info=dict(description=u"The text displayed", official=True, format='plaintext')), +) class SuperContestCombo(TableBase): u"""Combo of two moves in a Super Contest. @@ -1331,12 +1598,34 @@ class SuperContestEffect(TableBase): """ __tablename__ = 'super_contest_effects' __singlename__ = 'super_contest_effect' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description=u"This effect's unique ID.")) appeal = Column(SmallInteger, nullable=False, info=dict(description=u"The number of hearts the user gains.")) - flavor_text = ProseColumn(Unicode(64), plural='flavor_texts', nullable=False, - info=dict(description=u"A description of the effect.", format='plaintext')) + +create_translation_table('super_contest_effect_prose', SuperContestEffect, 'prose', + flavor_text = Column(Unicode(64), nullable=False, + info=dict(description=u"A description of the effect.", format='plaintext', official=True)), +) + +class Type(TableBase): + u"""Any of the elemental types Pokémon and moves can have.""" + __tablename__ = 'types' + __singlename__ = 'type' + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, + info=dict(description=u"A unique ID for this type.")) + identifier = Column(Unicode(12), nullable=False, + info=dict(description=u"An identifier", format='identifier')) + generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False, + info=dict(description=u"The ID of the generation this type first appeared in.")) + damage_class_id = Column(Integer, ForeignKey('move_damage_classes.id'), nullable=True, + info=dict(description=u"The ID of the damage class this type's moves had before Generation IV, null if not applicable (e.g. ???).")) + +create_translation_table('type_names', Type, 'names', + relation_lazy='joined', + name = Column(Unicode(12), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) class TypeEfficacy(TableBase): u"""The damage multiplier used when a move of a particular type damages a @@ -1350,25 +1639,29 @@ class TypeEfficacy(TableBase): damage_factor = Column(Integer, nullable=False, info=dict(description=u"The multiplier, as a percentage of damage inflicted.")) -class Type(TableBase, OfficiallyNamed): - u"""Any of the elemental types Pokémon and moves can have.""" - __tablename__ = 'types' - __singlename__ = 'type' - id = Column(Integer, primary_key=True, nullable=False, - info=dict(description=u"A unique ID for this type.")) - identifier = Column(Unicode(8), nullable=False, - info=dict(description=u"An identifier", format='identifier')) - generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False, - info=dict(description=u"The ID of the generation this type first appeared in.")) - damage_class_id = Column(Integer, ForeignKey('move_damage_classes.id'), nullable=True, - info=dict(description=u"The ID of the damage class this type's moves had before Generation IV, null if not applicable (e.g. ???).")) +class Version(TableBase): + u"""An individual main-series Pokémon game.""" + __tablename__ = 'versions' + __singlename__ = 'version' + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, + info=dict(description=u"A unique ID for this version.")) + version_group_id = Column(Integer, ForeignKey('version_groups.id'), nullable=False, + info=dict(description=u"The ID of the version group this game belongs to.")) + identifier = Column(Unicode(32), nullable=False, + info=dict(description=u'And identifier', format='identifier')) + +create_translation_table('version_names', Version, 'names', + relation_lazy='joined', + name = Column(Unicode(32), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) class VersionGroup(TableBase): u"""A group of versions, containing either two paired versions (such as Red and Blue) or a single game (such as Yellow.) """ __tablename__ = 'version_groups' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description=u"This version group's unique ID.")) generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False, info=dict(description=u"The ID of the generation the games in this group belong to.")) @@ -1378,196 +1671,303 @@ class VersionGroup(TableBase): class VersionGroupRegion(TableBase): u"""Maps a version group to a region that appears in it.""" __tablename__ = 'version_group_regions' - version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, + version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description=u"The ID of the version group.")) - region_id = Column(Integer, ForeignKey('regions.id'), primary_key=True, nullable=False, + region_id = Column(Integer, ForeignKey('regions.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description=u"The ID of the region.")) -class Version(TableBase, OfficiallyNamed): - u"""An individual main-series Pokémon game.""" - __tablename__ = 'versions' - __singlename__ = 'version' - id = Column(Integer, primary_key=True, nullable=False, - info=dict(description=u"A unique ID for this version.")) - version_group_id = Column(Integer, ForeignKey('version_groups.id'), nullable=False, - info=dict(description=u"The ID of the version group this game belongs to.")) - identifier = Column(Unicode(32), nullable=False, - info=dict(description=u'And identifier', format='identifier')) +### Relations down here, to avoid dependency ordering problems -### Relations down here, to avoid ordering problems Ability.changelog = relation(AbilityChangelog, order_by=AbilityChangelog.changed_in_version_group_id.desc(), - backref='ability', -) -Ability.flavor_text = relation(AbilityFlavorText, order_by=AbilityFlavorText.version_group_id, backref='ability') -Ability.generation = relation(Generation, backref='abilities') -Ability.all_pokemon = relation(Pokemon, - secondary=PokemonAbility.__table__, - order_by=Pokemon.order, - back_populates='all_abilities', -) -Ability.pokemon = relation(Pokemon, - secondary=PokemonAbility.__table__, - primaryjoin=and_( - PokemonAbility.ability_id == Ability.id, - PokemonAbility.is_dream == False - ), - order_by=Pokemon.order, - back_populates='abilities', -) -Ability.dream_pokemon = relation(Pokemon, - secondary=PokemonAbility.__table__, - primaryjoin=and_( - PokemonAbility.ability_id == Ability.id, - PokemonAbility.is_dream == True - ), - order_by=Pokemon.order, - back_populates='dream_ability', -) - -AbilityChangelog.changed_in = relation(VersionGroup, backref='ability_changelog') - -AbilityFlavorText.version_group = relation(VersionGroup) - -Berry.berry_firmness = relation(BerryFirmness, backref='berries') + backref=backref('ability', innerjoin=True, lazy='joined')) +Ability.flavor_text = relation(AbilityFlavorText, + order_by=AbilityFlavorText.version_group_id, + backref=backref('ability', innerjoin=True, lazy='joined')) +Ability.generation = relation(Generation, + innerjoin=True, + backref='abilities') + +AbilityChangelog.changed_in = relation(VersionGroup, + innerjoin=True, lazy='joined', + backref='ability_changelog') + +AbilityFlavorText.version_group = relation(VersionGroup, + innerjoin=True) +AbilityFlavorText.language = relation(Language, + innerjoin=True, lazy='joined') + + +Berry.berry_firmness = relation(BerryFirmness, + innerjoin=True, + backref='berries') Berry.firmness = association_proxy('berry_firmness', 'name') -Berry.flavors = relation(BerryFlavor, order_by=BerryFlavor.contest_type_id, backref='berry') -Berry.natural_gift_type = relation(Type) +Berry.flavors = relation(BerryFlavor, + order_by=BerryFlavor.contest_type_id, + backref=backref('berry', innerjoin=True)) +Berry.natural_gift_type = relation(Type, innerjoin=True) -BerryFlavor.contest_type = relation(ContestType) +BerryFlavor.contest_type = relation(ContestType, innerjoin=True) -ContestCombo.first = relation(Move, primaryjoin=ContestCombo.first_move_id==Move.id, - backref='contest_combo_first') -ContestCombo.second = relation(Move, primaryjoin=ContestCombo.second_move_id==Move.id, - backref='contest_combo_second') -Encounter.location_area = relation(LocationArea, backref='encounters') -Encounter.pokemon = relation(Pokemon, backref='encounters') -Encounter.version = relation(Version, backref='encounters') -Encounter.slot = relation(EncounterSlot, backref='encounters') +ContestCombo.first = relation(Move, + primaryjoin=ContestCombo.first_move_id==Move.id, + innerjoin=True, lazy='joined', + backref='contest_combo_first') +ContestCombo.second = relation(Move, + primaryjoin=ContestCombo.second_move_id==Move.id, + innerjoin=True, lazy='joined', + backref='contest_combo_second') -EncounterConditionValue.condition = relation(EncounterCondition, backref='values') -Encounter.condition_value_map = relation(EncounterConditionValueMap, backref='encounter') +Encounter.condition_value_map = relation(EncounterConditionValueMap, + backref='encounter') Encounter.condition_values = association_proxy('condition_value_map', 'condition_value') +Encounter.location_area = relation(LocationArea, + innerjoin=True, lazy='joined', + backref='encounters') +Encounter.pokemon = relation(Pokemon, + innerjoin=True, lazy='joined', + backref='encounters') +Encounter.version = relation(Version, + innerjoin=True, lazy='joined', + backref='encounters') +Encounter.slot = relation(EncounterSlot, + innerjoin=True, lazy='joined', + backref='encounters') + +EncounterConditionValue.condition = relation(EncounterCondition, + innerjoin=True, lazy='joined', + backref='values') EncounterConditionValueMap.condition_value = relation(EncounterConditionValue, - backref='encounter_map') + innerjoin=True, lazy='joined', + backref='encounter_map') + +EncounterSlot.terrain = relation(EncounterTerrain, + innerjoin=True, lazy='joined', + backref='slots') +EncounterSlot.version_group = relation(VersionGroup, innerjoin=True) + -EncounterSlot.terrain = relation(EncounterTerrain, backref='slots') -EncounterSlot.version_group = relation(VersionGroup) +EvolutionChain.growth_rate = relation(GrowthRate, + innerjoin=True, + backref='evolution_chains') +EvolutionChain.baby_trigger_item = relation(Item, + backref='evolution_chains') -EvolutionChain.growth_rate = relation(GrowthRate, backref='evolution_chains') -EvolutionChain.baby_trigger_item = relation(Item, backref='evolution_chains') -EvolutionChain.pokemon = relation(Pokemon, order_by=Pokemon.order, back_populates='evolution_chain') -Experience.growth_rate = relation(GrowthRate, backref='experience_table') +Experience.growth_rate = relation(GrowthRate, + innerjoin=True, lazy='joined', + backref='experience_table') -Generation.canonical_pokedex = relation(Pokedex, backref='canonical_for_generation') -Generation.versions = relation(Version, secondary=VersionGroup.__table__) -Generation.main_region = relation(Region) -GrowthRate.max_experience_obj = relation(Experience, primaryjoin=and_(Experience.growth_rate_id == GrowthRate.id, Experience.level == 100), uselist=False) +Generation.canonical_pokedex = relation(Pokedex, + backref='canonical_for_generation') +Generation.versions = relation(Version, + secondary=VersionGroup.__table__, + innerjoin=True) +Generation.main_region = relation(Region, innerjoin=True) + + +GrowthRate.max_experience_obj = relation(Experience, + primaryjoin=and_( + Experience.growth_rate_id == GrowthRate.id, + Experience.level == 100), + uselist=False, innerjoin=True) GrowthRate.max_experience = association_proxy('max_experience_obj', 'experience') -Item.berry = relation(Berry, uselist=False, backref='item') -Item.flags = relation(ItemFlag, secondary=ItemFlagMap.__table__) -Item.flavor_text = relation(ItemFlavorText, order_by=ItemFlavorText.version_group_id.asc(), backref='item') -Item.fling_effect = relation(ItemFlingEffect, backref='items') -Item.machines = relation(Machine, order_by=Machine.version_group_id.asc()) -Item.category = relation(ItemCategory) + +Item.berry = relation(Berry, + uselist=False, + backref='item') +Item.flags = relation(ItemFlag, + secondary=ItemFlagMap.__table__) +Item.flavor_text = relation(ItemFlavorText, + order_by=ItemFlavorText.version_group_id.asc(), + backref=backref('item', innerjoin=True, lazy='joined')) +Item.fling_effect = relation(ItemFlingEffect, + backref='items') +Item.machines = relation(Machine, + order_by=Machine.version_group_id.asc()) +Item.category = relation(ItemCategory, + innerjoin=True, + backref=backref('items', order_by=Item.identifier.asc())) Item.pocket = association_proxy('category', 'pocket') -ItemCategory.items = relation(Item, order_by=Item.identifier) -ItemCategory.pocket = relation(ItemPocket) +ItemCategory.pocket = relation(ItemPocket, innerjoin=True) + +ItemFlavorText.version_group = relation(VersionGroup, + innerjoin=True, lazy='joined') +ItemFlavorText.language = relation(Language, + innerjoin=True, lazy='joined') -ItemFlavorText.version_group = relation(VersionGroup) +ItemGameIndex.item = relation(Item, + innerjoin=True, lazy='joined', + backref='game_indices') +ItemGameIndex.generation = relation(Generation, + innerjoin=True, lazy='joined') -ItemInternalID.item = relation(Item, backref='internal_ids') -ItemInternalID.generation = relation(Generation) +ItemPocket.categories = relation(ItemCategory, + innerjoin=True, + order_by=ItemCategory.identifier.asc()) -ItemPocket.categories = relation(ItemCategory, order_by=ItemCategory.identifier) -Location.region = relation(Region, backref='locations') +Location.region = relation(Region, + innerjoin=True, + backref='locations') -LocationArea.location = relation(Location, backref='areas') +LocationArea.location = relation(Location, + innerjoin=True, lazy='joined', + backref='areas') + +LocationGameIndex.location = relation(Location, + innerjoin=True, lazy='joined', + backref='game_indices') +LocationGameIndex.generation = relation(Generation, + innerjoin=True, lazy='joined') -LocationInternalID.location = relation(Location, backref='internal_ids') -LocationInternalID.generation = relation(Generation) Machine.item = relation(Item) -Machine.version_group = relation(VersionGroup) +Machine.version_group = relation(VersionGroup, + innerjoin=True, lazy='joined') + Move.changelog = relation(MoveChangelog, order_by=MoveChangelog.changed_in_version_group_id.desc(), - backref='move', -) -Move.contest_effect = relation(ContestEffect, backref='moves') + backref=backref('move', innerjoin=True, lazy='joined')) +Move.contest_effect = relation(ContestEffect, + backref='moves') Move.contest_combo_next = association_proxy('contest_combo_first', 'second') Move.contest_combo_prev = association_proxy('contest_combo_second', 'first') -Move.contest_type = relation(ContestType, backref='moves') -Move.damage_class = relation(MoveDamageClass, backref='moves') +Move.contest_type = relation(ContestType, + backref='moves') +Move.damage_class = relation(MoveDamageClass, + innerjoin=True, + backref='moves') Move.flags = association_proxy('move_flags', 'flag') -Move.flavor_text = relation(MoveFlavorText, order_by=MoveFlavorText.version_group_id, backref='move') -Move.generation = relation(Generation, backref='moves') -Move.machines = relation(Machine, backref='move') -Move.meta = relation(MoveMeta, uselist=False, backref='move') +Move.flavor_text = relation(MoveFlavorText, + order_by=MoveFlavorText.version_group_id, backref='move') +Move.generation = relation(Generation, + innerjoin=True, + backref='moves') +Move.machines = relation(Machine, + backref='move') +Move.meta = relation(MoveMeta, + uselist=False, innerjoin=True, + backref='move') Move.meta_stat_changes = relation(MoveMetaStatChange) -Move.move_effect = relation(MoveEffect, backref='moves') -Move.move_flags = relation(MoveFlag, backref='move') -Move.super_contest_effect = relation(SuperContestEffect, backref='moves') +Move.move_effect = relation(MoveEffect, + innerjoin=True, + backref='moves') +Move.move_flags = relation(MoveFlag, + backref='move') +Move.super_contest_effect = relation(SuperContestEffect, + backref='moves') Move.super_contest_combo_next = association_proxy('super_contest_combo_first', 'second') Move.super_contest_combo_prev = association_proxy('super_contest_combo_second', 'first') -Move.target = relation(MoveTarget, backref='moves') -Move.type = relation(Type, back_populates='moves') - - -MoveChangelog.changed_in = relation(VersionGroup, backref='move_changelog') -MoveChangelog.move_effect = relation(MoveEffect, backref='move_changelog') -MoveChangelog.type = relation(Type, backref='move_changelog') +Move.target = relation(MoveTarget, + innerjoin=True, + backref='moves') +Move.type = relation(Type, + innerjoin=True, + backref='moves') + +Move.effect = markdown.MoveEffectProperty('effect') +Move.effect_map = markdown.MoveEffectPropertyMap('effect_map') +Move.short_effect = markdown.MoveEffectProperty('short_effect') +Move.short_effect_map = markdown.MoveEffectPropertyMap('short_effect_map') + +MoveChangelog.changed_in = relation(VersionGroup, + innerjoin=True, lazy='joined', + backref='move_changelog') +MoveChangelog.move_effect = relation(MoveEffect, + backref='move_changelog') +MoveChangelog.type = relation(Type, + backref='move_changelog') + +MoveChangelog.effect = markdown.MoveEffectProperty('effect') +MoveChangelog.effect_map = markdown.MoveEffectPropertyMap('effect_map') +MoveChangelog.short_effect = markdown.MoveEffectProperty('short_effect') +MoveChangelog.short_effect_map = markdown.MoveEffectPropertyMap('short_effect_map') MoveEffect.category_map = relation(MoveEffectCategoryMap) MoveEffect.categories = association_proxy('category_map', 'category') MoveEffect.changelog = relation(MoveEffectChangelog, order_by=MoveEffectChangelog.changed_in_version_group_id.desc(), - backref='move_effect', -) + backref='move_effect') MoveEffectCategoryMap.category = relation(MoveEffectCategory) -MoveEffectChangelog.changed_in = relation(VersionGroup, backref='move_effect_changelog') - -MoveFlag.flag = relation(MoveFlagType) - -MoveFlavorText.version_group = relation(VersionGroup) - -MoveMeta.category = relation(MoveMetaCategory, backref='move_meta') -MoveMeta.ailment = relation(MoveMetaAilment, backref='move_meta') +MoveEffectChangelog.changed_in = relation(VersionGroup, + innerjoin=True, lazy='joined', + backref='move_effect_changelog') + +MoveFlag.flag = relation(MoveFlagType, innerjoin=True, lazy='joined') + +MoveFlavorText.version_group = relation(VersionGroup, + innerjoin=True, lazy='joined') +MoveFlavorText.language = relation(Language, + innerjoin=True, lazy='joined') + +MoveMeta.category = relation(MoveMetaCategory, + innerjoin=True, lazy='joined', + backref='move_meta') +MoveMeta.ailment = relation(MoveMetaAilment, + innerjoin=True, lazy='joined', + backref='move_meta') + +MoveMetaStatChange.stat = relation(Stat, + innerjoin=True, lazy='joined', + backref='move_meta_stat_changes') + + +Nature.decreased_stat = relation(Stat, + primaryjoin=Nature.decreased_stat_id==Stat.id, + innerjoin=True, + backref='decreasing_natures') +Nature.increased_stat = relation(Stat, + primaryjoin=Nature.increased_stat_id==Stat.id, + innerjoin=True, + backref='increasing_natures') +Nature.hates_flavor = relation(ContestType, + primaryjoin=Nature.hates_flavor_id==ContestType.id, + innerjoin=True, + backref='hating_natures') +Nature.likes_flavor = relation(ContestType, + primaryjoin=Nature.likes_flavor_id==ContestType.id, + innerjoin=True, + backref='liking_natures') +Nature.battle_style_preferences = relation(NatureBattleStylePreference, + order_by=NatureBattleStylePreference.move_battle_style_id.asc(), + backref='nature') +Nature.pokeathlon_effects = relation(NaturePokeathlonStat, + order_by=NaturePokeathlonStat.pokeathlon_stat_id.asc()) -MoveMetaStatChange.stat = relation(Stat, backref='move_meta_stat_changes') +NatureBattleStylePreference.battle_style = relation(MoveBattleStyle, + innerjoin=True, lazy='joined', + backref='nature_preferences') -Nature.decreased_stat = relation(Stat, primaryjoin=Nature.decreased_stat_id==Stat.id, - backref='decreasing_natures') -Nature.increased_stat = relation(Stat, primaryjoin=Nature.increased_stat_id==Stat.id, - backref='increasing_natures') -Nature.hates_flavor = relation(ContestType, primaryjoin=Nature.hates_flavor_id==ContestType.id, - backref='hating_natures') -Nature.likes_flavor = relation(ContestType, primaryjoin=Nature.likes_flavor_id==ContestType.id, - backref='liking_natures') -Nature.battle_style_preferences = relation(NatureBattleStylePreference, - order_by=NatureBattleStylePreference.move_battle_style_id, - backref='nature') -Nature.pokeathlon_effects = relation(NaturePokeathlonStat, order_by=NaturePokeathlonStat.pokeathlon_stat_id) +NaturePokeathlonStat.pokeathlon_stat = relation(PokeathlonStat, + innerjoin=True, lazy='joined', + backref='nature_effects') -NatureBattleStylePreference.battle_style = relation(MoveBattleStyle, backref='nature_preferences') -NaturePokeathlonStat.pokeathlon_stat = relation(PokeathlonStat, backref='nature_effects') +Pokedex.region = relation(Region, + innerjoin=True, + backref='pokedexes') +Pokedex.version_groups = relation(VersionGroup, + innerjoin=True, + order_by=VersionGroup.id.asc(), + backref='pokedex') -Pokedex.region = relation(Region, backref='pokedexes') -Pokedex.version_groups = relation(VersionGroup, order_by=VersionGroup.id, back_populates='pokedex') Pokemon.all_abilities = relation(Ability, secondary=PokemonAbility.__table__, - order_by=PokemonAbility.slot, + order_by=PokemonAbility.slot.asc(), + innerjoin=True, + backref=backref('all_pokemon', + order_by=Pokemon.order.asc(), + ), ) Pokemon.abilities = relation(Ability, secondary=PokemonAbility.__table__, @@ -1575,7 +1975,11 @@ Pokemon.abilities = relation(Ability, Pokemon.id == PokemonAbility.pokemon_id, PokemonAbility.is_dream == False, ), - order_by=PokemonAbility.slot, + innerjoin=True, + order_by=PokemonAbility.slot.asc(), + backref=backref('pokemon', + order_by=Pokemon.order.asc(), + ), ) Pokemon.dream_ability = relation(Ability, secondary=PokemonAbility.__table__, @@ -1584,259 +1988,198 @@ Pokemon.dream_ability = relation(Ability, PokemonAbility.is_dream == True, ), uselist=False, + backref=backref('dream_pokemon', + order_by=Pokemon.order, + ), ) -Pokemon.pokemon_color = relation(PokemonColor, backref='pokemon') +Pokemon.pokemon_color = relation(PokemonColor, + innerjoin=True, + backref='pokemon') Pokemon.color = association_proxy('pokemon_color', 'name') -Pokemon.dex_numbers = relation(PokemonDexNumber, order_by=PokemonDexNumber.pokedex_id.asc(), backref='pokemon') -Pokemon.egg_groups = relation(EggGroup, secondary=PokemonEggGroup.__table__, - order_by=PokemonEggGroup.egg_group_id, - backref=backref('pokemon', order_by=Pokemon.order)) -Pokemon.evolution_chain = relation(EvolutionChain, back_populates='pokemon') +Pokemon.dex_numbers = relation(PokemonDexNumber, + innerjoin=True, + order_by=PokemonDexNumber.pokedex_id.asc(), + backref='pokemon') +Pokemon.egg_groups = relation(EggGroup, + secondary=PokemonEggGroup.__table__, + innerjoin=True, + order_by=PokemonEggGroup.egg_group_id.asc(), + backref=backref('pokemon', order_by=Pokemon.order.asc())) +Pokemon.evolution_chain = relation(EvolutionChain, + innerjoin=True, + backref=backref('pokemon', order_by=Pokemon.order.asc())) Pokemon.child_pokemon = relation(Pokemon, primaryjoin=Pokemon.id==PokemonEvolution.from_pokemon_id, secondary=PokemonEvolution.__table__, secondaryjoin=PokemonEvolution.to_pokemon_id==Pokemon.id, - backref=backref('parent_pokemon', uselist=False), -) -Pokemon.flavor_text = relation(PokemonFlavorText, order_by=PokemonFlavorText.version_id.asc(), backref='pokemon') -Pokemon.forms = relation(PokemonForm, primaryjoin=Pokemon.id==PokemonForm.form_base_pokemon_id, - order_by=(PokemonForm.order.asc(), PokemonForm.identifier.asc())) + backref=backref('parent_pokemon', uselist=False)) +Pokemon.flavor_text = relation(PokemonFlavorText, + order_by=PokemonFlavorText.version_id.asc(), + backref='pokemon') +Pokemon.forms = relation(PokemonForm, + primaryjoin=Pokemon.id==PokemonForm.form_base_pokemon_id, + order_by=(PokemonForm.order.asc(), PokemonForm.identifier.asc())) Pokemon.default_form = relation(PokemonForm, - primaryjoin=and_(Pokemon.id==PokemonForm.form_base_pokemon_id, PokemonForm.is_default==True), - uselist=False, -) -Pokemon.pokemon_habitat = relation(PokemonHabitat, backref='pokemon') + primaryjoin=and_( + Pokemon.id==PokemonForm.form_base_pokemon_id, + PokemonForm.is_default==True), + uselist=False) +Pokemon.pokemon_habitat = relation(PokemonHabitat, + backref='pokemon') Pokemon.habitat = association_proxy('pokemon_habitat', 'name') -Pokemon.items = relation(PokemonItem, backref='pokemon') -Pokemon.generation = relation(Generation, backref='pokemon') -Pokemon.shape = relation(PokemonShape, backref='pokemon') -Pokemon.stats = relation(PokemonStat, backref='pokemon', order_by=PokemonStat.stat_id.asc()) -Pokemon.types = relation(Type, secondary=PokemonType.__table__, - order_by=PokemonType.slot.asc(), - back_populates='pokemon') - -PokemonDexNumber.pokedex = relation(Pokedex) +Pokemon.items = relation(PokemonItem, + backref='pokemon') +Pokemon.generation = relation(Generation, + innerjoin=True, + backref='pokemon') +Pokemon.shape = relation(PokemonShape, + innerjoin=True, + backref='pokemon') +Pokemon.stats = relation(PokemonStat, + innerjoin=True, + order_by=PokemonStat.stat_id.asc(), + backref='pokemon') +Pokemon.types = relation(Type, + secondary=PokemonType.__table__, + innerjoin=True, + order_by=PokemonType.slot.asc(), + backref=backref('pokemon', order_by=Pokemon.order)) + +PokemonDexNumber.pokedex = relation(Pokedex, + innerjoin=True, lazy='joined') PokemonEvolution.from_pokemon = relation(Pokemon, primaryjoin=PokemonEvolution.from_pokemon_id==Pokemon.id, - backref='child_evolutions', -) + innerjoin=True, + backref='child_evolutions') PokemonEvolution.to_pokemon = relation(Pokemon, primaryjoin=PokemonEvolution.to_pokemon_id==Pokemon.id, - backref=backref('parent_evolution', uselist=False), -) + innerjoin=True, + backref=backref('parent_evolution', uselist=False)) PokemonEvolution.child_evolutions = relation(PokemonEvolution, primaryjoin=PokemonEvolution.from_pokemon_id==PokemonEvolution.to_pokemon_id, foreign_keys=[PokemonEvolution.to_pokemon_id], backref=backref('parent_evolution', remote_side=[PokemonEvolution.from_pokemon_id], - uselist=False, - ), -) -PokemonEvolution.trigger = relation(EvolutionTrigger, backref='evolutions') + uselist=False)) +PokemonEvolution.trigger = relation(EvolutionTrigger, + innerjoin=True, lazy='joined', + backref='evolutions') PokemonEvolution.trigger_item = relation(Item, primaryjoin=PokemonEvolution.trigger_item_id==Item.id, - backref='triggered_evolutions', -) + backref='triggered_evolutions') PokemonEvolution.held_item = relation(Item, primaryjoin=PokemonEvolution.held_item_id==Item.id, - backref='required_for_evolutions', -) -PokemonEvolution.location = relation(Location, backref='triggered_evolutions') -PokemonEvolution.known_move = relation(Move, backref='triggered_evolutions') + backref='required_for_evolutions') +PokemonEvolution.location = relation(Location, + backref='triggered_evolutions') +PokemonEvolution.known_move = relation(Move, + backref='triggered_evolutions') PokemonEvolution.party_pokemon = relation(Pokemon, primaryjoin=PokemonEvolution.party_pokemon_id==Pokemon.id, - backref='triggered_evolutions', -) + backref='triggered_evolutions') PokemonEvolution.trade_pokemon = relation(Pokemon, - primaryjoin=PokemonEvolution.trade_pokemon_id==Pokemon.id, -) - -PokemonFlavorText.version = relation(Version) - -PokemonForm.form_base_pokemon = relation(Pokemon, primaryjoin=PokemonForm.form_base_pokemon_id==Pokemon.id) -PokemonForm.unique_pokemon = relation(Pokemon, backref=backref('unique_form', uselist=False), - primaryjoin=PokemonForm.unique_pokemon_id==Pokemon.id) -PokemonForm.version_group = relation(VersionGroup) + primaryjoin=PokemonEvolution.trade_pokemon_id==Pokemon.id) + +PokemonFlavorText.version = relation(Version, innerjoin=True, lazy='joined') +PokemonFlavorText.language = relation(Language, innerjoin=True, lazy='joined') + +PokemonForm.form_base_pokemon = relation(Pokemon, + primaryjoin=PokemonForm.form_base_pokemon_id==Pokemon.id, + innerjoin=True) +PokemonForm.unique_pokemon = relation(Pokemon, + primaryjoin=PokemonForm.unique_pokemon_id==Pokemon.id, + backref=backref('unique_form', uselist=False)) +PokemonForm.version_group = relation(VersionGroup, + innerjoin=True) PokemonForm.form_group = association_proxy('form_base_pokemon', 'form_group') PokemonForm.pokeathlon_stats = relation(PokemonFormPokeathlonStat, - order_by=PokemonFormPokeathlonStat.pokeathlon_stat_id, - backref='pokemon_form') + order_by=PokemonFormPokeathlonStat.pokeathlon_stat_id, + backref='pokemon_form') + +PokemonFormGroup.pokemon = relation(Pokemon, + innerjoin=True, + backref=backref('form_group', uselist=False)) + +PokemonFormPokeathlonStat.pokeathlon_stat = relation(PokeathlonStat, + innerjoin=True, lazy='joined') + +PokemonItem.item = relation(Item, + innerjoin=True, lazy='joined', + backref='pokemon') +PokemonItem.version = relation(Version, + innerjoin=True, lazy='joined') + +PokemonMove.pokemon = relation(Pokemon, + innerjoin=True, lazy='joined', + backref='pokemon_moves') +PokemonMove.version_group = relation(VersionGroup, + innerjoin=True, lazy='joined') +PokemonMove.machine = relation(Machine, + primaryjoin=and_( + Machine.version_group_id==PokemonMove.version_group_id, + Machine.move_id==PokemonMove.move_id), + foreign_keys=[Machine.version_group_id, Machine.move_id], + uselist=False, + backref='pokemon_moves') +PokemonMove.move = relation(Move, + innerjoin=True, lazy='joined', + backref='pokemon_moves') +PokemonMove.method = relation(PokemonMoveMethod, + innerjoin=True, lazy='joined') -PokemonFormGroup.pokemon = relation(Pokemon, backref=backref('form_group', - uselist=False)) +PokemonStat.stat = relation(Stat, + innerjoin=True, lazy='joined') -PokemonFormPokeathlonStat.pokeathlon_stat = relation(PokeathlonStat) -PokemonItem.item = relation(Item, backref='pokemon') -PokemonItem.version = relation(Version) +Region.generation = relation(Generation, uselist=False) +Region.version_group_regions = relation(VersionGroupRegion, + order_by=VersionGroupRegion.version_group_id.asc(), + backref='region') +Region.version_groups = association_proxy('version_group_regions', 'version_group') -PokemonMove.pokemon = relation(Pokemon, backref='pokemon_moves') -PokemonMove.version_group = relation(VersionGroup) -PokemonMove.machine = relation(Machine, backref='pokemon_moves', - primaryjoin=and_(Machine.version_group_id==PokemonMove.version_group_id, - Machine.move_id==PokemonMove.move_id), - foreign_keys=[Machine.version_group_id, Machine.move_id], - uselist=False) -PokemonMove.move = relation(Move, backref='pokemon_moves') -PokemonMove.method = relation(PokemonMoveMethod) -PokemonStat.stat = relation(Stat) +Stat.damage_class = relation(MoveDamageClass, + backref='stats') -# This is technically a has-many; Generation.main_region_id -> Region.id -Region.generation = relation(Generation, uselist=False) -Region.version_group_regions = relation(VersionGroupRegion, backref='region', - order_by='VersionGroupRegion.version_group_id') -Region.version_groups = association_proxy('version_group_regions', 'version_group') +StatHint.stat = relation(Stat, + innerjoin=True, + backref='hints') -Stat.damage_class = relation(MoveDamageClass, backref='stats') -StatHint.stat = relation(Stat, backref='hints') +SuperContestCombo.first = relation(Move, + primaryjoin=SuperContestCombo.first_move_id==Move.id, + innerjoin=True, lazy='joined', + backref='super_contest_combo_first') +SuperContestCombo.second = relation(Move, + primaryjoin=SuperContestCombo.second_move_id==Move.id, + innerjoin=True, lazy='joined', + backref='super_contest_combo_second') -SuperContestCombo.first = relation(Move, primaryjoin=SuperContestCombo.first_move_id==Move.id, - backref='super_contest_combo_first') -SuperContestCombo.second = relation(Move, primaryjoin=SuperContestCombo.second_move_id==Move.id, - backref='super_contest_combo_second') Type.damage_efficacies = relation(TypeEfficacy, - primaryjoin=Type.id - ==TypeEfficacy.damage_type_id, - backref='damage_type') + primaryjoin=Type.id==TypeEfficacy.damage_type_id, + backref=backref('damage_type', innerjoin=True, lazy='joined')) Type.target_efficacies = relation(TypeEfficacy, - primaryjoin=Type.id - ==TypeEfficacy.target_type_id, - backref='target_type') - -Type.generation = relation(Generation, backref='types') -Type.damage_class = relation(MoveDamageClass, backref='types') -Type.pokemon = relation(Pokemon, secondary=PokemonType.__table__, - order_by=Pokemon.order, - back_populates='types') -Type.moves = relation(Move, back_populates='type', order_by=Move.id) - -Version.version_group = relation(VersionGroup, back_populates='versions') + primaryjoin=Type.id==TypeEfficacy.target_type_id, + backref=backref('target_type', innerjoin=True, lazy='joined')) + +Type.generation = relation(Generation, + innerjoin=True, + backref='types') +Type.damage_class = relation(MoveDamageClass, + backref='types') + + Version.generation = association_proxy('version_group', 'generation') -VersionGroup.versions = relation(Version, order_by=Version.id, back_populates='version_group') -VersionGroup.generation = relation(Generation, backref='version_groups') -VersionGroup.version_group_regions = relation(VersionGroupRegion, backref='version_group') +VersionGroup.versions = relation(Version, + innerjoin=True, + order_by=Version.id, + backref=backref('version_group', lazy='joined')) +VersionGroup.generation = relation(Generation, + innerjoin=True, lazy='joined', + backref='version_groups') +VersionGroup.version_group_regions = relation(VersionGroupRegion, + backref='version_group') VersionGroup.regions = association_proxy('version_group_regions', 'region') -VersionGroup.pokedex = relation(Pokedex, back_populates='version_groups') - -### Convenience function -def all_tables(): - u"""Yields all tables in the pokédex""" - for table in set(t for t in globals().values() if isclass(t)): - if issubclass(table, TableBase) and table is not TableBase: - yield table - - -### Add name tables -for table in all_tables(): - if issubclass(table, OfficiallyNamed): - cls = TextColumn - info=dict(description="The name", format='plaintext', official=True) - elif issubclass(table, UnofficiallyNamed): - cls = ProseColumn - info=dict(description="The name", format='plaintext', official=False) - else: - continue - table.name = cls(Unicode(class_mapper(table).c.identifier.type.length), - plural='names', nullable=False, info=info) - -### Add text/prose tables - -def makeTextTable(object_table, name_plural, name_singular, columns, lazy): - # With "Language", we'd have two language_id. So, rename one to 'lang' - safe_name = object_table.__singlename__ - if safe_name == 'language': - safe_name = 'lang' - - fields = { - safe_name + '_id': Column(Integer, - ForeignKey(object_table.id), primary_key=True, nullable=False, - info=dict(description="ID of the object this table represents") - ), - '__tablename__': table.__singlename__ + '_' + name_plural, - '__singlename__': table.__singlename__ + '_' + name_singular, - 'is_%s_table' % name_singular: True, - } - - fields.update((name, col) for name, plural, col in columns) - - name = table.__name__ + name_singular.capitalize() - - # There are some dynamic things that can only be set at class - # creation time because of declarative metaclass magic. - # So create class dynamically. - Strings = type(name, (TableBase, LanguageSpecific), fields) - - # Alias the described thing to 'object', to make meta stuff easier - Strings.object_id = getattr(Strings, safe_name + '_id') - - # The relation to the object - setattr(table, name_plural, relation( - Strings, - primaryjoin=(table.id == Strings.object_id), - backref=safe_name, - collection_class=attribute_mapped_collection('language'), - lazy=lazy, - )) - - Strings.object = getattr(Strings, safe_name) - - Strings.object_table = table - setattr(table, name_singular + '_table', Strings) - - Strings.language = relation( - Language, - primaryjoin=Strings.language_id == Language.id, - ) - - for colname, pluralname, column in columns: - # Provide a relation with all the names, and an English accessor - # for backwards compatibility - def scope(colname, pluralname, column): - def get_string(self): - return dict( - (l, getattr(t, colname)) - for l, t in getattr(self, name_plural).items() - ) - - def get_english_string(self): - try: - return get_string(self)['en'] - except KeyError: - raise AttributeError(colname) - - setattr(table, pluralname, property(get_string)) - setattr(table, colname, property(get_english_string)) - scope(colname, pluralname, column) - - if colname == 'name': - table.name_table = Strings - - return Strings - -for table in all_tables(): - text_columns = [] - prose_columns = [] - for colname in dir(table): - column = getattr(table, colname) - if isinstance(column, TextColumn): - text_columns.append((colname, column.plural, column.makeSAColumn())) - elif isinstance(column, ProseColumn): - prose_columns.append((colname, column.plural, column.makeSAColumn())) - if text_columns: - string_table = makeTextTable(table, 'texts', 'text', text_columns, lazy=False) - globals()[string_table.__name__] = string_table - if prose_columns: - string_table = makeTextTable(table, 'prose', 'prose', prose_columns, lazy=True) - globals()[string_table.__name__] = string_table - if (text_columns or prose_columns) and issubclass(table, LanguageSpecific): - raise AssertionError("Language-specific table %s shouldn't have explicit language-specific columns" % table) - -### Add language relations -for table in all_tables(): - if issubclass(table, LanguageSpecific): - table.language = relation(Language, primaryjoin=table.language_id == Language.id)