From 3bfcfe53e49edad20c15018eda57f414f410534a Mon Sep 17 00:00:00 2001 From: Faraphel Date: Thu, 18 Aug 2022 22:22:12 +0200 Subject: [PATCH] OriginalTrack is now a dataclass for better readability --- source/mkw/ModConfig.py | 4 +- source/mkw/OriginalTrack.py | 132 ++++++++++++++++++++---------------- source/wt/ctc.py | 4 +- 3 files changed, 79 insertions(+), 61 deletions(-) diff --git a/source/mkw/ModConfig.py b/source/mkw/ModConfig.py index 966c329..27c24f8 100644 --- a/source/mkw/ModConfig.py +++ b/source/mkw/ModConfig.py @@ -11,7 +11,7 @@ from source.mkw.Cup import Cup from source.mkw.MKWColor import bmg_color_text, bmg_color_raw from source.mkw.ModSettings import AbstractModSettings from source.mkw.Track import CustomTrack, DefaultTrack, Arena -from source.mkw.OriginalTrack import OriginalTrack +from source.mkw import OriginalTrack from source.progress import Progress from source.safe_eval import safe_eval, multiple_safe_eval from source.wt.szs import SZSPath @@ -450,7 +450,7 @@ class ModConfig: # if the track should use the default track instead in multiplayer, # copy the default track to the same file but with a _d at the end shutil.copy( - original_tracks_path / f"{OriginalTrack(track_data=track.special, track_key='slot').name}_d.szs", + original_tracks_path / f"{OriginalTrack.get(slot=track.special).name}_d.szs", destination_path / f"{track_file.stem}_d.szs" ) diff --git a/source/mkw/OriginalTrack.py b/source/mkw/OriginalTrack.py index e82266b..bc6e90e 100644 --- a/source/mkw/OriginalTrack.py +++ b/source/mkw/OriginalTrack.py @@ -1,3 +1,6 @@ +from dataclasses import dataclass + +from source.mkw import Slot from source.translation import translate as _ @@ -6,70 +9,85 @@ class OriginalTrackNotFound(Exception): super().__init__(_("CANNOT_FIND_ORIGINAL_TRACK", ' "', track_data, '" ')) +@dataclass(init=True, slots=True, frozen=True) class OriginalTrack: - all_original_tracks: list[dict] = [ - # wii tracks - {"name": "beginner_course", "slot": "T11", "nickname": "LC"}, - {"name": "farm_course", "slot": "T12", "nickname": "MMM"}, - {"name": "kinoko_course", "slot": "T13", "nickname": "MG"}, - {"name": "factory_course", "slot": "T14", "nickname": "TF"}, - - {"name": "castle_course", "slot": "T21", "nickname": "MC"}, - {"name": "shopping_course", "slot": "T22", "nickname": "CM"}, - {"name": "boardcross_course", "slot": "T23", "nickname": "DKS"}, - {"name": "truck_course", "slot": "T24", "nickname": "WGM"}, + """ + An object representing one of the original track / arena of the game + """ - {"name": "senior_course", "slot": "T31", "nickname": "DC"}, - {"name": "water_course", "slot": "T32", "nickname": "KC"}, - {"name": "treehouse_course", "slot": "T33", "nickname": "MT"}, - {"name": "volcano_course", "slot": "T34", "nickname": "GV"}, + name: str + slot: Slot + nickname: str - {"name": "desert_course", "slot": "T41", "nickname": "DDR"}, - {"name": "ridgehighway_course", "slot": "T42", "nickname": "MH"}, - {"name": "koopa_course", "slot": "T43", "nickname": "BC"}, - {"name": "rainbow_course", "slot": "T44", "nickname": "RR"}, - # retro tracks - {"name": "old_peach_gc", "slot": "T51", "nickname": "gPB"}, - {"name": "old_falls_ds", "slot": "T52", "nickname": "dYF"}, - {"name": "old_obake_sfc", "slot": "T53", "nickname": "sGV2"}, - {"name": "old_mario_64", "slot": "T54", "nickname": "nMR"}, +all_original_tracks: list[OriginalTrack] = [ + OriginalTrack(name="beginner_course", slot="T11", nickname="LC"), + OriginalTrack(name="farm_course", slot="T12", nickname="MMM"), + OriginalTrack(name="kinoko_course", slot="T13", nickname="MG"), + OriginalTrack(name="factory_course", slot="T14", nickname="TF"), - {"name": "old_sherbet_64", "slot": "T61", "nickname": "nSL"}, - {"name": "old_heyho_gba", "slot": "T62", "nickname": "gSGB"}, - {"name": "old_town_ds", "slot": "T63", "nickname": "dDS"}, - {"name": "old_waluigi_gc", "slot": "T64", "nickname": "gWS"}, + OriginalTrack(name="castle_course", slot="T21", nickname="MC"), + OriginalTrack(name="shopping_course", slot="T22", nickname="CM"), + OriginalTrack(name="boardcross_course", slot="T23", nickname="DKS"), + OriginalTrack(name="truck_course", slot="T24", nickname="WGM"), - {"name": "old_desert_ds", "slot": "T71", "nickname": "dDH"}, - {"name": "old_koopa_gba", "slot": "T72", "nickname": "gBC3"}, - {"name": "old_donkey_64", "slot": "T73", "nickname": "nDKJP"}, - {"name": "old_mario_gc", "slot": "T74", "nickname": "gMC"}, + OriginalTrack(name="senior_course", slot="T31", nickname="DC"), + OriginalTrack(name="water_course", slot="T32", nickname="KC"), + OriginalTrack(name="treehouse_course", slot="T33", nickname="MT"), + OriginalTrack(name="volcano_course", slot="T34", nickname="GV"), - {"name": "old_mario_sfc", "slot": "T81", "nickname": "sMC3"}, - {"name": "old_garden_ds", "slot": "T82", "nickname": "dPG"}, - {"name": "old_donkey_gc", "slot": "T83", "nickname": "gDKM"}, - {"name": "old_koopa_64", "slot": "T84", "nickname": "nBC"}, + OriginalTrack(name="desert_course", slot="T41", nickname="DDR"), + OriginalTrack(name="ridgehighway_course", slot="T42", nickname="MH"), + OriginalTrack(name="koopa_course", slot="T43", nickname="BC"), + OriginalTrack(name="rainbow_course", slot="T44", nickname="RR"), - # wii arena - {"name": "block_battle", "slot": "A11", "nickname": "aBP"}, - {"name": "venice_battle", "slot": "A12", "nickname": "aDP"}, - {"name": "skate_battle", "slot": "A13", "nickname": "aFS"}, - {"name": "casino_battle", "slot": "A14", "nickname": "aCCW"}, - {"name": "sand_battle", "slot": "A15", "nickname": "aTD"}, + # retro tracks + OriginalTrack(name="old_peach_gc", slot="T51", nickname="gPB"), + OriginalTrack(name="old_falls_ds", slot="T52", nickname="dYF"), + OriginalTrack(name="old_obake_sfc", slot="T53", nickname="sGV2"), + OriginalTrack(name="old_mario_64", slot="T54", nickname="nMR"), - # retro arena - {"name": "old_battle4_sfc", "slot": "A21", "nickname": "asBC4"}, - {"name": "old_battle3_gba", "slot": "A22", "nickname": "agBC3"}, - {"name": "old_matenro_64", "slot": "A23", "nickname": "anSS"}, - {"name": "old_CookieLand_gc", "slot": "A24", "nickname": "agCL"}, - {"name": "old_House_ds", "slot": "A25", "nickname": "adTH"}, - ] - - __slots__ = ("name", "slot", "nickname") - - def __init__(self, track_data: any, track_key: str = "slot"): - colors = list(filter(lambda color: color[track_key] == track_data, self.all_original_tracks)) - if len(colors) == 0: raise OriginalTrackNotFound(track_data) + OriginalTrack(name="old_sherbet_64", slot="T61", nickname="nSL"), + OriginalTrack(name="old_heyho_gba", slot="T62", nickname="gSGB"), + OriginalTrack(name="old_town_ds", slot="T63", nickname="dDS"), + OriginalTrack(name="old_waluigi_gc", slot="T64", nickname="gWS"), + + OriginalTrack(name="old_desert_ds", slot="T71", nickname="dDH"), + OriginalTrack(name="old_koopa_gba", slot="T72", nickname="gBC3"), + OriginalTrack(name="old_donkey_64", slot="T73", nickname="nDKJP"), + OriginalTrack(name="old_mario_gc", slot="T74", nickname="gMC"), + + OriginalTrack(name="old_mario_sfc", slot="T81", nickname="sMC3"), + OriginalTrack(name="old_garden_ds", slot="T82", nickname="dPG"), + OriginalTrack(name="old_donkey_gc", slot="T83", nickname="gDKM"), + OriginalTrack(name="old_koopa_64", slot="T84", nickname="nBC"), + + # wii arena + OriginalTrack(name="block_battle", slot="A11", nickname="aBP"), + OriginalTrack(name="venice_battle", slot="A12", nickname="aDP"), + OriginalTrack(name="skate_battle", slot="A13", nickname="aFS"), + OriginalTrack(name="casino_battle", slot="A14", nickname="aCCW"), + OriginalTrack(name="sand_battle", slot="A15", nickname="aTD"), + + # retro arena + OriginalTrack(name="old_battle4_sfc", slot="A21", nickname="asBC4"), + OriginalTrack(name="old_battle3_gba", slot="A22", nickname="agBC3"), + OriginalTrack(name="old_matenro_64", slot="A23", nickname="anSS"), + OriginalTrack(name="old_CookieLand_gc", slot="A24", nickname="agCL"), + OriginalTrack(name="old_House_ds", slot="A25", nickname="adTH"), +] + + +def get(**track_datas) -> OriginalTrack: + """ + Get a original track object from keys and its value + :param track_datas: dictionary of track key and their value + :return: the corresponding original track + """ + try: + return next(filter( + lambda og_track: all(getattr(og_track, key) == value for key, value in track_datas.items()), + all_original_tracks + )) + except StopIteration: raise OriginalTrackNotFound(track_datas) - for key, value in colors[0].items(): - setattr(self, key, value) diff --git a/source/wt/ctc.py b/source/wt/ctc.py index 1aab9a1..47c0580 100644 --- a/source/wt/ctc.py +++ b/source/wt/ctc.py @@ -1,4 +1,4 @@ -from source.mkw.OriginalTrack import OriginalTrack +from source.mkw import OriginalTrack from source.wt import * import re @@ -24,7 +24,7 @@ def bmg_ctfile(ctfile: "Path | str") -> str: # this command will generate unwanted definition for the originals tracks / arena. Delete them if # they are not custom - original_tracks_texts: list[str] = list(map(lambda data: data["name"], OriginalTrack.all_original_tracks)) + original_tracks_texts: list[str] = list(map(lambda og_track: og_track.name, OriginalTrack.all_original_tracks)) def remove_unwanted_definition(match: re.Match) -> str: def_id = int(match.group("id"), 16)