mirror of
https://github.com/veekun/pokedex.git
synced 2024-08-20 18:16:34 +00:00
053f2a8d22
Specifically: - Add support for detecting FLIM format - Add support for more color formats - Add a small decoded image type that knows how to write itself out as a PNG - Improve ETC1 decoder to work with images whose dimensions are not powers of two, images with no alpha channel, and images with the strange FLIM pixel order - Port the gen 6/7 extractor to Construct 2.8 - Switch to using script tags in language names, to distinguish Japanese kana from kanji and Simplified from Traditional Chinese - Drop the load-time merging of kanji and kana - Add paths to various text files in SUMO - Add form names for SUMO Pokémon - Clean up identifiers a bit, especially the distinction between species and Pokémon - Use the Pokémon schema type to dump what we have so far, and give it a couple more fields that didn't exist in gen 1 - Get movesets dumping correctly - Special-case a bunch of weirdness, where the number of dex sprites doesn't match the number of models in SUMO
370 lines
12 KiB
Python
370 lines
12 KiB
Python
# TODO eventually this file should be split up a bit, perhaps with the camel
|
|
# stuff and locus stuff in its own file
|
|
from collections import defaultdict
|
|
from collections import OrderedDict
|
|
from pprint import pprint
|
|
import types
|
|
|
|
import camel
|
|
|
|
|
|
class _Attribute:
|
|
name = None
|
|
_creation_order = 0
|
|
|
|
def __init__(self):
|
|
self._creation_order = _Attribute._creation_order
|
|
_Attribute._creation_order += 1
|
|
|
|
def __get__(self, inst, owner):
|
|
# TODO this is intended for the glom object, not a slice
|
|
return self.Glommed(self, inst)
|
|
|
|
def __set_name__(self, cls, name):
|
|
self.name = name
|
|
|
|
class Glommed:
|
|
def __init__(self, prop, obj):
|
|
self.prop = prop
|
|
self.obj = obj
|
|
|
|
def __repr__(self):
|
|
return "<{} of {!r}.{}: {!r}>".format(
|
|
type(self).__qualname__,
|
|
self.obj,
|
|
self.prop.name,
|
|
{game: getattr(slice, self.prop.name) for game, slice in self.obj._slices.items()},
|
|
)
|
|
|
|
|
|
# TODO classtools, key sort by _creation_order
|
|
|
|
|
|
class _Value(_Attribute):
|
|
def __init__(self, type, min=None, max=None):
|
|
super().__init__()
|
|
self.type = type
|
|
# TODO only make sense for comparable types
|
|
self.min = min
|
|
self.max = max
|
|
|
|
|
|
class _List(_Attribute):
|
|
def __init__(self, type, min=None, max=None):
|
|
super().__init__()
|
|
self.type = type
|
|
self.min = min
|
|
self.max = max
|
|
|
|
|
|
class _Map(_Attribute):
|
|
def __init__(self, key_type, value_type):
|
|
super().__init__()
|
|
self.key_type = key_type
|
|
self.value_type = value_type
|
|
|
|
|
|
class _Localized(_Attribute):
|
|
def __init__(self, value_type):
|
|
super().__init__()
|
|
self.value_type = value_type
|
|
|
|
|
|
class _ForwardDeclaration:
|
|
pass
|
|
|
|
|
|
class Slice:
|
|
is_slice = True
|
|
|
|
def __init__(self):
|
|
pass
|
|
|
|
|
|
class LocusMeta(type):
|
|
# This is purely a backport of Python 3.6 functionality, and is taken from
|
|
# PEP 487. Once the minimum version supported is 3.6, this metaclass can
|
|
# go away entirely.
|
|
if not hasattr(object, '__init_subclass__'):
|
|
def __new__(cls, *args, **kwargs):
|
|
if len(args) != 3:
|
|
return super().__new__(cls, *args)
|
|
name, bases, ns = args
|
|
init = ns.get('__init_subclass__')
|
|
if isinstance(init, types.FunctionType):
|
|
ns['__init_subclass__'] = classmethod(init)
|
|
else:
|
|
init = None
|
|
self = super().__new__(cls, name, bases, ns)
|
|
for k, v in self.__dict__.items():
|
|
func = getattr(v, '__set_name__', None)
|
|
if func is not None:
|
|
func(self, k)
|
|
sup = super(self, self)
|
|
if hasattr(sup, '__init_subclass__'):
|
|
sup.__init_subclass__(**kwargs)
|
|
return self
|
|
|
|
def __init__(cls, *args, **kwargs):
|
|
super().__init__(*args)
|
|
|
|
|
|
class Locus(metaclass=LocusMeta):
|
|
_attributes = {}
|
|
|
|
def __init_subclass__(cls, *, sliced_by=(), **kwargs):
|
|
# super().__init_subclass__(**kwargs)
|
|
# TODO how... do i... make an attribute on the class that's not inherited by instances
|
|
cls.sliced_by = sliced_by
|
|
cls._attributes = cls._attributes.copy()
|
|
for key, value in cls.__dict__.items():
|
|
if isinstance(value, _Attribute):
|
|
cls._attributes[key] = value
|
|
|
|
def __init__(self, **kwargs):
|
|
cls = type(self)
|
|
|
|
for key, value in kwargs.items():
|
|
if not isinstance(getattr(cls, key, None), _Attribute):
|
|
raise TypeError("Unexpected argument: {!r}".format(key))
|
|
|
|
setattr(self, key, value)
|
|
|
|
def __repr__(self):
|
|
return "<{}: {}>".format(
|
|
type(self).__qualname__,
|
|
'???', # TODO where is self.identifier assigned when writing?
|
|
)
|
|
|
|
|
|
class VersionedLocus(Locus, sliced_by=['game']):
|
|
def __init_subclass__(cls, **kwargs):
|
|
super(VersionedLocus, cls).__init_subclass__(**kwargs)
|
|
|
|
if not issubclass(cls, Slice):
|
|
class Sliced(cls, Slice):
|
|
base_class = cls
|
|
|
|
# TODO this is a circular reference; do i care?
|
|
cls.Sliced = Sliced
|
|
|
|
cls._slices = {}
|
|
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Loci definitions
|
|
|
|
# TODO seems to me that each of these, regardless of whether they have any
|
|
# additional data attached or not, are restricted to a fixed extra-game-ular
|
|
# list of identifiers
|
|
Type = _ForwardDeclaration()
|
|
Stat = _ForwardDeclaration()
|
|
GrowthRate = _ForwardDeclaration()
|
|
Evolution = _ForwardDeclaration()
|
|
EncounterMap = _ForwardDeclaration()
|
|
MoveSet = _ForwardDeclaration()
|
|
Pokedex = _ForwardDeclaration()
|
|
Item = _ForwardDeclaration()
|
|
Ability = _ForwardDeclaration()
|
|
|
|
|
|
class Pokémon(VersionedLocus):
|
|
name = _Localized(str)
|
|
|
|
types = _List(Type, min=1, max=2)
|
|
base_stats = _Map(Stat, int)
|
|
growth_rate = _Value(GrowthRate)
|
|
base_experience = _Value(int, min=0, max=255)
|
|
capture_rate = _Value(int, min=0, max=255)
|
|
held_items = _Map(Item, int)
|
|
gender_rate = _Value(int)
|
|
|
|
pokedex_numbers = _Map(Pokedex, int)
|
|
|
|
# TODO family?
|
|
evolutions = _List(Evolution)
|
|
|
|
genus = _Localized(str)
|
|
flavor_text = _Localized(str)
|
|
# TODO maybe want little wrapper types that can display as either imperial
|
|
# or metric
|
|
# TODO maybe also dump as metric rather than plain numbers
|
|
# Inches and pounds are both defined as exact numbers of centimeters and
|
|
# kilograms respectively, so this uses the largest units that can represent
|
|
# both metric and imperial values as integers with no loss of precision:
|
|
# myriameters (tenths of a millimeter) and micrograms.
|
|
# Divide by 100 for centimeters, or by 254 for inches
|
|
height = _Localized(int)
|
|
# Divide by one billion for kilograms, or by 453592370 for pounds
|
|
weight = _Localized(int)
|
|
|
|
# TODO this belongs to a place, not to a pokemon
|
|
#encounters = _Value(EncounterMap)
|
|
|
|
# TODO having a custom type here is handy, but it's not a locus
|
|
moves = _Value(MoveSet)
|
|
|
|
# TODO should this be written in hex, maybe?
|
|
game_index = _Value(int)
|
|
|
|
# FIXME how do i distinguish hidden ability?
|
|
abilities = _List(Ability)
|
|
|
|
Pokemon = Pokémon
|
|
|
|
|
|
MoveEffect = _ForwardDeclaration()
|
|
|
|
class Move(VersionedLocus):
|
|
name = _Localized(str)
|
|
type = _Value(Type)
|
|
power = _Value(int)
|
|
pp = _Value(int)
|
|
accuracy = _Value(int)
|
|
effect = _Value(MoveEffect)
|
|
|
|
|
|
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# The repository class, primary interface to the data
|
|
|
|
class LocusReader:
|
|
def __init__(self, identifier, locus, **kwargs):
|
|
self.identifier = identifier
|
|
self.locus = locus
|
|
# TODO what is kwargs here? in this case we really want a slice, right...?
|
|
|
|
def __getattr__(self):
|
|
pass
|
|
|
|
def __dir__(self):
|
|
pass
|
|
|
|
class QuantumProperty:
|
|
def __init__(self, qlocus, attr):
|
|
self.qlocus = qlocus
|
|
self.attr = attr
|
|
|
|
def __repr__(self):
|
|
return repr({key: getattr(locus, self.attr) for (key, locus) in self.qlocus.locus_map.items()})
|
|
|
|
class QuantumLocusReader:
|
|
def __init__(self, identifier, locus_cls, locus_map):
|
|
self.identifier = identifier
|
|
self.locus_cls = locus_cls
|
|
self.locus_map = locus_map
|
|
|
|
def __getattr__(self, attr):
|
|
return QuantumProperty(self, attr)
|
|
|
|
def __repr__(self):
|
|
return "<{}*: {}>".format(self.locus_cls.__name__, self.identifier)
|
|
|
|
class Repository:
|
|
def __init__(self):
|
|
# type -> identifier -> object
|
|
self.objects = defaultdict(lambda: {})
|
|
# type -> property -> value -> list of objects
|
|
self.index = defaultdict(lambda: defaultdict(lambda: defaultdict(set)))
|
|
|
|
def add(self, identifier, locus, **kwargs):
|
|
# TODO kwargs are used for slicing, e.g. a pokemon has a game, but this needs some rigid definition
|
|
# TODO this should be declared by the type itself, obviously
|
|
cls = type(locus)
|
|
_basket = self.objects[cls].setdefault(identifier, {})
|
|
# TODO so in the case of slicing (which is most loci), we don't
|
|
# actually want to store a single object, but a sliced-up collection of
|
|
# them (indicated by kwargs). but then it's kind of up in the air what
|
|
# we'll actually get /back/ when we go to fetch that object, and that
|
|
# is unsatisfying to me. i could make this a list of "baskets", which
|
|
# may hold one object or a number of slices, but i'm not sure how i
|
|
# feel about that; might have to just see how other loci work out.
|
|
# TODO either way, this is very hardcoded and needs to not be
|
|
_basket[kwargs['game']] = locus
|
|
# TODO this is more complex now that names are multi-language
|
|
#self.index[cls][cls.name][locus.name].add(locus)
|
|
|
|
def fetch(self, cls, identifier):
|
|
# TODO wrap in a... multi-thing
|
|
#return self.objects[cls][identifier]
|
|
return QuantumLocusReader(identifier, cls, self.objects[cls][identifier])
|
|
|
|
|
|
# TODO clean this garbage up -- better way of iterating the type, actually work for something other than pokemon...
|
|
POKEDEX_TYPES = camel.CamelRegistry(tag_prefix='tag:veekun.com,2005:pokedex/', tag_shorthand='!dex!')
|
|
|
|
@POKEDEX_TYPES.dumper(Locus, 'pokemon', version=None, inherit=True)
|
|
def _dump_locus(locus):
|
|
data = OrderedDict()
|
|
attrs = [(key, attr) for (key, attr) in type(locus).__dict__.items() if isinstance(attr, _Attribute)]
|
|
attrs.sort(key=lambda kv: kv[1]._creation_order)
|
|
|
|
for key, attr in attrs:
|
|
if key in locus.__dict__:
|
|
data[key.replace('_', '-')] = locus.__dict__[key]
|
|
|
|
return data
|
|
|
|
@POKEDEX_TYPES.loader('pokemon', version=None)
|
|
def _load_locus(data, version):
|
|
cls = Pokémon
|
|
# TODO wrap with a writer thing?
|
|
obj = cls()
|
|
for key, value in data.items():
|
|
key = key.replace('-', '_')
|
|
assert hasattr(cls, key)
|
|
setattr(obj, key, value)
|
|
|
|
return obj
|
|
|
|
|
|
def load_repository():
|
|
repository = Repository()
|
|
|
|
# just testing for now
|
|
cam = camel.Camel([POKEDEX_TYPES])
|
|
for game in ('jp-red', 'jp-green', 'jp-blue', 'ww-red', 'ww-blue', 'yellow'):
|
|
path = "pokedex/data/{}/pokemon.yaml".format(game)
|
|
with open(path) as f:
|
|
all_pokemon = cam.load(f.read())
|
|
for identifier, pokemon in all_pokemon.items():
|
|
repository.add(identifier, pokemon, game=game)
|
|
|
|
return repository, all_pokemon
|
|
|
|
|
|
def _temp_main():
|
|
repository, all_pokemon = load_repository()
|
|
|
|
# TODO NEXT TODO
|
|
# - how does the composite object work, exactly? eevee.name.single? eevee.name.latest? no, name needs a language...
|
|
# - but what about the vast majority of properties that are the same in every language and only vary by version?
|
|
# - what about later games, where only some properties vary by language? in the extreme case, xy/oras are single games!
|
|
|
|
# TODO should this prepend the prefix automatically... eh
|
|
eevee = repository.fetch(Pokemon, 'pokemon.eevee')
|
|
pprint(eevee)
|
|
# TODO i feel like this should work: eevee = repository.Pokemon['eevee']
|
|
print(eevee.name)
|
|
print(eevee.types)
|
|
|
|
|
|
# TODO alright so we need to figure out the "index" part, and how you
|
|
# access the index, and how a Pokemon object knows what game it belongs to,
|
|
# and what the kinda wrapper overlay objects look like. which i guess
|
|
# requires having moves and stuff too, and then ripping other gen 1 games
|
|
# as well. phew!
|
|
# TODO also some descriptor nonsense would be kind of nice up in here, i
|
|
# guess, to enforce that the yaml is sensible. but also we don't want to
|
|
# slow down loading any more than we absolutely have to, ahem. maybe do it
|
|
# as a test?
|
|
# TODO maybe worth considering that whole string de-duping idea.
|
|
# TODO lol whoops records don't actually know their own identifiers!! i
|
|
# think what we have here is a more low-level "raw" representation anyway;
|
|
# "eevee" would be the concept of eevee, you know. i guess.
|
|
print(all_pokemon['eevee'])
|
|
pprint(all_pokemon['eevee'].__dict__)
|
|
|
|
if __name__ == '__main__':
|
|
_temp_main()
|