PyLibMS 3.3.1__tar.gz → 3.3.2__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 3.3.1
+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.1 → pylibms-3.3.2}/PyLibMS.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 3.3.1
+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.1 → 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.1 → pylibms-3.3.2}/lms/common/lms_datatype.py

@@ -25,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]:

{pylibms-3.3.1 → 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.1 → pylibms-3.3.2}/lms/message/msbt.py

@@ -43,19 +43,15 @@ class MSBT:
 
         self.size_per_attribute = 0
 
-        self._slot_count = MSBT.DEFAULT_SLOT_COUNT
+        self.slot_count = MSBT.DEFAULT_SLOT_COUNT
 
         self.uses_encoded_attributes = True
         self.attr_string_table: bytes | None = None
 
         self._unsupported_section_map = unsupported_section_map or {}
 
-        # Some MSBTs store labels with NLI1 over LBL1
-        # This flag creates a MSBT instance with NLI1 preferred over LBL1
-        self.uses_nli1 = uses_nli1
-
         # 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" if not self.uses_nli1 else "NLI1"]
+        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
@@ -103,11 +99,6 @@ class MSBT:
         """Tuple of all the MSBT entries."""
         return tuple(self._entries)
 
-    @property
-    def slot_count(self) -> int:
-        """The slot count for the MSBT instance."""
-        return self._slot_count
-
     @property
     def section_list(self) -> tuple[str, ...]:
         """The list of sections with order preserved."""
@@ -118,6 +109,11 @@ class MSBT:
         """The list of unsupported sections."""
         return tuple(self._unsupported_section_map.keys())
 
+    @property
+    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."""

{pylibms-3.3.1 → 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.1 → pylibms-3.3.2}/lms/message/section/txt2.py

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

{pylibms-3.3.1 → 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.1 → pylibms-3.3.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "PyLibMS"
-version = "3.3.1"
+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"