PyLibMS 3.3__tar.gz → 3.3.2__tar.gz

{pylibms-3.3 → pylibms-3.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 3.3
+Version: 3.3.2
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and soon to be MSBF.
 Author: AbdyyEee
 License: Copyright 2025 AbdyyEee
@@ -20,7 +20,7 @@ Requires-Dist: PyYAML>=6.0.1
 Dynamic: license-file
 
 # PylibMS
-PylibMS is a library built in Python 3.10+ for the libMessageStudio (LMS) proprietary file formats from Nintendo. It supports the following:
+PylibMS is a library built in Python 3.12+ for the libMessageStudio (LMS) proprietary file formats (`msbt`, `msbp`, `msbf`) from Nintendo. It supports the following:
 
 * Full reading and writing of MSBT files.
 * Full reading of MSBP files.
@@ -35,7 +35,7 @@ This library is designed to support LMS revision 3.0 and above, with the associa
 * Mobile (Specific titles only)
 * Nintendo Switch
 
-MSBF is in current in the works.
+MSBF is currently in the works.
 
 # Features and Usage
 Simple preview of the library is below. See [the wiki](https://github.com/AbdyyEee/PylibMS/wiki) for more explanations and examples.

{pylibms-3.3 → pylibms-3.3.2}/PyLibMS.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 3.3
+Version: 3.3.2
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and soon to be MSBF.
 Author: AbdyyEee
 License: Copyright 2025 AbdyyEee
@@ -20,7 +20,7 @@ Requires-Dist: PyYAML>=6.0.1
 Dynamic: license-file
 
 # PylibMS
-PylibMS is a library built in Python 3.10+ for the libMessageStudio (LMS) proprietary file formats from Nintendo. It supports the following:
+PylibMS is a library built in Python 3.12+ for the libMessageStudio (LMS) proprietary file formats (`msbt`, `msbp`, `msbf`) from Nintendo. It supports the following:
 
 * Full reading and writing of MSBT files.
 * Full reading of MSBP files.
@@ -35,7 +35,7 @@ This library is designed to support LMS revision 3.0 and above, with the associa
 * Mobile (Specific titles only)
 * Nintendo Switch
 
-MSBF is in current in the works.
+MSBF is currently in the works.
 
 # Features and Usage
 Simple preview of the library is below. See [the wiki](https://github.com/AbdyyEee/PylibMS/wiki) for more explanations and examples.

{pylibms-3.3 → pylibms-3.3.2}/README.md

@@ -1,5 +1,5 @@
 # PylibMS
-PylibMS is a library built in Python 3.10+ for the libMessageStudio (LMS) proprietary file formats from Nintendo. It supports the following:
+PylibMS is a library built in Python 3.12+ for the libMessageStudio (LMS) proprietary file formats (`msbt`, `msbp`, `msbf`) from Nintendo. It supports the following:
 
 * Full reading and writing of MSBT files.
 * Full reading of MSBP files.
@@ -14,7 +14,7 @@ This library is designed to support LMS revision 3.0 and above, with the associa
 * Mobile (Specific titles only)
 * Nintendo Switch
 
-MSBF is in current in the works.
+MSBF is currently in the works.
 
 # Features and Usage
 Simple preview of the library is below. See [the wiki](https://github.com/AbdyyEee/PylibMS/wiki) for more explanations and examples.

{pylibms-3.3 → pylibms-3.3.2}/lms/common/lms_datatype.py

@@ -3,6 +3,18 @@ from __future__ import annotations
 from enum import Enum
 from typing import Type, TypeGuard
 
+ALIAS_MAP = {
+    "u8": "UINT8",
+    "u16": "UINT16",
+    "u32": "UINT32",
+    "i8": "INT8",
+    "i16": "INT16",
+    "i32": "INT32",
+    "f32": "FLOAT32",
+    "str": "STRING",
+    "bool": "BOOL",
+    "byte": "BYTES",
+}
 
 def is_number_datatype(value: object, datatype: LMS_DataType) -> TypeGuard[int | float]:
     return datatype in (
@@ -13,7 +25,7 @@ def is_number_datatype(value: object, datatype: LMS_DataType) -> TypeGuard[int |
         LMS_DataType.INT16,
         LMS_DataType.INT32,
         LMS_DataType.FLOAT32,
-    ) and isinstance(value, (int, float))
+    ) and isinstance(value, int)
 
 
 def is_list_datatype(value: object, datatype: LMS_DataType) -> TypeGuard[str]:
@@ -77,7 +89,7 @@ class LMS_DataType(Enum):
         raise TypeError(f"Signed is not a valid property for '{self.to_string()}'!")
 
     @property
-    def builtin_type(self) -> Type[int | str | float | bool | bytes]:
+    def builtin_type(self) -> Type[int | float | str | bool | bytes]:
         """The enum as the builtin python type."""
         return {
             LMS_DataType.UINT8: int,
@@ -116,20 +128,7 @@ class LMS_DataType(Enum):
         if member in cls.__members__:
             return cls[member]
 
-        alias_map = {
-            "u8": "UINT8",
-            "u16": "UINT16",
-            "u32": "UINT32",
-            "i8": "INT8",
-            "i16": "INT16",
-            "i32": "INT32",
-            "f32": "FLOAT32",
-            "str": "STRING",
-            "bool": "BOOL",
-            "byte": "BYTES",
-        }
-
-        alias_member = alias_map.get(string.lower())
+        alias_member = ALIAS_MAP.get(string.lower())
         if alias_member is not None:
             return cls[alias_member]
         else:

{pylibms-3.3 → pylibms-3.3.2}/lms/common/stream/fileinfo.py

@@ -33,7 +33,7 @@ def read_file_info(reader: FileReader, expected_magic: str) -> LMS_FileInfo:
 
     reader.seek(0, 2)
     if file_size != reader.tell():
-        raise lms_exceptions.LMS_MisalignedSizeError(f"Filesize is misaligned!")
+        raise lms_exceptions.LMS_MisalignedSizeError(f"File size is misaligned!")
 
     reader.seek(DATA_START)
 

{pylibms-3.3 → pylibms-3.3.2}/lms/message/definitions/field/lms_field.py

@@ -15,8 +15,7 @@ type FieldValue = int | str | float | bool | bytes
 @dataclass(frozen=True)
 class LMS_FieldMap:
     """
-    A wrapper for a dictionary of LMS_Field objects for controlled access, validation
-    and abstraction from the dict object.
+    A wrapper for a basic ``dict[str, LMS_Field]``. Difference is validation upon modification of a field.
     """
 
     fields: dict[str, LMS_Field]
@@ -52,8 +51,10 @@ class LMS_FieldMap:
     @classmethod
     def from_string_dict(cls, data: dict[str, str], definitions: list[ValueDefinition]):
         fields = {}
+        casted_value = None
 
         for definition in definitions:
+            # These datatypes do not require any casting
             if definition.datatype in (LMS_DataType.STRING, LMS_DataType.LIST):
                 fields[definition.name] = LMS_Field(data[definition.name], definition)
                 continue
@@ -64,7 +65,7 @@ class LMS_FieldMap:
                     casted_value = bytes.fromhex(value)
                 case LMS_DataType.BOOL:
                     if value not in ("false", "true"):
-                        raise ValueError("Value must be true or false for bool type.")
+                        raise ValueError("Invalid boolean value!")
                     casted_value = value.strip().lower() == "true"
                 case LMS_DataType.FLOAT32:
                     casted_value = float(value)
@@ -115,7 +116,7 @@ class LMS_Field:
 
     @property
     def list_items(self) -> list[str]:
-        """The list items bound to the field instance. Only is valid for `LMS_Datatype.LIST` values."""
+        """The list items bound to the field instance. Only is valid for ``LMS_Datatype.LIST`` values."""
         return self._definition.list_items
 
     @value.setter
@@ -141,7 +142,8 @@ def _verify_value(
         case LMS_DataType.LIST if isinstance(value, str):
             if value not in definition.list_items:
                 raise ValueError(
-                    f"The value of '{value}' provided for field '{definition.name}' is not in the list {definition.list_items}."
+                    f"""The value of '{value}' provided for field '{definition.name}' is not a 
+                    valid item in the list {definition.list_items}."""
                 )
             else:
                 return
@@ -172,5 +174,6 @@ def _verify_number_is_in_range(
 ):
     if not min_value <= value <= max_value:
         raise ValueError(
-            f"The value '{value}' of type '{definition.datatype}' provided for field '{definition.name}' is out of range of ({min_value}, {max_value})"
+            f"""The value '{value}' of type '{definition.datatype}' provided for field '{definition.name}' 
+            is out of range of ({min_value}, {max_value})"""
         )

{pylibms-3.3 → pylibms-3.3.2}/lms/message/definitions/lms_messagetext.py

@@ -1,6 +1,6 @@
 import re
 
-from lms.message.definitions.field.lms_field import LMS_FieldMap
+from lms.message.definitions.field.lms_field import LMS_FieldMap, FieldValue
 from lms.message.tag.lms_tag import (LMS_ControlTag, LMS_DecodedTag,
                                      LMS_EncodedTag, is_tag)
 from lms.message.tag.lms_tagexceptions import LMS_TagForbiddenParametersError
@@ -20,18 +20,18 @@ class LMS_MessageText:
         self._tag_config = tag_config
 
         if isinstance(message, str):
-            self._set_parts(message)
+            self._set_segments(message)
         else:
-            self._parts = message
+            self._segments = message
 
     def __iter__(self):
-        return iter(self._parts)
+        return iter(self._segments)
 
     @property
     def text(self) -> str:
         """The raw text of the message."""
         result = []
-        for part in self._parts:
+        for part in self._segments:
             if is_tag(part):
                 result.append(part.to_text())
             else:
@@ -40,19 +40,19 @@ class LMS_MessageText:
 
     @text.setter
     def text(self, string: str) -> None:
-        self._set_parts(string)
+        self._set_segments(string)
 
     @property
     def tags(self) -> list[LMS_ControlTag]:
         """The list of control tags in the message."""
-        return [part for part in self._parts if is_tag(part)]
+        return [part for part in self._segments if is_tag(part)]
 
     @property
     def tag_positions(self) -> dict[LMS_ControlTag, tuple[int, int]]:
         """Dict of tag objects to their start and end positions in text."""
         positions = {}
         pos = 0
-        for part in self._parts:
+        for part in self._segments:
             text_len = len(part)
             if is_tag(part):
                 positions[part] = (pos, pos + text_len)
@@ -86,7 +86,7 @@ class LMS_MessageText:
                 group_id, tag_index, None if not parameters else list(parameters)
             )
 
-        self._parts.append(tag)
+        self._segments.append(tag)
         return tag
 
     def append_decoded_tag(
@@ -94,7 +94,7 @@ class LMS_MessageText:
             group_name: str,
             tag_name: str,
             is_closing: bool = False,
-            **parameters: int | str | float | bool | bytes,
+            **parameters: FieldValue
     ) -> LMS_DecodedTag:
         """
         Appends a decoded tag to the current message and returns that tag.
@@ -120,7 +120,7 @@ class LMS_MessageText:
                 raise LMS_TagForbiddenParametersError("There may not be parameters for closing tags!")
 
             tag = LMS_DecodedTag(definition, is_closing=True)
-            self._parts.append(tag)
+            self._segments.append(tag)
             return tag
 
         if parameters:
@@ -129,7 +129,7 @@ class LMS_MessageText:
         else:
             tag = LMS_DecodedTag(definition)
 
-        self._parts.append(tag)
+        self._segments.append(tag)
         return tag
 
     def append_tag_string(self, tag: str) -> LMS_ControlTag:
@@ -158,13 +158,13 @@ class LMS_MessageText:
         else:
             raise ValueError(f"Invalid format in tag '{tag}'.")
 
-        self._parts.append(tag_obj)
+        self._segments.append(tag_obj)
         return tag_obj
 
-    def _set_parts(self, text: str) -> None:
-        self._parts = []
+    def _set_segments(self, text: str) -> None:
+        self._segments = []
         for part in self.TAG_FORMAT.split(text):
             if bool(re.match(self.TAG_FORMAT, part)):
                 self.append_tag_string(part)
             else:
-                self._parts.append(part)
+                self._segments.append(part)

{pylibms-3.3 → pylibms-3.3.2}/lms/message/msbt.py

@@ -9,20 +9,28 @@ class MSBT:
     """
     A class that represents a MSBT file.
 
+    ======
+    Usages
+    ======
+    https://github.com/AbdyyEee/PylibMS/wiki/MSBT
+
+    =========
+    File Info
+    =========
     https://nintendo-formats.com/libs/lms/msbt.html
     """
-
     MAGIC = "MsgStdBn"
 
     DEFAULT_SLOT_COUNT = 101
 
     ATR1_INDEX = 1
     TXT2_INDEX = 2
-    TSY_INDEX = 3
+    TSY1_INDEX = 3
 
     def __init__(
             self,
             info: LMS_FileInfo | None = None,
+            uses_nli1: bool = False,
             section_list: list[str] | None = None,
             unsupported_section_map: dict[str, bytes] | None = None,
             attribute_config: AttributeConfig | None = None,
@@ -43,13 +51,14 @@ class MSBT:
         self._unsupported_section_map = unsupported_section_map or {}
 
         # Store the section list so that the order of any and all sections is preserved when writing
-        self._section_list: list[str] = section_list or ["LBL1"]
+        self._section_list: list[str] = section_list or ["LBL1" if not uses_nli1 else "NLI1"]
 
         self._attribute_config = attribute_config
         self._tag_config = tag_config
 
     @classmethod
     def new(cls,
+            uses_nli1: bool = False,
             attribute_config: AttributeConfig | None = None,
             tag_config: TagConfig | None = None,
             is_big_endian: bool = False,
@@ -58,6 +67,7 @@ class MSBT:
             section_count: int = 2):
         """Create a new MSBT instance.
 
+        :param uses_nli1: flag to determine if to use nli1 section for labels.
         :param attribute_config: the attribute config object
         :param tag_config: the tag config object
         :param is_big_endian: if the file is big endian.
@@ -65,13 +75,13 @@ class MSBT:
         :param version: the file version.
         :param section_count: the number of sections.
 
-        ========
-        Examples
-        ========
+        ======
+        Usages
+        ======
         See https://github.com/AbdyyEee/PylibMS/wiki/MSBT#creating-a-msbt
         """
-        return MSBT(info=LMS_FileInfo(is_big_endian, encoding, version, section_count),
-                    attribute_config=attribute_config, tag_config=tag_config)
+        return MSBT(LMS_FileInfo(is_big_endian, encoding, version, section_count),
+                    uses_nli1=uses_nli1, attribute_config=attribute_config, tag_config=tag_config)
 
     def __len__(self) -> int:
         return len(self._entries)
@@ -100,12 +110,17 @@ class MSBT:
         return tuple(self._unsupported_section_map.keys())
 
     @property
-    def has_attributes(self) -> bool:
+    def uses_nli1(self) -> bool:
+        """If the MSBT contains the NLI1 section."""
+        return self.section_exists("NLI1")
+
+    @property
+    def contains_attributes(self) -> bool:
         """If the MSBT contains attributes."""
         return self.section_exists("ATR1")
 
     @property
-    def has_styles(self) -> bool:
+    def contains_styles(self) -> bool:
         """If the MSBT contains style indexes."""
         return self.section_exists("TSY1")
 
@@ -141,7 +156,7 @@ class MSBT:
             raise KeyError(f"The label '{entry.name}' already exists!")
 
         # The implementation of ensuring section orders are maintained are done by constant indexes.
-        # In most MSBT files, it goes as LBL1 -> TXT2 -> ATR1 -> TSY1.
+        # In most MSBT files, it goes as LBL1/NLI1 -> TXT2 -> ATR1 -> TSY1.
         # If add_entry is utilized on a new MSBT instance, then these indexes ensure the order is maintained.
         # While technically, undocumented sections (i.e. ATO1) can prefix TXT2 and other sections,
         # we do not need to account for that scenario as they aren't supported by the library
@@ -164,7 +179,7 @@ class MSBT:
                     f"Entry '{entry.name}' can't be added with no style index when styles already exist!"
                 )
         elif entry.style_index is not None:
-            self._section_list.insert(self.TSY_INDEX, "TSY1")
+            self._section_list.insert(self.TSY1_INDEX, "TSY1")
             self._info.section_count += 1
 
         self._entries.append(entry)

{pylibms-3.3 → pylibms-3.3.2}/lms/message/msbtio.py

@@ -79,12 +79,14 @@ def read_msbt(
     messages = atr1_data = style_indexes = None
 
     labels: dict[int, str] = {}
+    uses_nli1 = False
     for magic, size in read_section_data(reader, file_info.section_count):
         match magic:
             case "LBL1":
                 labels, slot_count = read_labels(reader)
             case "NLI1":
                 labels = read_nli1(reader)
+                uses_nli1 = True
             case "ATR1":
                 atr1_data = read_atr1(reader, attribute_config, size)
             case "TXT2":
@@ -98,7 +100,8 @@ def read_msbt(
             section_list.append(magic)
 
     file = MSBT(
-        file_info, section_list, unsupported_sections, attribute_config, tag_config
+        file_info, uses_nli1, section_list,
+        unsupported_sections, attribute_config, tag_config
     )
     file.slot_count = slot_count
 

{pylibms-3.3 → pylibms-3.3.2}/lms/message/section/atr1.py

@@ -39,7 +39,7 @@ def read_encoded_atr1(reader: FileReader, section_size: int) -> ATR1Data:
 
 def read_decoded_atr1(reader: FileReader, config: AttributeConfig) -> ATR1Data:
     # String table as a list is not necessary for decoded attributes
-    # It is easier to save all changes from the user by when writing
+    # It is easier to save all changes from the user  when writing
     # to recreate the table from all the string parameters in every attribute
     string_table = None
 

{pylibms-3.3 → pylibms-3.3.2}/lms/message/section/txt2.py

@@ -19,24 +19,23 @@ def read_txt2(
     for offset in reader.read_offset_array(message_count):
         reader.seek(offset)
 
-        text, parts = b"", []
+        text, text_segments = b"", []
         while (data := reader.read_bytes(encoding.width)) != encoding.terminator:
-            is_opening_tag = data == tag_start
             is_closing_tag = data == tag_close
 
-            if is_opening_tag or is_closing_tag:
-                parts.append(text.decode(encoding_format))
+            if data == tag_start or is_closing_tag:
+                text_segments.append(text.decode(encoding_format))
                 tag = read_tag(reader, config, is_closing_tag, suppress_tag_errors)
-                parts.append(tag)
+                text_segments.append(tag)
                 text = b""
             else:
                 text += data
 
         # Add the remaining text in case there were no control tags
         if text:
-            parts.append(text.decode(encoding_format))
+            text_segments.append(text.decode(encoding_format))
 
-        message = LMS_MessageText(parts, config)
+        message = LMS_MessageText(text_segments, config)
         messages.append(message)
 
     return messages

{pylibms-3.3 → pylibms-3.3.2}/lms/project/msbp.py

@@ -9,7 +9,15 @@ class MSBP:
     """
     A class that represents a MSBP file.
 
-    https://nintendo-formats.com/libs/lms/msbp.html.
+    ======
+    Usages
+    ======
+    https://github.com/AbdyyEee/PylibMS/wiki/MSBP
+
+    =========
+    File Info
+    =========
+    https://nintendo-formats.com/libs/lms/msbp.html
     """
 
     MAGIC = "MsgPrjBn"
@@ -23,10 +31,9 @@ class MSBP:
             styles: list[LMS_Style] | None,
             source_files: list[str] | None,
     ):
-        self.name: str = ""
+        self.name = ""
 
         self._info = info
-
         self._colors = colors
         self._attribute_definitions = config
         self._tag_groups = tag_groups
@@ -35,7 +42,7 @@ class MSBP:
 
     @property
     def info(self) -> LMS_FileInfo:
-        """The stream info of the MSBP."""
+        """The file info for the MSBP instance."""
         return self._info
 
     @property

{pylibms-3.3 → pylibms-3.3.2}/lms/project/msbpread.py

@@ -62,7 +62,7 @@ def read_msbp(stream: BinaryIO | bytes) -> MSBP:
     for magic, _ in read_section_data(reader, file_info.section_count):
         match magic:
             case "CLB1" | "ALB1" | "SLB1":
-                # Set the name attributes of last read item
+                # Set the name attribute of last read item
                 labels, _ = read_labels(reader)
                 for i in labels:
                     items[i].name = labels[i]

{pylibms-3.3 → pylibms-3.3.2}/pyproject.toml

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