From 4d3112e9e8eae96791769ec427df5b23db3fad62 Mon Sep 17 00:00:00 2001 From: Toast Date: Thu, 29 May 2025 12:43:55 +0200 Subject: [PATCH 1/4] Mod: remove unneded else statement --- src/leek/mod.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/leek/mod.py b/src/leek/mod.py index 73d7db0..ca06c2a 100644 --- a/src/leek/mod.py +++ b/src/leek/mod.py @@ -61,8 +61,7 @@ class Mod: if "enabled" not in self.__config: raise InvalidModError("config.toml does not contain the enabled key") - else: - self.__enabled = self.__config.get("enabled", bool) + self.__enabled = self.__config.get("enabled", bool) except FileNotFoundError: raise InvalidModError("config.toml does not exist") From 4d22e68a9b8dd24e601968d7c94d58ff6f9bf002 Mon Sep 17 00:00:00 2001 From: Toast Date: Thu, 29 May 2025 17:21:54 +0200 Subject: [PATCH 2/4] Mod: parse meta.json if it exists --- src/leek/mod.py | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/src/leek/mod.py b/src/leek/mod.py index ca06c2a..84d0ddc 100644 --- a/src/leek/mod.py +++ b/src/leek/mod.py @@ -1,10 +1,16 @@ import tomlkit +import json from pathlib import Path from tomlkit import TOMLDocument +from typing import Any class Mod: __config: TOMLDocument + + __has_meta_json: bool + __meta: dict[str, Any] + __path: Path __name: str __description: str @@ -53,6 +59,7 @@ class Mod: def __init__(self, path: Path) -> None: self.__path = path + self.__meta = {} try: config_toml = Path(self.__path, "config.toml") @@ -65,6 +72,17 @@ class Mod: except FileNotFoundError: raise InvalidModError("config.toml does not exist") + meta_json: Path = Path(self.__path, "meta.json") + if meta_json.exists(): + self.__has_meta_json = True + try: + with meta_json.open() as file: + self.__meta = json.load(file) + except json.JSONDecodeError as e: + print("Failed to parse meta.json!: ", e.msg) + else: + self.__has_meta_json = False + def __str__(self) -> str: return f"Mod({self.__path})" From 902227a8bd36a783675c8a84fcc2708621b02668 Mon Sep 17 00:00:00 2001 From: Toast Date: Thu, 29 May 2025 18:50:01 +0200 Subject: [PATCH 3/4] Mod: read name, description and authors from json if available --- src/leek/mod.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/leek/mod.py b/src/leek/mod.py index 84d0ddc..bbe2cab 100644 --- a/src/leek/mod.py +++ b/src/leek/mod.py @@ -24,12 +24,18 @@ class Mod: # Mod metadata @property def name(self) -> str | None: + if self.__has_meta_json: + if "name" in self.__meta: + return self.__meta.get("name", str) if "name" not in self.__config: return None return self.__config.get("name", str) @property def description(self) -> str | None: + if self.__has_meta_json: + if "description" in self.__meta: + return self.__meta.get("description", str) if "description" not in self.__config.keys(): return None else: @@ -37,6 +43,11 @@ class Mod: @property def author(self) -> str | None: + # TODO: return list with authors + if self.__has_meta_json: + if "authors" in self.__meta: + authors: list[str] = self.__meta.get("authors", list[str]) + return ", ".join(authors) if "author" not in self.__config: return None return self.__config.get("author", str) From 8a3661729823a6c101b5f8f5e6e7eedf04702781 Mon Sep 17 00:00:00 2001 From: Toast Date: Thu, 29 May 2025 19:08:59 +0200 Subject: [PATCH 4/4] Mod, QMod: add long description property --- src/leek/mod.py | 6 ++++++ src/leek/qmod.py | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/src/leek/mod.py b/src/leek/mod.py index bbe2cab..3e0809b 100644 --- a/src/leek/mod.py +++ b/src/leek/mod.py @@ -41,6 +41,12 @@ class Mod: else: return self.__config.get("description", str) + @property + def long_description(self) -> str | None: + if "descriptionLong" in self.__meta: + return self.__meta.get("descriptionLong", str) + return None + @property def author(self) -> str | None: # TODO: return list with authors diff --git a/src/leek/qmod.py b/src/leek/qmod.py index 74db253..a67c1dc 100644 --- a/src/leek/qmod.py +++ b/src/leek/qmod.py @@ -9,6 +9,8 @@ QML_IMPORT_NAME = "Leek" QML_IMPORT_MAJOR_VERSION = 1 +# Qt follows C++ naming conventions +# ruff: noqa: N802 @QmlElement @QmlUncreatable("QMod is intended to be returned by a QModListModel") class QMod(QObject): @@ -34,6 +36,10 @@ class QMod(QObject): def description(self) -> str | None: return self.__mod.description + @Property(str, constant=True) + def longDescription(self) -> str | None: + return self.__mod.long_description + mod_enabled = Signal(name="enabled") @Property(bool, notify=mod_enabled)