Scrap docutils for markdown. #275
[zzz-pokedex.git] / pokedex / db / tables.py
1 # encoding: utf8
2
3 from sqlalchemy import Column, ForeignKey, MetaData, Table
4 from sqlalchemy.ext.declarative import declarative_base
5 from sqlalchemy.ext.associationproxy import association_proxy
6 from sqlalchemy.orm import backref, eagerload_all, relation
7 from sqlalchemy.orm.session import Session
8 from sqlalchemy.sql import and_
9 from sqlalchemy.types import *
10
11 from pokedex.db import markdown
12
13 metadata = MetaData()
14 TableBase = declarative_base(metadata=metadata)
15
16 class Ability(TableBase):
17 __tablename__ = 'abilities'
18 __singlename__ = 'ability'
19 id = Column(Integer, primary_key=True, nullable=False)
20 name = Column(Unicode(24), nullable=False)
21 generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False)
22 effect = Column(markdown.MarkdownColumn(5120), nullable=False)
23 short_effect = Column(markdown.MarkdownColumn(255), nullable=False)
24
25 class AbilityFlavorText(TableBase):
26 __tablename__ = 'ability_flavor_text'
27 ability_id = Column(Integer, ForeignKey('abilities.id'), primary_key=True, nullable=False, autoincrement=False)
28 version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, autoincrement=False)
29 flavor_text = Column(Unicode(64), nullable=False)
30
31 class AbilityName(TableBase):
32 __tablename__ = 'ability_names'
33 ability_id = Column(Integer, ForeignKey('abilities.id'), primary_key=True, nullable=False, autoincrement=False)
34 language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, autoincrement=False)
35 name = Column(Unicode(16), nullable=False)
36
37 class Berry(TableBase):
38 __tablename__ = 'berries'
39 id = Column(Integer, primary_key=True, nullable=False)
40 item_id = Column(Integer, ForeignKey('items.id'), nullable=False)
41 firmness_id = Column(Integer, ForeignKey('berry_firmness.id'), nullable=False)
42 natural_gift_power = Column(Integer, nullable=True)
43 natural_gift_type_id = Column(Integer, ForeignKey('types.id'), nullable=True)
44 size = Column(Integer, nullable=False)
45 max_harvest = Column(Integer, nullable=False)
46 growth_time = Column(Integer, nullable=False)
47 soil_dryness = Column(Integer, nullable=False)
48 smoothness = Column(Integer, nullable=False)
49
50 class BerryFirmness(TableBase):
51 __tablename__ = 'berry_firmness'
52 id = Column(Integer, primary_key=True, nullable=False)
53 name = Column(Unicode(10), nullable=False)
54
55 class BerryFlavor(TableBase):
56 __tablename__ = 'berry_flavors'
57 berry_id = Column(Integer, ForeignKey('berries.id'), primary_key=True, nullable=False, autoincrement=False)
58 contest_type_id = Column(Integer, ForeignKey('contest_types.id'), primary_key=True, nullable=False, autoincrement=False)
59 flavor = Column(Integer, nullable=False)
60
61 class ContestCombo(TableBase):
62 __tablename__ = 'contest_combos'
63 first_move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False)
64 second_move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False)
65
66 class ContestEffect(TableBase):
67 __tablename__ = 'contest_effects'
68 id = Column(Integer, primary_key=True, nullable=False)
69 appeal = Column(SmallInteger, nullable=False)
70 jam = Column(SmallInteger, nullable=False)
71 flavor_text = Column(Unicode(64), nullable=False)
72 effect = Column(Unicode(255), nullable=False)
73
74 class ContestType(TableBase):
75 __tablename__ = 'contest_types'
76 id = Column(Integer, primary_key=True, nullable=False)
77 name = Column(Unicode(6), nullable=False)
78 flavor = Column(Unicode(6), nullable=False)
79 color = Column(Unicode(6), nullable=False)
80
81 class EggGroup(TableBase):
82 __tablename__ = 'egg_groups'
83 id = Column(Integer, primary_key=True, nullable=False)
84 name = Column(Unicode(16), nullable=False)
85
86 class Encounter(TableBase):
87 """Rows in this table represent encounters with wild Pokémon. Bear with
88 me, here.
89
90 Within a given area in a given game, encounters are differentiated by the
91 "slot" they are in and the state of the game world.
92
93 What the player is doing to get an encounter, such as surfing or walking
94 through tall grass, is called terrain. Each terrain has its own set of
95 encounter slots.
96
97 Within a terrain, slots are defined primarily by rarity. Each slot can
98 also be affected by world conditions; for example, the 20% slot for walking
99 in tall grass is affected by whether a swarm is in effect in that area.
100 "Is there a swarm?" is a condition; "there is a swarm" and "there is not a
101 swarm" are the possible values of this condition.
102
103 A slot (20% walking in grass) and any appropriate world conditions (no
104 swarm) are thus enough to define a specific encounter.
105
106 Well, okay, almost: each slot actually appears twice.
107 """
108
109 __tablename__ = 'encounters'
110 id = Column(Integer, primary_key=True, nullable=False)
111 version_id = Column(Integer, ForeignKey('versions.id'), nullable=False, autoincrement=False)
112 location_area_id = Column(Integer, ForeignKey('location_areas.id'), nullable=False, autoincrement=False)
113 encounter_slot_id = Column(Integer, ForeignKey('encounter_slots.id'), nullable=False, autoincrement=False)
114 pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=False, autoincrement=False)
115 min_level = Column(Integer, nullable=False, autoincrement=False)
116 max_level = Column(Integer, nullable=False, autoincrement=False)
117
118 class EncounterCondition(TableBase):
119 """Rows in this table represent varying conditions in the game world, such
120 as time of day.
121 """
122
123 __tablename__ = 'encounter_conditions'
124 id = Column(Integer, primary_key=True, nullable=False)
125 name = Column(Unicode(64), nullable=False)
126
127 class EncounterConditionValue(TableBase):
128 """Rows in this table represent possible states for a condition; for
129 example, the state of 'swarm' could be 'swarm' or 'no swarm'.
130 """
131
132 __tablename__ = 'encounter_condition_values'
133 id = Column(Integer, primary_key=True, nullable=False)
134 encounter_condition_id = Column(Integer, ForeignKey('encounter_conditions.id'), primary_key=False, nullable=False, autoincrement=False)
135 name = Column(Unicode(64), nullable=False)
136 is_default = Column(Boolean, nullable=False)
137
138 class EncounterConditionValueMap(TableBase):
139 """Maps encounters to the specific conditions under which they occur."""
140
141 __tablename__ = 'encounter_condition_value_map'
142 encounter_id = Column(Integer, ForeignKey('encounters.id'), primary_key=True, nullable=False, autoincrement=False)
143 encounter_condition_value_id = Column(Integer, ForeignKey('encounter_condition_values.id'), primary_key=True, nullable=False, autoincrement=False)
144
145 class EncounterTerrain(TableBase):
146 """Rows in this table represent ways the player can enter a wild encounter,
147 e.g., surfing, fishing, or walking through tall grass.
148 """
149
150 __tablename__ = 'encounter_terrain'
151 id = Column(Integer, primary_key=True, nullable=False)
152 name = Column(Unicode(64), nullable=False)
153
154 class EncounterSlot(TableBase):
155 """Rows in this table represent an abstract "slot" within a terrain,
156 associated with both some set of conditions and a rarity.
157
158 Note that there are two encounters per slot, so the rarities will only add
159 up to 50.
160 """
161
162 __tablename__ = 'encounter_slots'
163 id = Column(Integer, primary_key=True, nullable=False)
164 version_group_id = Column(Integer, ForeignKey('version_groups.id'), nullable=False, autoincrement=False)
165 encounter_terrain_id = Column(Integer, ForeignKey('encounter_terrain.id'), primary_key=False, nullable=False, autoincrement=False)
166 slot = Column(Integer, nullable=True)
167 rarity = Column(Integer, nullable=False)
168
169 class EncounterSlotCondition(TableBase):
170 """Lists all conditions that affect each slot."""
171
172 __tablename__ = 'encounter_slot_conditions'
173 encounter_slot_id = Column(Integer, ForeignKey('encounter_slots.id'), primary_key=True, nullable=False, autoincrement=False)
174 encounter_condition_id = Column(Integer, ForeignKey('encounter_conditions.id'), primary_key=True, nullable=False, autoincrement=False)
175
176 class EvolutionChain(TableBase):
177 __tablename__ = 'evolution_chains'
178 id = Column(Integer, primary_key=True, nullable=False)
179 growth_rate_id = Column(Integer, ForeignKey('growth_rates.id'), nullable=False)
180 steps_to_hatch = Column(Integer, nullable=False)
181 baby_trigger_item = Column(Unicode(12))
182
183 class EvolutionTrigger(TableBase):
184 __tablename__ = 'evolution_triggers'
185 id = Column(Integer, primary_key=True, nullable=False)
186 identifier = Column(Unicode(16), nullable=False)
187
188 class Experience(TableBase):
189 __tablename__ = 'experience'
190 growth_rate_id = Column(Integer, ForeignKey('growth_rates.id'), primary_key=True, nullable=False)
191 level = Column(Integer, primary_key=True, nullable=False, autoincrement=False)
192 experience = Column(Integer, nullable=False)
193
194 class Generation(TableBase):
195 __tablename__ = 'generations'
196 id = Column(Integer, primary_key=True, nullable=False)
197 main_region_id = Column(Integer, ForeignKey('regions.id'))
198 canonical_pokedex_id = Column(Integer, ForeignKey('pokedexes.id'))
199 name = Column(Unicode(16), nullable=False)
200
201 class GrowthRate(TableBase):
202 """`formula` is written in LaTeX math notation."""
203 __tablename__ = 'growth_rates'
204 id = Column(Integer, primary_key=True, nullable=False)
205 name = Column(Unicode(20), nullable=False)
206 formula = Column(Unicode(500), nullable=False)
207
208 class Item(TableBase):
209 __tablename__ = 'items'
210 __singlename__ = 'item'
211 id = Column(Integer, primary_key=True, nullable=False)
212 name = Column(Unicode(16), nullable=False)
213 category_id = Column(Integer, ForeignKey('item_categories.id'), nullable=False)
214 cost = Column(Integer, nullable=False)
215 fling_power = Column(Integer, nullable=True)
216 fling_effect_id = Column(Integer, ForeignKey('item_fling_effects.id'), nullable=True)
217 effect = Column(markdown.MarkdownColumn(5120), nullable=False)
218
219 @property
220 def appears_underground(self):
221 return any(flag.identifier == u'underground' for flag in self.flags)
222
223 class ItemCategory(TableBase):
224 __tablename__ = 'item_categories'
225 id = Column(Integer, primary_key=True, nullable=False)
226 pocket_id = Column(Integer, ForeignKey('item_pockets.id'), nullable=False)
227 name = Column(Unicode(16), nullable=False)
228
229 class ItemFlag(TableBase):
230 __tablename__ = 'item_flags'
231 id = Column(Integer, primary_key=True, nullable=False)
232 identifier = Column(Unicode(24), nullable=False)
233 name = Column(Unicode(64), nullable=False)
234
235 class ItemFlagMap(TableBase):
236 __tablename__ = 'item_flag_map'
237 item_id = Column(Integer, ForeignKey('items.id'), primary_key=True, autoincrement=False, nullable=False)
238 item_flag_id = Column(Integer, ForeignKey('item_flags.id'), primary_key=True, autoincrement=False, nullable=False)
239
240 class ItemFlavorText(TableBase):
241 __tablename__ = 'item_flavor_text'
242 item_id = Column(Integer, ForeignKey('items.id'), primary_key=True, autoincrement=False, nullable=False)
243 version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, autoincrement=False, nullable=False)
244 flavor_text = Column(Unicode(255), nullable=False)
245
246 class ItemFlingEffect(TableBase):
247 __tablename__ = 'item_fling_effects'
248 id = Column(Integer, primary_key=True, nullable=False)
249 effect = Column(Unicode(255), nullable=False)
250
251 class ItemInternalID(TableBase):
252 __tablename__ = 'item_internal_ids'
253 item_id = Column(Integer, ForeignKey('items.id'), primary_key=True, autoincrement=False, nullable=False)
254 generation_id = Column(Integer, ForeignKey('generations.id'), primary_key=True, autoincrement=False, nullable=False)
255 internal_id = Column(Integer, nullable=False)
256
257 class ItemPocket(TableBase):
258 __tablename__ = 'item_pockets'
259 id = Column(Integer, primary_key=True, nullable=False)
260 identifier = Column(Unicode(16), nullable=False)
261 name = Column(Unicode(16), nullable=False)
262
263 class Language(TableBase):
264 __tablename__ = 'languages'
265 id = Column(Integer, primary_key=True, nullable=False)
266 iso639 = Column(Unicode(2), nullable=False)
267 iso3166 = Column(Unicode(2), nullable=False)
268 name = Column(Unicode(16), nullable=False)
269
270 class Location(TableBase):
271 __tablename__ = 'locations'
272 __singlename__ = 'location'
273 id = Column(Integer, primary_key=True, nullable=False)
274 region_id = Column(Integer, ForeignKey('regions.id'))
275 name = Column(Unicode(64), nullable=False)
276
277 class LocationArea(TableBase):
278 __tablename__ = 'location_areas'
279 id = Column(Integer, primary_key=True, nullable=False)
280 location_id = Column(Integer, ForeignKey('locations.id'), nullable=False)
281 internal_id = Column(Integer, nullable=False)
282 name = Column(Unicode(64), nullable=True)
283
284 class LocationAreaEncounterRate(TableBase):
285 __tablename__ = 'location_area_encounter_rates'
286 location_area_id = Column(Integer, ForeignKey('location_areas.id'), primary_key=True, nullable=False, autoincrement=False)
287 encounter_terrain_id = Column(Integer, ForeignKey('encounter_terrain.id'), primary_key=True, nullable=False, autoincrement=False)
288 version_id = Column(Integer, ForeignKey('versions.id'), primary_key=True, autoincrement=False)
289 rate = Column(Integer, nullable=True)
290
291 class Machine(TableBase):
292 __tablename__ = 'machines'
293 machine_number = Column(Integer, primary_key=True, nullable=False, autoincrement=False)
294 version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, autoincrement=False)
295 item_id = Column(Integer, ForeignKey('items.id'), nullable=False)
296 move_id = Column(Integer, ForeignKey('moves.id'), nullable=False)
297
298 @property
299 def is_hm(self):
300 return self.machine_number >= 100
301
302 class MoveBattleStyle(TableBase):
303 __tablename__ = 'move_battle_styles'
304 id = Column(Integer, primary_key=True, nullable=False)
305 name = Column(Unicode(8), nullable=False)
306
307 class MoveEffectCategory(TableBase):
308 __tablename__ = 'move_effect_categories'
309 id = Column(Integer, primary_key=True, nullable=False)
310 name = Column(Unicode(64), nullable=False)
311 can_affect_user = Column(Boolean, nullable=False)
312
313 class MoveEffectCategoryMap(TableBase):
314 __tablename__ = 'move_effect_category_map'
315 move_effect_id = Column(Integer, ForeignKey('move_effects.id'), primary_key=True, nullable=False)
316 move_effect_category_id = Column(Integer, ForeignKey('move_effect_categories.id'), primary_key=True, nullable=False)
317 affects_user = Column(Boolean, primary_key=True, nullable=False)
318
319 class MoveDamageClass(TableBase):
320 __tablename__ = 'move_damage_classes'
321 id = Column(Integer, primary_key=True, nullable=False)
322 name = Column(Unicode(8), nullable=False)
323 description = Column(Unicode(64), nullable=False)
324
325 class MoveEffect(TableBase):
326 __tablename__ = 'move_effects'
327 id = Column(Integer, primary_key=True, nullable=False)
328 priority = Column(SmallInteger, nullable=False)
329 short_effect = Column(Unicode(256), nullable=False)
330 effect = Column(Unicode(5120), nullable=False)
331
332 class MoveFlag(TableBase):
333 __tablename__ = 'move_flags'
334 move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False)
335 move_flag_type_id = Column(Integer, ForeignKey('move_flag_types.id'), primary_key=True, nullable=False, autoincrement=False)
336
337 class MoveFlagType(TableBase):
338 __tablename__ = 'move_flag_types'
339 id = Column(Integer, primary_key=True, nullable=False)
340 name = Column(Unicode(32), nullable=False)
341 description = Column(markdown.MarkdownColumn(128), nullable=False)
342
343 class MoveFlavorText(TableBase):
344 __tablename__ = 'move_flavor_text'
345 move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False)
346 version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, autoincrement=False)
347 flavor_text = Column(Unicode(255), nullable=False)
348
349 class MoveName(TableBase):
350 __tablename__ = 'move_names'
351 move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False)
352 language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, autoincrement=False)
353 name = Column(Unicode(16), nullable=False)
354
355 class MoveTarget(TableBase):
356 __tablename__ = 'move_targets'
357 id = Column(Integer, primary_key=True, nullable=False)
358 name = Column(Unicode(32), nullable=False)
359 description = Column(Unicode(128), nullable=False)
360
361 class Move(TableBase):
362 __tablename__ = 'moves'
363 __singlename__ = 'move'
364 id = Column(Integer, primary_key=True, nullable=False)
365 name = Column(Unicode(12), nullable=False)
366 generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False)
367 type_id = Column(Integer, ForeignKey('types.id'), nullable=False)
368 power = Column(SmallInteger)
369 pp = Column(SmallInteger, nullable=False)
370 accuracy = Column(SmallInteger)
371 target_id = Column(Integer, ForeignKey('move_targets.id'), nullable=False)
372 damage_class_id = Column(Integer, ForeignKey('move_damage_classes.id'), nullable=False)
373 effect_id = Column(Integer, ForeignKey('move_effects.id'), nullable=False)
374 effect_chance = Column(Integer)
375 contest_type_id = Column(Integer, ForeignKey('contest_types.id'), nullable=True)
376 contest_effect_id = Column(Integer, ForeignKey('contest_effects.id'), nullable=True)
377 super_contest_effect_id = Column(Integer, ForeignKey('super_contest_effects.id'), nullable=False)
378
379 class Nature(TableBase):
380 __tablename__ = 'natures'
381 __singlename__ = 'nature'
382 id = Column(Integer, primary_key=True, nullable=False)
383 name = Column(Unicode(8), nullable=False)
384 decreased_stat_id = Column(Integer, ForeignKey('stats.id'), nullable=False)
385 increased_stat_id = Column(Integer, ForeignKey('stats.id'), nullable=False)
386 hates_flavor_id = Column(Integer, ForeignKey('contest_types.id'), nullable=False)
387 likes_flavor_id = Column(Integer, ForeignKey('contest_types.id'), nullable=False)
388
389 class NatureBattleStylePreference(TableBase):
390 __tablename__ = 'nature_battle_style_preferences'
391 nature_id = Column(Integer, ForeignKey('natures.id'), primary_key=True, nullable=False)
392 move_battle_style_id = Column(Integer, ForeignKey('move_battle_styles.id'), primary_key=True, nullable=False)
393 low_hp_preference = Column(Integer, nullable=False)
394 high_hp_preference = Column(Integer, nullable=False)
395
396 class NaturePokeathlonStat(TableBase):
397 __tablename__ = 'nature_pokeathlon_stats'
398 nature_id = Column(Integer, ForeignKey('natures.id'), primary_key=True, nullable=False)
399 pokeathlon_stat_id = Column(Integer, ForeignKey('pokeathlon_stats.id'), primary_key=True, nullable=False)
400 max_change = Column(Integer, nullable=False)
401
402 class PokeathlonStat(TableBase):
403 __tablename__ = 'pokeathlon_stats'
404 id = Column(Integer, primary_key=True, nullable=False)
405 name = Column(Unicode(8), nullable=False)
406
407 class Pokedex(TableBase):
408 __tablename__ = 'pokedexes'
409 id = Column(Integer, primary_key=True, nullable=False)
410 region_id = Column(Integer, ForeignKey('regions.id'), nullable=True)
411 name = Column(Unicode(16), nullable=False)
412 description = Column(Unicode(512))
413
414 class PokedexVersionGroup(TableBase):
415 __tablename__ = 'pokedex_version_groups'
416 pokedex_id = Column(Integer, ForeignKey('pokedexes.id'), primary_key=True, nullable=False, autoincrement=False)
417 version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, autoincrement=False)
418
419 class Pokemon(TableBase):
420 """The core to this whole mess.
421
422 Note that I use both 'forme' and 'form' in both code and the database. I
423 only use 'forme' when specifically referring to Pokémon that have multiple
424 distinct species as forms—i.e., different stats or movesets. 'Form' is a
425 more general term referring to any variation within a species, including
426 purely cosmetic forms like Unown.
427 """
428 __tablename__ = 'pokemon'
429 __singlename__ = 'pokemon'
430 id = Column(Integer, primary_key=True, nullable=False)
431 name = Column(Unicode(20), nullable=False)
432 forme_name = Column(Unicode(16))
433 forme_base_pokemon_id = Column(Integer, ForeignKey('pokemon.id'))
434 generation_id = Column(Integer, ForeignKey('generations.id'))
435 evolution_chain_id = Column(Integer, ForeignKey('evolution_chains.id'))
436 height = Column(Integer, nullable=False)
437 weight = Column(Integer, nullable=False)
438 species = Column(Unicode(16), nullable=False)
439 color_id = Column(Integer, ForeignKey('pokemon_colors.id'), nullable=False)
440 pokemon_shape_id = Column(Integer, ForeignKey('pokemon_shapes.id'), nullable=False)
441 habitat_id = Column(Integer, ForeignKey('pokemon_habitats.id'), nullable=True)
442 gender_rate = Column(Integer, nullable=False)
443 capture_rate = Column(Integer, nullable=False)
444 base_experience = Column(Integer, nullable=False)
445 base_happiness = Column(Integer, nullable=False)
446 is_baby = Column(Boolean, nullable=False)
447 has_gen4_fem_sprite = Column(Boolean, nullable=False)
448 has_gen4_fem_back_sprite = Column(Boolean, nullable=False)
449
450 ### Stuff to handle alternate Pokémon forms
451
452 @property
453 def national_id(self):
454 """Returns the National Pokédex number for this Pokémon. Use this
455 instead of the id directly; alternate formes may make the id incorrect.
456 """
457
458 if self.forme_base_pokemon_id:
459 return self.forme_base_pokemon_id
460 return self.id
461
462 @property
463 def full_name(self):
464 """Returns the name of this Pokémon, including its Forme, if any."""
465
466 if self.forme_name:
467 return "%s %s" % (self.forme_name.title(), self.name)
468 return self.name
469
470 @property
471 def normal_form(self):
472 """Returns the normal form for this Pokémon; i.e., this will return
473 regular Deoxys when called on any Deoxys form.
474 """
475
476 if self.forme_base_pokemon:
477 return self.forme_base_pokemon
478
479 return self
480
481 ### Not forms!
482
483 def stat(self, stat_name):
484 """Returns a PokemonStat record for the given stat name (or Stat row
485 object). Uses the normal has-many machinery, so all the stats are
486 effectively cached.
487 """
488 if isinstance(stat_name, Stat):
489 stat_name = stat_name.name
490
491 for pokemon_stat in self.stats:
492 if pokemon_stat.stat.name == stat_name:
493 return pokemon_stat
494
495 raise KeyError(u'No stat named %s' % stat_name)
496
497 @property
498 def better_damage_class(self):
499 u"""Returns the MoveDamageClass that this Pokémon is best suited for,
500 based on its attack stats.
501
502 If the attack stats are about equal (within 5), returns None. The
503 value None, not the damage class called 'None'.
504 """
505 phys = self.stat(u'Attack')
506 spec = self.stat(u'Special Attack')
507
508 diff = phys.base_stat - spec.base_stat
509
510 if diff > 5:
511 return phys.stat.damage_class
512 elif diff < -5:
513 return spec.stat.damage_class
514 else:
515 return None
516
517 class PokemonAbility(TableBase):
518 __tablename__ = 'pokemon_abilities'
519 pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
520 ability_id = Column(Integer, ForeignKey('abilities.id'), nullable=False)
521 slot = Column(Integer, primary_key=True, nullable=False, autoincrement=False)
522
523 class PokemonColor(TableBase):
524 __tablename__ = 'pokemon_colors'
525 id = Column(Integer, primary_key=True, nullable=False, autoincrement=False)
526 name = Column(Unicode(6), nullable=False)
527
528 class PokemonDexNumber(TableBase):
529 __tablename__ = 'pokemon_dex_numbers'
530 pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
531 pokedex_id = Column(Integer, ForeignKey('pokedexes.id'), primary_key=True, nullable=False, autoincrement=False)
532 pokedex_number = Column(Integer, nullable=False)
533
534 class PokemonEggGroup(TableBase):
535 __tablename__ = 'pokemon_egg_groups'
536 pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
537 egg_group_id = Column(Integer, ForeignKey('egg_groups.id'), primary_key=True, nullable=False, autoincrement=False)
538
539 class PokemonEvolution(TableBase):
540 __tablename__ = 'pokemon_evolution'
541 from_pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=False)
542 to_pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
543 evolution_trigger_id = Column(Integer, ForeignKey('evolution_triggers.id'), nullable=False)
544 trigger_item_id = Column(Integer, ForeignKey('items.id'), nullable=True)
545 minimum_level = Column(Integer, nullable=True)
546 gender = Column(Enum('male', 'female', name='pokemon_evolution_gender'), nullable=True)
547 location_id = Column(Integer, ForeignKey('locations.id'), nullable=True)
548 held_item_id = Column(Integer, ForeignKey('items.id'), nullable=True)
549 time_of_day = Column(Enum('morning', 'day', 'night', name='pokemon_evolution_time_of_day'), nullable=True)
550 known_move_id = Column(Integer, ForeignKey('moves.id'), nullable=True)
551 minimum_happiness = Column(Integer, nullable=True)
552 minimum_beauty = Column(Integer, nullable=True)
553 relative_physical_stats = Column(Integer, nullable=True)
554 party_pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=True)
555
556 class PokemonFlavorText(TableBase):
557 __tablename__ = 'pokemon_flavor_text'
558 pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
559 version_id = Column(Integer, ForeignKey('versions.id'), primary_key=True, nullable=False, autoincrement=False)
560 flavor_text = Column(Unicode(255), nullable=False)
561
562 class PokemonFormGroup(TableBase):
563 __tablename__ = 'pokemon_form_groups'
564 pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
565 is_battle_only = Column(Boolean, nullable=False)
566 description = Column(rst.RstTextColumn(1024), nullable=False)
567
568 class PokemonFormSprite(TableBase):
569 __tablename__ = 'pokemon_form_sprites'
570 id = Column(Integer, primary_key=True, nullable=False)
571 pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
572 introduced_in_version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, autoincrement=False)
573 name = Column(Unicode(16), nullable=True)
574 is_default = Column(Boolean, nullable=True)
575
576 class PokemonHabitat(TableBase):
577 __tablename__ = 'pokemon_habitats'
578 id = Column(Integer, primary_key=True, nullable=False, autoincrement=False)
579 name = Column(Unicode(16), nullable=False)
580
581 class PokemonItem(TableBase):
582 __tablename__ = 'pokemon_items'
583 pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
584 version_id = Column(Integer, ForeignKey('versions.id'), primary_key=True, nullable=False, autoincrement=False)
585 item_id = Column(Integer, ForeignKey('items.id'), primary_key=True, nullable=False, autoincrement=False)
586 rarity = Column(Integer, nullable=False)
587
588 class PokemonMove(TableBase):
589 __tablename__ = 'pokemon_moves'
590 pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
591 version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False, autoincrement=False)
592 move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False, index=True)
593 pokemon_move_method_id = Column(Integer, ForeignKey('pokemon_move_methods.id'), primary_key=True, nullable=False, autoincrement=False)
594 level = Column(Integer, primary_key=True, nullable=True, autoincrement=False, index=True)
595 order = Column(Integer, nullable=True, index=True)
596
597 class PokemonMoveMethod(TableBase):
598 __tablename__ = 'pokemon_move_methods'
599 id = Column(Integer, primary_key=True, nullable=False, autoincrement=False)
600 name = Column(Unicode(64), nullable=False)
601 description = Column(Unicode(255), nullable=False)
602
603 class PokemonName(TableBase):
604 __tablename__ = 'pokemon_names'
605 pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
606 language_id = Column(Integer, ForeignKey('languages.id'), primary_key=True, nullable=False, autoincrement=False)
607 name = Column(Unicode(16), nullable=False)
608
609 class PokemonShape(TableBase):
610 __tablename__ = 'pokemon_shapes'
611 id = Column(Integer, primary_key=True, nullable=False)
612 name = Column(Unicode(24), nullable=False)
613 awesome_name = Column(Unicode(16), nullable=False)
614
615 class PokemonStat(TableBase):
616 __tablename__ = 'pokemon_stats'
617 pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
618 stat_id = Column(Integer, ForeignKey('stats.id'), primary_key=True, nullable=False, autoincrement=False)
619 base_stat = Column(Integer, nullable=False)
620 effort = Column(Integer, nullable=False)
621
622 class PokemonType(TableBase):
623 __tablename__ = 'pokemon_types'
624 pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
625 type_id = Column(Integer, ForeignKey('types.id'), nullable=False)
626 slot = Column(Integer, primary_key=True, nullable=False, autoincrement=False)
627
628 class Region(TableBase):
629 """Major areas of the world: Kanto, Johto, etc."""
630 __tablename__ = 'regions'
631 id = Column(Integer, primary_key=True, nullable=False)
632 name = Column(Unicode(16), nullable=False)
633
634 class Stat(TableBase):
635 __tablename__ = 'stats'
636 id = Column(Integer, primary_key=True, nullable=False)
637 damage_class_id = Column(Integer, ForeignKey('move_damage_classes.id'), nullable=True)
638 name = Column(Unicode(16), nullable=False)
639
640 class SuperContestCombo(TableBase):
641 __tablename__ = 'super_contest_combos'
642 first_move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False)
643 second_move_id = Column(Integer, ForeignKey('moves.id'), primary_key=True, nullable=False, autoincrement=False)
644
645 class SuperContestEffect(TableBase):
646 __tablename__ = 'super_contest_effects'
647 id = Column(Integer, primary_key=True, nullable=False)
648 appeal = Column(SmallInteger, nullable=False)
649 flavor_text = Column(Unicode(64), nullable=False)
650
651 class TypeEfficacy(TableBase):
652 __tablename__ = 'type_efficacy'
653 damage_type_id = Column(Integer, ForeignKey('types.id'), primary_key=True, nullable=False, autoincrement=False)
654 target_type_id = Column(Integer, ForeignKey('types.id'), primary_key=True, nullable=False, autoincrement=False)
655 damage_factor = Column(Integer, nullable=False)
656
657 class Type(TableBase):
658 __tablename__ = 'types'
659 __singlename__ = 'type'
660 id = Column(Integer, primary_key=True, nullable=False)
661 name = Column(Unicode(8), nullable=False)
662 abbreviation = Column(Unicode(3), nullable=False)
663 generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False)
664 damage_class_id = Column(Integer, ForeignKey('move_damage_classes.id'), nullable=False) ## ??? is none; everything else is physical or special
665
666 class VersionGroup(TableBase):
667 __tablename__ = 'version_groups'
668 id = Column(Integer, primary_key=True, nullable=False)
669 generation_id = Column(Integer, ForeignKey('generations.id'), nullable=False)
670
671 class VersionGroupRegion(TableBase):
672 __tablename__ = 'version_group_regions'
673 version_group_id = Column(Integer, ForeignKey('version_groups.id'), primary_key=True, nullable=False)
674 region_id = Column(Integer, ForeignKey('regions.id'), primary_key=True, nullable=False)
675
676 class Version(TableBase):
677 __tablename__ = 'versions'
678 id = Column(Integer, primary_key=True, nullable=False)
679 version_group_id = Column(Integer, ForeignKey('version_groups.id'), nullable=False)
680 name = Column(Unicode(32), nullable=False)
681
682
683 ### Relations down here, to avoid ordering problems
684 Ability.flavor_text = relation(AbilityFlavorText, order_by=AbilityFlavorText.version_group_id, backref='ability')
685 Ability.foreign_names = relation(AbilityName, backref='ability')
686 Ability.generation = relation(Generation, backref='abilities')
687
688 AbilityFlavorText.version_group = relation(VersionGroup)
689
690 AbilityName.language = relation(Language)
691
692 Berry.berry_firmness = relation(BerryFirmness, backref='berries')
693 Berry.firmness = association_proxy('berry_firmness', 'name')
694 Berry.flavors = relation(BerryFlavor, order_by=BerryFlavor.contest_type_id, backref='berry')
695 Berry.natural_gift_type = relation(Type)
696
697 BerryFlavor.contest_type = relation(ContestType)
698
699 ContestCombo.first = relation(Move, primaryjoin=ContestCombo.first_move_id==Move.id,
700 backref='contest_combo_first')
701 ContestCombo.second = relation(Move, primaryjoin=ContestCombo.second_move_id==Move.id,
702 backref='contest_combo_second')
703
704 Encounter.location_area = relation(LocationArea, backref='encounters')
705 Encounter.pokemon = relation(Pokemon, backref='encounters')
706 Encounter.version = relation(Version, backref='encounters')
707 Encounter.slot = relation(EncounterSlot, backref='encounters')
708
709 EncounterConditionValue.condition = relation(EncounterCondition, backref='values')
710
711 Encounter.condition_value_map = relation(EncounterConditionValueMap, backref='encounter')
712 Encounter.condition_values = association_proxy('condition_value_map', 'condition_value')
713 EncounterConditionValueMap.condition_value = relation(EncounterConditionValue,
714 backref='encounter_map')
715
716 EncounterSlot.terrain = relation(EncounterTerrain, backref='slots')
717
718 EncounterSlot.condition_map = relation(EncounterSlotCondition, backref='slot')
719 EncounterSlot.conditions = association_proxy('condition_map', 'condition')
720 EncounterSlotCondition.condition = relation(EncounterCondition,
721 backref='slot_map')
722
723 EvolutionChain.growth_rate = relation(GrowthRate, backref='evolution_chains')
724
725 Experience.growth_rate = relation(GrowthRate, backref='experience_table')
726
727 Generation.canonical_pokedex = relation(Pokedex, backref='canonical_for_generation')
728 Generation.versions = relation(Version, secondary=VersionGroup.__table__)
729 Generation.main_region = relation(Region)
730
731 GrowthRate.max_experience_obj = relation(Experience, primaryjoin=and_(Experience.growth_rate_id == GrowthRate.id, Experience.level == 100), uselist=False)
732 GrowthRate.max_experience = association_proxy('max_experience_obj', 'experience')
733
734 Item.berry = relation(Berry, uselist=False, backref='item')
735 Item.flags = relation(ItemFlag, secondary=ItemFlagMap.__table__)
736 Item.flavor_text = relation(ItemFlavorText, order_by=ItemFlavorText.version_group_id.asc(), backref='item')
737 Item.fling_effect = relation(ItemFlingEffect, backref='items')
738 Item.machines = relation(Machine, order_by=Machine.version_group_id.asc())
739 Item.category = relation(ItemCategory)
740 Item.pocket = association_proxy('category', 'pocket')
741
742 ItemCategory.items = relation(Item, order_by=Item.name)
743 ItemCategory.pocket = relation(ItemPocket)
744
745 ItemFlavorText.version_group = relation(VersionGroup)
746
747 ItemPocket.categories = relation(ItemCategory, order_by=ItemCategory.name)
748
749 Location.region = relation(Region, backref='locations')
750
751 LocationArea.location = relation(Location, backref='areas')
752
753 Machine.item = relation(Item)
754 Machine.version_group = relation(VersionGroup)
755
756 Move.contest_effect = relation(ContestEffect, backref='moves')
757 Move.contest_combo_next = association_proxy('contest_combo_first', 'second')
758 Move.contest_combo_prev = association_proxy('contest_combo_second', 'first')
759 Move.contest_type = relation(ContestType, backref='moves')
760 Move.damage_class = relation(MoveDamageClass, backref='moves')
761 Move.flags = association_proxy('move_flags', 'flag')
762 Move.flavor_text = relation(MoveFlavorText, order_by=MoveFlavorText.version_group_id, backref='move')
763 Move.foreign_names = relation(MoveName, backref='move')
764 Move.generation = relation(Generation, backref='moves')
765 Move.machines = relation(Machine, backref='move')
766 Move.move_effect = relation(MoveEffect, backref='moves')
767 Move.move_flags = relation(MoveFlag, backref='move')
768 Move.super_contest_effect = relation(SuperContestEffect, backref='moves')
769 Move.super_contest_combo_next = association_proxy('super_contest_combo_first', 'second')
770 Move.super_contest_combo_prev = association_proxy('super_contest_combo_second', 'first')
771 Move.target = relation(MoveTarget, backref='moves')
772 Move.type = relation(Type, backref='moves')
773
774 Move.effect = markdown.MoveEffectProperty('effect')
775 Move.priority = association_proxy('move_effect', 'priority')
776 Move.short_effect = markdown.MoveEffectProperty('short_effect')
777
778 MoveEffect.category_map = relation(MoveEffectCategoryMap)
779 MoveEffect.categories = association_proxy('category_map', 'category')
780 MoveEffectCategoryMap.category = relation(MoveEffectCategory)
781
782 MoveFlag.flag = relation(MoveFlagType)
783
784 MoveFlavorText.version_group = relation(VersionGroup)
785
786 MoveName.language = relation(Language)
787
788 Nature.decreased_stat = relation(Stat, primaryjoin=Nature.decreased_stat_id==Stat.id,
789 backref='decreasing_natures')
790 Nature.increased_stat = relation(Stat, primaryjoin=Nature.increased_stat_id==Stat.id,
791 backref='increasing_natures')
792 Nature.hates_flavor = relation(ContestType, primaryjoin=Nature.hates_flavor_id==ContestType.id,
793 backref='hating_natures')
794 Nature.likes_flavor = relation(ContestType, primaryjoin=Nature.likes_flavor_id==ContestType.id,
795 backref='liking_natures')
796 Nature.battle_style_preferences = relation(NatureBattleStylePreference,
797 order_by=NatureBattleStylePreference.move_battle_style_id,
798 backref='nature')
799 Nature.pokeathlon_effects = relation(NaturePokeathlonStat, order_by=NaturePokeathlonStat.pokeathlon_stat_id)
800
801 NatureBattleStylePreference.battle_style = relation(MoveBattleStyle, backref='nature_preferences')
802
803 NaturePokeathlonStat.pokeathlon_stat = relation(PokeathlonStat, backref='nature_effects')
804
805 Pokedex.region = relation(Region, backref='pokedexes')
806 Pokedex.version_groups = relation(VersionGroup, secondary=PokedexVersionGroup.__table__, backref='pokedexes')
807
808 Pokemon.abilities = relation(Ability, secondary=PokemonAbility.__table__,
809 order_by=PokemonAbility.slot,
810 backref='pokemon')
811 Pokemon.formes = relation(Pokemon, primaryjoin=Pokemon.id==Pokemon.forme_base_pokemon_id,
812 backref=backref('forme_base_pokemon',
813 remote_side=[Pokemon.id]))
814 Pokemon.pokemon_color = relation(PokemonColor, backref='pokemon')
815 Pokemon.color = association_proxy('pokemon_color', 'name')
816 Pokemon.dex_numbers = relation(PokemonDexNumber, backref='pokemon')
817 Pokemon.default_form_sprite = relation(PokemonFormSprite,
818 primaryjoin=and_(
819 Pokemon.id==PokemonFormSprite.pokemon_id,
820 PokemonFormSprite.is_default==True,
821 ),
822 uselist=False)
823 Pokemon.egg_groups = relation(EggGroup, secondary=PokemonEggGroup.__table__,
824 order_by=PokemonEggGroup.egg_group_id,
825 backref='pokemon')
826 Pokemon.evolution_chain = relation(EvolutionChain, backref='pokemon')
827 Pokemon.child_pokemon = relation(Pokemon,
828 primaryjoin=Pokemon.id==PokemonEvolution.from_pokemon_id,
829 secondary=PokemonEvolution.__table__,
830 secondaryjoin=PokemonEvolution.to_pokemon_id==Pokemon.id,
831 backref=backref('parent_pokemon', uselist=False),
832 )
833 Pokemon.flavor_text = relation(PokemonFlavorText, order_by=PokemonFlavorText.version_id.asc(), backref='pokemon')
834 Pokemon.foreign_names = relation(PokemonName, backref='pokemon')
835 Pokemon.pokemon_habitat = relation(PokemonHabitat, backref='pokemon')
836 Pokemon.habitat = association_proxy('pokemon_habitat', 'name')
837 Pokemon.items = relation(PokemonItem, backref='pokemon')
838 Pokemon.generation = relation(Generation, backref='pokemon')
839 Pokemon.shape = relation(PokemonShape, backref='pokemon')
840 Pokemon.stats = relation(PokemonStat, backref='pokemon')
841 Pokemon.types = relation(Type, secondary=PokemonType.__table__, order_by=PokemonType.slot.asc())
842
843 PokemonDexNumber.pokedex = relation(Pokedex)
844
845 PokemonEvolution.from_pokemon = relation(Pokemon,
846 primaryjoin=PokemonEvolution.from_pokemon_id==Pokemon.id,
847 backref='child_evolutions',
848 )
849 PokemonEvolution.to_pokemon = relation(Pokemon,
850 primaryjoin=PokemonEvolution.to_pokemon_id==Pokemon.id,
851 backref=backref('parent_evolution', uselist=False),
852 )
853 PokemonEvolution.child_evolutions = relation(PokemonEvolution,
854 primaryjoin=PokemonEvolution.from_pokemon_id==PokemonEvolution.to_pokemon_id,
855 foreign_keys=[PokemonEvolution.to_pokemon_id],
856 backref=backref('parent_evolution',
857 remote_side=[PokemonEvolution.from_pokemon_id],
858 uselist=False,
859 ),
860 )
861 PokemonEvolution.trigger = relation(EvolutionTrigger, backref='evolutions')
862 PokemonEvolution.trigger_item = relation(Item,
863 primaryjoin=PokemonEvolution.trigger_item_id==Item.id,
864 backref='triggered_evolutions',
865 )
866 PokemonEvolution.held_item = relation(Item,
867 primaryjoin=PokemonEvolution.held_item_id==Item.id,
868 backref='required_for_evolutions',
869 )
870 PokemonEvolution.location = relation(Location, backref='triggered_evolutions')
871 PokemonEvolution.known_move = relation(Move, backref='triggered_evolutions')
872 PokemonEvolution.party_pokemon = relation(Pokemon,
873 primaryjoin=PokemonEvolution.party_pokemon_id==Pokemon.id,
874 backref='triggered_evolutions',
875 )
876
877 PokemonFlavorText.version = relation(Version)
878
879 PokemonItem.item = relation(Item, backref='pokemon')
880 PokemonItem.version = relation(Version)
881
882 PokemonFormGroup.pokemon = relation(Pokemon, backref=backref('form_group',
883 uselist=False))
884 PokemonFormSprite.pokemon = relation(Pokemon, backref='form_sprites')
885 PokemonFormSprite.introduced_in = relation(VersionGroup)
886
887 PokemonMove.pokemon = relation(Pokemon, backref='pokemon_moves')
888 PokemonMove.version_group = relation(VersionGroup)
889 PokemonMove.machine = relation(Machine, backref='pokemon_moves',
890 primaryjoin=and_(Machine.version_group_id==PokemonMove.version_group_id,
891 Machine.move_id==PokemonMove.move_id),
892 foreign_keys=[Machine.version_group_id, Machine.move_id],
893 uselist=False)
894 PokemonMove.move = relation(Move, backref='pokemon_moves')
895 PokemonMove.method = relation(PokemonMoveMethod)
896
897 PokemonName.language = relation(Language)
898
899 PokemonStat.stat = relation(Stat)
900
901 # This is technically a has-many; Generation.main_region_id -> Region.id
902 Region.generation = relation(Generation, uselist=False)
903 Region.version_group_regions = relation(VersionGroupRegion, backref='region',
904 order_by='VersionGroupRegion.version_group_id')
905 Region.version_groups = association_proxy('version_group_regions', 'version_group')
906
907 Stat.damage_class = relation(MoveDamageClass, backref='stats')
908
909 SuperContestCombo.first = relation(Move, primaryjoin=SuperContestCombo.first_move_id==Move.id,
910 backref='super_contest_combo_first')
911 SuperContestCombo.second = relation(Move, primaryjoin=SuperContestCombo.second_move_id==Move.id,
912 backref='super_contest_combo_second')
913
914 Type.damage_efficacies = relation(TypeEfficacy,
915 primaryjoin=Type.id
916 ==TypeEfficacy.damage_type_id,
917 backref='damage_type')
918 Type.target_efficacies = relation(TypeEfficacy,
919 primaryjoin=Type.id
920 ==TypeEfficacy.target_type_id,
921 backref='target_type')
922
923 Type.generation = relation(Generation, backref='types')
924 Type.damage_class = relation(MoveDamageClass, backref='types')
925
926 Version.version_group = relation(VersionGroup, backref='versions')
927 Version.generation = association_proxy('version_group', 'generation')
928
929 VersionGroup.generation = relation(Generation, backref='version_groups')
930 VersionGroup.version_group_regions = relation(VersionGroupRegion, backref='version_group')
931 VersionGroup.regions = association_proxy('version_group_regions', 'region')