X-Git-Url: http://git.veekun.com/zzz-pokedex.git/blobdiff_plain/0069207e4e6fc2c68d0f9c2eb8ad9fc818349b38..0383b7997dc0d64cfd686f1ca99d9d06f75b0268:/pokedex/db/tables.py diff --git a/pokedex/db/tables.py b/pokedex/db/tables.py index 20fcbea..7ed588f 100644 --- a/pokedex/db/tables.py +++ b/pokedex/db/tables.py @@ -15,14 +15,11 @@ Columns have a info dictionary with these keys: - identifier: A fan-made identifier in the [-_a-z0-9]* format. Not intended for translation. - latex: A formula in LaTeX syntax. +- ripped: True for text that has been ripped from the games, and can be ripped + again for new versions or languages -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. +See `pokedex.db.multilang` for how localizable text columns work. The session +classes in that module can be used to change the default language. """ # XXX: Check if "gametext" is set correctly everywhere @@ -30,33 +27,16 @@ 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.declarative import declarative_base, DeclarativeMeta from sqlalchemy.ext.associationproxy import association_proxy -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 import backref, relation +from sqlalchemy.orm.session import 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) +from pokedex.db import markdown, multilang class TableSuperclass(object): """Superclass for declarative tables, to give them some generic niceties @@ -82,36 +62,44 @@ class TableSuperclass(object): def __str__(self): return unicode(self).encode('utf8') +mapped_classes = [] +class TableMetaclass(DeclarativeMeta): + def __init__(cls, name, bases, attrs): + super(TableMetaclass, cls).__init__(name, bases, attrs) + if hasattr(cls, '__tablename__'): + mapped_classes.append(cls) + cls.translation_classes = [] + 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) +### Need Language first, to create the partial() below -class ProseColumn(LanguageSpecificColumn): - """A column that will appear in the corresponding _prose table""" +class Language(TableBase): + u"""A language the Pokémon games have been translated into + """ + __tablename__ = 'languages' + __singlename__ = 'language' + id = Column(Integer, primary_key=True, nullable=False, + info=dict(description="A numeric ID")) + iso639 = Column(Unicode(2), nullable=False, + info=dict(description="The two-letter code of the country where this language is spoken. Note that it is not unique.", format='identifier')) + iso3166 = Column(Unicode(2), nullable=False, + info=dict(description="The two-letter code of the language. Note that it is not unique.", format='identifier')) + identifier = Column(Unicode(16), nullable=False, + info=dict(description="An identifier", format='identifier')) + official = Column(Boolean, nullable=False, index=True, + info=dict(description=u"True iff games are produced in the language.")) + order = Column(Integer, nullable=True, + info=dict(description=u"Order for sorting in foreign name lists.")) -class TextColumn(LanguageSpecificColumn): - """A column that will appear in the corresponding _text table""" +create_translation_table = partial(multilang.create_translation_table, language_class=Language) +create_translation_table('language_names', Language, 'names', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) ### The actual tables @@ -126,12 +114,18 @@ class Ability(TableBase): 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')) - name = TextColumn(Unicode(24), nullable=False, index=True, plural='names', - info=dict(description="The name", format='plaintext', official=True)) + +create_translation_table('ability_names', Ability, 'names', + relation_lazy='joined', + name = Column(Unicode(24), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True, ripped=True)), +) +create_translation_table('ability_prose', Ability, 'prose', + effect = Column(markdown.MarkdownColumn(5120), nullable=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.""" @@ -143,10 +137,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' @@ -154,6 +151,8 @@ class AbilityFlavorText(TableBase, LanguageSpecific): info=dict(description="The ID of the ability")) version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description="The ID of the version group this flavor text is taken from")) + language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, + info=dict(description="The language")) flavor_text = Column(Unicode(64), nullable=False, info=dict(description="The actual flavor text", official=True, format='gametext')) @@ -193,8 +192,12 @@ class BerryFirmness(TableBase): info=dict(description="A unique ID for this firmness")) 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)) + +create_translation_table('berry_firmness_names', BerryFirmness, 'names', + relation_lazy='joined', + name = Column(Unicode(10), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) class BerryFlavor(TableBase): u"""A Berry flavor level. @@ -227,10 +230,13 @@ 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')) + +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. @@ -241,12 +247,16 @@ class ContestType(TableBase): 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')) - name = TextColumn(Unicode(6), nullable=False, index=True, plural='names', - info=dict(description="The name", format='plaintext', official=True)) + +create_translation_table('contest_type_names', ContestType, 'names', + relation_lazy='joined', + 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. @@ -259,8 +269,12 @@ class EggGroup(TableBase): info=dict(description="A unique ID for this group")) 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)) + +create_translation_table('egg_group_prose', EggGroup, 'names', + relation_lazy='joined', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) class Encounter(TableBase): u"""Encounters with wild Pokémon. @@ -312,8 +326,11 @@ class EncounterCondition(TableBase): info=dict(description="A unique ID for this condition")) 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)) + +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'. @@ -329,8 +346,11 @@ class EncounterConditionValue(TableBase): 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)) + +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. @@ -341,19 +361,6 @@ class EncounterConditionValueMap(TableBase): encounter_condition_value_id = Column(Integer, ForeignKey('encounter_condition_values.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description="The ID of the encounter condition value")) -class EncounterTerrain(TableBase): - u"""A way the player can enter a wild encounter, e.g., surfing, fishing, or walking through tall grass. - """ - - __tablename__ = 'encounter_terrain' - __singlename__ = __tablename__ - id = Column(Integer, primary_key=True, nullable=False, - info=dict(description="A unique ID for the terrain")) - identifier = Column(Unicode(64), nullable=False, - info=dict(description="An identifier", format='identifier')) - 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. @@ -373,6 +380,22 @@ class EncounterSlot(TableBase): rarity = Column(Integer, nullable=False, info=dict(description="The chance of the encounter as a percentage")) +class EncounterTerrain(TableBase): + u"""A way the player can enter a wild encounter, e.g., surfing, fishing, or walking through tall grass. + """ + + __tablename__ = 'encounter_terrain' + __singlename__ = __tablename__ + id = Column(Integer, primary_key=True, nullable=False, + info=dict(description="A unique ID for the terrain")) + identifier = Column(Unicode(64), nullable=False, + info=dict(description="An identifier", format='identifier')) + +create_translation_table('encounter_terrain_prose', EncounterTerrain, 'prose', + name = Column(Unicode(64), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), +) + class EvolutionChain(TableBase): u"""A family of Pokémon that are linked by evolution """ @@ -393,8 +416,11 @@ class EvolutionTrigger(TableBase): info=dict(description="A numeric ID")) 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)) + +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 @@ -420,8 +446,12 @@ class Generation(TableBase): info=dict(description=u"ID of the Pokédex this generation's main games use by default")) identifier = Column(Unicode(16), nullable=False, info=dict(description=u'An identifier', format='identifier')) - name = TextColumn(Unicode(16), nullable=False, index=True, plural='names', - info=dict(description="The name", format='plaintext', official=True)) + +create_translation_table('generation_names', Generation, 'names', + relation_lazy='joined', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) class GrowthRate(TableBase): u"""Growth rate of a Pokémon, i.e. the EXP → level function. @@ -434,8 +464,11 @@ class GrowthRate(TableBase): 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)) + +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". @@ -454,12 +487,6 @@ 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 = 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')) - name = TextColumn(Unicode(20), nullable=False, index=True, plural='names', - info=dict(description="The name", format='plaintext', official=True)) @property def appears_underground(self): @@ -467,6 +494,22 @@ class Item(TableBase): """ return any(flag.identifier == u'underground' for flag in self.flags) +create_translation_table('item_names', Item, 'names', + relation_lazy='joined', + name = Column(Unicode(20), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True, ripped=True)), +) +create_translation_table('item_prose', Item, 'prose', + short_effect = Column(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')), +) +create_translation_table('item_flavor_summaries', Item, 'flavor_summaries', + flavor_summary = Column(Unicode(512), nullable=True, + info=dict(description=u"Text containing facts from all flavor texts, for languages without official game translations", official=False, format='plaintext', ripped=True)), +) + class ItemCategory(TableBase): u"""An item category """ @@ -479,8 +522,12 @@ class ItemCategory(TableBase): info=dict(description="ID of the pocket these items go to")) 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)) + +create_translation_table('item_category_prose', ItemCategory, 'prose', + relation_lazy='joined', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), +) class ItemFlag(TableBase): u"""An item attribute such as "consumable" or "holdable". @@ -491,10 +538,13 @@ class ItemFlag(TableBase): 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')) - name = ProseColumn(Unicode(24), nullable=False, index=True, plural='names', - info=dict(description="The name", format='plaintext', official=False)) + +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. @@ -505,15 +555,18 @@ class ItemFlagMap(TableBase): item_flag_id = Column(Integer, ForeignKey('item_flags.id'), primary_key=True, autoincrement=False, nullable=False, info=dict(description="The ID of the item flag")) -class ItemFlavorText(TableBase, LanguageSpecific): +class ItemFlavorText(TableBase): u"""An in-game description of an item """ __tablename__ = 'item_flavor_text' __singlename__ = 'item_flavor_text' + summary_column = Item.flavor_summaries_table, 'flavor_summary' item_id = Column(Integer, ForeignKey('items.id'), primary_key=True, autoincrement=False, nullable=False, info=dict(description="The ID of the item")) version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, autoincrement=False, nullable=False, info=dict(description="ID of the version group that sports this text")) + language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, + info=dict(description="The language")) flavor_text = Column(Unicode(255), nullable=False, info=dict(description="The flavor text itself", official=True, format='gametext')) @@ -524,18 +577,21 @@ 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')) -class ItemInternalID(TableBase): +create_translation_table('item_fling_effect_prose', ItemFlingEffect, 'prose', + effect = Column(Unicode(255), nullable=False, + info=dict(description="Description of the effect", format='plaintext')), +) + +class ItemGameIndex(TableBase): u"""The internal ID number a game uses for an item """ - __tablename__ = 'item_internal_ids' + __tablename__ = 'item_game_indices' item_id = Column(Integer, ForeignKey('items.id'), primary_key=True, autoincrement=False, nullable=False, info=dict(description="The database ID of the item")) generation_id = Column(Integer, ForeignKey('generations.id'), primary_key=True, autoincrement=False, nullable=False, info=dict(description="ID of the generation of games")) - internal_id = Column(Integer, nullable=False, + game_index = Column(Integer, nullable=False, info=dict(description="Internal ID of the item in the generation")) class ItemPocket(TableBase): @@ -547,28 +603,12 @@ class ItemPocket(TableBase): info=dict(description="A numeric ID")) identifier = Column(Unicode(16), nullable=False, info=dict(description="An identifier of this pocket", format='identifier')) - 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 - """ - __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.")) - name = TextColumn(Unicode(16), nullable=False, index=True, plural='names', - info=dict(description="The name", format='plaintext', official=True)) +create_translation_table('item_pocket_names', ItemPocket, 'names', + relation_lazy='joined', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) class Location(TableBase): u"""A place in the Pokémon world @@ -581,8 +621,12 @@ class Location(TableBase): info=dict(description="ID of the region this location is in")) 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)) + +create_translation_table('location_names', Location, 'names', + relation_lazy='joined', + name = Column(Unicode(64), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) class LocationArea(TableBase): u"""A sub-area of a location @@ -593,12 +637,16 @@ class LocationArea(TableBase): info=dict(description="A numeric ID")) location_id = Column(Integer, ForeignKey('locations.id'), nullable=False, info=dict(description="ID of the location this area is part of")) - internal_id = Column(Integer, nullable=False, + game_index = Column(Integer, nullable=False, info=dict(description="ID the games ude for this area")) identifier = Column(Unicode(64), nullable=True, info=dict(description="An identifier", format='identifier')) - name = ProseColumn(Unicode(64), nullable=False, index=True, plural='names', - info=dict(description="The name", format='plaintext', official=False)) + +create_translation_table('location_area_prose', LocationArea, 'prose', + relation_lazy='joined', + name = Column(Unicode(64), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), +) class LocationAreaEncounterRate(TableBase): # XXX: What's this exactly? Someone add the docstring & revise the descriptions @@ -612,15 +660,15 @@ class LocationAreaEncounterRate(TableBase): rate = Column(Integer, nullable=True, info=dict(description="The encounter rate")) # units? -class LocationInternalID(TableBase): +class LocationGameIndex(TableBase): u"""IDs the games use internally for locations """ - __tablename__ = 'location_internal_ids' + __tablename__ = 'location_game_indices' location_id = Column(Integer, ForeignKey('locations.id'), nullable=False, primary_key=True, info=dict(description="Database ID of the locaion")) generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False, primary_key=True, info=dict(description="ID of the generation this entry to")) - internal_id = Column(Integer, nullable=False, + game_index = Column(Integer, nullable=False, info=dict(description="Internal game ID of the location")) class Machine(TableBase): @@ -642,6 +690,52 @@ class Machine(TableBase): """ return self.machine_number >= 100 +class Move(TableBase): + u"""A Move: technique or attack a Pokémon can learn to use + """ + __tablename__ = 'moves' + __singlename__ = 'move' + id = Column(Integer, primary_key=True, nullable=False, + info=dict(description="A numeric ID")) + identifier = Column(Unicode(24), nullable=False, + info=dict(description="An identifier", format='identifier')) + generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False, + info=dict(description="ID of the generation this move first appeared in")) + type_id = Column(Integer, ForeignKey('types.id'), nullable=False, + info=dict(description="ID of the move's elemental type")) + power = Column(SmallInteger, nullable=False, + info=dict(description="Base power of the move")) + pp = Column(SmallInteger, nullable=True, + info=dict(description="Base PP (Power Points) of the move, nullable if not applicable (e.g. Struggle and Shadow moves).")) + accuracy = Column(SmallInteger, nullable=True, + info=dict(description="Accuracy of the move; NULL means it never misses")) + priority = Column(SmallInteger, nullable=False, + info=dict(description="The move's priority bracket")) + target_id = Column(Integer, ForeignKey('move_targets.id'), nullable=False, + info=dict(description="ID of the target (range) of the move")) + damage_class_id = Column(Integer, ForeignKey('move_damage_classes.id'), nullable=False, + info=dict(description="ID of the damage class (physical/special) of the move")) + effect_id = Column(Integer, ForeignKey('move_effects.id'), nullable=False, + info=dict(description="ID of the move's effect")) + effect_chance = Column(Integer, nullable=True, + info=dict(description="The chance for a secondary effect. What this is a chance of is specified by the move's effect.")) + contest_type_id = Column(Integer, ForeignKey('contest_types.id'), nullable=True, + info=dict(description="ID of the move's Contest type (e.g. cool or smart)")) + contest_effect_id = Column(Integer, ForeignKey('contest_effects.id'), nullable=True, + info=dict(description="ID of the move's Contest effect")) + super_contest_effect_id = Column(Integer, ForeignKey('super_contest_effects.id'), nullable=True, + info=dict(description="ID of the move's Super Contest effect")) + +create_translation_table('move_names', Move, 'names', + relation_lazy='joined', + name = Column(Unicode(24), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True, ripped=True)) +) +create_translation_table('move_flavor_summaries', Move, 'flavor_summaries', + flavor_summary = Column(Unicode(512), nullable=True, + info=dict(description=u"Text containing facts from all flavor texts, for languages without official game translations", official=False, format='plaintext', ripped=True)), +) + class MoveBattleStyle(TableBase): u"""A battle style of a move""" # XXX: Explain better __tablename__ = 'move_battle_styles' @@ -650,8 +744,66 @@ class MoveBattleStyle(TableBase): info=dict(description="A numeric ID")) 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)) + +create_translation_table('move_battle_style_prose', MoveBattleStyle, 'prose', + relation_lazy='joined', + name = Column(Unicode(8), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), +) + +class MoveChangelog(TableBase): + """History of changes to moves across main game versions.""" + __tablename__ = 'move_changelog' + __singlename__ = 'move_changelog' + move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, + info=dict(description="ID of the move that changed")) + changed_in_version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, + info=dict(description="ID of the version group in which the move changed")) + type_id = Column(Integer, ForeignKey('types.id'), nullable=True, + info=dict(description="Prior type of the move, or NULL if unchanged")) + power = Column(SmallInteger, nullable=True, + info=dict(description="Prior base power of the move, or NULL if unchanged")) + pp = Column(SmallInteger, nullable=True, + info=dict(description="Prior base PP of the move, or NULL if unchanged")) + accuracy = Column(SmallInteger, nullable=True, + info=dict(description="Prior accuracy of the move, or NULL if unchanged")) + effect_id = Column(Integer, ForeignKey('move_effects.id'), nullable=True, + info=dict(description="Prior ID of the effect, or NULL if unchanged")) + effect_chance = Column(Integer, nullable=True, + info=dict(description="Prior effect chance, or NULL if unchanged")) + +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")) + identifier = Column(Unicode(16), nullable=False, + info=dict(description="An identifier", format='identifier')) + +create_translation_table('move_damage_class_prose', MoveDamageClass, 'prose', + relation_lazy='joined', + name = Column(Unicode(16), nullable=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 + """ + __tablename__ = 'move_effects' + __singlename__ = 'move_effect' + id = Column(Integer, primary_key=True, nullable=False, + info=dict(description="A numeric ID")) + +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 MoveEffectCategory(TableBase): u"""Category of a move effect @@ -664,8 +816,11 @@ class MoveEffectCategory(TableBase): 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)) + +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 @@ -678,32 +833,6 @@ class MoveEffectCategoryMap(TableBase): affects_user = Column(Boolean, primary_key=True, nullable=False, info=dict(description="Set if the user is affected")) -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")) - 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 = ProseColumn(Unicode(256), plural='short_effects', nullable=False, - info=dict(description="A short summary of the effect", format='plaintext')) - effect = ProseColumn(Unicode(5120), plural='effects', nullable=False, - info=dict(description="A detailed description of the effect", format='plaintext')) - class MoveEffectChangelog(TableBase): """History of changes to move effects across main game versions.""" __tablename__ = 'move_effect_changelog' @@ -714,14 +843,17 @@ class MoveEffectChangelog(TableBase): info=dict(description="The ID of the effect 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 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 """ @@ -742,19 +874,26 @@ class MoveFlagType(TableBase): 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')) - name = ProseColumn(Unicode(32), nullable=False, index=True, plural='names', - info=dict(description="The name", format='plaintext', official=False)) -class MoveFlavorText(TableBase, LanguageSpecific): +create_translation_table('move_flag_type_prose', MoveFlagType, 'prose', + relation_lazy='joined', + 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' + summary_column = Move.flavor_summaries_table, 'flavor_summary' move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description="ID of the move")) version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description="ID of the version group this text appears in")) + language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, + info=dict(description="The language")) flavor_text = Column(Unicode(255), nullable=False, info=dict(description="The flavor text", official=True, format='gametext')) @@ -794,12 +933,16 @@ class MoveMetaAilment(TableBase): """ __tablename__ = 'move_meta_ailments' __singlename__ = 'move_meta_ailment' - id = Column(Integer, primary_key=True, nullable=False, + id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) identifier = Column(Unicode(24), nullable=False, info=dict(description="An identifier", format='identifier')) - name = TextColumn(Unicode(24), nullable=False, index=True, plural='names', - info=dict(description="The name", format='plaintext', official=True)) + +create_translation_table('move_meta_ailment_names', MoveMetaAilment, 'names', + relation_lazy='joined', + name = Column(Unicode(24), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) class MoveMetaCategory(TableBase): u"""Very general categories that loosely group move effects.""" @@ -807,8 +950,12 @@ class MoveMetaCategory(TableBase): __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")) + +create_translation_table('move_meta_category_prose', MoveMetaCategory, 'prose', + relation_lazy='joined', + description = Column(Unicode(64), nullable=False, + info=dict(description="A description of the category", format="plaintext", official=False)), +) class MoveMetaStatChange(TableBase): u"""Stat changes moves (may) make.""" @@ -829,69 +976,14 @@ class MoveTarget(TableBase): 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')) - 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 - """ - __tablename__ = 'moves' - __singlename__ = 'move' - id = Column(Integer, primary_key=True, nullable=False, - info=dict(description="A numeric ID")) - identifier = Column(Unicode(24), nullable=False, - info=dict(description="An identifier", format='identifier')) - generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False, - info=dict(description="ID of the generation this move first appeared in")) - type_id = Column(Integer, ForeignKey('types.id'), nullable=False, - info=dict(description="ID of the move's elemental type")) - power = Column(SmallInteger, nullable=False, - info=dict(description="Base power of the move")) - pp = Column(SmallInteger, nullable=True, - info=dict(description="Base PP (Power Points) of the move, nullable if not applicable (e.g. Struggle and Shadow moves).")) - accuracy = Column(SmallInteger, nullable=True, - info=dict(description="Accuracy of the move; NULL means it never misses")) - priority = Column(SmallInteger, nullable=False, - info=dict(description="The move's priority bracket")) - target_id = Column(Integer, ForeignKey('move_targets.id'), nullable=False, - info=dict(description="ID of the target (range) of the move")) - damage_class_id = Column(Integer, ForeignKey('move_damage_classes.id'), nullable=False, - info=dict(description="ID of the damage class (physical/special) of the move")) - effect_id = Column(Integer, ForeignKey('move_effects.id'), nullable=False, - info=dict(description="ID of the move's effect")) - effect_chance = Column(Integer, nullable=True, - info=dict(description="The chance for a secondary effect. What this is a chance of is specified by the move's effect.")) - contest_type_id = Column(Integer, ForeignKey('contest_types.id'), nullable=True, - info=dict(description="ID of the move's Contest type (e.g. cool or smart)")) - contest_effect_id = Column(Integer, ForeignKey('contest_effects.id'), nullable=True, - info=dict(description="ID of the move's Contest effect")) - super_contest_effect_id = Column(Integer, ForeignKey('super_contest_effects.id'), nullable=True, - info=dict(description="ID of the move's Super Contest effect")) - 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, - info=dict(description="ID of the version group in which the move changed")) - type_id = Column(Integer, ForeignKey('types.id'), nullable=True, - info=dict(description="Prior type of the move, or NULL if unchanged")) - power = Column(SmallInteger, nullable=True, - info=dict(description="Prior base power of the move, or NULL if unchanged")) - pp = Column(SmallInteger, nullable=True, - info=dict(description="Prior base PP of the move, or NULL if unchanged")) - accuracy = Column(SmallInteger, nullable=True, - info=dict(description="Prior accuracy of the move, or NULL if unchanged")) - effect_id = Column(Integer, ForeignKey('move_effects.id'), nullable=True, - info=dict(description="Prior ID of the effect, or NULL if unchanged")) - effect_chance = Column(Integer, nullable=True, - info=dict(description="Prior effect chance, or NULL if unchanged")) +create_translation_table('move_target_prose', MoveTarget, 'prose', + relation_lazy='joined', + name = Column(Unicode(32), nullable=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 Nature(TableBase): u"""A nature a Pokémon can have, such as Calm or Brave @@ -910,8 +1002,6 @@ 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): @@ -920,6 +1010,12 @@ class Nature(TableBase): """ return self.increased_stat_id == self.decreased_stat_id +create_translation_table('nature_names', Nature, 'names', + relation_lazy='joined', + name = Column(Unicode(8), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True, ripped=True)), +) + class NatureBattleStylePreference(TableBase): u"""Battle Palace move preference @@ -956,8 +1052,11 @@ class PokeathlonStat(TableBase): info=dict(description="A numeric ID")) 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)) + +create_translation_table('pokeathlon_stat_names', PokeathlonStat, 'names', + name = Column(Unicode(8), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) class Pokedex(TableBase): u"""A collection of Pokémon species ordered in a particular way @@ -970,10 +1069,14 @@ class Pokedex(TableBase): 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')) - name = ProseColumn(Unicode(16), nullable=False, index=True, plural='names', - info=dict(description="The name", format='plaintext', official=False)) + +create_translation_table('pokedex_prose', Pokedex, 'prose', + relation_lazy='joined', + 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. @@ -992,12 +1095,9 @@ 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 = TextColumn(Unicode(16), nullable=False, plural='species_names', - info=dict(description=u'The short flavor text, such as "Seed" or "Lizard"; usually affixed with the word "Pokémon"', - official=True, format='plaintext')) color_id = Column(Integer, ForeignKey('pokemon_colors.id'), nullable=False, info=dict(description=u"ID of this Pokémon's Pokédex color, as used for a gimmick search function in the games.")) - pokemon_shape_id = Column(Integer, ForeignKey('pokemon_shapes.id'), nullable=True, + pokemon_shape_id = Column(Integer, ForeignKey('pokemon_shapes.id'), nullable=False, info=dict(description=u"ID of this Pokémon's body shape, as used for a gimmick search function in the games.")) habitat_id = Column(Integer, ForeignKey('pokemon_habitats.id'), nullable=True, info=dict(description=u"ID of this Pokémon's habitat, as used for a gimmick search function in the games.")) @@ -1017,8 +1117,6 @@ 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 @@ -1102,6 +1200,19 @@ class Pokemon(TableBase): else: return None +create_translation_table('pokemon_names', Pokemon, 'names', + relation_lazy='joined', + name = Column(Unicode(20), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True, ripped=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')), +) +create_translation_table('pokemon_flavor_summaries', Pokemon, 'flavor_summaries', + flavor_summary = Column(Unicode(512), nullable=True, + info=dict(description=u"Text containing facts from all flavor texts, for languages without official game translations", official=False, format='plaintext', ripped=True)), +) + class PokemonAbility(TableBase): u"""Maps an ability to a Pokémon that can have it """ @@ -1127,8 +1238,12 @@ class PokemonColor(TableBase): info=dict(description=u"ID of the Pokémon")) 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)) + +create_translation_table('pokemon_color_names', PokemonColor, 'names', + relation_lazy='joined', + name = Column(Unicode(6), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) class PokemonDexNumber(TableBase): u"""The number of a Pokémon in a particular Pokédex (e.g. Jigglypuff is #138 in Hoenn's 'dex) @@ -1188,16 +1303,19 @@ class PokemonEvolution(TableBase): trade_pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=True, info=dict(description=u"The ID of the Pokémon for which this Pokémon must be traded.")) -class PokemonFlavorText(TableBase, LanguageSpecific): +class PokemonFlavorText(TableBase): u"""In-game Pokédex descrption of a Pokémon. """ __tablename__ = 'pokemon_flavor_text' + summary_column = Pokemon.flavor_summaries_table, 'flavor_summary' pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description=u"ID of the Pokémon")) version_id = Column(Integer, ForeignKey('versions.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description=u"ID of the version that has this flavor text")) + language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, + info=dict(description="The language")) flavor_text = Column(Unicode(255), nullable=False, - info=dict(description=u"ID of the version that has this flavor text", official=True, format='gametext')) + info=dict(description=u"The flavor text", official=True, format='gametext')) class PokemonForm(TableBase): u"""An individual form of a Pokémon. @@ -1221,8 +1339,6 @@ 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): @@ -1253,20 +1369,30 @@ class PokemonForm(TableBase): else: return self.form_base_pokemon.name +create_translation_table('pokemon_form_names', PokemonForm, 'names', + relation_lazy='joined', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) + class PokemonFormGroup(TableBase): u"""Information about a Pokémon's forms as a group.""" __tablename__ = 'pokemon_form_groups' __singlename__ = 'pokemon_form_group' pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description=u"ID of the base form Pokémon")) - term = ProseColumn(Unicode(16), plural='terms', nullable=True, - info=dict(description=u"The term for this Pokémon's forms, e.g. \"Cloak\" for Burmy or \"Forme\" for Deoxys.", official=True, format='plaintext')) is_battle_only = Column(Boolean, nullable=False, info=dict(description=u"Set iff the forms only change in battle")) - description = ProseColumn(markdown.MarkdownColumn(1024), plural='descriptions', nullable=False, - info=dict(description=u"Description of how the forms work", format='markdown')) +# FIXME remooove PokemonFormGroup.id = PokemonFormGroup.pokemon_id +create_translation_table('pokemon_form_group_prose', PokemonFormGroup, 'prose', + term = Column(Unicode(16), nullable=True, + info=dict(description=u"The term for this Pokémon's forms, e.g. \"Cloak\" for Burmy or \"Forme\" for Deoxys.", official=True, format='plaintext')), + description = Column(markdown.MarkdownColumn(1024), nullable=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' @@ -1281,6 +1407,17 @@ 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 PokemonGameIndex(TableBase): + u"""The number of a Pokémon a game uses internally + """ + __tablename__ = 'pokemon_game_indices' + pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, autoincrement=False, nullable=False, + info=dict(description=u"Database ID of the Pokémon")) + generation_id = Column(Integer, ForeignKey('generations.id'), primary_key=True, autoincrement=False, nullable=False, + info=dict(description=u"Database ID of the generation")) + game_index = Column(Integer, nullable=False, + info=dict(description=u"Internal ID the generation's games use for the Pokémon")) + class PokemonHabitat(TableBase): u"""The habitat of a Pokémon, as given in the FireRed/LeafGreen version Pokédex """ @@ -1290,19 +1427,12 @@ class PokemonHabitat(TableBase): info=dict(description=u"A numeric ID")) 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 - """ - __tablename__ = 'pokemon_internal_ids' - pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, autoincrement=False, nullable=False, - info=dict(description=u"Database ID of the Pokémon")) - generation_id = Column(Integer, ForeignKey('generations.id'), primary_key=True, autoincrement=False, nullable=False, - info=dict(description=u"Database ID of the generation")) - internal_id = Column(Integer, nullable=False, - info=dict(description=u"Internal ID the generation's games use for the Pokémon")) +create_translation_table('pokemon_habitat_names', PokemonHabitat, 'names', + relation_lazy='joined', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) class PokemonItem(TableBase): u"""Record of an item a Pokémon can hold in the wild @@ -1348,10 +1478,14 @@ class PokemonMoveMethod(TableBase): 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')) - name = ProseColumn(Unicode(64), nullable=False, index=True, plural='names', - info=dict(description="The name", format='plaintext', official=False)) + +create_translation_table('pokemon_move_method_prose', PokemonMoveMethod, 'prose', + relation_lazy='joined', + 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. @@ -1362,10 +1496,14 @@ class PokemonShape(TableBase): 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')) - name = ProseColumn(Unicode(24), nullable=False, index=True, plural='names', - info=dict(description="The name", format='plaintext', official=False)) + +create_translation_table('pokemon_shape_prose', PokemonShape, 'prose', + relation_lazy='joined', + 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 @@ -1400,8 +1538,12 @@ class Region(TableBase): info=dict(description=u"A numeric ID")) 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)) + +create_translation_table('region_names', Region, 'names', + relation_lazy='joined', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) class Stat(TableBase): u"""A Stat, such as Attack or Speed @@ -1414,8 +1556,14 @@ class Stat(TableBase): info=dict(description=u"For offensive and defensive stats, the damage this stat relates to; otherwise None (the NULL value)")) identifier = Column(Unicode(16), nullable=False, info=dict(description=u"An identifier", format='identifier')) - name = TextColumn(Unicode(16), nullable=False, index=True, plural='names', - info=dict(description="The name", format='plaintext', official=True)) + is_battle_only = Column(Boolean, nullable=False, + info=dict(description=u"Whether this stat only exists within a battle")) + +create_translation_table('stat_names', Stat, 'names', + relation_lazy='joined', + name = Column(Unicode(16), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) class StatHint(TableBase): u"""Flavor text for genes that appears in a Pokémon's summary. Sometimes @@ -1429,8 +1577,12 @@ class StatHint(TableBase): 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')) + +create_translation_table('stat_hint_names', StatHint, 'names', + relation_lazy='joined', + message = Column(Unicode(24), nullable=False, index=True, + info=dict(description=u"The text displayed", official=True, format='plaintext')), +) class SuperContestCombo(TableBase): u"""Combo of two moves in a Super Contest. @@ -1450,20 +1602,11 @@ 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')) -class TypeEfficacy(TableBase): - u"""The damage multiplier used when a move of a particular type damages a - Pokémon of a particular other type. - """ - __tablename__ = 'type_efficacy' - damage_type_id = Column(Integer, ForeignKey('types.id'), primary_key=True, nullable=False, autoincrement=False, - info=dict(description=u"The ID of the damaging type.")) - target_type_id = Column(Integer, ForeignKey('types.id'), primary_key=True, nullable=False, autoincrement=False, - info=dict(description=u"The ID of the defending Pokémon's type.")) - damage_factor = Column(Integer, nullable=False, - info=dict(description=u"The multiplier, as a percentage of damage inflicted.")) +create_translation_table('super_contest_effect_prose', SuperContestEffect, 'prose', + flavor_text = Column(Unicode(64), nullable=False, + info=dict(description=u"A description of the effect.", format='plaintext', official=True)), +) class Type(TableBase): u"""Any of the elemental types Pokémon and moves can have.""" @@ -1477,8 +1620,41 @@ class Type(TableBase): 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. ???).")) - name = TextColumn(Unicode(12), nullable=False, index=True, plural='names', - info=dict(description="The name", format='plaintext', official=True)) + +create_translation_table('type_names', Type, 'names', + relation_lazy='joined', + name = Column(Unicode(12), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) + +class TypeEfficacy(TableBase): + u"""The damage multiplier used when a move of a particular type damages a + Pokémon of a particular other type. + """ + __tablename__ = 'type_efficacy' + damage_type_id = Column(Integer, ForeignKey('types.id'), primary_key=True, nullable=False, autoincrement=False, + info=dict(description=u"The ID of the damaging type.")) + target_type_id = Column(Integer, ForeignKey('types.id'), primary_key=True, nullable=False, autoincrement=False, + info=dict(description=u"The ID of the defending Pokémon's type.")) + damage_factor = Column(Integer, nullable=False, + info=dict(description=u"The multiplier, as a percentage of damage inflicted.")) + +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.")) + identifier = Column(Unicode(32), nullable=False, + info=dict(description=u'And identifier', format='identifier')) + +create_translation_table('version_names', Version, 'names', + relation_lazy='joined', + name = Column(Unicode(32), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=True)), +) class VersionGroup(TableBase): u"""A group of versions, containing either two paired versions (such as Red @@ -1500,20 +1676,6 @@ 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): - u"""An individual main-series Pokémon game.""" - __tablename__ = 'versions' - __singlename__ = 'version' - id = Column(Integer, primary_key=True, nullable=False, - info=dict(description=u"A unique ID for this version.")) - version_group_id = Column(Integer, ForeignKey('version_groups.id'), nullable=False, - info=dict(description=u"The ID of the version group this game belongs to.")) - identifier = Column(Unicode(32), nullable=False, - info=dict(description=u'And identifier', format='identifier')) - 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 Ability.changelog = relation(AbilityChangelog, order_by=AbilityChangelog.changed_in_version_group_id.desc(), @@ -1521,33 +1683,11 @@ Ability.changelog = relation(AbilityChangelog, ) Ability.flavor_text = relation(AbilityFlavorText, order_by=AbilityFlavorText.version_group_id, backref='ability') Ability.generation = relation(Generation, backref='abilities') -Ability.all_pokemon = relation(Pokemon, - secondary=PokemonAbility.__table__, - order_by=Pokemon.order, - back_populates='all_abilities', -) -Ability.pokemon = relation(Pokemon, - secondary=PokemonAbility.__table__, - primaryjoin=and_( - PokemonAbility.ability_id == Ability.id, - PokemonAbility.is_dream == False - ), - order_by=Pokemon.order, - back_populates='abilities', -) -Ability.dream_pokemon = relation(Pokemon, - secondary=PokemonAbility.__table__, - primaryjoin=and_( - PokemonAbility.ability_id == Ability.id, - PokemonAbility.is_dream == True - ), - order_by=Pokemon.order, - back_populates='dream_ability', -) AbilityChangelog.changed_in = relation(VersionGroup, backref='ability_changelog') AbilityFlavorText.version_group = relation(VersionGroup) +AbilityFlavorText.language = relation(Language) Berry.berry_firmness = relation(BerryFirmness, backref='berries') Berry.firmness = association_proxy('berry_firmness', 'name') @@ -1578,7 +1718,6 @@ 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') Experience.growth_rate = relation(GrowthRate, backref='experience_table') @@ -1601,9 +1740,10 @@ 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) +ItemGameIndex.item = relation(Item, backref='game_indices') +ItemGameIndex.generation = relation(Generation) ItemPocket.categories = relation(ItemCategory, order_by=ItemCategory.identifier) @@ -1611,8 +1751,8 @@ Location.region = relation(Region, backref='locations') LocationArea.location = relation(Location, backref='areas') -LocationInternalID.location = relation(Location, backref='internal_ids') -LocationInternalID.generation = relation(Generation) +LocationGameIndex.location = relation(Location, backref='game_indices') +LocationGameIndex.generation = relation(Generation) Machine.item = relation(Item) Machine.version_group = relation(VersionGroup) @@ -1638,12 +1778,22 @@ 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.type = relation(Type, backref='moves') + +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.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.effect_map = markdown.MoveEffectProperty('effect_map') +MoveChangelog.short_effect = markdown.MoveEffectProperty('short_effect') +MoveChangelog.short_effect_map = markdown.MoveEffectProperty('short_effect_map') + MoveEffect.category_map = relation(MoveEffectCategoryMap) MoveEffect.categories = association_proxy('category_map', 'category') MoveEffect.changelog = relation(MoveEffectChangelog, @@ -1657,6 +1807,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') @@ -1681,11 +1832,14 @@ 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, backref='pokedex') Pokemon.all_abilities = relation(Ability, secondary=PokemonAbility.__table__, order_by=PokemonAbility.slot, + backref=backref('all_pokemon', + order_by=Pokemon.order, + ), ) Pokemon.abilities = relation(Ability, secondary=PokemonAbility.__table__, @@ -1694,6 +1848,9 @@ Pokemon.abilities = relation(Ability, PokemonAbility.is_dream == False, ), order_by=PokemonAbility.slot, + backref=backref('pokemon', + order_by=Pokemon.order, + ), ) Pokemon.dream_ability = relation(Ability, secondary=PokemonAbility.__table__, @@ -1702,6 +1859,9 @@ Pokemon.dream_ability = relation(Ability, PokemonAbility.is_dream == True, ), uselist=False, + backref=backref('dream_pokemon', + order_by=Pokemon.order, + ), ) Pokemon.pokemon_color = relation(PokemonColor, backref='pokemon') Pokemon.color = association_proxy('pokemon_color', 'name') @@ -1709,7 +1869,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, backref=backref('pokemon', order_by=Pokemon.order)) Pokemon.child_pokemon = relation(Pokemon, primaryjoin=Pokemon.id==PokemonEvolution.from_pokemon_id, secondary=PokemonEvolution.__table__, @@ -1729,9 +1889,11 @@ Pokemon.items = relation(PokemonItem, backref='pokemon') Pokemon.generation = relation(Generation, backref='pokemon') Pokemon.shape = relation(PokemonShape, backref='pokemon') Pokemon.stats = relation(PokemonStat, backref='pokemon', order_by=PokemonStat.stat_id.asc()) -Pokemon.types = relation(Type, secondary=PokemonType.__table__, - order_by=PokemonType.slot.asc(), - back_populates='pokemon') +Pokemon.types = relation(Type, + secondary=PokemonType.__table__, + order_by=PokemonType.slot.asc(), + backref=backref('pokemon', order_by=Pokemon.order), +) PokemonDexNumber.pokedex = relation(Pokedex) @@ -1771,6 +1933,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), @@ -1827,295 +1990,10 @@ Type.target_efficacies = relation(TypeEfficacy, Type.generation = relation(Generation, backref='types') Type.damage_class = relation(MoveDamageClass, backref='types') -Type.pokemon = relation(Pokemon, secondary=PokemonType.__table__, - order_by=Pokemon.order, - back_populates='types') -Type.moves = relation(Move, back_populates='type', order_by=Move.id) -Version.version_group = relation(VersionGroup, back_populates='versions') Version.generation = association_proxy('version_group', 'generation') -VersionGroup.versions = relation(Version, order_by=Version.id, back_populates='version_group') +VersionGroup.versions = relation(Version, order_by=Version.id, backref='version_group') 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')