- 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 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 import (
+ backref, eagerload_all, relation, class_mapper, synonym, mapper,
+ )
+from sqlalchemy.orm.session import Session, object_session
from sqlalchemy.orm.collections import attribute_mapped_collection
+from sqlalchemy.ext.associationproxy import association_proxy
from sqlalchemy.sql import and_
+from sqlalchemy.sql.expression import ColumnOperators
+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)
+
metadata = MetaData()
-TableBase = declarative_base(metadata=metadata)
+TableBase = declarative_base(metadata=metadata, metaclass=TableMetaclass)
### Helper classes
+# XXX this stuff isn't covered anywhere; maybe put it in TableBase??
class Named(object):
"""Mixin for objects that have names"""
def __unicode__(self):
def __repr__(self):
return str(self)
-class OfficiallyNamed(Named):
- """Mixin for stuff with official names"""
-
-class UnofficiallyNamed(Named):
- """Mixin for stuff with unofficial names"""
-
class LanguageSpecific(object):
"""Mixin for prose and text tables"""
@declared_attr
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)
### 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'
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))
class AbilityChangelog(TableBase):
"""History of changes to abilities across main game versions."""
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'
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))
class BerryFlavor(TableBase):
u"""A Berry flavor level.
effect = ProseColumn(Unicode(255), plural='effects', nullable=False,
info=dict(description="A detailed description of the effect", format='plaintext'))
-class ContestType(TableBase, OfficiallyNamed):
+class ContestType(TableBase):
u"""A Contest type, such as "cool" or "smart", and their associated Berry flavors and Pokéblock colors.
"""
__tablename__ = 'contest_types'
info=dict(description="The name of the corresponding Berry flavor", official=True, format='plaintext'))
color = TextColumn(Unicode(6), nullable=False, plural='colors',
info=dict(description=u"The name of the corresponding Pokéblock color", official=True, format='plaintext'))
+ name = TextColumn(Unicode(6), nullable=False, index=True, plural='names',
+ info=dict(description="The name", format='plaintext', official=True))
-class EggGroup(TableBase, UnofficiallyNamed):
+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)
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))
class Encounter(TableBase):
u"""Encounters with wild Pokémon.
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.
"""
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))
-class EncounterConditionValue(TableBase, UnofficiallyNamed):
+class EncounterConditionValue(TableBase):
u"""A possible state for a condition; for example, the state of 'swarm' could be 'swarm' or 'no swarm'.
"""
info=dict(description="An identifier", format='identifier'))
is_default = Column(Boolean, nullable=False,
info=dict(description='Set if this value is the default state for the condition'))
+ name = ProseColumn(Unicode(64), nullable=False, index=True, plural='names',
+ info=dict(description="The name", format='plaintext', official=False))
class EncounterConditionValueMap(TableBase):
u"""Maps encounters to the specific conditions under which they occur.
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.
"""
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.
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'
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))
class Experience(TableBase):
u"""EXP needed for a certain level with a certain growth rate
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'
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))
-class GrowthRate(TableBase, UnofficiallyNamed):
+class GrowthRate(TableBase):
u"""Growth rate of a Pokémon, i.e. the EXP → level function.
"""
__tablename__ = 'growth_rates'
info=dict(description="An identifier", format='identifier'))
formula = Column(Unicode(500), nullable=False,
info=dict(description="The formula", format='latex'))
+ name = ProseColumn(Unicode(20), nullable=False, index=True, plural='names',
+ info=dict(description="The name", format='plaintext', official=False))
-class Item(TableBase, OfficiallyNamed):
+class Item(TableBase):
u"""An Item from the games, like "Poké Ball" or "Bicycle".
"""
__tablename__ = 'items'
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):
"""
return any(flag.identifier == u'underground' for flag in self.flags)
-class ItemCategory(TableBase, UnofficiallyNamed):
+class ItemCategory(TableBase):
u"""An item category
"""
# XXX: This is fanon, right?
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))
-class ItemFlag(TableBase, UnofficiallyNamed):
+class ItemFlag(TableBase):
u"""An item attribute such as "consumable" or "holdable".
"""
__tablename__ = 'item_flags'
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))
class ItemFlagMap(TableBase):
u"""Maps an item flag to its item.
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'
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, OfficiallyNamed):
+class Language(TableBase):
u"""A language the Pokémon games have been transleted into
"""
__tablename__ = 'languages'
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))
# Languages compare equal to its identifier, so a dictionary of
# translations, with a Language as the key, can be indexed by the identifier
def __hash__(self):
return hash(self.identifier)
-class Location(TableBase, OfficiallyNamed):
+class Location(TableBase):
u"""A place in the Pokémon world
"""
__tablename__ = 'locations'
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))
-class LocationArea(TableBase, UnofficiallyNamed):
+class LocationArea(TableBase):
u"""A sub-area of a location
"""
__tablename__ = 'location_areas'
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))
class LocationAreaEncounterRate(TableBase):
# XXX: What's this exactly? Someone add the docstring & revise the descriptions
"""
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'
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))
-class MoveEffectCategory(TableBase, UnofficiallyNamed):
+class MoveEffectCategory(TableBase):
u"""Category of a move effect
"""
__tablename__ = 'move_effect_categories'
info=dict(description="An identifier", format='identifier'))
can_affect_user = Column(Boolean, nullable=False,
info=dict(description="Set if the user can be affected"))
+ name = ProseColumn(Unicode(64), nullable=False, index=True, plural='names',
+ info=dict(description="The name", format='plaintext', official=False))
class MoveEffectCategoryMap(TableBase):
u"""Maps a move effect category to a move effect
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'
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
__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),
+ {},
+ )
+
class MoveFlag(TableBase):
u"""Maps a move flag to a move
"""
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'
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):
u"""In-game description of a move
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'))
+ name = TextColumn(Unicode(24), nullable=False, index=True, plural='names',
+ info=dict(description="The name", format='plaintext', official=True))
class MoveMetaCategory(TableBase):
u"""Very general categories that loosely group move effects."""
__tablename__ = 'move_meta_categories'
__singlename__ = 'move_meta_category'
- id = Column(Integer, primary_key=True, nullable=False)
- description = ProseColumn(Unicode(64), plural='descriptions', nullable=False)
+ id = Column(Integer, primary_key=True, nullable=False,
+ info=dict(description="A numeric ID"))
+ description = ProseColumn(Unicode(64), plural='descriptions', nullable=False,
+ info=dict(description="A description of the category"))
class MoveMetaStatChange(TableBase):
u"""Stat changes moves (may) make."""
__tablename__ = 'move_meta_stat_changes'
- move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False)
- 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'
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, OfficiallyNamed):
+class Move(TableBase):
u"""A Move: technique or attack a Pokémon can learn to use
"""
__tablename__ = 'moves'
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."""
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'
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):
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'
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))
-class Pokedex(TableBase, UnofficiallyNamed):
+class Pokedex(TableBase):
u"""A collection of Pokémon species ordered in a particular way
"""
__tablename__ = 'pokedexes'
info=dict(description=u"An identifier", format='identifier'))
description = ProseColumn(Unicode(512), plural='descriptions', nullable=False,
info=dict(description=u"A longer description of the Pokédex", format='plaintext'))
+ name = ProseColumn(Unicode(16), nullable=False, index=True, plural='names',
+ info=dict(description="The name", format='plaintext', official=False))
-class Pokemon(TableBase, OfficiallyNamed):
+class Pokemon(TableBase):
u"""A species of Pokémon. The core to this whole mess.
"""
__tablename__ = 'pokemon'
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
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'
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))
class PokemonDexNumber(TableBase):
u"""The number of a Pokémon in a particular Pokédex (e.g. Jigglypuff is #138 in Hoenn's 'dex)
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
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):
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'
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
{},
)
-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'
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))
-class PokemonShape(TableBase, UnofficiallyNamed):
+class PokemonShape(TableBase):
u"""The shape of a Pokémon's body, as used in generation IV Pokédexes.
"""
__tablename__ = 'pokemon_shapes'
info=dict(description=u"An identifier", format='identifier'))
awesome_name = ProseColumn(Unicode(16), plural='awesome_names', nullable=False,
info=dict(description=u"A splendiferous name of the body shape", format='plaintext'))
+ name = ProseColumn(Unicode(24), nullable=False, index=True, plural='names',
+ info=dict(description="The name", format='plaintext', official=False))
class PokemonStat(TableBase):
u"""A stat value of a Pokémon
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'
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 Stat(TableBase, OfficiallyNamed):
+class Stat(TableBase):
u"""A Stat, such as Attack or Speed
"""
__tablename__ = 'stats'
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))
class StatHint(TableBase):
u"""Flavor text for genes that appears in a Pokémon's summary. Sometimes
"""
__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"))
+ message = TextColumn(Unicode(24), plural='messages', nullable=False, index=True, unique=True,
+ info=dict(description=u"The text displayed", official=True, format='plaintext'))
class SuperContestCombo(TableBase):
u"""Combo of two moves in a Super Contest.
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. ???)."))
+ name = TextColumn(Unicode(12), nullable=False, index=True, plural='names',
+ info=dict(description="The name", format='plaintext', official=True))
class VersionGroup(TableBase):
u"""A group of versions, containing either two paired versions (such as Red
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'
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
Move.target = relation(MoveTarget, backref='moves')
Move.type = relation(Type, back_populates='moves')
-
MoveChangelog.changed_in = relation(VersionGroup, backref='move_changelog')
MoveChangelog.move_effect = relation(MoveEffect, backref='move_changelog')
MoveChangelog.type = relation(Type, backref='move_changelog')
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
+default_lang = u'en'
+
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)
+ tablename = object_table.__singlename__ + '_' + name_plural
+ singlename = object_table.__singlename__ + '_' + name_singular
+
+ class Strings(object):
+ __tablename__ = tablename
+ __singlename__ = singlename
+ _attrname = name_plural
+ _language_identifier = association_proxy('language', 'identifier')
+
+ for name, plural, column in columns:
+ column.name = 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(tablename, metadata,
+ Column(safe_name + '_id', Integer, ForeignKey(object_table.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)
+ )
- # Alias the described thing to 'object', to make meta stuff easier
- Strings.object_id = getattr(Strings, safe_name + '_id')
+ mapper(Strings, table,
+ properties={
+ "object_id": synonym(safe_name + '_id'),
+ "language": relation(
+ Language,
+ primaryjoin=table.c.language_id == Language.id,
+ ),
+ },
+ )
# The relation to the object
- setattr(table, name_plural, relation(
+ setattr(object_table, name_plural, relation(
Strings,
- primaryjoin=(table.id == Strings.object_id),
+ primaryjoin=(object_table.id == Strings.object_id),
backref=safe_name,
collection_class=attribute_mapped_collection('language'),
lazy=lazy,
))
-
+ str(getattr(object_table, name_plural)) # [MORE MAGIC]. aka do not remove, or entire app fails. XXX what the fuck man
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,
- )
+ # Link the tables themselves, so we can get them if needed
+ Strings.object_table = object_table
+ setattr(object_table, name_singular + '_table', Strings)
for colname, pluralname, column in columns:
- # Provide a relation with all the names, and an English accessor
+ # Provide a property 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)
+ setattr(object_table, pluralname, StringProperty(
+ object_table, Strings, colname,
+ ))
+ setattr(object_table, colname, DefaultLangProperty(pluralname))
if colname == 'name':
- table.name_table = Strings
+ object_table.name_table = Strings
return Strings
-for table in all_tables():
- text_columns = []
- prose_columns = []
+class StringProperty(object):
+ def __init__(self, cls, stringclass, colname):
+ self.cls = cls
+ self.colname = colname
+ self.stringclass = stringclass
+
+ def __get__(self, instance, cls):
+ if instance:
+ return StringMapping(instance, self)
+ else:
+ return self
+
+ def __getitem__(self, lang):
+ return StringExpression(self, lang)
+
+ def __str__(self):
+ return '<StringDict %s.%s>' % (self.cls, self.colname)
+
+class StringMapping(collections.MutableMapping):
+ def __init__(self, instance, prop):
+ self.stringclass = prop.stringclass
+ self.instance = instance
+ self.strings = getattr(instance, prop.stringclass._attrname)
+ self.colname = prop.colname
+
+ def __len__(self):
+ return len(self.strings)
+
+ def __iter__(self):
+ return iter(self.strings)
+
+ def __contains__(self, lang):
+ return lang in self.strings
+
+ def __getitem__(self, lang):
+ return getattr(self.strings[lang], self.colname)
+
+ def __setitem__(self, lang, value):
+ try:
+ # Modifying an existing row
+ row = self.strings[lang]
+ except KeyError:
+ # We need do add a whole row for the language
+ row = self.stringclass()
+ row.object_id = self.instance.id
+ session = object_session(self.instance)
+ if isinstance(lang, basestring):
+ lang = session.query(Language).filter_by(
+ identifier=lang).one()
+ row.language = lang
+ self.strings[lang] = row
+ session.add(row)
+ return setattr(row, self.colname, value)
+
+ def __delitem__(self, lang):
+ raise NotImplementedError('Cannot delete a single string. '
+ 'Perhaps you wan to delete all of %s.%s?' %
+ (self.instance, self.stringclass._attrname)
+ )
+
+class StringExpression(ColumnOperators):
+ def __init__(self, prop, lang):
+ self.prop = prop
+ self.column = getattr(prop.stringclass, prop.colname)
+ self.lang_column = prop.stringclass._language_identifier
+ if isinstance(lang, basestring):
+ self.lang = lang
+ else:
+ self.lang = lang.identifier
+
+ def operate(self, op, *values, **kwargs):
+ return getattr(self.prop.cls, self.prop.stringclass._attrname).any(and_(
+ self.lang_column == self.lang,
+ op(self.column, *values, **kwargs),
+ ))
+
+class DefaultLangProperty(object):
+ def __init__(self, colname):
+ self.colname = colname
+
+ def __get__(self, instance, cls):
+ if instance:
+ return getattr(instance, self.colname)[default_lang]
+ else:
+ return getattr(cls, self.colname)[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((colname, column.plural, column.makeSAColumn()))
+ text_columns.append(spec)
elif isinstance(column, ProseColumn):
- prose_columns.append((colname, column.plural, column.makeSAColumn()))
+ 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)
- 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():
+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')
projects / zzz-pokedex.git / blobdiff