PyLibMS 5.0.1__tar.gz → 5.0.2__tar.gz

{pylibms-5.0.1 → pylibms-5.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 5.0.1
+Version: 5.0.2
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
 Author: AbdyyEee
 License-Expression: MIT
@@ -23,6 +23,7 @@ Dynamic: license-file
 [![Python Versions](https://img.shields.io/pypi/pyversions/PyLibMS)](https://pypi.org/project/PyLibMS/)
 ![LICENSE](https://img.shields.io/badge/license-MIT-blue)
 [![PyPI version](https://badge.fury.io/py/PyLibMS.svg)](https://badge.fury.io/py/PyLibMS)
+![Tests](https://github.com/abdyyeee/PyLibMS/actions/workflows/tests.yml/badge.svg?branch=main)
 
 PyLibMS is a library built in Python 3.11 and above for reading and writing of libMessageStudio (LMS) proprietary file
 formats from Nintendo.
@@ -90,7 +91,7 @@ pip install PyLibMS
 
 # Build Instructions
 
-Python version must be `3.10` or higher.
+Python version must be `3.11` or higher.
 
 Clone the repository, then run `pip install` (venv recommended)
 
@@ -102,15 +103,7 @@ pip install -e .
 
 # AI Disclaimer
 
-Code in this library was written by me. AI was utilized occasionally when fit and always reviewed by me.
-
-`MSBT`: Only usage of AI was for control tag regex formats and for understanding implementing string importing with
-`re`.
-
-`MSBP`: AI was not utilized anywhere.
-
-`MSBF`: AI was only utilized for the `LMS_BaseNode.get_descendents` function and for consultation for ways to improve
-the API.
+Code in this library was written by me. AI was utilized occasionally when developing MSBT (specifically tag string importing) , MSBF and assisting in creating unit tests. 
 
 # Credits & Sources
 

{pylibms-5.0.1 → pylibms-5.0.2}/PyLibMS.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 5.0.1
+Version: 5.0.2
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
 Author: AbdyyEee
 License-Expression: MIT
@@ -23,6 +23,7 @@ Dynamic: license-file
 [![Python Versions](https://img.shields.io/pypi/pyversions/PyLibMS)](https://pypi.org/project/PyLibMS/)
 ![LICENSE](https://img.shields.io/badge/license-MIT-blue)
 [![PyPI version](https://badge.fury.io/py/PyLibMS.svg)](https://badge.fury.io/py/PyLibMS)
+![Tests](https://github.com/abdyyeee/PyLibMS/actions/workflows/tests.yml/badge.svg?branch=main)
 
 PyLibMS is a library built in Python 3.11 and above for reading and writing of libMessageStudio (LMS) proprietary file
 formats from Nintendo.
@@ -90,7 +91,7 @@ pip install PyLibMS
 
 # Build Instructions
 
-Python version must be `3.10` or higher.
+Python version must be `3.11` or higher.
 
 Clone the repository, then run `pip install` (venv recommended)
 
@@ -102,15 +103,7 @@ pip install -e .
 
 # AI Disclaimer
 
-Code in this library was written by me. AI was utilized occasionally when fit and always reviewed by me.
-
-`MSBT`: Only usage of AI was for control tag regex formats and for understanding implementing string importing with
-`re`.
-
-`MSBP`: AI was not utilized anywhere.
-
-`MSBF`: AI was only utilized for the `LMS_BaseNode.get_descendents` function and for consultation for ways to improve
-the API.
+Code in this library was written by me. AI was utilized occasionally when developing MSBT (specifically tag string importing) , MSBF and assisting in creating unit tests. 
 
 # Credits & Sources
 

{pylibms-5.0.1 → pylibms-5.0.2}/PyLibMS.egg-info/SOURCES.txt

@@ -36,7 +36,6 @@ lms/message/msbt.py
 lms/message/msbtentry.py
 lms/message/msbtio.py
 lms/message/definitions/__init__.py
-lms/message/definitions/field/__init__.py
 lms/message/section/__init__.py
 lms/message/section/atr1.py
 lms/message/section/nli1.py

{pylibms-5.0.1 → pylibms-5.0.2}/README.md

@@ -3,6 +3,7 @@
 [![Python Versions](https://img.shields.io/pypi/pyversions/PyLibMS)](https://pypi.org/project/PyLibMS/)
 ![LICENSE](https://img.shields.io/badge/license-MIT-blue)
 [![PyPI version](https://badge.fury.io/py/PyLibMS.svg)](https://badge.fury.io/py/PyLibMS)
+![Tests](https://github.com/abdyyeee/PyLibMS/actions/workflows/tests.yml/badge.svg?branch=main)
 
 PyLibMS is a library built in Python 3.11 and above for reading and writing of libMessageStudio (LMS) proprietary file
 formats from Nintendo.
@@ -70,7 +71,7 @@ pip install PyLibMS
 
 # Build Instructions
 
-Python version must be `3.10` or higher.
+Python version must be `3.11` or higher.
 
 Clone the repository, then run `pip install` (venv recommended)
 
@@ -82,15 +83,7 @@ pip install -e .
 
 # AI Disclaimer
 
-Code in this library was written by me. AI was utilized occasionally when fit and always reviewed by me.
-
-`MSBT`: Only usage of AI was for control tag regex formats and for understanding implementing string importing with
-`re`.
-
-`MSBP`: AI was not utilized anywhere.
-
-`MSBF`: AI was only utilized for the `LMS_BaseNode.get_descendents` function and for consultation for ways to improve
-the API.
+Code in this library was written by me. AI was utilized occasionally when developing MSBT (specifically tag string importing) , MSBF and assisting in creating unit tests. 
 
 # Credits & Sources
 

{pylibms-5.0.1 → pylibms-5.0.2}/lms/common/field/io.py

@@ -3,7 +3,6 @@ from typing import Callable
 from lms.common.field.lms_datatype import (
     LMS_DataType,
     is_bool_datatype,
-    is_bytes_datatype,
     is_enum_datatype,
     is_number_datatype,
 )
@@ -72,8 +71,6 @@ def write_field(
             write_variable_width_value(value)
         else:
             writer.write_uint8(value)
-    elif is_bytes_datatype(field.value, field.datatype):
-        writer.write_bytes(field.value)
     elif is_bool_datatype(field.value, field.datatype):
         if write_variable_width_value is not None:
             write_variable_width_value(bool(field.value))

{pylibms-5.0.1 → pylibms-5.0.2}/lms/common/field/lms_datatype.py

@@ -22,6 +22,9 @@ ALIAS_MAP = {
 
 
 def is_number_datatype(value: object, datatype: LMS_DataType) -> TypeGuard[int | float]:
+    if isinstance(value, float) and datatype is LMS_DataType.FLOAT32:
+        return True
+
     return datatype in (
         LMS_DataType.UINT8,
         LMS_DataType.UINT16,
@@ -29,7 +32,6 @@ def is_number_datatype(value: object, datatype: LMS_DataType) -> TypeGuard[int |
         LMS_DataType.INT8,
         LMS_DataType.INT16,
         LMS_DataType.INT32,
-        LMS_DataType.FLOAT32,
     ) and isinstance(value, int)
 
 
@@ -138,8 +140,8 @@ def verify_number_from_datatype(
     else:
         bits = datatype.stream_size * 8
         if datatype.signed:
-            max_value = 2 ** (bits - 1)
-            min_value = -max_value
+            min_value = -(2 ** (bits - 1))
+            max_value = (2 ** (bits - 1)) - 1
         else:
             min_value, max_value = 0, (2 ** bits) - 1
 

{pylibms-5.0.1 → pylibms-5.0.2}/lms/common/field/lms_field.py

@@ -93,7 +93,7 @@ class LMS_FieldMap:
             value = data[definition.name]
             match definition.datatype:
                 case LMS_DataType.BOOL:
-                    if value not in ("false", "true"):
+                    if value.lower() not in ("false", "true"):
                         raise ValueError("Invalid boolean value!")
                     casted_value = value.strip().lower() == "true"
                 case LMS_DataType.FLOAT32:
@@ -174,7 +174,7 @@ def _verify_value_from_definition(
                 )
             else:
                 return
-        case _ if isinstance(value, int):
+        case _ if isinstance(value, (int, float)):
             verify_number_from_datatype(value, definition.datatype)
             return
 

{pylibms-5.0.1 → pylibms-5.0.2}/lms/message/lms_messagetext.py

@@ -7,7 +7,7 @@ from lms.message.tag.lms_tag import (
     LMS_ControlTag,
     LMS_DecodedTag,
     LMS_EncodedTag,
-    is_tag,
+    is_tag, TAG_PADDING_VALUE,
 )
 from lms.message.tag.lms_tagexceptions import LMS_TagForbiddenParametersError
 from lms.titleconfig.config import TagConfig
@@ -90,8 +90,12 @@ class LMS_MessageText:
 
             tag = LMS_EncodedTag(group_id, tag_index, is_closing=True)
         else:
+            list_parameters = list(parameters)
+            if len(list_parameters) % 2 == 1:
+                list_parameters.append(TAG_PADDING_VALUE)
+
             tag = LMS_EncodedTag(
-                group_id, tag_index, None if not parameters else list(parameters)
+                group_id, tag_index, None if not parameters else list_parameters
             )
 
         self._segments.append(tag)
@@ -121,7 +125,7 @@ class LMS_MessageText:
         if self._tag_config is None:
             raise ValueError("A TitleConfig is required to append decoded tags.")
 
-        definition = self._tag_config.get_definition_by_names(group_name, tag_name)
+        definition = self._tag_config[group_name][tag_name]
 
         if is_closing:
             if parameters:

{pylibms-5.0.1 → pylibms-5.0.2}/lms/message/msbt.py

@@ -1,7 +1,9 @@
 from typing import overload
 
+from lms.common.field.lms_field import LMS_FieldMap
 from lms.common.lms_fileinfo import LMS_FileInfo
 from lms.fileio.encoding import FileEncoding
+from lms.message.lms_messagetext import LMS_MessageText
 from lms.message.msbtentry import MSBTEntry
 from lms.titleconfig.definitions.attribute import AttributeConfig
 from lms.titleconfig.definitions.tags import TagConfig
@@ -219,6 +221,24 @@ class MSBT:
         self._entries.append(entry)
         self._label_map[entry.name] = entry
 
+    def create_entry(self, name: str,
+                     message: str = None,
+                     attribute: LMS_FieldMap | bytes | None = None,
+                     style_index: int = None) -> MSBTEntry:
+        """
+        Creates an MSBT Entry and adds it to the file.
+
+        param name: the name of the entry.
+        param message: the message of the entry.
+        param attribute: the attribute of the entry.
+        param style_index: the style of the entry.
+        """
+        self.add_entry(entry := MSBTEntry(name,
+                                          message=LMS_MessageText(message, self._tag_config),
+                                          attribute=attribute,
+                                          style_index=style_index))
+        return entry
+
     def delete_entry(self, entry: MSBTEntry) -> None:
         """
         Deletes an entry from the MSBT instance.

{pylibms-5.0.1 → pylibms-5.0.2}/lms/message/tag/io/param_io.py

@@ -59,6 +59,8 @@ def write_decoded_parameters(
                 param_size += 2 + len(field.value) * writer.encoding.width
             case LMS_DataType.ENUM:
                 param_size += 1
+            case LMS_DataType.BOOL:
+                param_size += 1
             case _:
                 param_size += field.datatype.stream_size
 

{pylibms-5.0.1 → pylibms-5.0.2}/lms/message/tag/io/tag_io.py

@@ -37,7 +37,7 @@ def read_tag(
         return _read_encoded_tag(reader, group_id, tag_index, is_closing)
 
     definition = tag_config[group_id][tag_index]
-    
+
     # Tags not defined in the config are not considered fallback tags
     # Not all configs will define every tag, so this is simply a measure to still read tags that aren't defined
     if definition is None:
@@ -79,15 +79,15 @@ def _read_encoded_tag(
 def _read_decoded_tag(
         reader: FileReader, definition: TagDefinition, is_closing: bool = False
 ) -> LMS_DecodedTag:
+    if is_closing:
+        return LMS_DecodedTag(definition, is_closing=True)
+
     parameter_size = reader.read_uint16()
     end = reader.tell() + parameter_size
 
     if not parameter_size:
         return LMS_DecodedTag(definition)
 
-    if is_closing:
-        return LMS_DecodedTag(definition, is_closing=True)
-
     parameters = read_decoded_parameters(reader, definition)
     reader.seek(end)
     return LMS_DecodedTag(definition, parameters)

{pylibms-5.0.1 → pylibms-5.0.2}/lms/message/tag/lms_tag.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import re
-from typing import TypeGuard, TypeAlias
+from typing import TypeGuard, TypeAlias, Sequence
 
 from lms.common.field.lms_field import LMS_FieldMap
 from lms.message.tag.lms_tagexceptions import (
@@ -29,44 +29,48 @@ class LMS_EncodedTag:
             is_fallback: bool = False,
             is_closing: bool = False,
     ):
-        self._group_id = group_id
-        self._tag_index = tag_index
+        self.group_id = group_id
+        self.tag_index = tag_index
+        self.is_closing = is_closing
+
         self._parameters = parameters
 
         self._is_fallback = is_fallback
-        self._is_closing = is_closing
 
     def __len__(self) -> int:
         return len(self.to_text())
 
     @property
-    def group_id(self) -> int:
-        """The group id for the tag."""
-        return self._group_id
+    def parameters(self) -> tuple[int, ...]:
+        """The list of parameters."""
+        return () if self._parameters is None else tuple(self._parameters)
 
-    @property
-    def tag_index(self) -> int:
-        """The tag index in the tags group."""
-        return self._tag_index
+    @parameters.setter
+    def parameters(self, parameters: Sequence[int] | None) -> None:
+        if parameters is None:
+            self._parameters = None
+            return
 
-    @property
-    def parameters(self) -> tuple[int, ...] | None:
-        """The list of parameters."""
-        return tuple(self._parameters)
+        for value in parameters:
+            if type(value) is not int:
+                raise TypeError("Each parameter must be an integer.")
+            if not 0 <= value <= 0xFF:
+                raise ValueError("Each parameter must be between 0 and 255.")
+
+        new = list(parameters)
+        if len(new) % 2 == 1:
+            new.append(TAG_PADDING_VALUE)
+
+        self._parameters = tuple(new)
 
     @property
     def is_fallback(self) -> bool:
         """Determines if the tag is a fallback tag. Fallback tags have a '!' prefix before the group index."""
         return self._is_fallback
 
-    @property
-    def is_closing(self) -> bool:
-        """Determines if the tag is a closing tag."""
-        return self._is_closing
-
     def to_text(self) -> str:
-        if self._is_closing:
-            return f"[/{self._group_id}:{self._tag_index}]"
+        if self.is_closing:
+            return f"[/{self.group_id}:{self.tag_index}]"
 
         fallback_prefix = "!" if self._is_fallback else ""
 
@@ -134,7 +138,7 @@ class LMS_DecodedTag:
     """
 
     TAG_FORMAT = re.compile(
-        r"\[\s*(/)?\s*([A-Za-z]\w*)\s*:\s*([A-Za-z]+)(?:\s+[^]]*)?\s*]"
+        r"\[\s*(/)?\s*([A-Za-z]\w*)\s*:\s*([A-Za-z]\w*)(?:\s+[^]]*)?\s*]"
     )
     PARAMETER_FORMAT = re.compile(r'(\w+)="([^"]*)"')
 

{pylibms-5.0.1 → pylibms-5.0.2}/pyproject.toml

@@ -7,7 +7,7 @@ include = ["lms*"]
 
 [project]
 name = "PyLibMS"
-version = "5.0.1"
+version = "5.0.2"
 requires-python = ">=3.11"
 description = "Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF."
 readme = "README.md"