Merge pull request #233 from randovania/feature/lazy-imports

Update ruff rules, use if TYPE_CHECKING/future annotations

.github/workflows/dependency.yml

@@ -17,4 +17,4 @@ jobs:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
 
       - name: Automatically approve the PR
-        uses: hmarr/auto-approve-action@v4
+        uses: hmarr/auto-approve-action@v4

pyproject.toml

@@ -64,11 +64,34 @@ filterwarnings = [
 
 [tool.ruff]
 line-length = 120
-lint.select = ["E", "F", "W", "C90", "I", "UP"]
 src = ["src"]
 
-# Version to target for generated code.
-target-version = "py310"
+[tool.ruff.lint]
+select = [
+    "E", "F", "W", "C90", "I", "UP", "C4",
+    "RSE",
+    "TCH",
+    # "PTH",
+    "COM818", "COM819",
+    "ISC",
+    "PIE",
+    # "PT",
+
+    "PLC",
+    "PLC0208",  # iterating over set is also not deterministic, so we shouldn't do that!
+
+    "PLE",
+    "PLR0402", "PLR1711", "PLR1722", "PLR0206", "PLR0133", "PLR0124",
+    "PLW",
+    "SIM101",
+]
+extend-ignore = [
+    "ISC001",  # may cause conflicts with formatter
+    "PLW2901",  # `for` loop variable `key` overwritten by assignment target
+]
+
+[tool.ruff.lint.isort]
+required-imports = ["from __future__ import annotations"]
 
 [tool.ruff.lint.mccabe]
 # Flag errors (`C901`) whenever the complexity level exceeds 25.

setup.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import os
 import subprocess
 import sys

src/mercury_engine_data_structures/__main__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from mercury_engine_data_structures import cli
 
 if __name__ == "__main__":

src/mercury_engine_data_structures/__pyinstaller/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import os
 
 # Functions

src/mercury_engine_data_structures/__pyinstaller/hook-mercury_engine_data_structures.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from PyInstaller.utils.hooks import collect_data_files
 
 # https://pyinstaller.readthedocs.io/en/stable/hooks.html#provide-hooks-with-package

src/mercury_engine_data_structures/_dread_data_construct.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import struct
 
 import construct

src/mercury_engine_data_structures/adapters/enum_adapter.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from construct import Adapter, Enum, Int32ub
 
 

src/mercury_engine_data_structures/adapters/offset.py

@@ -1,14 +1,16 @@
+from __future__ import annotations
+
 from construct import AdaptationError, Adapter
 
 
 class OffsetAdapter(Adapter):
     # stores offsets as indices
 
     def _get_table(self, context):
-        raise NotImplementedError()
+        raise NotImplementedError
 
     def _get_table_length(self, context):
-        raise NotImplementedError()
+        raise NotImplementedError
 
     def _get_base_offset(self, context):
         return 0

src/mercury_engine_data_structures/formats/base_resource.py → src/mercury_engine_data_structures/base_resource.py

@@ -2,14 +2,12 @@
 
 import typing
 
-from construct import Construct, Container
-
-from mercury_engine_data_structures.game_check import Game
-
 if typing.TYPE_CHECKING:
     import typing_extensions
+    from construct import Construct, Container
 
     from mercury_engine_data_structures.file_tree_editor import FileTreeEditor
+    from mercury_engine_data_structures.game_check import Game
 
 
 class BaseResource:
@@ -24,7 +22,7 @@ def __init__(self, raw: Container, target_game: Game, editor: FileTreeEditor | N
 
     @classmethod
     def construct_class(cls, target_game: Game) -> Construct:
-        raise NotImplementedError()
+        raise NotImplementedError
 
     @classmethod
     def parse(cls, data: bytes, target_game: Game, editor: FileTreeEditor | None = None) -> typing_extensions.Self:

src/mercury_engine_data_structures/cli.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import argparse
 import asyncio
 import itertools

src/mercury_engine_data_structures/common_types.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import copy
 import functools
 import struct

src/mercury_engine_data_structures/construct_extensions/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import operator
 
 import construct.expr

src/mercury_engine_data_structures/construct_extensions/alignment.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import io
 
 import construct

src/mercury_engine_data_structures/construct_extensions/enum.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import enum
 
 import construct

src/mercury_engine_data_structures/construct_extensions/function_complex.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import re
 
 import construct

src/mercury_engine_data_structures/construct_extensions/json.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Any
 
 from construct import EnumIntegerString

src/mercury_engine_data_structures/construct_extensions/misc.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import construct
 from construct import Const, Construct, FocusedSeq, Optional, stream_tell
 

src/mercury_engine_data_structures/construct_extensions/strings.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import construct
 from construct.core import (
     FixedSized,
@@ -50,7 +52,7 @@ def PaddedStringRobust(length, encoding):
     macro = StringEncodedRobust(FixedSized(length, NullStripped(GreedyBytes, pad=encodingunit(encoding))), encoding)
 
     def _emitfulltype(ksy, bitwise):
-        return dict(size=length, type="strz", encoding=encoding)
+        return {"size": length, "type": "strz", "encoding": encoding}
 
     macro._emitfulltype = _emitfulltype
     return macro
@@ -86,8 +88,8 @@ def _emitparse(code):
 
     def _emitseq(ksy, bitwise):
         return [
-            dict(id="lengthfield", type=lengthfield._compileprimitivetype(ksy, bitwise)),
-            dict(id="data", size="lengthfield", type="str", encoding=encoding),
+            {"id": "lengthfield", "type": lengthfield._compileprimitivetype(ksy, bitwise)},
+            {"id": "data", "size": "lengthfield", "type": "str", "encoding": encoding},
         ]
 
     macro._emitseq = _emitseq
@@ -176,7 +178,7 @@ def read_util_term_{i}(io, this):
     macro._emitparse = _emitparse
 
     def _emitfulltype(ksy, bitwise):
-        return dict(type="strz", encoding=encoding)
+        return {"type": "strz", "encoding": encoding}
 
     macro._emitfulltype = _emitfulltype
 
@@ -210,7 +212,7 @@ def GreedyStringRobust(encoding):
     macro = StringEncodedRobust(GreedyBytes, encoding)
 
     def _emitfulltype(ksy, bitwise):
-        return dict(size_eos=True, type="str", encoding=encoding)
+        return {"size_eos": True, "type": "str", "encoding": encoding}
 
     macro._emitfulltype = _emitfulltype
     return macro

src/mercury_engine_data_structures/construct_extensions/version.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import enum
 from functools import partial
 

src/mercury_engine_data_structures/crc.py

@@ -2,6 +2,8 @@
 Module for calculating CRC hashes with the algorithm and data used by Mercury Engine.
 """
 
+from __future__ import annotations
+
 _crc32_constants = [
     0x00000000,
     0x77073096,

src/mercury_engine_data_structures/dread_data.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import functools
 import json
 import typing

src/mercury_engine_data_structures/file_tree_editor.py

@@ -1,20 +1,25 @@
+from __future__ import annotations
+
 import copy
 import enum
 import json
 import logging
 import os.path
 import typing
-from collections.abc import Iterator
-from pathlib import Path
-
-import construct
 
 from mercury_engine_data_structures import dread_data, formats, samus_returns_data
+from mercury_engine_data_structures.base_resource import AssetId, BaseResource, NameOrAssetId, resolve_asset_id
 from mercury_engine_data_structures.formats import Toc
-from mercury_engine_data_structures.formats.base_resource import AssetId, BaseResource, NameOrAssetId, resolve_asset_id
 from mercury_engine_data_structures.formats.pkg import Pkg
 from mercury_engine_data_structures.game_check import Game
-from mercury_engine_data_structures.romfs import RomFs
+
+if typing.TYPE_CHECKING:
+    from collections.abc import Iterator
+    from pathlib import Path
+
+    import construct
+
+    from mercury_engine_data_structures.romfs import RomFs
 
 _T = typing.TypeVar("_T", bound=BaseResource)
 logger = logging.getLogger(__name__)

src/mercury_engine_data_structures/formats/__init__.py

@@ -1,5 +1,8 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
 from mercury_engine_data_structures.formats.bapd import Bapd
-from mercury_engine_data_structures.formats.base_resource import AssetType, BaseResource
 from mercury_engine_data_structures.formats.bcmdl import Bcmdl
 from mercury_engine_data_structures.formats.bcskla import Bcskla
 from mercury_engine_data_structures.formats.bctex import Bctex
@@ -47,6 +50,9 @@
 from mercury_engine_data_structures.formats.toc import Toc
 from mercury_engine_data_structures.formats.txt import Txt
 
+if TYPE_CHECKING:
+    from mercury_engine_data_structures.base_resource import AssetType, BaseResource
+
 ALL_FORMATS = {
     "PKG": Pkg,
     "BAPD": Bapd,

src/mercury_engine_data_structures/formats/bapd.py

@@ -1,8 +1,14 @@
-import construct
+from __future__ import annotations
 
-from mercury_engine_data_structures.formats.base_resource import BaseResource
+from typing import TYPE_CHECKING
+
+from mercury_engine_data_structures.base_resource import BaseResource
 from mercury_engine_data_structures.formats.standard_format import game_model
-from mercury_engine_data_structures.game_check import Game
+
+if TYPE_CHECKING:
+    import construct
+
+    from mercury_engine_data_structures.game_check import Game
 
 BAPD = game_model("sound::CAudioPresets", "2.3.2")
 

src/mercury_engine_data_structures/formats/bcmdl.py

@@ -1,3 +1,7 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
 import construct
 from construct.core import (
     Array,
@@ -24,9 +28,11 @@
     stream_seek,
 )
 
+from mercury_engine_data_structures.base_resource import BaseResource
 from mercury_engine_data_structures.common_types import Float, StrId
-from mercury_engine_data_structures.formats.base_resource import BaseResource
-from mercury_engine_data_structures.game_check import Game
+
+if TYPE_CHECKING:
+    from mercury_engine_data_structures.game_check import Game
 
 # Partial implementation to generate material variants
 # Based off Joschuka's MMDL implementation in Noesis

src/mercury_engine_data_structures/formats/bcskla.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import construct
 from construct.core import (
     Adapter,
@@ -20,9 +22,9 @@
     this,
 )
 
+from mercury_engine_data_structures.base_resource import BaseResource
 from mercury_engine_data_structures.common_types import Float, VersionAdapter
 from mercury_engine_data_structures.construct_extensions.alignment import AlignTo
-from mercury_engine_data_structures.formats.base_resource import BaseResource
 from mercury_engine_data_structures.formats.property_enum import PropertyEnumDoubleUnsafe
 from mercury_engine_data_structures.game_check import Game
 

src/mercury_engine_data_structures/formats/bctex.py

@@ -1,10 +1,12 @@
+from __future__ import annotations
+
 from enum import Enum
 
 import construct
 from construct.core import Error
 
+from mercury_engine_data_structures.base_resource import BaseResource
 from mercury_engine_data_structures.common_types import StrId, UInt
-from mercury_engine_data_structures.formats.base_resource import BaseResource
 from mercury_engine_data_structures.game_check import Game
 
 BlockType = construct.Enum(

src/mercury_engine_data_structures/formats/bgsnds.py

@@ -1,8 +1,14 @@
-from construct import Construct
+from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
+from mercury_engine_data_structures.base_resource import BaseResource
 from mercury_engine_data_structures.formats import standard_format
-from mercury_engine_data_structures.formats.base_resource import BaseResource
-from mercury_engine_data_structures.game_check import Game
+
+if TYPE_CHECKING:
+    from construct import Construct
+
+    from mercury_engine_data_structures.game_check import Game
 
 
 class Bgsnds(BaseResource):

src/mercury_engine_data_structures/formats/bldef.py

@@ -1,8 +1,14 @@
-from construct import Construct, Container
+from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
+from mercury_engine_data_structures.base_resource import BaseResource
 from mercury_engine_data_structures.formats import standard_format
-from mercury_engine_data_structures.formats.base_resource import BaseResource
-from mercury_engine_data_structures.game_check import Game
+
+if TYPE_CHECKING:
+    from construct import Construct, Container
+
+    from mercury_engine_data_structures.game_check import Game
 
 
 class Bldef(BaseResource):