X-Git-Url: http://git.veekun.com/zzz-pokedex.git/blobdiff_plain/409006486eb3a3a0ef3f720bbbdf215df0ba6fb8..29856ad8bf84858312a73a621aec9a9742515144:/pokedex/db/tables.py diff --git a/pokedex/db/tables.py b/pokedex/db/tables.py index cf9b780..aadd245 100644 --- a/pokedex/db/tables.py +++ b/pokedex/db/tables.py @@ -15,72 +15,98 @@ 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. + +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 -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, declared_attr, DeclarativeMeta, + ) from sqlalchemy.ext.associationproxy import association_proxy -from sqlalchemy.orm import backref, eagerload_all, relation, class_mapper -from sqlalchemy.orm.session import Session -from sqlalchemy.orm.collections import attribute_mapped_collection +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 - -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') - - def __repr__(self): - return str(self) - -class OfficiallyNamed(Named): - """Mixin for stuff with official names""" + return unicode(self).encode('utf8') -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) -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 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.")) -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_texts', 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' @@ -91,10 +117,17 @@ class Ability(TableBase, OfficiallyNamed): 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_texts', Ability, 'names', + name = Column(Unicode(24), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) +create_translation_table('ability_prose', Ability, 'prose', + effect = Column(markdown.MarkdownColumn(5120), nullable=False, + info=dict(description="A detailed description of this ability's effect", format='markdown')), + short_effect = Column(markdown.MarkdownColumn(255), nullable=False, + 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.""" @@ -106,10 +139,13 @@ class AbilityChangelog(TableBase): 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 +153,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, + info=dict(description="The language")) flavor_text = Column(Unicode(64), nullable=False, info=dict(description="The actual flavor text", official=True, format='gametext')) @@ -147,7 +185,7 @@ 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' @@ -157,6 +195,11 @@ class BerryFirmness(TableBase, OfficiallyNamed): identifier = Column(Unicode(10), nullable=False, info=dict(description="An identifier", format='identifier')) +create_translation_table('berry_firmness_texts', BerryFirmness, 'names', + 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. """ @@ -188,12 +231,15 @@ class ContestEffect(TableBase): 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=False, + info=dict(description="The 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='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' @@ -202,12 +248,17 @@ class ContestType(TableBase, OfficiallyNamed): 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_texts', ContestType, 'names', + name = Column(Unicode(6), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), + flavor = Column(Unicode(6), nullable=False, + info=dict(description="The name of the corresponding Berry flavor", official=True, format='plaintext')), + color = Column(Unicode(6), nullable=False, + 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) @@ -219,6 +270,11 @@ class EggGroup(TableBase, UnofficiallyNamed): identifier = Column(Unicode(16), nullable=False, info=dict(description=u"An identifier.", format='identifier')) +create_translation_table('egg_group_prose', EggGroup, 'names', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), +) + class Encounter(TableBase): u"""Encounters with wild Pokémon. @@ -259,7 +315,7 @@ 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. """ @@ -270,7 +326,12 @@ class EncounterCondition(TableBase, UnofficiallyNamed): 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'. """ @@ -285,6 +346,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,7 +360,7 @@ 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): +class EncounterTerrain(TableBase): u"""A way the player can enter a wild encounter, e.g., surfing, fishing, or walking through tall grass. """ @@ -305,6 +371,11 @@ class EncounterTerrain(TableBase, UnofficiallyNamed): 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 EncounterSlot(TableBase): u"""An abstract "slot" within a terrain, associated with both some set of conditions and a rarity. @@ -335,7 +406,7 @@ class EvolutionChain(TableBase): 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' @@ -345,6 +416,11 @@ class EvolutionTrigger(TableBase, UnofficiallyNamed): 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 """ @@ -356,7 +432,7 @@ class Experience(TableBase): 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' @@ -370,7 +446,12 @@ class Generation(TableBase, OfficiallyNamed): identifier = Column(Unicode(16), nullable=False, info=dict(description=u'An identifier', format='identifier')) -class GrowthRate(TableBase, UnofficiallyNamed): +create_translation_table('generation_texts', Generation, 'names', + 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' @@ -382,7 +463,12 @@ class GrowthRate(TableBase, UnofficiallyNamed): 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' @@ -399,10 +485,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,7 +492,18 @@ class Item(TableBase, OfficiallyNamed): """ return any(flag.identifier == u'underground' for flag in self.flags) -class ItemCategory(TableBase, UnofficiallyNamed): +create_translation_table('item_texts', Item, 'names', + name = Column(Unicode(20), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) +create_translation_table('item_prose', Item, 'prose', + short_effect = Column(Unicode(256), 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 description of the item's effect.", format='markdown')), +) + +class ItemCategory(TableBase): u"""An item category """ # XXX: This is fanon, right? @@ -423,7 +516,12 @@ class ItemCategory(TableBase, UnofficiallyNamed): 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', + 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' @@ -432,8 +530,13 @@ class ItemFlag(TableBase, UnofficiallyNamed): 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=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), + description = Column(Unicode(64), nullable=False, + info=dict(description="Short description of the flag", format='plaintext')), +) class ItemFlagMap(TableBase): u"""Maps an item flag to its item. @@ -444,7 +547,7 @@ 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' @@ -453,6 +556,8 @@ class ItemFlavorText(TableBase, LanguageSpecific): 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, + info=dict(description="The language")) flavor_text = Column(Unicode(255), nullable=False, info=dict(description="The flavor text itself", official=True, format='gametext')) @@ -463,8 +568,11 @@ class ItemFlingEffect(TableBase): __singlename__ = 'item_fling_effect' id = Column(Integer, primary_key=True, nullable=False, info=dict(description="A numeric ID")) - effect = ProseColumn(Unicode(255), plural='effects', nullable=False, - info=dict(description="Description of the effect", format='plaintext')) + +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 ItemInternalID(TableBase): u"""The internal ID number a game uses for an item @@ -477,7 +585,7 @@ class ItemInternalID(TableBase): internal_id = 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' @@ -487,43 +595,12 @@ class ItemPocket(TableBase, OfficiallyNamed): 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_texts', ItemPocket, 'names', + 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' @@ -535,7 +612,12 @@ class Location(TableBase, OfficiallyNamed): identifier = Column(Unicode(64), nullable=False, info=dict(description="An identifier", format='identifier')) -class LocationArea(TableBase, UnofficiallyNamed): +create_translation_table('location_texts', Location, 'names', + 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' @@ -549,6 +631,11 @@ class LocationArea(TableBase, UnofficiallyNamed): identifier = Column(Unicode(64), nullable=True, info=dict(description="An identifier", format='identifier')) +create_translation_table('location_area_prose', LocationArea, 'prose', + 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' @@ -591,7 +678,7 @@ class Machine(TableBase): """ return self.machine_number >= 100 -class MoveBattleStyle(TableBase, UnofficiallyNamed): +class MoveBattleStyle(TableBase): u"""A battle style of a move""" # XXX: Explain better __tablename__ = 'move_battle_styles' __singlename__ = 'move_battle_style' @@ -600,7 +687,12 @@ class MoveBattleStyle(TableBase, UnofficiallyNamed): 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', + name = Column(Unicode(8), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), +) + +class MoveEffectCategory(TableBase): u"""Category of a move effect """ __tablename__ = 'move_effect_categories' @@ -612,6 +704,11 @@ class MoveEffectCategory(TableBase, UnofficiallyNamed): 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 """ @@ -623,7 +720,7 @@ class MoveEffectCategoryMap(TableBase): affects_user = Column(Boolean, primary_key=True, nullable=False, info=dict(description="Set if the user is affected")) -class MoveDamageClass(TableBase, UnofficiallyNamed): +class MoveDamageClass(TableBase): u"""Any of the damage classes moves can have, i.e. physical, special, or non-damaging. """ __tablename__ = 'move_damage_classes' @@ -632,8 +729,13 @@ class MoveDamageClass(TableBase, UnofficiallyNamed): 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')) + +create_translation_table('move_damage_class_prose', MoveDamageClass, 'prose', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), + description = Column(Unicode(64), nullable=False, + info=dict(description="A description of the class", format='plaintext')), +) class MoveEffect(TableBase): u"""An effect of a move @@ -642,10 +744,13 @@ class MoveEffect(TableBase): __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')) + +create_translation_table('move_effect_prose', MoveEffect, 'prose', + short_effect = Column(Unicode(256), nullable=False, + info=dict(description="A short summary of the effect", format='plaintext')), + effect = Column(Unicode(5120), 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.""" @@ -653,12 +758,20 @@ class MoveEffectChangelog(TableBase): __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'), 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,7 +784,7 @@ 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' @@ -680,10 +793,15 @@ class MoveFlagType(TableBase, UnofficiallyNamed): 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', + name = Column(Unicode(32), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), + description = Column(markdown.MarkdownColumn(128), nullable=False, + 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' @@ -691,50 +809,80 @@ class MoveFlavorText(TableBase, LanguageSpecific): 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, + 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, + 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_texts', MoveMetaAilment, 'names', + 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, + info=dict(description="A numeric ID")) + +create_translation_table('move_meta_category_prose', MoveMetaCategory, 'prose', + description = Column(Unicode(64), 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) - 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' @@ -743,10 +891,15 @@ class MoveTarget(TableBase, UnofficiallyNamed): 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): +create_translation_table('move_target_prose', MoveTarget, 'prose', + name = Column(Unicode(32), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), + description = Column(Unicode(128), nullable=False, + info=dict(description="A description", format='plaintext')), +) + +class Move(TableBase): u"""A Move: technique or attack a Pokémon can learn to use """ __tablename__ = 'moves' @@ -782,6 +935,12 @@ class Move(TableBase, OfficiallyNamed): 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_texts', Move, 'names', + name = Column(Unicode(24), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)) +) + + class MoveChangelog(TableBase): """History of changes to moves across main game versions.""" __tablename__ = 'move_changelog' @@ -803,7 +962,7 @@ class MoveChangelog(TableBase): effect_chance = Column(Integer, nullable=True, info=dict(description="Prior effect chance, or NULL if unchanged")) -class Nature(TableBase, OfficiallyNamed): +class Nature(TableBase): u"""A nature a Pokémon can have, such as Calm or Brave """ __tablename__ = 'natures' @@ -828,6 +987,11 @@ class Nature(TableBase, OfficiallyNamed): """ return self.increased_stat_id == self.decreased_stat_id +create_translation_table('nature_texts', Nature, 'names', + name = Column(Unicode(8), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) + class NatureBattleStylePreference(TableBase): u"""Battle Palace move preference @@ -855,7 +1019,7 @@ class NaturePokeathlonStat(TableBase): 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' @@ -865,7 +1029,12 @@ class PokeathlonStat(TableBase, OfficiallyNamed): identifier = Column(Unicode(8), nullable=False, info=dict(description="An identifier", format='identifier')) -class Pokedex(TableBase, UnofficiallyNamed): +create_translation_table('pokeathlon_stat_texts', 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' @@ -876,10 +1045,15 @@ class Pokedex(TableBase, UnofficiallyNamed): 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', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), + description = Column(Unicode(512), nullable=False, + 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' @@ -896,9 +1070,6 @@ 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, @@ -1004,6 +1175,14 @@ class Pokemon(TableBase, OfficiallyNamed): else: return None +create_translation_table('pokemon_texts', Pokemon, 'names', + name = Column(Unicode(20), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), + species = Column(Unicode(16), nullable=False, + info=dict(description=u'The short flavor text, such as "Seed" or "Lizard"; usually affixed with the word "Pokémon"', + official=True, format='plaintext')), +) + class PokemonAbility(TableBase): u"""Maps an ability to a Pokémon that can have it """ @@ -1020,7 +1199,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 +1209,11 @@ class PokemonColor(TableBase, OfficiallyNamed): identifier = Column(Unicode(6), nullable=False, info=dict(description=u"An identifier", format='identifier')) +create_translation_table('pokemon_color_texts', PokemonColor, 'names', + 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,7 +1272,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, LanguageSpecific): +class PokemonFlavorText(TableBase): u"""In-game Pokédex descrption of a Pokémon. """ __tablename__ = 'pokemon_flavor_text' @@ -1096,10 +1280,12 @@ class PokemonFlavorText(TableBase, LanguageSpecific): 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, + 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')) -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 @@ -1151,20 +1337,29 @@ class PokemonForm(TableBase, OfficiallyNamed): else: return self.form_base_pokemon.name +create_translation_table('pokemon_form_texts', PokemonForm, 'names', + 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=False, + 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 +1374,7 @@ 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 PokemonHabitat(TableBase): u"""The habitat of a Pokémon, as given in the FireRed/LeafGreen version Pokédex """ __tablename__ = 'pokemon_habitats' @@ -1189,6 +1384,11 @@ class PokemonHabitat(TableBase, OfficiallyNamed): identifier = Column(Unicode(16), nullable=False, info=dict(description=u"An identifier", format='identifier')) +create_translation_table('pokemon_habitat_texts', PokemonHabitat, 'names', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) + class PokemonInternalID(TableBase): u"""The number of a Pokémon a game uses internally """ @@ -1235,7 +1435,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,10 +1444,16 @@ 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', + name = Column(Unicode(64), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), + description = Column(Unicode(255), nullable=False, + 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' @@ -1256,8 +1462,13 @@ class PokemonShape(TableBase, UnofficiallyNamed): 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', + name = Column(Unicode(24), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), + awesome_name = Column(Unicode(16), nullable=False, + 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,7 +1494,7 @@ 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' @@ -1293,7 +1504,12 @@ class Region(TableBase, OfficiallyNamed): identifier = Column(Unicode(16), nullable=False, info=dict(description=u"An identifier", format='identifier')) -class Stat(TableBase, OfficiallyNamed): +create_translation_table('region_texts', Region, 'names', + 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' @@ -1305,17 +1521,28 @@ class Stat(TableBase, OfficiallyNamed): identifier = Column(Unicode(16), nullable=False, info=dict(description=u"An identifier", format='identifier')) +create_translation_table('stat_texts', Stat, 'names', + 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 called "characteristics". """ __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, + 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_texts', StatHint, 'names', + 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. @@ -1335,8 +1562,12 @@ class SuperContestEffect(TableBase): 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')), +) + class TypeEfficacy(TableBase): u"""The damage multiplier used when a move of a particular type damages a @@ -1350,19 +1581,24 @@ 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): +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, info=dict(description=u"A unique ID for this type.")) - identifier = Column(Unicode(8), nullable=False, + 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_texts', Type, 'names', + name = Column(Unicode(12), 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.) @@ -1383,7 +1619,7 @@ class VersionGroupRegion(TableBase): region_id = Column(Integer, ForeignKey('regions.id'), primary_key=True, nullable=False, info=dict(description=u"The ID of the region.")) -class Version(TableBase, OfficiallyNamed): +class Version(TableBase): u"""An individual main-series Pokémon game.""" __tablename__ = 'versions' __singlename__ = 'version' @@ -1394,6 +1630,11 @@ class Version(TableBase, OfficiallyNamed): identifier = Column(Unicode(32), nullable=False, info=dict(description=u'And identifier', format='identifier')) +create_translation_table('version_texts', Version, 'names', + name = Column(Unicode(32), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) + ### Relations down here, to avoid ordering problems Ability.changelog = relation(AbilityChangelog, @@ -1405,7 +1646,7 @@ Ability.generation = relation(Generation, backref='abilities') Ability.all_pokemon = relation(Pokemon, secondary=PokemonAbility.__table__, order_by=Pokemon.order, - back_populates='all_abilities', + #back_populates='all_abilities', ) Ability.pokemon = relation(Pokemon, secondary=PokemonAbility.__table__, @@ -1414,7 +1655,7 @@ Ability.pokemon = relation(Pokemon, PokemonAbility.is_dream == False ), order_by=Pokemon.order, - back_populates='abilities', + #back_populates='abilities', ) Ability.dream_pokemon = relation(Pokemon, secondary=PokemonAbility.__table__, @@ -1423,12 +1664,13 @@ Ability.dream_pokemon = relation(Pokemon, PokemonAbility.is_dream == True ), order_by=Pokemon.order, - back_populates='dream_ability', + #back_populates='dream_ability', ) AbilityChangelog.changed_in = relation(VersionGroup, backref='ability_changelog') AbilityFlavorText.version_group = relation(VersionGroup) +AbilityFlavorText.language = relation(Language) Berry.berry_firmness = relation(BerryFirmness, backref='berries') Berry.firmness = association_proxy('berry_firmness', 'name') @@ -1459,7 +1701,7 @@ EncounterSlot.version_group = relation(VersionGroup) 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') +EvolutionChain.pokemon = relation(Pokemon, order_by=Pokemon.order)#, back_populates='evolution_chain') Experience.growth_rate = relation(GrowthRate, backref='experience_table') @@ -1482,6 +1724,7 @@ ItemCategory.items = relation(Item, order_by=Item.identifier) ItemCategory.pocket = relation(ItemPocket) ItemFlavorText.version_group = relation(VersionGroup) +ItemFlavorText.language = relation(Language) ItemInternalID.item = relation(Item, backref='internal_ids') ItemInternalID.generation = relation(Generation) @@ -1519,22 +1762,12 @@ 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') - -Move.effect = markdown.MoveEffectProperty('effect') -Move.effects = markdown.MoveEffectsProperty('effect') -Move.short_effect = markdown.MoveEffectProperty('short_effect') -Move.short_effects = markdown.MoveEffectsProperty('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.effects = markdown.MoveEffectsProperty('effect') -MoveChangelog.short_effect = markdown.MoveEffectProperty('short_effect') -MoveChangelog.short_effects = markdown.MoveEffectsProperty('short_effect') - MoveEffect.category_map = relation(MoveEffectCategoryMap) MoveEffect.categories = association_proxy('category_map', 'category') MoveEffect.changelog = relation(MoveEffectChangelog, @@ -1548,6 +1781,7 @@ MoveEffectChangelog.changed_in = relation(VersionGroup, backref='move_effect_cha MoveFlag.flag = relation(MoveFlagType) MoveFlavorText.version_group = relation(VersionGroup) +MoveFlavorText.language = relation(Language) MoveMeta.category = relation(MoveMetaCategory, backref='move_meta') MoveMeta.ailment = relation(MoveMetaAilment, backref='move_meta') @@ -1572,7 +1806,7 @@ NatureBattleStylePreference.battle_style = relation(MoveBattleStyle, backref='na NaturePokeathlonStat.pokeathlon_stat = relation(PokeathlonStat, backref='nature_effects') Pokedex.region = relation(Region, backref='pokedexes') -Pokedex.version_groups = relation(VersionGroup, order_by=VersionGroup.id, back_populates='pokedex') +Pokedex.version_groups = relation(VersionGroup, order_by=VersionGroup.id)#, back_populates='pokedex') Pokemon.all_abilities = relation(Ability, secondary=PokemonAbility.__table__, @@ -1600,7 +1834,7 @@ Pokemon.dex_numbers = relation(PokemonDexNumber, order_by=PokemonDexNumber.poked 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.evolution_chain = relation(EvolutionChain)#, back_populates='pokemon') Pokemon.child_pokemon = relation(Pokemon, primaryjoin=Pokemon.id==PokemonEvolution.from_pokemon_id, secondary=PokemonEvolution.__table__, @@ -1622,7 +1856,7 @@ 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') + )#back_populates='pokemon') PokemonDexNumber.pokedex = relation(Pokedex) @@ -1662,6 +1896,7 @@ PokemonEvolution.trade_pokemon = relation(Pokemon, ) PokemonFlavorText.version = relation(Version) +PokemonFlavorText.language = relation(Language) 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), @@ -1720,10 +1955,10 @@ 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') + )#back_populates='types') Type.moves = relation(Move, back_populates='type', order_by=Move.id) -Version.version_group = relation(VersionGroup, back_populates='versions') +Version.version_group = relation(VersionGroup)#, back_populates='versions') Version.generation = association_proxy('version_group', 'generation') VersionGroup.versions = relation(Version, order_by=Version.id, back_populates='version_group') @@ -1732,120 +1967,12 @@ VersionGroup.version_group_regions = relation(VersionGroupRegion, backref='versi 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) +Move.effect = markdown.MoveEffectProperty('effect') +Move.effect_map = markdown.MoveEffectProperty('effect_map') +Move.short_effect = markdown.MoveEffectProperty('short_effect') +Move.short_effect_map = markdown.MoveEffectProperty('short_effect_map') + +MoveChangelog.effect = markdown.MoveEffectProperty('effect') +MoveChangelog.effect_map = markdown.MoveEffectProperty('effect_map') +MoveChangelog.short_effect = markdown.MoveEffectProperty('short_effect') +MoveChangelog.short_effect_map = markdown.MoveEffectProperty('short_effect_map')