X-Git-Url: http://git.veekun.com/zzz-pokedex.git/blobdiff_plain/8cb267bd53921cdcde82e7a8c9ae302d21ef8e26..acec17f23a8d18407ca183cb8064636cf5183237:/pokedex/db/tables.py diff --git a/pokedex/db/tables.py b/pokedex/db/tables.py index 9348800..24008e1 100644 --- a/pokedex/db/tables.py +++ b/pokedex/db/tables.py @@ -4,6 +4,7 @@ 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 * @@ -39,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. @@ -65,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 EncounterType(TableBase): - """Rows in this table represent ways the player can enter a wild encounter; - i.e. surfing, fishing, or walking through tall grass. +class EncounterConditionValueMap(TableBase): + """Maps encounters to the specific conditions under which they occur.""" + + __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) @@ -132,8 +144,8 @@ 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.""" @@ -151,13 +163,14 @@ class Item(TableBase): 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): @@ -170,15 +183,27 @@ class LocationArea(TableBase): 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_types.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) - generation_id = Column(Integer, ForeignKey('generations.id'), 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) @@ -387,6 +412,12 @@ 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) @@ -415,12 +446,19 @@ class Type(TableBase): 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) @@ -434,24 +472,35 @@ ContestCombo.first = relation(Move, primaryjoin=ContestCombo.first_move_id==Move 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.generation = relation(Generation) +Machine.version_group = relation(VersionGroup) Move.contest_effect = relation(ContestEffect, backref='moves') Move.contest_combo_next = association_proxy('contest_combo_first', 'second') @@ -474,6 +523,10 @@ 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) @@ -517,6 +570,11 @@ 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) @@ -524,6 +582,12 @@ 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, @@ -538,7 +602,12 @@ Type.target_efficacies = relation(TypeEfficacy, ==TypeEfficacy.target_type_id, backref='target_type') +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')