Compatibility with Python 3.8

Author: BenjaminHalko

README.md

@@ -5,7 +5,7 @@
 ![Downloads](https://img.shields.io/pepy/dt/wii-music-editor)
 
 ## Installation
-[Download](https://www.python.org/downloads/) and install Python 3.9 or later.
+[Download](https://www.python.org/downloads/) and install Python 3.8 or later.
 
 Then, open a terminal and run the following command:
 ```bash

pyproject.toml

@@ -7,7 +7,7 @@ authors = [
 ]
 license = { file = "LICENSE" }
 readme = "README.md"
-requires-python = ">=3.9,<3.13"
+requires-python = ">=3.8,<3.15"
 dependencies = [
     "importlib_metadata",
     "mido",

setup.py

@@ -15,8 +15,12 @@ def has_ext_modules(self):
 class PostInstallCommand(install):
     def run(self):
         install.run(self)
-        install_site = site.getsitepackages()[1]
-        if not (Path(install_site) / "wii_music_editor").is_dir():
+        install_site = None
+        for sp in site.getsitepackages():
+            if (Path(sp) / "wii_music_editor").is_dir():
+                install_site = sp
+                break
+        if install_site is None:
             install_site = self.install_usersite
         make_shortcut(
             f"{install_site}/wii_music_editor/__main__.py",
@@ -44,6 +48,6 @@ def run(self):
     distclass=BinaryDistribution,
     package_data={"wii_music_editor": data},
     cmdclass={
-        'install': PostInstallCommand,
+        "install": PostInstallCommand,
     },
 )

wii_music_editor/editor/brsar.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pathlib import Path
 
 
@@ -6,6 +8,7 @@ class BrsarGroup:
     Each group in a brsar file holds a list of songs.
     Different groups are used for different types of songs.
     """
+
     Regular = 2
     Maestro = 21
     Handbell = 23
@@ -20,14 +23,15 @@ class __BrsarSection:
     :param parent: The `parent` attribute is the parent section of the section.
     :param offset: The `offset` attribute is the offset of the section from the start of the file.
     """
+
     _referenceValueOffset = 0x04
     _referenceSize = 0x08
 
-    root: 'Brsar'
-    parent: '__BrsarSection'
+    root: "Brsar"
+    parent: "__BrsarSection"
     offset: int
 
-    def __init__(self, parent: '__BrsarSection', offset: int):
+    def __init__(self, parent: "__BrsarSection", offset: int):
         self.parent = parent
         self.root = parent.root
         self.offset = offset
@@ -39,7 +43,7 @@ def read_bytes(self, offset: int) -> int:
         """
         length = 4
         offset += self.offset
-        return int.from_bytes(self.root.data[offset:offset + length], "big")
+        return int.from_bytes(self.root.data[offset : offset + length], "big")
 
     def section_reference(self, offset: int) -> int:
         """
@@ -61,7 +65,7 @@ def increment_value(self, value: str, increment: int) -> None:
         offset = getattr(self, f"_{value}") + self.offset
         val = getattr(self, value) + increment
         setattr(self, value, val)
-        self.root.data[offset:offset + length] = val.to_bytes(length, "big")
+        self.root.data[offset : offset + length] = val.to_bytes(length, "big")
 
 
 class Brsar(__BrsarSection):
@@ -70,6 +74,7 @@ class Brsar(__BrsarSection):
     A list of all the sections in a brsar file can be found at https://wiki.tockdom.com/wiki/BRSAR_(File_Format).
     :param path: The path to a brsar file.
     """
+
     _fileLength = 0x08
     _infoSectionOffset = 0x18
     _infoSectionSize = 0x1C
@@ -84,8 +89,8 @@ class Brsar(__BrsarSection):
 
     brsarPath: Path
     data: bytearray
-    infoSection: 'InfoSection'
-    fileSection: 'FileSection'
+    infoSection: "InfoSection"
+    fileSection: "FileSection"
 
     def __init__(self, path: Path):
         self.root = self
@@ -118,22 +123,24 @@ def replace_song(self, song: bytearray, group_index: int, item_index: int):
         incrementAmount = len(song) - itemGroup.rseqSize
 
         # Replace song data
-        self.data = self.data[:rseqOffset]+song+self.data[rseqOffset+itemGroup.rseqSize:]
+        self.data = (
+            self.data[:rseqOffset] + song + self.data[rseqOffset + itemGroup.rseqSize :]
+        )
 
         # Update Group Table
-        songGroup.increment_value('rseqSize', incrementAmount)
-        songGroup.increment_value('rwarOffset', incrementAmount)
-        itemGroup.increment_value('rseqSize', incrementAmount)
-        for item in songGroup.itemTable.entries[item_index+1:]:
-            item.increment_value('rseqOffset', incrementAmount)
+        songGroup.increment_value("rseqSize", incrementAmount)
+        songGroup.increment_value("rwarOffset", incrementAmount)
+        itemGroup.increment_value("rseqSize", incrementAmount)
+        for item in songGroup.itemTable.entries[item_index + 1 :]:
+            item.increment_value("rseqOffset", incrementAmount)
 
         # Update other group tables
-        for group in self.infoSection.groupDataTable.entries[group_index+1:]:
-            group.increment_value('rseqOffset', incrementAmount)
-            group.increment_value('rwarOffset', incrementAmount)
+        for group in self.infoSection.groupDataTable.entries[group_index + 1 :]:
+            group.increment_value("rseqOffset", incrementAmount)
+            group.increment_value("rwarOffset", incrementAmount)
 
         # Update Section Size
-        self.increment_value('fileLength', incrementAmount)
+        self.increment_value("fileLength", incrementAmount)
 
     def get_song(self, group_index: int, item_index: int) -> bytearray:
         """
@@ -145,7 +152,7 @@ def get_song(self, group_index: int, item_index: int) -> bytearray:
         songGroup = self.infoSection.groupDataTable.entries[group_index]
         itemGroup = songGroup.itemTable.entries[item_index]
         rseqOffset = songGroup.rseqOffset + itemGroup.rseqOffset
-        return self.data[rseqOffset:rseqOffset+itemGroup.rseqSize]
+        return self.data[rseqOffset : rseqOffset + itemGroup.rseqSize]
 
     def save(self):
         with open(self.brsarPath, "wb") as file:
@@ -159,10 +166,11 @@ class InfoSection(__BrsarSection):
     :param parent: A reference to the brsar header.
     :param offset: The `offset` attribute is the offset of the section from the start of the file.
     """
+
     _groupTable = 0x28
 
     parent: Brsar
-    groupDataTable: 'GroupDataTable'
+    groupDataTable: "GroupDataTable"
 
     def __init__(self, parent: Brsar, offset: int):
         super().__init__(parent, offset)
@@ -177,6 +185,7 @@ class FileSection(__BrsarSection):
     :param parent: A reference to the brsar header.
     :param offset: The offset from the start of the file.
     """
+
     _sectionSize = 0x04
 
     parent: Brsar
@@ -195,17 +204,20 @@ class GroupDataTable(__BrsarSection):
     :param parent: A reference to the info section.
     :param offset: The offset from the start of the file.
     """
+
     __numEntries = 0x00
     __entries = 0x04
 
     parent: InfoSection
-    entries: list['GroupDataEntry']
+    entries: list["GroupDataEntry"]
 
     def __init__(self, parent: InfoSection, offset: int):
         super().__init__(parent, offset)
         numEntries = self.read_bytes(self.__numEntries)
         self.entries = [
-            GroupDataEntry(self, self.section_reference(self.__entries + i * self._referenceSize))
+            GroupDataEntry(
+                self, self.section_reference(self.__entries + i * self._referenceSize)
+            )
             for i in range(numEntries)
         ]
 
@@ -219,20 +231,23 @@ class GroupDataEntry(__BrsarSection):
     :param parent: A reference to the group data table.
     :param offset: The offset from the start of the file.
     """
+
     _rseqOffset = 0x10
     _rseqSize = 0x14
     _rwarOffset = 0x18
     _groupItemEntry = 0x20
 
     parent: GroupDataTable
-    itemTable: 'GroupItemTable'
+    itemTable: "GroupItemTable"
 
     def __init__(self, parent: GroupDataTable, offset: int):
         super().__init__(parent, offset)
         self.rseqOffset = self.read_bytes(self._rseqOffset)
         self.rseqSize = self.read_bytes(self._rseqSize)
         self.rwarOffset = self.read_bytes(self._rwarOffset)
-        self.itemTable = GroupItemTable(self, self.section_reference(self._groupItemEntry))
+        self.itemTable = GroupItemTable(
+            self, self.section_reference(self._groupItemEntry)
+        )
 
 
 class GroupItemTable(__BrsarSection):
@@ -243,17 +258,20 @@ class GroupItemTable(__BrsarSection):
     :param parent: A reference to the group data entry.
     :param offset: The offset from the start of the file.
     """
+
     __numEntries = 0x00
     __entries = 0x04
 
     parent: GroupDataEntry
-    entries: list['GroupItemEntry']
+    entries: list["GroupItemEntry"]
 
     def __init__(self, parent: GroupDataEntry, offset: int):
         super().__init__(parent, offset)
         numEntries = self.read_bytes(self.__numEntries)
         self.entries = [
-            GroupItemEntry(self, self.section_reference(self.__entries + i * self._referenceSize))
+            GroupItemEntry(
+                self, self.section_reference(self.__entries + i * self._referenceSize)
+            )
             for i in range(numEntries)
         ]
 
@@ -265,6 +283,7 @@ class GroupItemEntry(__BrsarSection):
     Each rseqOffset is relative to the group offset.
     https://wiki.tockdom.com/wiki/BRSAR_(File_Format)#Group_Item_Info_Entry
     """
+
     _rseqOffset = 0x04
     _rseqSize = 0x08
 
@@ -276,4 +295,3 @@ def __init__(self, parent: GroupItemTable, offset: int):
         super().__init__(parent, offset)
         self.rseqOffset = self.read_bytes(self._rseqOffset)
         self.rseqSize = self.read_bytes(self._rseqSize)
-    

wii_music_editor/editor/editor.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import logging
 
 from wii_music_editor.data.songs import SongClass, SongType, song_list
@@ -51,19 +53,26 @@ def replace_song(song: SongClass, score_midi: Midi, song_midi: Midi):
         dol = MainDol(rom_folder.mainDolPath)
         dol.write_song_info(song, score_midi.length, dol.songSegmentLength)
         dol.write_song_info(song, score_midi.tempo, dol.songSegmentTempo)
-        dol.write_song_info(song, score_midi.time_signature, dol.songSegmentTimeSignature, 0x01)
+        dol.write_song_info(
+            song, score_midi.time_signature, dol.songSegmentTimeSignature, 0x01
+        )
         dol.save()
 
 
 def replace_song_text(song: SongClass, name: str, description: str, genre: str):
     logging.info(f"Changing text for song: {song.name}")
     index = song.mem_order
-    if (rom_folder.text.songs[index] != name or rom_folder.text.descriptions[index] != description or
-            rom_folder.text.genres[index] != genre):
+    if (
+        rom_folder.text.songs[index] != name
+        or rom_folder.text.descriptions[index] != description
+        or rom_folder.text.genres[index] != genre
+    ):
         rom_folder.text.change_name(song, [name, description, genre])
 
 
-def get_original_song(song: SongClass) -> tuple[Midi, Midi, str, str, str, int, int, int]:
+def get_original_song(
+    song: SongClass,
+) -> tuple[Midi, Midi, str, str, str, int, int, int]:
     # Main Dol
     length = 0
     tempo = 0
@@ -82,7 +91,7 @@ def get_original_song(song: SongClass) -> tuple[Midi, Midi, str, str, str, int,
         rom_folder.textBackup.genres[song.list_order],
         length,
         tempo,
-        time_signature
+        time_signature,
     )
 
 
@@ -101,5 +110,7 @@ def replace_style_text(style: Style, name: str):
 def replace_default_style(song: SongClass, style: Style):
     logging.info(f"Changing default style for song '{song.name}' to '{style.name}'")
     rom_folder.default_styles[song.list_order] = style.style_id
-    rom_folder.mainDol.write_song_info(song, style.style_id, rom_folder.mainDol.songSegmentDefaultStyle)
+    rom_folder.mainDol.write_song_info(
+        song, style.style_id, rom_folder.mainDol.songSegmentDefaultStyle
+    )
     rom_folder.mainDol.save()