PyLibMS 3.1.2__tar.gz → 3.1.3__tar.gz

{pylibms-3.1.2 → pylibms-3.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 3.1.2
+Version: 3.1.3
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
 Author: AbdyyEee
 License: Copyright 2025 AbdyyEee

{pylibms-3.1.2 → pylibms-3.1.3}/PyLibMS.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 3.1.2
+Version: 3.1.3
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
 Author: AbdyyEee
 License: Copyright 2025 AbdyyEee

pylibms-3.1.3/lms/common/lms_fileinfo.py

@@ -0,0 +1,11 @@
+from dataclasses import dataclass, field
+
+from lms.fileio.encoding import FileEncoding
+
+
+@dataclass(frozen=True)
+class LMS_FileInfo:
+    is_big_endian: bool = False
+    encoding: FileEncoding = FileEncoding.UTF16
+    version: int = 3
+    section_count: int = 2

{pylibms-3.1.2 → pylibms-3.1.3}/lms/message/definitions/lms_messagetext.py

@@ -16,13 +16,13 @@ class LMS_MessageText:
         message: str | list[str | LMS_ControlTag],
         tag_config: TagConfig | None = None,
     ):
+        self._tag_config = tag_config
+
         if isinstance(message, str):
             self._set_parts(message)
         else:
             self._parts = message
 
-        self._tag_config = tag_config
-
     def __iter__(self):
         return iter(self._parts)
 
@@ -118,11 +118,11 @@ class LMS_MessageText:
 
         :param tag: the tag string.
         """
-        if re.match(LMS_DecodedTag.TAG_FORMAT, tag):
+        if re.fullmatch(LMS_DecodedTag.TAG_FORMAT, tag):
             if self._tag_config is None:
                 raise ValueError("TagConfig is required to append decoded tags.")
             self._parts.append(LMS_DecodedTag.from_string(tag, self._tag_config))
-        elif re.match(LMS_EncodedTag.TAG_FORMAT, tag):
+        elif re.fullmatch(LMS_EncodedTag.TAG_FORMAT, tag):
             self._parts.append(LMS_EncodedTag.from_string(tag))
         else:
             raise ValueError(f"Invalid format for tag '{tag}'.")

{pylibms-3.1.2 → pylibms-3.1.3}/lms/message/msbt.py

@@ -1,7 +1,7 @@
 from typing import overload
 
 from lms.common.lms_fileinfo import LMS_FileInfo
-from lms.message.definitions.field.lms_field import LMS_FieldMap
+from lms.message.definitions.field.lms_field import FieldValue, LMS_FieldMap
 from lms.message.definitions.lms_messagetext import LMS_MessageText
 from lms.message.msbtentry import MSBTEntry
 from lms.titleconfig.definitions.attribute import AttributeConfig
@@ -15,11 +15,11 @@ class MSBT:
 
     def __init__(
         self,
-        info: LMS_FileInfo,
-        attribute_config: AttributeConfig | None,
-        tag_config: TagConfig | None,
+        info: LMS_FileInfo | None = None,
+        attribute_config: AttributeConfig | None = None,
+        tag_config: TagConfig | None = None,
     ):
-        self._info = info
+        self._info = info if info is not None else LMS_FileInfo()
 
         self._entries: list[MSBTEntry] = []
 
@@ -33,9 +33,13 @@ class MSBT:
         self.uses_encoded_attributes = True
 
         self.unsupported_sections: dict[str, bytes] = {}
-        self.section_list: list[str] = []
 
-        # List of unsupported sections mapped to their raw data
+        # Default section list used for writing
+        # The section order is usually fixed at LBL1 -> TXT2 -> ATR1 -> TSY1
+        # However, ATR1 and TSY1 are not in the default list ince usually these are not required sections
+        # The order of additional sections is preserved when reading
+        self.section_list: list[str] = ["LBL1", "TXT2"]
+
         self._attribute_config = attribute_config
         self._tag_config = tag_config
 
@@ -73,8 +77,9 @@ class MSBT:
     def add_entry(
         self,
         name: str,
+        *,
         text: str | None = None,
-        attribute: dict | bytes | None = None,
+        attribute: dict[str, FieldValue] | bytes | None = None,
         style_index: int | None = None,
     ) -> None:
         """
@@ -88,27 +93,39 @@ class MSBT:
         if name in [entry.name for entry in self.entries]:
             raise KeyError(f"The label '{name}' already exists!")
 
-        if isinstance(attribute, dict):
-            if self._attribute_config is None:
-                raise ValueError(
-                    "The attribute config must have been provided when reading to add decoded attributes!"
+        match attribute:
+            case dict():
+                if self._attribute_config is None:
+                    raise ValueError(
+                        "The attribute config must have been provided when reading to add decoded attributes!"
+                    )
+                converted_attr = LMS_FieldMap.from_dict(
+                    attribute, self._attribute_config.definitions
                 )
-            converted_attribute = LMS_FieldMap.from_dict(
-                attribute, self._attribute_config.definitions
-            )
-        else:
-            converted_attribute = attribute
+            case bytes():
+                converted_attr = attribute
+            case None:
+                converted_attr = None
+            case _:
+                raise TypeError("The provided attributes are not type bytes or dict!")
 
         if text is not None:
             message_text = LMS_MessageText(text, self._tag_config)
         else:
             message_text = ""
 
+        # Insert the section magics in the correct position that when writing the sections will be properly recognized
+        if attribute is not None and "ATR1" not in self.section_list:
+            self.section_list.insert(2, "ATR1")
+
+        if style_index is not None and "TSY1" not in self.section_list:
+            self.section_list.insert(3, "TSY1")
+
         self._entries.append(
             MSBTEntry(
                 name,
                 message=message_text,
-                attribute=converted_attribute,
+                attribute=converted_attr,
                 style_index=style_index,
             )
         )

{pylibms-3.1.2 → pylibms-3.1.3}/lms/message/msbtio.py

@@ -46,24 +46,6 @@ def read_msbt_path(
         )
 
 
-def write_msbt_path(file_path: str, file: MSBT) -> None:
-    """
-    Writes a MSBT file to a given file path.
-
-    :param file_path: the path to write the file to.
-    :param msbt: the MSBT file object.
-
-    ## Usage
-    ```
-    write_msbt_path("path/to/file.msbt", msbt)
-    ...
-    ```
-    """
-    with open(file_path, "wb") as stream:
-        data = write_msbt(file)
-        stream.write(data)
-
-
 def read_msbt(
     stream: BinaryIO | bytes,
     *,
@@ -112,7 +94,8 @@ def read_msbt(
             case _:
                 file.unsupported_sections[magic] = reader.read_bytes(size)
 
-        file.section_list.append(magic)
+        if not file.section_exists(magic):
+            file.section_list.append(magic)
 
     for i, label in labels.items():
         text = None if messages is None else messages[i]
@@ -125,6 +108,24 @@ def read_msbt(
     return file
 
 
+def write_msbt_path(file_path: str, file: MSBT) -> None:
+    """
+    Writes a MSBT file to a given file path.
+
+    :param file_path: the path to write the file to.
+    :param msbt: the MSBT file object.
+
+    ## Usage
+    ```
+    write_msbt_path("path/to/file.msbt", msbt)
+    ...
+    ```
+    """
+    with open(file_path, "wb") as stream:
+        data = write_msbt(file)
+        stream.write(data)
+
+
 def write_msbt(file: MSBT) -> bytes:
     """Writes a MSBT file and returns the data.
 

{pylibms-3.1.2 → pylibms-3.1.3}/lms/message/tag/lms_tag.py

@@ -1,8 +1,7 @@
 import re
-from typing import TypeGuard, runtime_checkable
+from typing import TypeGuard
 
-from lms.message.definitions.field.lms_field import (LMS_Field, LMS_FieldMap,
-                                                     convert_string_to_type)
+from lms.message.definitions.field.lms_field import LMS_FieldMap
 from lms.message.tag.lms_tagexceptions import LMS_InvalidTagFormatError
 from lms.titleconfig.definitions.tags import TagConfig, TagDefinition
 
@@ -12,16 +11,19 @@ type LMS_ControlTag = LMS_EncodedTag | LMS_DecodedTag
 
 
 def is_tag(obj: object) -> TypeGuard[LMS_ControlTag]:
+    """Typeguard for a tag."""
     return isinstance(obj, (LMS_EncodedTag, LMS_DecodedTag))
 
 
 class LMS_EncodedTag:
-    """A class that represents an encoded tag.
+    """
+    A class that represents an encoded tag.
 
     Example encoded tags:
         - `[0:3 00-00-00-FF]`
         - `[0:4]`
-        - `[1:0 01-00-00-CD]`"""
+        - `[1:0 01-00-00-CD]`
+    """
 
     TAG_FORMAT = re.compile(r"\[\s*(\/)?\s*(\d+)\s*:\s*(\d+)(?:[^\]]*)\]")
     PARAMETER_FORMAT = re.compile(r"^\s*([0-9A-Fa-f]{2})(\s*-\s*[0-9A-Fa-f]{2})*\s*$")
@@ -118,14 +120,18 @@ class LMS_EncodedTag:
 
 
 class LMS_DecodedTag:
-    """A class that represents a decoded tag.
+    """
+    A class that represents a decoded tag.
 
-    Example encoded tags:
+    Example decoded tags:
         - `[System:Color r="0" g="255" b="255" a="255"]`
         - `[System:Pagebreak]`
-        - `[Mii:Nickname buffer="1" type="Text" conversion="None"]`"""
+        - `[Mii:Nickname buffer="1" type="Text" conversion="None"]`
+    """
 
-    TAG_FORMAT = re.compile(r"\[\s*(/)?\s*(\w+)\s*:\s*(\w+)(?:\s+[^\]]*)?\s*\]")
+    TAG_FORMAT = re.compile(
+        r"\[\s*(/)?\s*([A-Za-z][\w]*)\s*:\s*([A-Za-z]+)(?:\s+[^\]]*)?\s*\]"
+    )
     PARAMETER_FORMAT = re.compile(r'(\w+)="([^"]*)"')
 
     def __init__(

{pylibms-3.1.2 → pylibms-3.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "PyLibMS"
-version = "3.1.2"
+version = "3.1.3"
 requires-python = ">=3.12"
 description = "Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF."
 readme = "README.md"

pylibms-3.1.2/lms/common/lms_fileinfo.py

@@ -1,11 +0,0 @@
-from dataclasses import dataclass
-
-from lms.fileio.encoding import FileEncoding
-
-
-@dataclass(frozen=True)
-class LMS_FileInfo:
-    is_big_endian: bool
-    encoding: FileEncoding
-    version: int
-    section_count: int