koro 2.0.2__py3-none-any.whl → 2.0.3__py3-none-any.whl

koro/slot/bin.py

@@ -5,7 +5,6 @@ from ..stage import Stage
 from .file import FileSlot
 from .xml import XmlSlot
 
-
 __all__ = ["BinSlot"]
 
 

koro/slot/save.py

@@ -1,12 +1,20 @@
+from collections.abc import Mapping, Sequence
 from enum import Enum, unique
 from io import BytesIO
 from operator import index as ix
 from os.path import basename, dirname, join
-from typing import TYPE_CHECKING, Annotated, Any, Literal, SupportsIndex
-from collections.abc import Mapping, Sequence
+from typing import (
+    TYPE_CHECKING,
+    Annotated,
+    Any,
+    Final,
+    Literal,
+    SupportsIndex,
+    TypeAlias,
+)
+from warnings import warn
 
 from ..stage import Stage
-
 from . import Slot
 from .xml import XmlSlot
 
@@ -16,7 +24,13 @@ else:
     StrOrBytesPath = Any
 
 
-__all__ = ["EditorPage", "get_slots", "SaveSlot"]
+__all__ = ["EditorPage", "SaveSlot"]
+
+_SIZE_LIMIT: Final[int] = 156864
+
+SlotNumber: TypeAlias = Literal[
+    1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20
+]
 
 
 @unique
@@ -30,23 +44,23 @@ class SaveSlot(Slot):
     __match_args__ = ("path", "page", "index")
     __slots__ = ("_offset", "_path")
 
-    _offset: Literal[8, 156392, 312776, 469160]
+    _offset: Literal[8, 156872, 313736, 470600]
     _path: str | bytes
 
     def __init__(
         self,
         path: StrOrBytesPath,
         page: EditorPage,
-        index: Annotated[
-            SupportsIndex,
-            Literal[
-                1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20
-            ],
-        ],
+        index: Annotated[SupportsIndex, SlotNumber],
     ) -> None:
         index = ix(index) - 1
-        if index in range(0, 20):
-            self._offset = 8 + 156864 * (index & 3)  # type: ignore[assignment]
+        if index in range(20):
+            if page == EditorPage.HUDSON and index in range(5):
+                warn(
+                    "Modifications to Hudson 01-05 are ignored by the game. These stages are read from disc (/data/A19S00X.bin) and are empty by default when inspected with this library; writes made by this library will have no effect in-game.",
+                    RuntimeWarning,
+                )
+            self._offset = 8 + _SIZE_LIMIT * (index & 3)  # type: ignore[assignment]
             self._path = join(path, f"ed{(index >> 2) + 5 * page.value:02}.dat")  # type: ignore[arg-type]
         else:
             raise ValueError("index must be between 1 and 20")
@@ -69,10 +83,8 @@ class SaveSlot(Slot):
         return hash((self._offset, self._path))
 
     @property
-    def index(
-        self,
-    ) -> Literal[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]:
-        return (int(basename(self._path)[2:4]) % 5 >> 2 | self._offset // 156864) + 1  # type: ignore[return-value]
+    def index(self) -> SlotNumber:
+        return (int(basename(self._path)[2:4]) % 5 >> 2 | self._offset // _SIZE_LIMIT) + 1  # type: ignore[return-value]
 
     def load(self) -> Stage | None:
         try:
@@ -82,10 +94,8 @@ class SaveSlot(Slot):
                     block: bytearray = bytearray()
                     while True:
                         block.clear()
-                        block.extend(f.read1())
-                        if len(b.getbuffer()) + len(block) > 156864:
-                            del block[156864 - len(b.getbuffer()) :]
-                        if block[-1]:
+                        block.extend(f.read1(_SIZE_LIMIT - len(b.getbuffer())))
+                        if block and block[-1]:
                             b.write(block)
                         else:
                             while block:
@@ -115,11 +125,13 @@ class SaveSlot(Slot):
 
     def save(self, data: Stage | None) -> None:
         binary: bytes = b"" if data is None else XmlSlot.serialize(data)
-        if len(binary) > 156864:
+        if len(binary) > _SIZE_LIMIT:
             raise ValueError("serialized stage data is too large to save")
         try:
             with open(self._path, "xb") as f:
-                f.write(bytes(638976))
+                f.write(
+                    bytes(638976)
+                )  # Weird. Would expect this to be 627464 (8 + 4 * (_SIZE_LIMIT))
             if data is None:
                 return
         except FileExistsError:
@@ -127,10 +139,11 @@ class SaveSlot(Slot):
         with open(self._path, "r+b") as f:
             f.seek(self._offset)
             f.write(binary)
-            f.write(bytes(156864 - len(binary)))
+            f.write(bytes(_SIZE_LIMIT - len(binary)))
 
 
 def get_slots(save: StrOrBytesPath, /) -> Mapping[EditorPage, Sequence[SaveSlot]]:
+    warn("function get_slots is deprecated", DeprecationWarning)
     return {
         page: tuple(SaveSlot(save, page, i) for i in range(1, 21))
         for page in EditorPage

koro/slot/xml.py

@@ -12,7 +12,6 @@ from ..stage.part import (
     BasePart,
     BlinkingTile,
     Bumper,
-    TextBox,
     Cannon,
     ConveyorBelt,
     DashTunnel,
@@ -41,6 +40,7 @@ from ..stage.part import (
     Speed,
     Spring,
     Start,
+    TextBox,
     Thorn,
     TimedDevice,
     ToyTrain,

koro/stage/model.py

@@ -1,7 +1,6 @@
 from enum import Enum, unique
 from typing import TypeAlias
 
-
 __all__ = ["DecorationModel", "DeviceModel", "Model", "PartModel"]
 
 

koro/stage/part.py

@@ -2,14 +2,13 @@ from __future__ import annotations
 
 from abc import ABC, abstractmethod
 from collections.abc import Iterable, MutableSequence
-from enum import Enum, unique, Flag
+from enum import Enum, Flag, unique
 from operator import index
 from sys import maxsize
 from typing import Any, Final, Iterator, Literal, Self, SupportsIndex, overload
 
 from .model import DecorationModel, DeviceModel, PartModel
 
-
 __all__ = [
     "Ant",
     "BasePart",

{koro-2.0.2.dist-info → koro-2.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: koro
-Version: 2.0.2
+Version: 2.0.3
 Summary: Tools for manipulating levels made in Marble Saga: Kororinpa
 Home-page: https://github.com/DigitalDetective47/koro
 Author: DigitalDetective47
@@ -14,6 +14,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: File Formats
 Classifier: Topic :: Games/Entertainment
 Classifier: Typing :: Typed

koro-2.0.3.dist-info/RECORD

@@ -0,0 +1,15 @@
+koro/__init__.py,sha256=5_P8Q_L1Jo-bqMmzAK9tPKkmaSffbuid16voHwj8vys,192
+koro/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+koro/slot/__init__.py,sha256=YJ3FjOF4o1Vo8joMpLTw27-Dwaoxq5YfQSER-ymJjFE,398
+koro/slot/bin.py,sha256=Q0vKE5hTzGIGER-kpZnRykA3oAkXaK6uSAibS5Y1gBM,6527
+koro/slot/file.py,sha256=QxBIXzFqzT6mzVZ5bq8xeR8vWfcNFpjHzsEEEqSzlz4,1656
+koro/slot/save.py,sha256=bX9XW8qcNbd2qelwmHRoPMkQsQkL-ZAFx_F5sW-xWRE,4916
+koro/slot/xml.py,sha256=TXogt9AlR93_jG63j2fv3AeEbkB4D8xp3CE1OI_2OjA,42147
+koro/stage/__init__.py,sha256=xdMGSuI4fNDVSSHnuSwMyzFVyRxpcsSDxCl0EQWGJJM,2448
+koro/stage/model.py,sha256=ZxmuKceendBqtVgmkJUYwbVzb7lGGhSoeCumgx3zwuQ,8428
+koro/stage/part.py,sha256=QE7BFltmhm2pTQKjMrH0bxMj5h5Z8neOxxQEMd6RDGw,46885
+koro-2.0.3.dist-info/LICENSE,sha256=awOCsWJ58m_2kBQwBUGWejVqZm6wuRtCL2hi9rfa0X4,1211
+koro-2.0.3.dist-info/METADATA,sha256=ErAsRu5QewfmllvUwcsbuD-RUB2f6zJhNxzwiWdoZJA,4405
+koro-2.0.3.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+koro-2.0.3.dist-info/top_level.txt,sha256=Msq6ssMwv56hnBQqwaTdJJkxM7x7BZ-3JfQbkepQAEY,5
+koro-2.0.3.dist-info/RECORD,,

{koro-2.0.2.dist-info → koro-2.0.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (70.3.0)
+Generator: setuptools (75.8.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

koro-2.0.2.dist-info/RECORD

@@ -1,14 +0,0 @@
-koro/__init__.py,sha256=5_P8Q_L1Jo-bqMmzAK9tPKkmaSffbuid16voHwj8vys,192
-koro/slot/__init__.py,sha256=YJ3FjOF4o1Vo8joMpLTw27-Dwaoxq5YfQSER-ymJjFE,398
-koro/slot/bin.py,sha256=KaspkI3MZAoUTkVD8cSNP8sjn_ZI9U7qLt885zEK5C0,6528
-koro/slot/file.py,sha256=QxBIXzFqzT6mzVZ5bq8xeR8vWfcNFpjHzsEEEqSzlz4,1656
-koro/slot/save.py,sha256=ng1lCfUunJxsok9Isux2sRfth3VbB8vRvcpz4zDIelM,4450
-koro/slot/xml.py,sha256=evjIx-egPC43HqMCtBmmrjggyZ3xjERquqhaSIFQz0I,42147
-koro/stage/__init__.py,sha256=xdMGSuI4fNDVSSHnuSwMyzFVyRxpcsSDxCl0EQWGJJM,2448
-koro/stage/model.py,sha256=JNN6xT9o-47oTETu0_bWZpVBPOm2xkRgItKnREExbHo,8429
-koro/stage/part.py,sha256=zo2uxQ6QccG3Ja7sos6IUiwnjvXJDFoWRcTbUVXeQ5E,46886
-koro-2.0.2.dist-info/LICENSE,sha256=awOCsWJ58m_2kBQwBUGWejVqZm6wuRtCL2hi9rfa0X4,1211
-koro-2.0.2.dist-info/METADATA,sha256=fhMg_HIOEOu69Q0bjpExNDLIWqMx0l0pD4PpR2VkOvE,4354
-koro-2.0.2.dist-info/WHEEL,sha256=Z4pYXqR_rTB7OWNDYFOm1qRk0RX6GFP2o8LgvP453Hk,91
-koro-2.0.2.dist-info/top_level.txt,sha256=Msq6ssMwv56hnBQqwaTdJJkxM7x7BZ-3JfQbkepQAEY,5
-koro-2.0.2.dist-info/RECORD,,