- 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
class Named(object):
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)
__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
"""
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)
+ 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, OfficiallyNamed):
u"""Common status ailments moves can inflict on a single Pokémon, including
"""
__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'))
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):
u"""Targetting or "range" of a move, e.g. "Affects all opponents" or "Affects user".
"""
__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.
__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."))
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():
+for table in list(table_classes):
if issubclass(table, OfficiallyNamed):
cls = TextColumn
info=dict(description="The name", format='plaintext', official=True)
else:
continue
table.name = cls(Unicode(class_mapper(table).c.identifier.type.length),
- plural='names', nullable=False, info=info)
+ plural='names', index=True, 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,
))
-
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))
+ 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