X-Git-Url: http://git.veekun.com/zzz-pokedex.git/blobdiff_plain/08ed701502c20612ef794f27a58a6909664cccf3..0069207e4e6fc2c68d0f9c2eb8ad9fc818349b38:/pokedex/db/tables.py diff --git a/pokedex/db/tables.py b/pokedex/db/tables.py index c025059..20fcbea 100644 --- a/pokedex/db/tables.py +++ b/pokedex/db/tables.py @@ -15,27 +15,105 @@ 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. -- foreign: If set, the column contains foreign (non-English) text. +A localizable text column is visible as two properties: +The plural-name property (e.g. Pokemon.names) is a language-to-name dictionary: + bulbasaur.names['en'] == "Bulbasaur" and bulbasaur.names['de'] == "Bisasam". + You can use Pokemon.names['en'] to filter a query. +The singular-name property returns the name in the default language, English. + For example bulbasaur.name == "Bulbasaur" + Setting pokedex.db.tables.default_lang changes the default language. """ # XXX: Check if "gametext" is set correctly everywhere -# XXX: Some columns paradoxically have official=True and markup='identifier'. -# This is when one column is used as both the English name (lowercased) and -# an identifier. This should be fixed. +import collections +from functools import partial -from sqlalchemy import Column, ForeignKey, MetaData, PrimaryKeyConstraint, Table -from sqlalchemy.ext.declarative import declarative_base +from sqlalchemy import Column, ForeignKey, MetaData, PrimaryKeyConstraint, Table, UniqueConstraint +from sqlalchemy.ext.declarative import ( + declarative_base, declared_attr, DeclarativeMeta, + ) from sqlalchemy.ext.associationproxy import association_proxy -from sqlalchemy.orm import backref, eagerload_all, relation -from sqlalchemy.orm.session import Session +from sqlalchemy.orm import ( + backref, compile_mappers, eagerload_all, relation, class_mapper, synonym, mapper, + ) +from sqlalchemy.orm.session import Session, object_session +from sqlalchemy.orm.interfaces import AttributeExtension +from sqlalchemy.orm.collections import attribute_mapped_collection, MappedCollection, collection, collection_adapter +from sqlalchemy.ext.associationproxy import _AssociationDict, association_proxy from sqlalchemy.sql import and_ +from sqlalchemy.sql.expression import ColumnOperators, bindparam +from sqlalchemy.schema import ColumnDefault from sqlalchemy.types import * +from inspect import isclass from pokedex.db import markdown +# A list of all table classes will live in table_classes +table_classes = [] + +class TableMetaclass(DeclarativeMeta): + def __init__(cls, name, bases, attrs): + super(TableMetaclass, cls).__init__(name, bases, attrs) + if hasattr(cls, '__tablename__'): + table_classes.append(cls) + +class TableSuperclass(object): + """Superclass for declarative tables, to give them some generic niceties + like stringification. + """ + 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 u"<%s object (%s): %s>" % (typename, pk, self.identifier) + except AttributeError: + return u"<%s object (%s)>" % (typename, pk) + + def __str__(self): + return unicode(self).encode('utf8') + metadata = MetaData() -TableBase = declarative_base(metadata=metadata) +TableBase = declarative_base(metadata=metadata, cls=TableSuperclass, metaclass=TableMetaclass) + +### Helper classes +class LanguageSpecific(object): + """Mixin for prose and text tables""" + @declared_attr + def language_id(cls): + return Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, + info=dict(description="The language")) + +class LanguageSpecificColumn(object): + """A column that will not appear in the table it's defined in, but in a related one""" + _ordering = [1] + def __init__(self, *args, **kwargs): + self.args = args + self.plural = kwargs.pop('plural') + self.kwargs = kwargs + self.order = self._ordering[0] + self._ordering[0] += 1 + + def makeSAColumn(self): + return Column(*self.args, **self.kwargs) + +class ProseColumn(LanguageSpecificColumn): + """A column that will appear in the corresponding _prose table""" + +class TextColumn(LanguageSpecificColumn): + """A column that will appear in the corresponding _text table""" + + +### The actual tables class Ability(TableBase): u"""An ability a Pokémon can have, such as Static or Pressure. @@ -44,26 +122,31 @@ class Ability(TableBase): __singlename__ = 'ability' id = Column(Integer, primary_key=True, nullable=False, info=dict(description="This ability's unique ID; matches the games' internal ID")) - name = Column(Unicode(24), nullable=False, - info=dict(description="The official English name of this ability", official=True, format='plaintext')) + 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 = Column(markdown.MarkdownColumn(5120), nullable=False, + effect = ProseColumn(markdown.MarkdownColumn(5120), plural='effects', nullable=False, info=dict(description="A detailed description of this ability's effect", format='markdown')) - short_effect = Column(markdown.MarkdownColumn(255), nullable=False, + short_effect = ProseColumn(markdown.MarkdownColumn(255), plural='short_effects', nullable=False, info=dict(description="A short summary of this ability's effect", format='markdown')) + name = TextColumn(Unicode(24), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=True)) class AbilityChangelog(TableBase): """History of changes to abilities across main game versions.""" __tablename__ = 'ability_changelog' - ability_id = Column(Integer, ForeignKey('abilities.id'), primary_key=True, nullable=False, + __singlename__ = 'ability_changelog' + id = Column(Integer, primary_key=True, nullable=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'), 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 ability changed")) - effect = Column(markdown.MarkdownColumn(255), nullable=False, + effect = ProseColumn(markdown.MarkdownColumn(255), plural='effects', nullable=False, info=dict(description="A description of the old behavior", format='markdown')) -class AbilityFlavorText(TableBase): +class AbilityFlavorText(TableBase, LanguageSpecific): u"""In-game flavor text of an ability """ __tablename__ = 'ability_flavor_text' @@ -74,17 +157,6 @@ class AbilityFlavorText(TableBase): flavor_text = Column(Unicode(64), nullable=False, info=dict(description="The actual flavor text", official=True, format='gametext')) -class AbilityName(TableBase): - u"""Non-English official name of an ability - """ - __tablename__ = 'ability_names' - ability_id = Column(Integer, ForeignKey('abilities.id'), primary_key=True, nullable=False, autoincrement=False, - info=dict(description="The ID of the ability")) - language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, autoincrement=False, - info=dict(description="The ID of the language")) - name = Column(Unicode(16), nullable=False, - info=dict(description="The ID of the language", official=True, foreign=True, format='plaintext')) - class Berry(TableBase): u"""A Berry, consumable item that grows on trees @@ -116,10 +188,13 @@ 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, info=dict(description="A unique ID for this firmness")) - name = Column(Unicode(10), nullable=False, - info=dict(description="The games' English label for this firmness level", official=True, format='plaintext')) + identifier = Column(Unicode(10), nullable=False, + info=dict(description="An identifier", format='identifier')) + name = TextColumn(Unicode(10), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=True)) class BerryFlavor(TableBase): u"""A Berry flavor level. @@ -145,29 +220,33 @@ class ContestEffect(TableBase): u"""Effect of a move when used in a Contest. """ __tablename__ = 'contest_effects' + __singlename__ = 'contest_effect' id = Column(Integer, primary_key=True, nullable=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 = Column(Unicode(64), nullable=False, - info=dict(description="The English in-game description of this effect", official=True, format='gametext')) - effect = Column(Unicode(255), nullable=False, - info=dict(description="A detailed description of the effect", format='markdown')) + 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): 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, info=dict(description="A unique ID for this Contest type")) - name = Column(Unicode(6), nullable=False, - info=dict(description="The English name of the Contest type", official=True, format='identifier')) - flavor = Column(Unicode(6), nullable=False, - info=dict(description="The English name of the corresponding Berry flavor", official=True, format='identifier')) - color = Column(Unicode(6), nullable=False, - info=dict(description=u"The English name of the corresponding Pokéblock color", official=True, format='identifier')) + 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')) + name = TextColumn(Unicode(6), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=True)) class EggGroup(TableBase): u"""An Egg group. Usually, two Pokémon can breed if they share an Egg Group. @@ -175,11 +254,13 @@ class EggGroup(TableBase): (exceptions are the Ditto and No Eggs groups) """ __tablename__ = 'egg_groups' + __singlename__ = 'egg_group' id = Column(Integer, primary_key=True, nullable=False, info=dict(description="A unique ID for this group")) - name = Column(Unicode(16), nullable=False, - info=dict(description=u"The English name of this egg group, from Earl's Pokémon Academy in Pokémon Stadium 2. " - u"And no, these haven't officially been used anywhere else.", official=True, format='identifier')) + identifier = Column(Unicode(16), nullable=False, + info=dict(description=u"An identifier.", format='identifier')) + name = ProseColumn(Unicode(16), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=False)) class Encounter(TableBase): u"""Encounters with wild Pokémon. @@ -226,24 +307,30 @@ class EncounterCondition(TableBase): """ __tablename__ = 'encounter_conditions' + __singlename__ = 'encounter_condition' id = Column(Integer, primary_key=True, nullable=False, info=dict(description="A unique ID for this condition")) - name = Column(Unicode(64), nullable=False, - info=dict(description="An English label for the condition", format='plaintext')) + identifier = Column(Unicode(64), nullable=False, + info=dict(description="An identifier", format='identifier')) + name = ProseColumn(Unicode(64), nullable=False, index=True, plural='names', + 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, 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")) - name = Column(Unicode(64), nullable=False, - info=dict(description="An English label for this value", format='plaintext')) + identifier = Column(Unicode(64), nullable=False, + info=dict(description="An identifier", format='identifier')) is_default = Column(Boolean, nullable=False, info=dict(description='Set if this value is the default state for the condition')) + name = ProseColumn(Unicode(64), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=False)) class EncounterConditionValueMap(TableBase): u"""Maps encounters to the specific conditions under which they occur. @@ -259,10 +346,13 @@ class EncounterTerrain(TableBase): """ __tablename__ = 'encounter_terrain' + __singlename__ = __tablename__ id = Column(Integer, primary_key=True, nullable=False, info=dict(description="A unique ID for the terrain")) - name = Column(Unicode(64), nullable=False, - info=dict(description="An English label for this terrain", format='plaintext')) + identifier = Column(Unicode(64), nullable=False, + info=dict(description="An identifier", format='identifier')) + name = ProseColumn(Unicode(64), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=False)) class EncounterSlot(TableBase): u"""An abstract "slot" within a terrain, associated with both some set of conditions and a rarity. @@ -298,10 +388,13 @@ 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, info=dict(description="A numeric ID")) identifier = Column(Unicode(16), nullable=False, - info=dict(description="An English identifier", format='identifier')) + info=dict(description="An identifier", format='identifier')) + name = ProseColumn(Unicode(16), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=False)) class Experience(TableBase): u"""EXP needed for a certain level with a certain growth rate @@ -318,25 +411,31 @@ class Generation(TableBase): u"""A Generation of the Pokémon franchise """ __tablename__ = 'generations' + __singlename__ = 'generation' id = Column(Integer, primary_key=True, nullable=False, info=dict(description="A numeric ID")) main_region_id = Column(Integer, ForeignKey('regions.id'), info=dict(description="ID of the region this generation's main games take place in")) canonical_pokedex_id = Column(Integer, ForeignKey('pokedexes.id'), info=dict(description=u"ID of the Pokédex this generation's main games use by default")) - name = Column(Unicode(16), nullable=False, - info=dict(description=u'An English name of this generation, such as "Generation IV"', format='plaintext')) + identifier = Column(Unicode(16), nullable=False, + info=dict(description=u'An identifier', format='identifier')) + name = TextColumn(Unicode(16), nullable=False, index=True, plural='names', + 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, info=dict(description="A numeric ID")) - name = Column(Unicode(20), nullable=False, - info=dict(description="A name for the", format='identifier')) + 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')) + name = ProseColumn(Unicode(20), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=False)) class Item(TableBase): u"""An Item from the games, like "Poké Ball" or "Bicycle". @@ -345,8 +444,8 @@ class Item(TableBase): __singlename__ = 'item' id = Column(Integer, primary_key=True, nullable=False, info=dict(description="A numeric ID")) - name = Column(Unicode(20), nullable=False, - info=dict(description="The English name of the item", official=True, format='plaintext')) + identifier = Column(Unicode(20), nullable=False, + info=dict(description="An identifier", format='identifier')) category_id = Column(Integer, ForeignKey('item_categories.id'), nullable=False, info=dict(description="ID of a category this item belongs to")) cost = Column(Integer, nullable=False, @@ -355,10 +454,12 @@ class Item(TableBase): 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 = Column(Unicode(256), nullable=False, + short_effect = ProseColumn(Unicode(256), plural='short_effects', nullable=False, info=dict(description="A short summary of the effect", format='plaintext')) - effect = Column(markdown.MarkdownColumn(5120), nullable=False, - info=dict(description=u"Detailed English description of the item's effect.", format='markdown')) + effect = ProseColumn(markdown.MarkdownColumn(5120), plural='effects', nullable=False, + info=dict(description=u"Detailed description of the item's effect.", format='markdown')) + name = TextColumn(Unicode(20), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=True)) @property def appears_underground(self): @@ -371,23 +472,29 @@ class ItemCategory(TableBase): """ # XXX: This is fanon, right? __tablename__ = 'item_categories' + __singlename__ = 'item_category' id = Column(Integer, primary_key=True, nullable=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")) - name = Column(Unicode(16), nullable=False, - info=dict(description="English name of the category", format='plaintext')) + identifier = Column(Unicode(16), nullable=False, + info=dict(description="An identifier", format='identifier')) + name = ProseColumn(Unicode(16), nullable=False, index=True, plural='names', + 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, info=dict(description="A numeric ID")) identifier = Column(Unicode(24), nullable=False, info=dict(description="Identifier of the flag", format='identifier')) - name = Column(Unicode(64), nullable=False, - info=dict(description="Short English description of the flag", format='plaintext')) + description = ProseColumn(Unicode(64), plural='descriptions', nullable=False, + info=dict(description="Short description of the flag", format='plaintext')) + name = ProseColumn(Unicode(24), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=False)) class ItemFlagMap(TableBase): u"""Maps an item flag to its item. @@ -398,10 +505,11 @@ 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): +class ItemFlavorText(TableBase, LanguageSpecific): u"""An in-game description of an item """ __tablename__ = 'item_flavor_text' + __singlename__ = 'item_flavor_text' 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, @@ -413,10 +521,11 @@ class ItemFlingEffect(TableBase): u"""An effect of the move Fling when used with a specific item """ __tablename__ = 'item_fling_effects' + __singlename__ = 'item_fling_effect' id = Column(Integer, primary_key=True, nullable=False, info=dict(description="A numeric ID")) - effect = Column(Unicode(255), nullable=False, - info=dict(description="English description of the effect", format='plaintext')) + effect = ProseColumn(Unicode(255), plural='effects', nullable=False, + info=dict(description="Description of the effect", format='plaintext')) class ItemInternalID(TableBase): u"""The internal ID number a game uses for an item @@ -429,40 +538,37 @@ class ItemInternalID(TableBase): internal_id = Column(Integer, nullable=False, info=dict(description="Internal ID of the item in the generation")) -class ItemName(TableBase): - u"""A non-English name of an item - """ - __tablename__ = 'item_names' - item_id = Column(Integer, ForeignKey('items.id'), primary_key=True, nullable=False, autoincrement=False, - info=dict(description="The ID of the item")) - language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, autoincrement=False, - info=dict(description="The ID of the language")) - name = Column(Unicode(16), nullable=False, - info=dict(description="The name of the item in this language", foreign=True, format='plaintext')) - class ItemPocket(TableBase): u"""A pocket that categorizes items """ __tablename__ = 'item_pockets' + __singlename__ = 'item_pocket' 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 of this pocket", format='identifier')) - name = Column(Unicode(16), nullable=False, - info=dict(description="A numeric ID", format='plaintext')) + name = TextColumn(Unicode(16), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=True)) class Language(TableBase): - u"""A language the Pokémon games have been transleted into; except English + 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.")) + 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.")) - name = Column(Unicode(16), nullable=False, - info=dict(description="The English name of the language", format='plaintext')) + 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.")) + name = TextColumn(Unicode(16), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=True)) class Location(TableBase): u"""A place in the Pokémon world @@ -473,21 +579,26 @@ class Location(TableBase): info=dict(description="A numeric ID")) region_id = Column(Integer, ForeignKey('regions.id'), info=dict(description="ID of the region this location is in")) - name = Column(Unicode(64), nullable=False, - info=dict(description="English name of the location", official=True, format='plaintext')) + identifier = Column(Unicode(64), nullable=False, + info=dict(description="An identifier", format='identifier')) + name = TextColumn(Unicode(64), nullable=False, index=True, plural='names', + 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, 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, info=dict(description="ID the games ude for this area")) - name = Column(Unicode(64), nullable=True, - info=dict(description="An English name of the area, if applicable", format='plaintext')) + identifier = Column(Unicode(64), nullable=True, + info=dict(description="An identifier", format='identifier')) + name = ProseColumn(Unicode(64), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=False)) class LocationAreaEncounterRate(TableBase): # XXX: What's this exactly? Someone add the docstring & revise the descriptions @@ -534,21 +645,27 @@ class Machine(TableBase): 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, info=dict(description="A numeric ID")) - name = Column(Unicode(8), nullable=False, - info=dict(description="An English name for this battle style", format='plaintext')) + identifier = Column(Unicode(8), nullable=False, + info=dict(description="An identifier", format='identifier')) + name = ProseColumn(Unicode(8), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=False)) 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, info=dict(description="A numeric ID")) - name = Column(Unicode(64), nullable=False, - info=dict(description="English name of the category", format='plaintext')) + 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")) + name = ProseColumn(Unicode(64), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=False)) class MoveEffectCategoryMap(TableBase): u"""Maps a move effect category to a move effect @@ -565,34 +682,46 @@ 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, info=dict(description="A numeric ID")) - name = Column(Unicode(16), nullable=False, - info=dict(description="An English name of the class", format='plaintext')) - description = Column(Unicode(64), nullable=False, - info=dict(description="An English description of the class", format='plaintext')) + 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')) + name = ProseColumn(Unicode(16), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=False)) 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 = Column(Unicode(256), nullable=False, + short_effect = ProseColumn(Unicode(256), plural='short_effects', nullable=False, info=dict(description="A short summary of the effect", format='plaintext')) - effect = Column(Unicode(5120), nullable=False, + 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' - effect_id = Column(Integer, ForeignKey('move_effects.id'), primary_key=True, nullable=False, + __singlename__ = 'move_effect_changelog' + id = Column(Integer, primary_key=True, nullable=False, + info=dict(description="A numeric ID")) + 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 = Column(markdown.MarkdownColumn(255), nullable=False, + 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), + {}, + ) + class MoveFlag(TableBase): u"""Maps a move flag to a move """ @@ -608,16 +737,17 @@ 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, info=dict(description="A numeric ID")) - identifier = Column(Unicode(16), nullable=False, + identifier = Column(Unicode(32), nullable=False, info=dict(description="A short identifier for the flag", format='identifier')) - name = Column(Unicode(32), nullable=False, - info=dict(description="An English name for the flag", format='plaintext')) - description = Column(markdown.MarkdownColumn(128), nullable=False, - info=dict(description="A short English description of the flag", format='markdown')) + description = ProseColumn(markdown.MarkdownColumn(128), plural='descriptions', nullable=False, + info=dict(description="A short description of the flag", format='markdown')) + name = ProseColumn(Unicode(32), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=False)) -class MoveFlavorText(TableBase): +class MoveFlavorText(TableBase, LanguageSpecific): u"""In-game description of a move """ __tablename__ = 'move_flavor_text' @@ -626,29 +756,83 @@ class MoveFlavorText(TableBase): 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")) flavor_text = Column(Unicode(255), nullable=False, - info=dict(description="The English flavor text", official=True, format='gametext')) + info=dict(description="The flavor text", official=True, format='gametext')) -class MoveName(TableBase): - u"""Non-English name of a move - """ - __tablename__ = 'move_names' +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, + 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, + info=dict(description="A numeric ID")) + identifier = Column(Unicode(24), nullable=False, + info=dict(description="An identifier", format='identifier')) + name = TextColumn(Unicode(24), nullable=False, index=True, plural='names', + 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, + info=dict(description="A numeric ID")) + description = ProseColumn(Unicode(64), plural='descriptions', nullable=False, + info=dict(description="A description of the category")) + +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, info=dict(description="ID of the move")) - language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, autoincrement=False, - info=dict(description="ID of the language")) - name = Column(Unicode(16), nullable=False, - info=dict(description="ID of the language", foreign=True, format='plaintext')) + 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): 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, info=dict(description="A numeric ID")) - name = Column(Unicode(32), nullable=False, - info=dict(description="An English name", format='plaintext')) - description = Column(Unicode(128), nullable=False, - info=dict(description="An English description", format='plaintext')) + 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')) + name = ProseColumn(Unicode(32), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=False)) class Move(TableBase): u"""A Move: technique or attack a Pokémon can learn to use @@ -657,16 +841,16 @@ class Move(TableBase): __singlename__ = 'move' id = Column(Integer, primary_key=True, nullable=False, info=dict(description="A numeric ID")) - name = Column(Unicode(24), nullable=False, - info=dict(description="The English name of the move", official=True, format='plaintext')) + 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=False, - info=dict(description="Base PP (Power Points) 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, @@ -685,10 +869,13 @@ class Move(TableBase): 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")) + name = TextColumn(Unicode(24), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=True)) 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, @@ -713,8 +900,8 @@ class Nature(TableBase): __singlename__ = 'nature' id = Column(Integer, primary_key=True, nullable=False, info=dict(description="A numeric ID")) - name = Column(Unicode(8), nullable=False, - info=dict(description="An English name of the nature", official=True, format='plaintext')) + identifier = Column(Unicode(8), nullable=False, + info=dict(description="An identifier", format='identifier')) decreased_stat_id = Column(Integer, ForeignKey('stats.id'), nullable=False, info=dict(description="ID of the stat that this nature decreases by 10% (if decreased_stat_id is the same, the effects cancel out)")) increased_stat_id = Column(Integer, ForeignKey('stats.id'), nullable=False, @@ -723,6 +910,8 @@ class Nature(TableBase): info=dict(description=u"ID of the Berry flavor the Pokémon hates (if likes_flavor_id is the same, the effects cancel out)")) likes_flavor_id = Column(Integer, ForeignKey('contest_types.id'), nullable=False, info=dict(description=u"ID of the Berry flavor the Pokémon likes (if hates_flavor_id is the same, the effects cancel out)")) + name = TextColumn(Unicode(8), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=True)) @property def is_neutral(self): @@ -747,17 +936,6 @@ class NatureBattleStylePreference(TableBase): high_hp_preference = Column(Integer, nullable=False, info=dict(description=u"Chance of using the move, in percent, if HP is over ½")) -class NatureName(TableBase): - u"""Non-english name of a Nature - """ - __tablename__ = 'nature_names' - nature_id = Column(Integer, ForeignKey('natures.id'), primary_key=True, nullable=False, autoincrement=False, - info=dict(description="ID of the nature")) - language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, autoincrement=False, - info=dict(description="ID of the language")) - name = Column(Unicode(8), nullable=False, - info=dict(description="The nature's foreign name", foreign=True, format='plaintext')) - class NaturePokeathlonStat(TableBase): u"""Specifies how a Nature affects a Pokéathlon stat """ @@ -773,23 +951,29 @@ 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, info=dict(description="A numeric ID")) - name = Column(Unicode(8), nullable=False, - info=dict(description="The English name of the stat", official=True, format='plaintext')) + identifier = Column(Unicode(8), nullable=False, + info=dict(description="An identifier", format='identifier')) + name = TextColumn(Unicode(8), nullable=False, index=True, plural='names', + 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, 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")) - name = Column(Unicode(16), nullable=False, - info=dict(description=u"An English name of the Pokédex", format='plaintext')) - description = Column(Unicode(512), + 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')) + name = ProseColumn(Unicode(16), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=False)) class Pokemon(TableBase): u"""A species of Pokémon. The core to this whole mess. @@ -798,8 +982,8 @@ class Pokemon(TableBase): __singlename__ = 'pokemon' id = Column(Integer, primary_key=True, nullable=False, info=dict(description=u"A numeric ID")) - name = Column(Unicode(20), nullable=False, - info=dict(description=u"The English name of the Pokémon", official=True, format='plaintext')) + identifier = Column(Unicode(20), nullable=False, + info=dict(description=u"An identifier", format='identifier')) generation_id = Column(Integer, ForeignKey('generations.id'), info=dict(description=u"ID of the generation this species first appeared in")) evolution_chain_id = Column(Integer, ForeignKey('evolution_chains.id'), @@ -808,8 +992,8 @@ class Pokemon(TableBase): 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 = Column(Unicode(16), nullable=False, - info=dict(description=u'The short English flavor text, such as "Seed" or "Lizard"; usually affixed with the word "Pokémon"', + 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.")) @@ -833,6 +1017,8 @@ class Pokemon(TableBase): info=dict(description=u"Set iff the species exhibits enough sexual dimorphism to have separate sets of sprites in Gen IV and beyond.")) order = Column(Integer, nullable=False, index=True, info=dict(description=u"Order for sorting. Almost national order, except families and forms are grouped together.")) + name = TextColumn(Unicode(20), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=True)) ### Stuff to handle alternate Pokémon forms @@ -866,7 +1052,7 @@ class Pokemon(TableBase): u"""Returns the Pokémon's name, including its form if applicable.""" if self.form_name: - return '{0} {1}'.format(self.form_name, self.name) + return u'{0} {1}'.format(self.form_name, self.name) else: return self.name @@ -936,10 +1122,13 @@ class PokemonColor(TableBase): u"""The "Pokédex color" of a Pokémon species. Usually based on the Pokémon's color. """ __tablename__ = 'pokemon_colors' + __singlename__ = 'pokemon_color' id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description=u"ID of the Pokémon")) - name = Column(Unicode(6), nullable=False, - info=dict(description=u"The English name of the color", official=True, format='identifier')) + identifier = Column(Unicode(6), nullable=False, + info=dict(description=u"An identifier", format='identifier')) + name = TextColumn(Unicode(6), nullable=False, index=True, plural='names', + 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) @@ -984,7 +1173,7 @@ class PokemonEvolution(TableBase): info=dict(description=u"The ID of the location the evolution must be triggered at.")) held_item_id = Column(Integer, ForeignKey('items.id'), nullable=True, info=dict(description=u"The ID of the item the Pokémon must hold.")) - time_of_day = Column(Enum('morning', 'day', 'night', name='pokemon_evolution_time_of_day'), nullable=True, + time_of_day = Column(Enum('day', 'night', name='pokemon_evolution_time_of_day'), nullable=True, info=dict(description=u"The required time of day.")) known_move_id = Column(Integer, ForeignKey('moves.id'), nullable=True, info=dict(description=u"The ID of the move the Pokémon must know.")) @@ -999,7 +1188,7 @@ class PokemonEvolution(TableBase): trade_pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=True, info=dict(description=u"The ID of the Pokémon for which this Pokémon must be traded.")) -class PokemonFlavorText(TableBase): +class PokemonFlavorText(TableBase, LanguageSpecific): u"""In-game Pokédex descrption of a Pokémon. """ __tablename__ = 'pokemon_flavor_text' @@ -1020,8 +1209,8 @@ class PokemonForm(TableBase): __singlename__ = 'pokemon_form' id = Column(Integer, primary_key=True, nullable=False, info=dict(description=u'A unique ID for this form.')) - name = Column(Unicode(16), nullable=True, - info=dict(description=u"This form's name, e.g. \"Plant\" for Plant Cloak Burmy.", official=True, format='plaintext')) + identifier = Column(Unicode(16), nullable=True, + info=dict(description=u"An identifier", format='identifier')) form_base_pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=False, autoincrement=False, info=dict(description=u'The ID of the base Pokémon for this form.')) unique_pokemon_id = Column(Integer, ForeignKey('pokemon.id'), autoincrement=False, @@ -1032,6 +1221,8 @@ class PokemonForm(TableBase): info=dict(description=u'Set for exactly one form used as the default for each species.')) order = Column(Integer, nullable=False, autoincrement=False, info=dict(description=u'The order in which forms should be sorted. Multiple forms may have equal order, in which case they should fall back on sorting by name.')) + name = TextColumn(Unicode(16), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=True)) @property def pokemon(self): @@ -1047,7 +1238,7 @@ class PokemonForm(TableBase): if not self.name: return None elif self.form_group and self.form_group.term: - return '{0} {1}'.format(self.name, self.form_group.term) + return u'{0} {1}'.format(self.name, self.form_group.term) else: return self.name @@ -1058,21 +1249,23 @@ class PokemonForm(TableBase): """ if self.name: - return '{0} {1}'.format(self.name, self.form_base_pokemon.name) + return u'{0} {1}'.format(self.name, self.form_base_pokemon.name) else: return self.form_base_pokemon.name 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 = Column(Unicode(16), nullable=True, + 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 = Column(markdown.MarkdownColumn(1024), nullable=False, - info=dict(description=u"English description of how the forms work", format='markdown')) + description = ProseColumn(markdown.MarkdownColumn(1024), plural='descriptions', nullable=False, + info=dict(description=u"Description of how the forms work", format='markdown')) +PokemonFormGroup.id = PokemonFormGroup.pokemon_id class PokemonFormPokeathlonStat(TableBase): u"""A Pokémon form's performance in one Pokéathlon stat.""" @@ -1092,10 +1285,13 @@ class PokemonHabitat(TableBase): u"""The habitat of a Pokémon, as given in the FireRed/LeafGreen version Pokédex """ __tablename__ = 'pokemon_habitats' + __singlename__ = 'pokemon_habitat' id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description=u"A numeric ID")) - name = Column(Unicode(16), nullable=False, - info=dict(description=u"The English name of the habitat", official=True, format='plaintext')) + identifier = Column(Unicode(16), nullable=False, + info=dict(description=u"An identifier", format='identifier')) + name = TextColumn(Unicode(16), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=True)) class PokemonInternalID(TableBase): u"""The number of a Pokémon a game uses internally @@ -1147,34 +1343,29 @@ class PokemonMoveMethod(TableBase): u"""A method a move can be learned by, such as "Level up" or "Tutor". """ __tablename__ = 'pokemon_move_methods' + __singlename__ = 'pokemon_move_method' id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description=u"A numeric ID")) - name = Column(Unicode(64), nullable=False, - info=dict(description=u"An English name of the method", format='plaintext')) - description = Column(Unicode(255), nullable=False, + 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 PokemonName(TableBase): - u"""A non-English name of a Pokémon. - """ - __tablename__ = 'pokemon_names' - pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False, - info=dict(description=u"ID of the Pokémon")) - language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, autoincrement=False, - info=dict(description=u"ID of the language")) - name = Column(Unicode(16), nullable=False, - info=dict(description=u"Name of the Pokémon in the language", foreign=True, format='plaintext')) + name = ProseColumn(Unicode(64), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=False)) 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, info=dict(description=u"A numeric ID")) - name = Column(Unicode(24), nullable=False, - info=dict(description=u"A boring English name of the body shape", format='plaintext')) - awesome_name = Column(Unicode(16), nullable=False, - info=dict(description=u"A splendiferous, technically English, name of the body shape", format='plaintext')) + 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')) + name = ProseColumn(Unicode(24), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=False)) class PokemonStat(TableBase): u"""A stat value of a Pokémon @@ -1204,21 +1395,42 @@ class Region(TableBase): u"""Major areas of the world: Kanto, Johto, etc. """ __tablename__ = 'regions' + __singlename__ = 'region' id = Column(Integer, primary_key=True, nullable=False, info=dict(description=u"A numeric ID")) - name = Column(Unicode(16), nullable=False, - info=dict(description=u"The English name of the region", official=True, format='plaintext')) + identifier = Column(Unicode(16), nullable=False, + info=dict(description=u"An identifier", format='identifier')) + name = TextColumn(Unicode(16), nullable=False, index=True, plural='names', + 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, 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)")) - name = Column(Unicode(16), nullable=False, - info=dict(description=u"The English name of the stat", official=True, format='plaintext')) + identifier = Column(Unicode(16), nullable=False, + info=dict(description=u"An identifier", format='identifier')) + name = TextColumn(Unicode(16), nullable=False, index=True, plural='names', + 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 + called "characteristics". + """ + __tablename__ = 'stat_hints' + __singlename__ = 'stat_hint' + id = Column(Integer, primary_key=True, nullable=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")) + message = TextColumn(Unicode(24), plural='messages', nullable=False, index=True, unique=True, + info=dict(description=u"The text displayed", official=True, format='plaintext')) class SuperContestCombo(TableBase): u"""Combo of two moves in a Super Contest. @@ -1233,12 +1445,13 @@ class SuperContestEffect(TableBase): u"""An effect a move can have when used in the Super Contest """ __tablename__ = 'super_contest_effects' + __singlename__ = 'super_contest_effect' id = Column(Integer, primary_key=True, nullable=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 = Column(Unicode(64), nullable=False, - info=dict(description=u"An English description of the effect.", format='plaintext')) + flavor_text = ProseColumn(Unicode(64), plural='flavor_texts', nullable=False, + info=dict(description=u"A description of the effect.", format='plaintext')) class TypeEfficacy(TableBase): u"""The damage multiplier used when a move of a particular type damages a @@ -1258,24 +1471,14 @@ class Type(TableBase): __singlename__ = 'type' id = Column(Integer, primary_key=True, nullable=False, info=dict(description=u"A unique ID for this type.")) - name = Column(Unicode(8), nullable=False, - info=dict(description=u"This type's English name.", format='plaintext')) - abbreviation = Column(Unicode(3), nullable=False, - info=dict(description=u"An arbitrary 3-letter abbreviation of this type.", format='plaintext')) # XXX: Or is it not arbitrary? + 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=False, - info=dict(description=u"The ID of the damage class this type's moves had before Generation IV.")) - -class TypeName(TableBase): - u"""An official non-English name of an elemental type.""" - __tablename__ = 'type_names' - type_id = Column(Integer, ForeignKey('types.id'), primary_key=True, nullable=False, autoincrement=False, - info=dict(description=u"The ID of the type.")) - language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, autoincrement=False, - info=dict(description=u"The ID of the language.")) - name = Column(Unicode(16), nullable=False, - info=dict(description=u"The name of the type in this language.", foreign=True, format='plaintext')) + 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. ???).")) + name = TextColumn(Unicode(12), nullable=False, index=True, plural='names', + 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 @@ -1300,12 +1503,15 @@ class VersionGroupRegion(TableBase): class Version(TableBase): 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.")) - name = Column(Unicode(32), nullable=False, - info=dict(description=u'The English "version" name for this game, e.g. "Red", without the rest of the title.', official=True, format='plaintext')) + identifier = Column(Unicode(32), nullable=False, + info=dict(description=u'And identifier', format='identifier')) + name = TextColumn(Unicode(32), nullable=False, index=True, plural='names', + info=dict(description="The name", format='plaintext', official=True)) ### Relations down here, to avoid ordering problems @@ -1314,10 +1520,10 @@ Ability.changelog = relation(AbilityChangelog, backref='ability', ) Ability.flavor_text = relation(AbilityFlavorText, order_by=AbilityFlavorText.version_group_id, backref='ability') -Ability.foreign_names = relation(AbilityName, 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, @@ -1326,6 +1532,7 @@ Ability.pokemon = relation(Pokemon, PokemonAbility.ability_id == Ability.id, PokemonAbility.is_dream == False ), + order_by=Pokemon.order, back_populates='abilities', ) Ability.dream_pokemon = relation(Pokemon, @@ -1334,6 +1541,7 @@ Ability.dream_pokemon = relation(Pokemon, PokemonAbility.ability_id == Ability.id, PokemonAbility.is_dream == True ), + order_by=Pokemon.order, back_populates='dream_ability', ) @@ -1341,8 +1549,6 @@ AbilityChangelog.changed_in = relation(VersionGroup, backref='ability_changelog' AbilityFlavorText.version_group = relation(VersionGroup) -AbilityName.language = relation(Language) - Berry.berry_firmness = relation(BerryFirmness, backref='berries') Berry.firmness = association_proxy('berry_firmness', 'name') Berry.flavors = relation(BerryFlavor, order_by=BerryFlavor.contest_type_id, backref='berry') @@ -1387,12 +1593,11 @@ 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.foreign_names = relation(ItemName, backref='item') Item.machines = relation(Machine, order_by=Machine.version_group_id.asc()) Item.category = relation(ItemCategory) Item.pocket = association_proxy('category', 'pocket') -ItemCategory.items = relation(Item, order_by=Item.name) +ItemCategory.items = relation(Item, order_by=Item.identifier) ItemCategory.pocket = relation(ItemPocket) ItemFlavorText.version_group = relation(VersionGroup) @@ -1400,9 +1605,7 @@ ItemFlavorText.version_group = relation(VersionGroup) ItemInternalID.item = relation(Item, backref='internal_ids') ItemInternalID.generation = relation(Generation) -ItemName.language = relation(Language) - -ItemPocket.categories = relation(ItemCategory, order_by=ItemCategory.name) +ItemPocket.categories = relation(ItemCategory, order_by=ItemCategory.identifier) Location.region = relation(Region, backref='locations') @@ -1425,38 +1628,41 @@ Move.contest_type = relation(ContestType, backref='moves') Move.damage_class = relation(MoveDamageClass, backref='moves') Move.flags = association_proxy('move_flags', 'flag') Move.flavor_text = relation(MoveFlavorText, order_by=MoveFlavorText.version_group_id, backref='move') -Move.foreign_names = relation(MoveName, backref='move') Move.generation = relation(Generation, backref='moves') Move.machines = relation(Machine, backref='move') +Move.meta = relation(MoveMeta, uselist=False, 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.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, backref='moves') - -Move.effect = markdown.MoveEffectProperty('effect') -Move.short_effect = markdown.MoveEffectProperty('short_effect') +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') -MoveChangelog.effect = markdown.MoveEffectProperty('effect') -MoveChangelog.short_effect = markdown.MoveEffectProperty('short_effect') - 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', +) MoveEffectCategoryMap.category = relation(MoveEffectCategory) +MoveEffectChangelog.changed_in = relation(VersionGroup, backref='move_effect_changelog') + MoveFlag.flag = relation(MoveFlagType) MoveFlavorText.version_group = relation(VersionGroup) -MoveName.language = relation(Language) +MoveMeta.category = relation(MoveMetaCategory, backref='move_meta') +MoveMeta.ailment = relation(MoveMetaAilment, backref='move_meta') + +MoveMetaStatChange.stat = relation(Stat, backref='move_meta_stat_changes') -Nature.foreign_names = relation(NatureName, backref='nature') 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, @@ -1472,8 +1678,6 @@ Nature.pokeathlon_effects = relation(NaturePokeathlonStat, order_by=NaturePokeat NatureBattleStylePreference.battle_style = relation(MoveBattleStyle, backref='nature_preferences') -NatureName.language = relation(Language) - NaturePokeathlonStat.pokeathlon_stat = relation(PokeathlonStat, backref='nature_effects') Pokedex.region = relation(Region, backref='pokedexes') @@ -1513,9 +1717,8 @@ Pokemon.child_pokemon = relation(Pokemon, backref=backref('parent_pokemon', uselist=False), ) Pokemon.flavor_text = relation(PokemonFlavorText, order_by=PokemonFlavorText.version_id.asc(), backref='pokemon') -Pokemon.foreign_names = relation(PokemonName, backref='pokemon') Pokemon.forms = relation(PokemonForm, primaryjoin=Pokemon.id==PokemonForm.form_base_pokemon_id, - order_by=(PokemonForm.order.asc(), PokemonForm.name.asc())) + 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, @@ -1596,8 +1799,6 @@ PokemonMove.machine = relation(Machine, backref='pokemon_moves', PokemonMove.move = relation(Move, backref='pokemon_moves') PokemonMove.method = relation(PokemonMoveMethod) -PokemonName.language = relation(Language, lazy='joined') - PokemonStat.stat = relation(Stat) # This is technically a has-many; Generation.main_region_id -> Region.id @@ -1608,6 +1809,8 @@ Region.version_groups = association_proxy('version_group_regions', 'version_grou Stat.damage_class = relation(MoveDamageClass, backref='stats') +StatHint.stat = relation(Stat, backref='hints') + 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, @@ -1624,12 +1827,10 @@ Type.target_efficacies = relation(TypeEfficacy, Type.generation = relation(Generation, backref='types') Type.damage_class = relation(MoveDamageClass, backref='types') -Type.foreign_names = relation(TypeName, backref='type') Type.pokemon = relation(Pokemon, secondary=PokemonType.__table__, order_by=Pokemon.order, back_populates='types') - -TypeName.language = relation(Language) +Type.moves = relation(Move, back_populates='type', order_by=Move.id) Version.version_group = relation(VersionGroup, back_populates='versions') Version.generation = association_proxy('version_group', 'generation') @@ -1639,3 +1840,282 @@ VersionGroup.generation = relation(Generation, 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') + + +### Add text/prose tables + +default_lang = u'en' + +def create_translation_table(_table_name, foreign_class, + _language_class=Language, **kwargs): + """Creates a table that represents some kind of data attached to the given + foreign class, but translated across several languages. Returns the new + table's mapped class. +TODO give it a __table__ or __init__? + + `foreign_class` must have a `__singlename__`, currently only used to create + the name of the foreign key column. +TODO remove this requirement + + Also supports the notion of a default language, which is attached to the + session. This is English by default, for historical and practical reasons. + + Usage looks like this: + + class Foo(Base): ... + + create_translation_table('foo_bars', Foo, + name = Column(...), + ) + + # Now you can do the following: + foo.name + foo.name_map['en'] + foo.foo_bars['en'] + + foo.name_map['en'] = "new name" + del foo.name_map['en'] + + q.options(joinedload(Foo.default_translation)) + q.options(joinedload(Foo.foo_bars)) + + In the above example, the following attributes are added to Foo: + + - `foo_bars`, a relation to the new table. It uses a dict-based collection + class, where the keys are language identifiers and the values are rows in + the created tables. + - `foo_bars_local`, a relation to the row in the new table that matches the + current default language. + + Note that these are distinct relations. Even though the former necessarily + includes the latter, SQLAlchemy doesn't treat them as linked; loading one + will not load the other. Modifying both within the same transaction has + undefined behavior. + + For each column provided, the following additional attributes are added to + Foo: + + - `(column)_map`, an association proxy onto `foo_bars`. + - `(column)`, an association proxy onto `foo_bars_local`. + + Pardon the naming disparity, but the grammar suffers otherwise. + + Modifying these directly is not likely to be a good idea. + """ + # n.b.: _language_class only exists for the sake of tests, which sometimes + # want to create tables entirely separate from the pokedex metadata + + foreign_key_name = foreign_class.__singlename__ + '_id' + # A foreign key "language_id" will clash with the language_id we naturally + # put in every table. Rename it something else + if foreign_key_name == 'language_id': + # TODO change language_id below instead and rename this + foreign_key_name = 'lang_id' + + Translations = type(_table_name, (object,), { + '_language_identifier': association_proxy('language', 'identifier'), + }) + + # Create the table object + table = Table(_table_name, foreign_class.__table__.metadata, + Column(foreign_key_name, Integer, ForeignKey(foreign_class.id), + primary_key=True, nullable=False), + Column('language_id', Integer, ForeignKey(_language_class.id), + primary_key=True, nullable=False), + ) + + # Add ye columns + # Column objects have a _creation_order attribute in ascending order; use + # this to get the (unordered) kwargs sorted correctly + kwitems = kwargs.items() + kwitems.sort(key=lambda kv: kv[1]._creation_order) + for name, column in kwitems: + column.name = name + table.append_column(column) + + # Construct ye mapper + mapper(Translations, table, properties={ + # TODO change to foreign_id + 'object_id': synonym(foreign_key_name), + # TODO change this as appropriate + 'language': relation(_language_class, + primaryjoin=table.c.language_id == _language_class.id, + lazy='joined', + innerjoin=True), + # TODO does this need to join to the original table? + }) + + # Add full-table relations to the original class + # Class.foo_bars + setattr(foreign_class, _table_name, relation(Translations, + primaryjoin=foreign_class.id == Translations.object_id, + collection_class=attribute_mapped_collection('language'), + # TODO + lazy='select', + )) + # Class.foo_bars_local + # This is a bit clever; it uses bindparam() to make the join clause + # modifiable on the fly. db sessions know the current language identifier + # populates the bindparam. + local_relation_name = _table_name + '_local' + setattr(foreign_class, local_relation_name, relation(Translations, + primaryjoin=and_( + foreign_class.id == Translations.object_id, + Translations._language_identifier == + bindparam('_default_language', required=True), + ), + uselist=False, + # TODO MORESO HERE + lazy='select', + )) + + # Add per-column proxies to the original class + for name, column in kwitems: + # Class.(column) -- accessor for the default language's value + setattr(foreign_class, name, + association_proxy(local_relation_name, name)) + + # Class.(column)_map -- accessor for the language dict + # Need a custom creator since Translations doesn't have an init, and + # these are passed as *args anyway + def creator(language, value): + row = Translations() + row.language = language + setattr(row, name, value) + return row + setattr(foreign_class, name + '_map', + association_proxy(_table_name, name, creator=creator)) + + # Done + return Translations + +def makeTextTable(foreign_table_class, table_suffix_plural, table_suffix_singular, columns, lazy, Language=Language): + # With "Language", we'd have two language_id. So, rename one to 'lang' + foreign_key_name = foreign_table_class.__singlename__ + if foreign_key_name == 'language': + foreign_key_name = 'lang' + + table_name = foreign_table_class.__singlename__ + '_' + table_suffix_plural + + class TranslatedStringsTable(object): + __tablename__ = table_name + _attrname = table_suffix_plural + _language_identifier = association_proxy('language', 'identifier') + + for column_name, column_name_plural, column in columns: + column.name = column_name + if not column.nullable: + # A Python side default value, so that the strings can be set + # one by one without the DB complaining about missing values + column.default = ColumnDefault(u'') + + table = Table(table_name, foreign_table_class.__table__.metadata, + Column(foreign_key_name + '_id', Integer, ForeignKey(foreign_table_class.id), + primary_key=True, nullable=False), + Column('language_id', Integer, ForeignKey(Language.id), + primary_key=True, index=True, nullable=False), + *(column for name, plural, column in columns) + ) + + mapper(TranslatedStringsTable, table, + properties={ + "object_id": synonym(foreign_key_name + '_id'), + "language": relation(Language, + primaryjoin=table.c.language_id == Language.id, + ), + foreign_key_name: relation(foreign_table_class, + primaryjoin=(foreign_table_class.id == table.c[foreign_key_name + "_id"]), + backref=backref(table_suffix_plural, + collection_class=attribute_mapped_collection('_language_identifier'), + lazy=lazy, + ), + ), + }, + ) + + # The relation to the object + TranslatedStringsTable.object = getattr(TranslatedStringsTable, foreign_key_name) + + # Link the tables themselves, so we can get them if needed + TranslatedStringsTable.foreign_table_class = foreign_table_class + setattr(foreign_table_class, table_suffix_singular + '_table', TranslatedStringsTable) + + for column_name, column_name_plural, column in columns: + # Provide a property with all the names, and an English accessor + # for backwards compatibility + def text_string_creator(language_code, string): + row = TranslatedStringsTable() + row._language_identifier = language_code + setattr(row, column_name, string) + return row + + setattr(foreign_table_class, column_name_plural, + association_proxy(table_suffix_plural, column_name, creator=text_string_creator)) + setattr(foreign_table_class, column_name, DefaultLangProperty(column_name_plural)) + + if column_name == 'name': + foreign_table_class.name_table = TranslatedStringsTable + + compile_mappers() + return TranslatedStringsTable + +class DefaultLangProperty(object): + def __init__(self, column_name): + self.column_name = column_name + + def __get__(self, instance, cls): + if instance: + return getattr(instance, self.column_name)[default_lang] + else: + # TODO I think this is kind of broken + return getattr(cls, self.column_name)[default_lang] + + def __set__(self, instance, value): + getattr(instance, self.colname)[default_lang] = value + + def __delete__(self, instance): + del getattr(instance, self.colname)[default_lang] + +for table in list(table_classes): + # Find all the language-specific columns, keeping them in the order they + # were defined + all_columns = [] + for colname in dir(table): + column = getattr(table, colname) + if isinstance(column, LanguageSpecificColumn): + all_columns.append((colname, column)) + delattr(table, colname) + all_columns.sort(key=lambda pair: pair[1].order) + + # Break them into text and prose columns + text_columns = [] + prose_columns = [] + for colname, column in all_columns: + spec = colname, column.plural, column.makeSAColumn() + if isinstance(column, TextColumn): + text_columns.append(spec) + elif isinstance(column, ProseColumn): + prose_columns.append(spec) + + if (text_columns or prose_columns) and issubclass(table, LanguageSpecific): + raise AssertionError("Language-specific table %s shouldn't have explicit language-specific columns" % table) + + if text_columns: + string_table = makeTextTable(table, 'texts', 'text', text_columns, lazy=False) + if prose_columns: + string_table = makeTextTable(table, 'prose', 'prose', prose_columns, lazy='select') + +### Add language relations +for table in list(table_classes): + if issubclass(table, LanguageSpecific): + table.language = relation(Language, primaryjoin=table.language_id == Language.id) + +Move.effect = DefaultLangProperty('effects') +Move.effects = markdown.MoveEffectsProperty('effect') +Move.short_effect = DefaultLangProperty('short_effects') +Move.short_effects = markdown.MoveEffectsProperty('short_effect') + +MoveChangelog.effect = DefaultLangProperty('effects') +MoveChangelog.effects = markdown.MoveEffectsProperty('effect') +MoveChangelog.short_effect = DefaultLangProperty('short_effects') +MoveChangelog.short_effects = markdown.MoveEffectsProperty('short_effect')