move globpattern declaration to bg3_data_checker.py

Author: daescha

games/baldursgate3/bg3_data_checker.py

@@ -1,9 +1,33 @@
+from pathlib import Path
+
 import mobase
 
-from ...basic_features import BasicModDataChecker, utils
+from . import bg3_utils
+from ...basic_features import BasicModDataChecker, utils, GlobPatterns
 
 
 class BG3ModDataChecker(BasicModDataChecker):
+    def __init__(self):
+        super().__init__(
+            GlobPatterns(
+                valid=[
+                    "*.pak",
+                    str(Path("Mods") / "*.pak"),  # standard mods
+                    "bin",  # native mods / Script Extender
+                    "Script Extender",  # mods which are configured via jsons in this folder
+                    "Data",  # loose file mods
+                ]
+                + [str(Path("*") / f) for f in bg3_utils.loose_file_folders],
+                move={
+                    "Root/": "",  # root builder not needed
+                    "*.dll": "bin/",
+                    "ScriptExtenderSettings.json": "bin/",
+                }
+                | {f: "Data/" for f in bg3_utils.loose_file_folders},
+                delete=["info.json", "*.txt"],
+            )
+        )
+
     def dataLooksValid(
         self, filetree: mobase.IFileTree
     ) -> mobase.ModDataChecker.CheckReturn:

games/baldursgate3/bg3_data_content.py

@@ -2,6 +2,8 @@
 
 import mobase
 
+from . import bg3_utils
+
 
 class Content(IntEnum):
     PAK = auto()
@@ -44,13 +46,7 @@ def getContentsFor(self, filetree: mobase.IFileTree) -> list[int]:
                         contents.add(Content.NATIVE)
                     case _:
                         for e in entry:
-                            if e.name() in {
-                                "Mods",
-                                "Localization",
-                                "ScriptExtender",
-                                "Public",
-                                "Generated",
-                            }:
+                            if e.name() in bg3_utils.loose_file_folders:
                                 contents.add(Content.WORKSPACE)
                                 break
             elif entry.name().endswith(".pak"):

games/baldursgate3/bg3_utils.py

@@ -20,15 +20,16 @@
 )
 from PyQt6.QtWidgets import QApplication, QMainWindow, QProgressDialog
 
+loose_file_folders = {
+    "Public",
+    "Mods",
+    "Generated",
+    "Localization",
+    "ScriptExtender",
+}
+
 
 class BG3Utils:
-    loose_file_folders = {
-        "Public",
-        "Mods",
-        "Generated",
-        "Localization",
-        "ScriptExtender",
-    }
     _mod_settings_xml_start = """<?xml version="1.0" encoding="UTF-8"?>
     <save>
         <version major="4" minor="8" revision="0" build="200"/>
@@ -288,7 +289,9 @@ def _convert_jsons_in_dir_to_yaml(path: Path):
             ):
                 with open(file, "r") as json_file:
                     with open(converted_path, "w") as yaml_file:
-                        yaml.dump(json.load(json_file), yaml_file, indent=2)
+                        yaml.dump(
+                            json.load(json_file), yaml_file, indent=2, sort_keys=False
+                        )
                 qInfo(f"Converted {file} to YAML")
         except OSError as e:
             qWarning(f"Error accessing file {converted_path}: {e}")

games/baldursgate3/pak_parser.py

@@ -141,8 +141,7 @@ def _get_metadata_for_file(
                 return ""
             elif next(
                 itertools.chain(
-                    file.glob(f"{folder}/*")
-                    for folder in self._utils.loose_file_folders
+                    file.glob(f"{folder}/*") for folder in bg3_utils.loose_file_folders
                 ),
                 False,
             ):

games/game_baldursgate3.py

@@ -21,7 +21,6 @@
 from ..basic_features import (
     BasicGameSaveGameInfo,
     BasicLocalSavegames,
-    GlobPatterns,
 )
 from ..basic_game import BasicGame
 
@@ -62,27 +61,7 @@ def init(self, organizer: mobase.IOrganizer) -> bool:
             bg3_script_extender,
         )
 
-        self._register_feature(
-            bg3_data_checker.BG3ModDataChecker(
-                GlobPatterns(
-                    valid=[
-                        "*.pak",
-                        str(Path("Mods") / "*.pak"),  # standard mods
-                        "bin",  # native mods / Script Extender
-                        "Script Extender",  # mods which are configured via jsons in this folder
-                        "Data",  # loose file mods
-                    ]
-                    + [str(Path("*") / f) for f in self._utils.loose_file_folders],
-                    move={
-                        "Root/": "",
-                        "*.dll": "bin/",
-                        "ScriptExtenderSettings.json": "bin/",
-                    }  # root builder not needed
-                    | {f: "Data/" for f in self._utils.loose_file_folders},
-                    delete=["info.json", "*.txt"],
-                )
-            )
-        )
+        self._register_feature(bg3_data_checker.BG3ModDataChecker())
         self._register_feature(bg3_script_extender.BG3ScriptExtender(self))
         self._register_feature(bg3_data_content.BG3DataContent())
         self._register_feature(BasicGameSaveGameInfo(lambda s: s.with_suffix(".webp")))