X-Git-Url: http://git.veekun.com/zzz-pokedex.git/blobdiff_plain/ee57dfd4a3c77fc76231aff79ae68c9295d68613..375f0c6e5a68322c6718f6af818452c279badc86:/pokedex/db/tables.py diff --git a/pokedex/db/tables.py b/pokedex/db/tables.py index 31a4210..24008e1 100644 --- a/pokedex/db/tables.py +++ b/pokedex/db/tables.py @@ -2,26 +2,36 @@ from sqlalchemy import Column, ForeignKey, MetaData, Table from sqlalchemy.ext.declarative import declarative_base +from sqlalchemy.ext.associationproxy import association_proxy from sqlalchemy.orm import backref, relation +from sqlalchemy.sql import and_ from sqlalchemy.types import * from sqlalchemy.databases.mysql import * +from pokedex.db import rst + metadata = MetaData() TableBase = declarative_base(metadata=metadata) class Ability(TableBase): __tablename__ = 'abilities' + __singlename__ = 'ability' id = Column(Integer, primary_key=True, nullable=False) name = Column(Unicode(24), nullable=False) flavor_text = Column(Unicode(64), nullable=False) effect = Column(Unicode(255), nullable=False) +class ContestCombo(TableBase): + __tablename__ = 'contest_combos' + first_move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False) + second_move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False) + class ContestEffect(TableBase): __tablename__ = 'contest_effects' id = Column(Integer, primary_key=True, nullable=False) appeal = Column(SmallInteger, nullable=False) jam = Column(SmallInteger, nullable=False) - flavor = Column(Unicode(255), nullable=False) + flavor_text = Column(Unicode(64), nullable=False) effect = Column(Unicode(255), nullable=False) class EggGroup(TableBase): @@ -30,23 +40,23 @@ class EggGroup(TableBase): name = Column(Unicode(16), nullable=False) class Encounter(TableBase): - """Rows in this table represent encounters with wild Pokémon. + """Rows in this table represent encounters with wild Pokémon. Bear with + me, here. Within a given area in a given game, encounters are differentiated by the - slot they are in and a world condition. + "slot" they are in and the state of the game world. - Groups of slots belong to encounter types; these are what the player is - doing to get an encounter, such as surfing or walking through tall grass. + 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 + encounter slots. - Within an encounter type, slots are defined primarily by rarity. Each slot - can also be affected by a world condition; for example, the 20% slot for - walking in tall grass is affected by whether a swarm is in effect in the - areas. "There is a swarm" and "there is not a swarm" are conditions, and - together they make a condition group. However, since "not a swarm" is a - base state rather than any sort of new state, it is omitted and instead - referred to by a NULL. + Within a terrain, 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 + swarm" are the possible values of this condition. - A slot (20% walking in grass) and single world condition (NULL, i.e. no + A slot (20% walking in grass) and any appropriate world conditions (no swarm) are thus enough to define a specific encounter. Well, okay, almost: each slot actually appears twice. @@ -56,57 +66,68 @@ class Encounter(TableBase): id = Column(Integer, primary_key=True, nullable=False) version_id = Column(Integer, ForeignKey('versions.id'), nullable=False, autoincrement=False) location_area_id = Column(Integer, ForeignKey('location_areas.id'), nullable=False, autoincrement=False) - encounter_type_slot_id = Column(Integer, ForeignKey('encounter_type_slots.id'), nullable=False, autoincrement=False) - encounter_condition_id = Column(Integer, ForeignKey('encounter_conditions.id'), nullable=True, autoincrement=False) + encounter_slot_id = Column(Integer, ForeignKey('encounter_slots.id'), nullable=False, autoincrement=False) pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=False, autoincrement=False) min_level = Column(Integer, nullable=False, autoincrement=False) max_level = Column(Integer, nullable=False, autoincrement=False) class EncounterCondition(TableBase): - """Rows in this table represent something different about the world that - can affect what Pokémon are encountered. + """Rows in this table represent varying conditions in the game world, such + as time of day. """ __tablename__ = 'encounter_conditions' id = Column(Integer, primary_key=True, nullable=False) - encounter_condition_group_id = Column(Integer, ForeignKey('encounter_condition_groups.id'), primary_key=False, nullable=False, autoincrement=False) name = Column(Unicode(64), nullable=False) -class EncounterConditionGroup(TableBase): - """Rows in this table represent a group of mutually exclusive conditions, - such as morning/day/night. "Conditions" that are part of the default state - of the world, such as "not during a swarm" or "not using the PokéRadar", - are not included in this table and are referred to by NULLs in other - tables. +class EncounterConditionValue(TableBase): + """Rows in this table represent possible states for a condition; for + example, the state of 'swarm' could be 'swarm' or 'no swarm'. """ - __tablename__ = 'encounter_condition_groups' + __tablename__ = 'encounter_condition_values' id = Column(Integer, primary_key=True, nullable=False) + encounter_condition_id = Column(Integer, ForeignKey('encounter_conditions.id'), primary_key=False, nullable=False, autoincrement=False) name = Column(Unicode(64), nullable=False) + is_default = Column(Boolean, nullable=False) + +class EncounterConditionValueMap(TableBase): + """Maps encounters to the specific conditions under which they occur.""" -class EncounterType(TableBase): - """Rows in this table represent ways the player can enter a wild encounter; - i.e. surfing, fishing, or walking through tall grass. + __tablename__ = 'encounter_condition_value_map' + encounter_id = Column(Integer, ForeignKey('encounters.id'), primary_key=True, nullable=False, autoincrement=False) + encounter_condition_value_id = Column(Integer, ForeignKey('encounter_condition_values.id'), primary_key=True, nullable=False, autoincrement=False) + +class EncounterTerrain(TableBase): + """Rows in this table represent ways the player can enter a wild encounter, + e.g., surfing, fishing, or walking through tall grass. """ - __tablename__ = 'encounter_types' + __tablename__ = 'encounter_terrain' id = Column(Integer, primary_key=True, nullable=False) name = Column(Unicode(64), nullable=False) -class EncounterTypeSlot(TableBase): - """Rows in this table represent an abstract "slot" within an encounter - type, associated with both a condition group and a rarity. +class EncounterSlot(TableBase): + """Rows in this table represent an abstract "slot" within a terrain, + 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. """ - __tablename__ = 'encounter_type_slots' + __tablename__ = 'encounter_slots' id = Column(Integer, primary_key=True, nullable=False) - encounter_type_id = Column(Integer, ForeignKey('encounter_types.id'), primary_key=False, nullable=False, autoincrement=False) - encounter_condition_group_id = Column(Integer, ForeignKey('encounter_condition_groups.id'), primary_key=False, nullable=True, autoincrement=False) + version_group_id = Column(Integer, ForeignKey('version_groups.id'), nullable=False, autoincrement=False) + encounter_terrain_id = Column(Integer, ForeignKey('encounter_terrain.id'), primary_key=False, nullable=False, autoincrement=False) rarity = Column(Integer, nullable=False, autoincrement=False) +class EncounterSlotCondition(TableBase): + """Lists all conditions that affect each slot.""" + + __tablename__ = 'encounter_slot_conditions' + encounter_slot_id = Column(Integer, ForeignKey('encounter_slots.id'), primary_key=True, nullable=False, autoincrement=False) + encounter_condition_id = Column(Integer, ForeignKey('encounter_conditions.id'), primary_key=True, nullable=False, autoincrement=False) + class EvolutionChain(TableBase): __tablename__ = 'evolution_chains' id = Column(Integer, primary_key=True, nullable=False) @@ -123,29 +144,33 @@ class EvolutionMethod(TableBase): class Generation(TableBase): __tablename__ = 'generations' id = Column(Integer, primary_key=True, nullable=False) + main_region_id = Column(Integer, ForeignKey('regions.id')) name = Column(Unicode(16), nullable=False) - main_region = Column(Unicode(16), nullable=False) class GrowthRate(TableBase): + """`formula` is written in LaTeX math notation.""" __tablename__ = 'growth_rates' id = Column(Integer, primary_key=True, nullable=False) - name = Column(Unicode(16), nullable=False) - formula = Column(Unicode(255), nullable=False) + name = Column(Unicode(20), nullable=False) + formula = Column(Unicode(500), nullable=False) class Item(TableBase): __tablename__ = 'items' + __singlename__ = 'item' id = Column(Integer, primary_key=True, nullable=False) name = Column(Unicode(16), nullable=False) class Language(TableBase): __tablename__ = 'languages' id = Column(Integer, primary_key=True, nullable=False) + iso3166 = Column(Unicode(2), nullable=False) name = Column(Unicode(16), nullable=False) class Location(TableBase): __tablename__ = 'locations' + __singlename__ = 'location' id = Column(Integer, primary_key=True, nullable=False) - generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False) + region_id = Column(Integer, ForeignKey('regions.id')) name = Column(Unicode(64), nullable=False) class LocationArea(TableBase): @@ -155,12 +180,65 @@ class LocationArea(TableBase): internal_id = Column(Integer, nullable=False) name = Column(Unicode(64), nullable=True) +class LocationAreaEncounterRate(TableBase): + __tablename__ = 'location_area_encounter_rates' + location_area_id = Column(Integer, ForeignKey('location_areas.id'), primary_key=True, nullable=False, autoincrement=False) + encounter_type_id = Column(Integer, ForeignKey('encounter_terrain.id'), primary_key=True, nullable=False, autoincrement=False) + rate = Column(Integer, nullable=True) + +class Machine(TableBase): + __tablename__ = 'machines' + machine_number = Column(Integer, primary_key=True, nullable=False, autoincrement=False) + version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, autoincrement=False) + move_id = Column(Integer, ForeignKey('moves.id'), nullable=False) + +class MoveEffectCategory(TableBase): + __tablename__ = 'move_effect_categories' + id = Column(Integer, primary_key=True, nullable=False) + name = Column(Unicode(64), nullable=False) + can_affect_user = Column(Boolean, nullable=False) + +class MoveEffectCategoryMap(TableBase): + __tablename__ = 'move_effect_category_map' + move_effect_id = Column(Integer, ForeignKey('move_effects.id'), primary_key=True, nullable=False) + move_effect_category_id = Column(Integer, ForeignKey('move_effect_categories.id'), primary_key=True, nullable=False) + affects_user = Column(Boolean, primary_key=True, nullable=False) + +class MoveDamageClass(TableBase): + __tablename__ = 'move_damage_classes' + id = Column(Integer, primary_key=True, nullable=False) + name = Column(Unicode(8), nullable=False) + description = Column(Unicode(64), nullable=False) + class MoveEffect(TableBase): __tablename__ = 'move_effects' id = Column(Integer, primary_key=True, nullable=False) priority = Column(SmallInteger, nullable=False) - short_effect = Column(Unicode(128), nullable=False) - effect = Column(Unicode(255), nullable=False) + short_effect = Column(Unicode(256), nullable=False) + effect = Column(Unicode(5120), nullable=False) + +class MoveFlag(TableBase): + __tablename__ = 'move_flags' + move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False) + move_flag_type_id = Column(Integer, ForeignKey('move_flag_types.id'), primary_key=True, nullable=False, autoincrement=False) + +class MoveFlagType(TableBase): + __tablename__ = 'move_flag_types' + id = Column(Integer, primary_key=True, nullable=False) + name = Column(Unicode(32), nullable=False) + description = Column(rst.RstTextColumn(128), nullable=False) + +class MoveFlavorText(TableBase): + __tablename__ = 'move_flavor_text' + move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False) + generation_id = Column(Integer, ForeignKey('generations.id'), primary_key=True, nullable=False, autoincrement=False) + flavor_text = Column(Unicode(255), nullable=False) + +class MoveName(TableBase): + __tablename__ = 'move_names' + move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False) + language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, autoincrement=False) + name = Column(Unicode(16), nullable=False) class MoveTarget(TableBase): __tablename__ = 'move_targets' @@ -170,19 +248,21 @@ class MoveTarget(TableBase): class Move(TableBase): __tablename__ = 'moves' + __singlename__ = 'move' id = Column(Integer, primary_key=True, nullable=False) name = Column(Unicode(12), nullable=False) + generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False) type_id = Column(Integer, ForeignKey('types.id'), nullable=False) power = Column(SmallInteger) pp = Column(SmallInteger, nullable=False) accuracy = Column(SmallInteger) target_id = Column(Integer, ForeignKey('move_targets.id'), nullable=False) - category = Column(Unicode(8), nullable=False) + damage_class_id = Column(Integer, ForeignKey('move_damage_classes.id'), nullable=False) effect_id = Column(Integer, ForeignKey('move_effects.id'), nullable=False) effect_chance = Column(Integer) contest_type = Column(Unicode(8), nullable=False) contest_effect_id = Column(Integer, ForeignKey('contest_effects.id'), nullable=True) - super_contest_effect_id = Column(Integer, nullable=False) + super_contest_effect_id = Column(Integer, ForeignKey('super_contest_effects.id'), nullable=False) class Pokemon(TableBase): """The core to this whole mess. @@ -194,6 +274,7 @@ class Pokemon(TableBase): purely cosmetic forms like Unown. """ __tablename__ = 'pokemon' + __singlename__ = 'pokemon' id = Column(Integer, primary_key=True, nullable=False) name = Column(Unicode(20), nullable=False) forme_name = Column(Unicode(16)) @@ -281,6 +362,7 @@ class PokemonFormSprite(TableBase): __tablename__ = 'pokemon_form_sprites' id = Column(Integer, primary_key=True, nullable=False) pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False) + introduced_in_version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, autoincrement=False) name = Column(Unicode(16), nullable=True) class PokemonItem(TableBase): @@ -296,7 +378,7 @@ class PokemonMove(TableBase): version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, autoincrement=False) move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False, index=True) pokemon_move_method_id = Column(Integer, ForeignKey('pokemon_move_methods.id'), primary_key=True, nullable=False, autoincrement=False) - level = Column(Integer, primary_key=True, nullable=True) + level = Column(Integer, primary_key=True, nullable=True, autoincrement=False) order = Column(Integer, nullable=True) class PokemonMoveMethod(TableBase): @@ -330,11 +412,28 @@ class PokemonType(TableBase): type_id = Column(Integer, ForeignKey('types.id'), nullable=False) slot = Column(Integer, primary_key=True, nullable=False, autoincrement=False) +class Region(TableBase): + """Major areas of the world: Kanto, Johto, etc.""" + __tablename__ = 'regions' + id = Column(Integer, primary_key=True, nullable=False) + name = Column(Unicode(16), nullable=False) + class Stat(TableBase): __tablename__ = 'stats' id = Column(Integer, primary_key=True, nullable=False) name = Column(Unicode(16), nullable=False) +class SuperContestCombo(TableBase): + __tablename__ = 'super_contest_combos' + first_move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False) + second_move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False) + +class SuperContestEffect(TableBase): + __tablename__ = 'super_contest_effects' + id = Column(Integer, primary_key=True, nullable=False) + appeal = Column(SmallInteger, nullable=False) + flavor_text = Column(Unicode(64), nullable=False) + class TypeEfficacy(TableBase): __tablename__ = 'type_efficacy' damage_type_id = Column(Integer, ForeignKey('types.id'), primary_key=True, nullable=False, autoincrement=False) @@ -343,15 +442,23 @@ class TypeEfficacy(TableBase): class Type(TableBase): __tablename__ = 'types' + __singlename__ = 'type' id = Column(Integer, primary_key=True, nullable=False) name = Column(Unicode(8), nullable=False) abbreviation = Column(Unicode(3), nullable=False) + generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False) + damage_class_id = Column(Integer, ForeignKey('move_damage_classes.id'), nullable=False) ## ??? is none; everything else is physical or special class VersionGroup(TableBase): __tablename__ = 'version_groups' id = Column(Integer, primary_key=True, nullable=False) generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False) +class VersionGroupRegion(TableBase): + __tablename__ = 'version_group_regions' + version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False) + region_id = Column(Integer, ForeignKey('regions.id'), primary_key=True, nullable=False) + class Version(TableBase): __tablename__ = 'versions' id = Column(Integer, primary_key=True, nullable=False) @@ -360,21 +467,72 @@ class Version(TableBase): ### Relations down here, to avoid ordering problems +ContestCombo.first = relation(Move, primaryjoin=ContestCombo.first_move_id==Move.id, + backref='contest_combo_first') +ContestCombo.second = relation(Move, primaryjoin=ContestCombo.second_move_id==Move.id, + backref='contest_combo_second') + +Encounter.location_area = relation(LocationArea, backref='encounters') Encounter.pokemon = relation(Pokemon, backref='encounters') Encounter.version = relation(Version, backref='encounters') -Encounter.location_area = relation(LocationArea, backref='encounters') -Encounter.slot = relation(EncounterTypeSlot, backref='encounters') -Encounter.condition = relation(EncounterCondition, backref='encounters') +Encounter.slot = relation(EncounterSlot, backref='encounters') -EncounterCondition.group = relation(EncounterConditionGroup, - backref='conditions') +EncounterConditionValue.condition = relation(EncounterCondition, backref='values') -EncounterTypeSlot.type = relation(EncounterType, backref='slots') +Encounter.condition_value_map = relation(EncounterConditionValueMap, backref='encounter') +Encounter.condition_values = association_proxy('condition_value_map', 'condition_value') +EncounterConditionValueMap.condition_value = relation(EncounterConditionValue, + backref='encounter_map') + +EncounterSlot.terrain = relation(EncounterTerrain, backref='slots') + +EncounterSlot.condition_map = relation(EncounterSlotCondition, backref='slot') +EncounterSlot.conditions = association_proxy('condition_map', 'condition') +EncounterSlotCondition.condition = relation(EncounterCondition, + backref='slot_map') EvolutionChain.growth_rate = relation(GrowthRate, backref='evolution_chains') +Generation.versions = relation(Version, secondary=VersionGroup.__table__) +Generation.main_region = relation(Region) + +Location.region = relation(Region, backref='locations') + LocationArea.location = relation(Location, backref='areas') +Machine.version_group = relation(VersionGroup) + +Move.contest_effect = relation(ContestEffect, backref='moves') +Move.contest_combo_next = association_proxy('contest_combo_first', 'second') +Move.contest_combo_prev = association_proxy('contest_combo_second', 'first') +Move.damage_class = relation(MoveDamageClass, backref='moves') +Move.flags = association_proxy('move_flags', 'flag') +Move.flavor_text = relation(MoveFlavorText, order_by=MoveFlavorText.generation_id, backref='move') +Move.foreign_names = relation(MoveName, backref='pokemon') +Move.generation = relation(Generation, backref='moves') +Move.machines = relation(Machine, backref='move') +Move.move_effect = relation(MoveEffect, backref='moves') +Move.move_flags = relation(MoveFlag, backref='move') +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, backref='moves') + +Move.effect = rst.MoveEffectProperty('effect') +Move.priority = association_proxy('move_effect', 'priority') +Move.short_effect = rst.MoveEffectProperty('short_effect') + +MoveEffect.category_map = relation(MoveEffectCategoryMap) +MoveEffect.categories = association_proxy('category_map', 'category') +MoveEffectCategoryMap.category = relation(MoveEffectCategory) + +MoveFlag.flag = relation(MoveFlagType) + +MoveFlavorText.generation = relation(Generation) + +MoveName.language = relation(Language) + Pokemon.abilities = relation(Ability, secondary=PokemonAbility.__table__, order_by=PokemonAbility.slot, backref='pokemon') @@ -390,7 +548,7 @@ Pokemon.evolution_method = relation(EvolutionMethod) Pokemon.evolution_children = relation(Pokemon, primaryjoin=Pokemon.id==Pokemon.evolution_parent_pokemon_id, backref=backref('evolution_parent', remote_side=[Pokemon.id])) -Pokemon.flavor_text = relation(PokemonFlavorText, backref='pokemon') +Pokemon.flavor_text = relation(PokemonFlavorText, order_by=PokemonFlavorText.pokemon_id, backref='pokemon') Pokemon.foreign_names = relation(PokemonName, backref='pokemon') Pokemon.items = relation(PokemonItem) Pokemon.generation = relation(Generation, backref='pokemon') @@ -408,9 +566,15 @@ PokemonItem.version = relation(Version) PokemonFormGroup.pokemon = relation(Pokemon, backref=backref('form_group', uselist=False)) PokemonFormSprite.pokemon = relation(Pokemon, backref='form_sprites') +PokemonFormSprite.introduced_in = relation(VersionGroup) PokemonMove.pokemon = relation(Pokemon, backref='pokemon_moves') PokemonMove.version_group = relation(VersionGroup) +PokemonMove.machine = relation(Machine, backref='pokemon_moves', + primaryjoin=and_(Machine.version_group_id==PokemonMove.version_group_id, + Machine.move_id==PokemonMove.move_id), + foreign_keys=[Machine.version_group_id, Machine.move_id], + uselist=False) PokemonMove.move = relation(Move, backref='pokemon_moves') PokemonMove.method = relation(PokemonMoveMethod) @@ -418,6 +582,17 @@ PokemonName.language = relation(Language) PokemonStat.stat = relation(Stat) +# This is technically a has-many; Generation.main_region_id -> Region.id +Region.generation = relation(Generation, uselist=False) +Region.version_group_regions = relation(VersionGroupRegion, backref='region', + order_by='VersionGroupRegion.version_group_id') +Region.version_groups = association_proxy('version_group_regions', 'version_group') + +SuperContestCombo.first = relation(Move, primaryjoin=SuperContestCombo.first_move_id==Move.id, + backref='super_contest_combo_first') +SuperContestCombo.second = relation(Move, primaryjoin=SuperContestCombo.second_move_id==Move.id, + backref='super_contest_combo_second') + Type.damage_efficacies = relation(TypeEfficacy, primaryjoin=Type.id ==TypeEfficacy.damage_type_id, @@ -427,6 +602,12 @@ Type.target_efficacies = relation(TypeEfficacy, ==TypeEfficacy.target_type_id, backref='target_type') -Version.generation = relation(Generation, secondary=VersionGroup.__table__, - backref='versions') +Type.generation = relation(Generation, backref='types') +Type.damage_class = relation(MoveDamageClass, backref='types') + Version.version_group = relation(VersionGroup, backref='versions') +Version.generation = association_proxy('version_group', 'generation') + +VersionGroup.generation = relation(Generation, backref='version_groups') +VersionGroup.version_group_regions = relation(VersionGroupRegion, backref='version_group') +VersionGroup.regions = association_proxy('version_group_regions', 'region')