X-Git-Url: http://git.veekun.com/zzz-pokedex.git/blobdiff_plain/4a7ad7baa2578ab157b4344ee387d77fbeccb187..095fdd7d58c012cbe6345d369d00c26b8159e935:/pokedex/db/tables.py diff --git a/pokedex/db/tables.py b/pokedex/db/tables.py index 8e4ca42..9553349 100644 --- a/pokedex/db/tables.py +++ b/pokedex/db/tables.py @@ -32,7 +32,7 @@ from sqlalchemy.ext.associationproxy import association_proxy from sqlalchemy.orm import backref, relation from sqlalchemy.orm.session import Session from sqlalchemy.orm.interfaces import AttributeExtension -from sqlalchemy.sql import and_ +from sqlalchemy.sql import and_, or_ from sqlalchemy.schema import ColumnDefault from sqlalchemy.types import * @@ -62,6 +62,9 @@ class TableSuperclass(object): def __str__(self): return unicode(self).encode('utf8') + def __repr__(self): + return unicode(self).encode('utf8') + mapped_classes = [] class TableMetaclass(DeclarativeMeta): def __init__(cls, name, bases, attrs): @@ -121,9 +124,9 @@ create_translation_table('ability_names', Ability, 'names', 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, + effect = Column(markdown.MarkdownColumn(5120), nullable=True, info=dict(description="A detailed description of this ability's effect", format='markdown')), - short_effect = Column(markdown.MarkdownColumn(255), nullable=False, + short_effect = Column(markdown.MarkdownColumn(512), nullable=True, info=dict(description="A short summary of this ability's effect", format='markdown')), ) @@ -232,9 +235,9 @@ class ContestEffect(TableBase): info=dict(description="The base number of hearts the user's opponent loses")) create_translation_table('contest_effect_prose', ContestEffect, 'prose', - flavor_text = Column(Unicode(64), nullable=False, + flavor_text = Column(Unicode(64), nullable=True, info=dict(description="The in-game description of this effect", official=True, format='gametext')), - effect = Column(Unicode(255), nullable=False, + effect = Column(Unicode(255), nullable=True, info=dict(description="A detailed description of the effect", format='plaintext')), ) @@ -250,11 +253,11 @@ class ContestType(TableBase): create_translation_table('contest_type_names', ContestType, 'names', relation_lazy='joined', - name = Column(Unicode(6), nullable=False, index=True, + name = Column(Unicode(6), nullable=True, index=True, info=dict(description="The name", format='plaintext', official=True)), - flavor = Column(Unicode(6), nullable=False, + flavor = Column(Unicode(6), nullable=True, info=dict(description="The name of the corresponding Berry flavor", official=True, format='plaintext')), - color = Column(Unicode(6), nullable=False, + color = Column(Unicode(6), nullable=True, info=dict(description=u"The name of the corresponding Pokéblock color", official=True, format='plaintext')), ) @@ -285,10 +288,10 @@ class Encounter(TableBase): "slot" they are in and the state of the game world. What the player is doing to get an encounter, such as surfing or walking - through tall grass, is called terrain. Each terrain has its own set of + through tall grass, is called a method. Each method has its own set of encounter slots. - Within a terrain, slots are defined primarily by rarity. Each slot can + Within a method, slots are defined primarily by rarity. Each slot can also be affected by world conditions; for example, the 20% slot for walking in tall grass is affected by whether a swarm is in effect in that area. "Is there a swarm?" is a condition; "there is a swarm" and "there is not a @@ -308,7 +311,7 @@ class Encounter(TableBase): location_area_id = Column(Integer, ForeignKey('location_areas.id'), nullable=False, autoincrement=False, info=dict(description="The ID of the location of this encounter")) encounter_slot_id = Column(Integer, ForeignKey('encounter_slots.id'), nullable=False, autoincrement=False, - info=dict(description="The ID of the encounter slot, which determines terrain and rarity")) + info=dict(description="The ID of the encounter slot, which determines method and rarity")) pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=False, autoincrement=False, info=dict(description=u"The ID of the encountered Pokémon")) min_level = Column(Integer, nullable=False, autoincrement=False, @@ -361,8 +364,24 @@ 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 EncounterMethod(TableBase): + u"""A way the player can enter a wild encounter, e.g., surfing, fishing, or walking through tall grass. + """ + + __tablename__ = 'encounter_methods' + __singlename__ = 'encounter_method' + id = Column(Integer, primary_key=True, nullable=False, + info=dict(description="A unique ID for the method")) + identifier = Column(Unicode(16), nullable=False, unique=True, + info=dict(description="An identifier", format='identifier')) + +create_translation_table('encounter_method_prose', EncounterMethod, 'prose', + name = Column(Unicode(64), nullable=False, index=True, + info=dict(description="The name", format='plaintext', official=False)), +) + class EncounterSlot(TableBase): - u"""An abstract "slot" within a terrain, associated with both some set of conditions and a rarity. + u"""An abstract "slot" within a method, associated with both some set of conditions and a rarity. Note that there are two encounters per slot, so the rarities will only add up to 50. @@ -373,29 +392,13 @@ class EncounterSlot(TableBase): info=dict(description="A unique ID for this slot")) version_group_id = Column(Integer, ForeignKey('version_groups.id'), nullable=False, autoincrement=False, info=dict(description="The ID of the version group this slot is in")) - encounter_terrain_id = Column(Integer, ForeignKey('encounter_terrain.id'), primary_key=False, nullable=False, autoincrement=False, - info=dict(description="The ID of the terrain")) + encounter_method_id = Column(Integer, ForeignKey('encounter_methods.id'), primary_key=False, nullable=False, autoincrement=False, + info=dict(description="The ID of the method")) slot = Column(Integer, nullable=True, - info=dict(description="This slot's order for the location and terrain")) - rarity = Column(Integer, nullable=False, + info=dict(description="This slot's order for the location and method")) + rarity = Column(Integer, nullable=True, 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 """ @@ -500,9 +503,9 @@ create_translation_table('item_names', Item, 'names', info=dict(description="The name", format='plaintext', official=True, ripped=True)), ) create_translation_table('item_prose', Item, 'prose', - short_effect = Column(markdown.MarkdownColumn(256), nullable=False, - info=dict(description="A short summary of the effect", format='plaintext')), - effect = Column(markdown.MarkdownColumn(5120), nullable=False, + short_effect = Column(markdown.MarkdownColumn(256), nullable=True, + info=dict(description="A short summary of the effect", format='markdown')), + effect = Column(markdown.MarkdownColumn(5120), nullable=True, info=dict(description=u"Detailed description of the item's effect.", format='markdown')), ) create_translation_table('item_flavor_summaries', Item, 'flavor_summaries', @@ -540,9 +543,9 @@ class ItemFlag(TableBase): info=dict(description="Identifier of the flag", format='identifier')) create_translation_table('item_flag_prose', ItemFlag, 'prose', - name = Column(Unicode(24), nullable=False, index=True, + name = Column(Unicode(24), nullable=True, index=True, info=dict(description="The name", format='plaintext', official=False)), - description = Column(Unicode(64), nullable=False, + description = Column(Unicode(64), nullable=True, info=dict(description="Short description of the flag", format='plaintext')), ) @@ -653,8 +656,8 @@ class LocationAreaEncounterRate(TableBase): __tablename__ = 'location_area_encounter_rates' location_area_id = Column(Integer, ForeignKey('location_areas.id'), primary_key=True, nullable=False, autoincrement=False, info=dict(description="ID of the area")) - encounter_terrain_id = Column(Integer, ForeignKey('encounter_terrain.id'), primary_key=True, nullable=False, autoincrement=False, - info=dict(description="ID of the terrain")) + encounter_method_id = Column(Integer, ForeignKey('encounter_methods.id'), primary_key=True, nullable=False, autoincrement=False, + info=dict(description="ID of the method")) version_id = Column(Integer, ForeignKey('versions.id'), primary_key=True, autoincrement=False, info=dict(description="ID of the version")) rate = Column(Integer, nullable=True, @@ -784,9 +787,9 @@ class MoveDamageClass(TableBase): create_translation_table('move_damage_class_prose', MoveDamageClass, 'prose', relation_lazy='joined', - name = Column(Unicode(16), nullable=False, index=True, + name = Column(Unicode(16), nullable=True, index=True, info=dict(description="The name", format='plaintext', official=False)), - description = Column(Unicode(64), nullable=False, + description = Column(Unicode(64), nullable=True, info=dict(description="A description of the class", format='plaintext')), ) @@ -799,40 +802,12 @@ class MoveEffect(TableBase): info=dict(description="A numeric ID")) create_translation_table('move_effect_prose', MoveEffect, 'prose', - short_effect = Column(Unicode(256), nullable=False, + short_effect = Column(Unicode(256), nullable=True, 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')), + effect = Column(Unicode(5120), nullable=True, + info=dict(description="A detailed description of the effect", format='markdown')), ) -class MoveEffectCategory(TableBase): - u"""Category of a move effect - """ - __tablename__ = 'move_effect_categories' - __singlename__ = 'move_effect_category' - id = Column(Integer, primary_key=True, nullable=False, - info=dict(description="A numeric ID")) - identifier = Column(Unicode(64), nullable=False, - info=dict(description="An identifier", format='identifier')) - can_affect_user = Column(Boolean, nullable=False, - info=dict(description="Set if the user can be affected")) - -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 - """ - __tablename__ = 'move_effect_category_map' - move_effect_id = Column(Integer, ForeignKey('move_effects.id'), primary_key=True, nullable=False, - info=dict(description="ID of the move effect")) - move_effect_category_id = Column(Integer, ForeignKey('move_effect_categories.id'), primary_key=True, nullable=False, - info=dict(description="ID of the category")) - affects_user = Column(Boolean, primary_key=True, nullable=False, - info=dict(description="Set if the user is affected")) - class MoveEffectChangelog(TableBase): """History of changes to move effects across main game versions.""" __tablename__ = 'move_effect_changelog' @@ -877,9 +852,9 @@ class MoveFlagType(TableBase): create_translation_table('move_flag_type_prose', MoveFlagType, 'prose', relation_lazy='joined', - name = Column(Unicode(32), nullable=False, index=True, + name = Column(Unicode(32), nullable=True, index=True, info=dict(description="The name", format='plaintext', official=False)), - description = Column(markdown.MarkdownColumn(128), nullable=False, + description = Column(markdown.MarkdownColumn(256), nullable=True, info=dict(description="A short description of the flag", format='markdown')), ) @@ -935,7 +910,7 @@ class MoveMetaAilment(TableBase): __singlename__ = 'move_meta_ailment' id = Column(Integer, primary_key=True, nullable=False, autoincrement=False, info=dict(description="A numeric ID")) - identifier = Column(Unicode(24), nullable=False, + identifier = Column(Unicode(24), nullable=False, index=True, unique=True, info=dict(description="An identifier", format='identifier')) create_translation_table('move_meta_ailment_names', MoveMetaAilment, 'names', @@ -950,6 +925,8 @@ class MoveMetaCategory(TableBase): __singlename__ = 'move_meta_category' id = Column(Integer, primary_key=True, nullable=False, info=dict(description="A numeric ID")) + identifier = Column(Unicode(32), nullable=False, index=True, unique=True, + info=dict(description="An identifier", format='identifier')) create_translation_table('move_meta_category_prose', MoveMetaCategory, 'prose', relation_lazy='joined', @@ -979,9 +956,9 @@ class MoveTarget(TableBase): create_translation_table('move_target_prose', MoveTarget, 'prose', relation_lazy='joined', - name = Column(Unicode(32), nullable=False, index=True, + name = Column(Unicode(32), nullable=True, index=True, info=dict(description="The name", format='plaintext', official=False)), - description = Column(Unicode(128), nullable=False, + description = Column(Unicode(128), nullable=True, info=dict(description="A description", format='plaintext')), ) @@ -1072,9 +1049,9 @@ class Pokedex(TableBase): create_translation_table('pokedex_prose', Pokedex, 'prose', relation_lazy='joined', - name = Column(Unicode(16), nullable=False, index=True, + name = Column(Unicode(16), nullable=True, index=True, info=dict(description="The name", format='plaintext', official=False)), - description = Column(Unicode(512), nullable=False, + description = Column(Unicode(512), nullable=True, info=dict(description=u"A longer description of the Pokédex", format='plaintext')), ) @@ -1091,6 +1068,8 @@ class Pokemon(TableBase): info=dict(description=u"ID of the generation this species first appeared in")) evolution_chain_id = Column(Integer, ForeignKey('evolution_chains.id'), info=dict(description=u"ID of the species' evolution chain (a.k.a. family)")) + evolves_from_pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=True, + info=dict(description=u"The Pokémon species from which this one evolves")) height = Column(Integer, nullable=False, info=dict(description=u"The height of the Pokémon, in decimeters (tenths of a meter)")) weight = Column(Integer, nullable=False, @@ -1121,12 +1100,6 @@ class Pokemon(TableBase): ### Stuff to handle alternate Pokémon forms @property - def form(self): - u"""Returns the Pokémon's form, using its default form as fallback.""" - - return self.unique_form or self.default_form - - @property def is_base_form(self): u"""Returns True iff the Pokémon is the base form for its species, e.g. Land Shaymin. @@ -1202,9 +1175,9 @@ class Pokemon(TableBase): create_translation_table('pokemon_names', Pokemon, 'names', relation_lazy='joined', - name = Column(Unicode(20), nullable=False, index=True, + name = Column(Unicode(20), nullable=True, index=True, info=dict(description="The name", format='plaintext', official=True, ripped=True)), - species = Column(Unicode(16), nullable=False, + species = Column(Unicode(16), nullable=True, info=dict(description=u'The short flavor text, such as "Seed" or "Lizard"; usually affixed with the word "Pokémon"', official=True, format='plaintext')), ) @@ -1272,9 +1245,9 @@ class PokemonEvolution(TableBase): Any condition may be null if it does not apply for a particular Pokémon. """ __tablename__ = 'pokemon_evolution' - from_pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=False, - info=dict(description=u"The ID of the pre-evolution Pokémon.")) - to_pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False, + id = Column(Integer, primary_key=True, nullable=False, + info=dict(description=u"A numeric ID")) + evolved_pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=False, info=dict(description=u"The ID of the post-evolution Pokémon.")) evolution_trigger_id = Column(Integer, ForeignKey('evolution_triggers.id'), nullable=False, info=dict(description=u"The ID of the evolution trigger.")) @@ -1341,13 +1314,6 @@ class PokemonForm(TableBase): 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.')) @property - def pokemon(self): - u"""Returns the Pokémon for this form, using the form base as fallback. - """ - - return self.unique_pokemon or self.form_base_pokemon - - @property def full_name(self): u"""Returns the full name of this form, e.g. "Plant Cloak".""" @@ -1389,7 +1355,7 @@ 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, + description = Column(markdown.MarkdownColumn(1024), nullable=True, info=dict(description=u"Description of how the forms work", format='markdown')), ) @@ -1481,9 +1447,9 @@ class PokemonMoveMethod(TableBase): create_translation_table('pokemon_move_method_prose', PokemonMoveMethod, 'prose', relation_lazy='joined', - name = Column(Unicode(64), nullable=False, index=True, + name = Column(Unicode(64), nullable=True, index=True, info=dict(description="The name", format='plaintext', official=False)), - description = Column(Unicode(255), nullable=False, + description = Column(Unicode(255), nullable=True, info=dict(description=u"A detailed description of how the method works", format='plaintext')), ) @@ -1499,9 +1465,9 @@ class PokemonShape(TableBase): create_translation_table('pokemon_shape_prose', PokemonShape, 'prose', relation_lazy='joined', - name = Column(Unicode(24), nullable=False, index=True, + name = Column(Unicode(24), nullable=True, index=True, info=dict(description="The name", format='plaintext', official=False)), - awesome_name = Column(Unicode(16), nullable=False, + awesome_name = Column(Unicode(16), nullable=True, info=dict(description=u"A splendiferous name of the body shape", format='plaintext')), ) @@ -1744,7 +1710,7 @@ EncounterConditionValueMap.condition_value = relation(EncounterConditionValue, innerjoin=True, lazy='joined', backref='encounter_map') -EncounterSlot.terrain = relation(EncounterTerrain, +EncounterSlot.method = relation(EncounterMethod, innerjoin=True, lazy='joined', backref='slots') EncounterSlot.version_group = relation(VersionGroup, innerjoin=True) @@ -1821,6 +1787,12 @@ LocationArea.location = relation(Location, innerjoin=True, lazy='joined', backref='areas') +LocationAreaEncounterRate.location_area = relation(LocationArea, + innerjoin=True, + backref='encounter_rates') +LocationAreaEncounterRate.method = relation(EncounterMethod, + innerjoin=True) + LocationGameIndex.location = relation(Location, innerjoin=True, lazy='joined', backref='game_indices') @@ -1891,12 +1863,9 @@ MoveChangelog.effect_map = markdown.MoveEffectPropertyMap('effect_map') MoveChangelog.short_effect = markdown.MoveEffectProperty('short_effect') MoveChangelog.short_effect_map = markdown.MoveEffectPropertyMap('short_effect_map') -MoveEffect.category_map = relation(MoveEffectCategoryMap) -MoveEffect.categories = association_proxy('category_map', 'category') MoveEffect.changelog = relation(MoveEffectChangelog, order_by=MoveEffectChangelog.changed_in_version_group_id.desc(), backref='move_effect') -MoveEffectCategoryMap.category = relation(MoveEffectCategory) MoveEffectChangelog.changed_in = relation(VersionGroup, innerjoin=True, lazy='joined', @@ -2008,11 +1977,13 @@ Pokemon.egg_groups = relation(EggGroup, Pokemon.evolution_chain = relation(EvolutionChain, innerjoin=True, backref=backref('pokemon', order_by=Pokemon.order.asc())) -Pokemon.child_pokemon = relation(Pokemon, - primaryjoin=Pokemon.id==PokemonEvolution.from_pokemon_id, - secondary=PokemonEvolution.__table__, - secondaryjoin=PokemonEvolution.to_pokemon_id==Pokemon.id, - backref=backref('parent_pokemon', uselist=False)) +Pokemon.parent_pokemon = relation(Pokemon, + primaryjoin=Pokemon.evolves_from_pokemon_id==Pokemon.id, + remote_side=[Pokemon.id], + backref='child_pokemon') +Pokemon.evolutions = relation(PokemonEvolution, + primaryjoin=Pokemon.id==PokemonEvolution.evolved_pokemon_id, + backref=backref('evolved_pokemon', innerjoin=True, lazy='joined')) Pokemon.flavor_text = relation(PokemonFlavorText, order_by=PokemonFlavorText.version_id.asc(), backref='pokemon') @@ -2044,24 +2015,18 @@ Pokemon.types = relation(Type, innerjoin=True, order_by=PokemonType.slot.asc(), backref=backref('pokemon', order_by=Pokemon.order)) +Pokemon.form = relation(PokemonForm, + primaryjoin=or_( + PokemonForm.unique_pokemon_id==Pokemon.id, + and_(PokemonForm.unique_pokemon_id==None, + PokemonForm.form_base_pokemon_id==Pokemon.id, + PokemonForm.is_default==True) + ), + uselist=False) PokemonDexNumber.pokedex = relation(Pokedex, innerjoin=True, lazy='joined') -PokemonEvolution.from_pokemon = relation(Pokemon, - primaryjoin=PokemonEvolution.from_pokemon_id==Pokemon.id, - innerjoin=True, - backref='child_evolutions') -PokemonEvolution.to_pokemon = relation(Pokemon, - primaryjoin=PokemonEvolution.to_pokemon_id==Pokemon.id, - innerjoin=True, - backref=backref('parent_evolution', uselist=False)) -PokemonEvolution.child_evolutions = relation(PokemonEvolution, - primaryjoin=PokemonEvolution.from_pokemon_id==PokemonEvolution.to_pokemon_id, - foreign_keys=[PokemonEvolution.to_pokemon_id], - backref=backref('parent_evolution', - remote_side=[PokemonEvolution.from_pokemon_id], - uselist=False)) PokemonEvolution.trigger = relation(EvolutionTrigger, innerjoin=True, lazy='joined', backref='evolutions') @@ -2090,6 +2055,12 @@ PokemonForm.form_base_pokemon = relation(Pokemon, PokemonForm.unique_pokemon = relation(Pokemon, primaryjoin=PokemonForm.unique_pokemon_id==Pokemon.id, backref=backref('unique_form', uselist=False)) +PokemonForm.pokemon = relation(Pokemon, + primaryjoin=or_( + PokemonForm.unique_pokemon_id==Pokemon.id, + and_(PokemonForm.unique_pokemon_id==None, + PokemonForm.form_base_pokemon_id==Pokemon.id) + ), uselist=False) PokemonForm.version_group = relation(VersionGroup, innerjoin=True) PokemonForm.form_group = association_proxy('form_base_pokemon', 'form_group')