PyLibMS 4.2.3__tar.gz → 4.2.5__tar.gz

{pylibms-4.2.3 → pylibms-4.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 4.2.3
+Version: 4.2.5
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
 Author: AbdyyEee
 License-Expression: MIT
@@ -20,10 +20,13 @@ Requires-Dist: requests>=2.34.0
 Dynamic: license-file
 
 # PyLibMS
-[![Python Versions](https://img.shields.io/pypi/pyversions/PyLibMS)](https://pypi.org/project/PyLibMS/) 
+
+[![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)
 
-PyLibMS is a library built in Python 3.10 and above for reading and writing of libMessageStudio (LMS) proprietary file formats from Nintendo. 
+PyLibMS is a library built in Python 3.10 and above for reading and writing of libMessageStudio (LMS) proprietary file
+formats from Nintendo.
 
 The following is supported
 | Format | Read | Write | Configuration Support                                                                     |
@@ -32,7 +35,9 @@ The following is supported
 | `MSBF`        | ✅    | ✅     | Support for custom node definitions, attaching names and descriptions to nodes. Altering parameter datatypes for flexibility between games.  |
 | `MSBP`        | ✅    | ❌     | Generating configuration files for use with `MSBT` files.                                                                                       |
 
-This library is designed to support LMS revision >=3.0. These include files generated for late **Wii** titles, **Nintendo 3DS**, **Wii U**, **Mobile**, **Nintendo Switch** and **Nintendo Switch 2** games.
+
+This library is designed to support LMS revision >=3.0. These include files generated for late **Wii** titles,
+**Nintendo 3DS**, **Wii U**, **Mobile**, **Nintendo Switch** and **Nintendo Switch 2** games.
 
 # Features and Usage
 
@@ -50,25 +55,27 @@ msbt = read_msbt_path("Text.msbt")
 ```
 
 ### MSBP
+
 ```py
 from lms.project.msbpread import read_msbp_path
 
 msbp = read_msbp_path("Project.msbp")
 ```
 
-
 ### MSBF
+
 ```py
 from lms.flowchart.msbfio import read_msbf_path
 
 msbf = read_msbf_path("Flowchart.msbf")
 ```
 
-
 ## Writing
+
 There is no writing for `MSBP` files as most of the time it acts as leftover metadata and not actually loaded by games.
 
 ### MSBT
+
 ```py
 from lms.message.msbtio import write_msbt_path
 
@@ -76,6 +83,7 @@ write_msbt_path("Out_text.msbt")
 ```
 
 ### MSBF
+
 ```py
 from lms.flowchart.msbfio import write_msbf_path
 
@@ -107,7 +115,9 @@ pip install -e .
 ```
 
 # Credits & Sources
-* [SS-Decomp](https://github.com/zeldaret/ss): Referenced some parts of their MSBF decomp when adding the format to [Nintendo-File-Formats](https://nintendo-formats.com) and this library.
+
+* [SS-Decomp](https://github.com/zeldaret/ss): Referenced some parts of their MSBF decomp when adding the format
+  to [Nintendo-File-Formats](https://nintendo-formats.com) and this library.
 * [Nintendo-File-Formats](https://nintendo-formats.com) by Kinnay: For existing information on the MSBT and MSBP file
   formats.
 * [Trippixyz](https://github.com/Trippixyz): For helping me get started general decompilation of the formats and general

{pylibms-4.2.3 → pylibms-4.2.5}/PyLibMS.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 4.2.3
+Version: 4.2.5
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
 Author: AbdyyEee
 License-Expression: MIT
@@ -20,10 +20,13 @@ Requires-Dist: requests>=2.34.0
 Dynamic: license-file
 
 # PyLibMS
-[![Python Versions](https://img.shields.io/pypi/pyversions/PyLibMS)](https://pypi.org/project/PyLibMS/) 
+
+[![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)
 
-PyLibMS is a library built in Python 3.10 and above for reading and writing of libMessageStudio (LMS) proprietary file formats from Nintendo. 
+PyLibMS is a library built in Python 3.10 and above for reading and writing of libMessageStudio (LMS) proprietary file
+formats from Nintendo.
 
 The following is supported
 | Format | Read | Write | Configuration Support                                                                     |
@@ -32,7 +35,9 @@ The following is supported
 | `MSBF`        | ✅    | ✅     | Support for custom node definitions, attaching names and descriptions to nodes. Altering parameter datatypes for flexibility between games.  |
 | `MSBP`        | ✅    | ❌     | Generating configuration files for use with `MSBT` files.                                                                                       |
 
-This library is designed to support LMS revision >=3.0. These include files generated for late **Wii** titles, **Nintendo 3DS**, **Wii U**, **Mobile**, **Nintendo Switch** and **Nintendo Switch 2** games.
+
+This library is designed to support LMS revision >=3.0. These include files generated for late **Wii** titles,
+**Nintendo 3DS**, **Wii U**, **Mobile**, **Nintendo Switch** and **Nintendo Switch 2** games.
 
 # Features and Usage
 
@@ -50,25 +55,27 @@ msbt = read_msbt_path("Text.msbt")
 ```
 
 ### MSBP
+
 ```py
 from lms.project.msbpread import read_msbp_path
 
 msbp = read_msbp_path("Project.msbp")
 ```
 
-
 ### MSBF
+
 ```py
 from lms.flowchart.msbfio import read_msbf_path
 
 msbf = read_msbf_path("Flowchart.msbf")
 ```
 
-
 ## Writing
+
 There is no writing for `MSBP` files as most of the time it acts as leftover metadata and not actually loaded by games.
 
 ### MSBT
+
 ```py
 from lms.message.msbtio import write_msbt_path
 
@@ -76,6 +83,7 @@ write_msbt_path("Out_text.msbt")
 ```
 
 ### MSBF
+
 ```py
 from lms.flowchart.msbfio import write_msbf_path
 
@@ -107,7 +115,9 @@ pip install -e .
 ```
 
 # Credits & Sources
-* [SS-Decomp](https://github.com/zeldaret/ss): Referenced some parts of their MSBF decomp when adding the format to [Nintendo-File-Formats](https://nintendo-formats.com) and this library.
+
+* [SS-Decomp](https://github.com/zeldaret/ss): Referenced some parts of their MSBF decomp when adding the format
+  to [Nintendo-File-Formats](https://nintendo-formats.com) and this library.
 * [Nintendo-File-Formats](https://nintendo-formats.com) by Kinnay: For existing information on the MSBT and MSBP file
   formats.
 * [Trippixyz](https://github.com/Trippixyz): For helping me get started general decompilation of the formats and general

{pylibms-4.2.3 → pylibms-4.2.5}/README.md

@@ -1,8 +1,11 @@
 # PyLibMS
-[![Python Versions](https://img.shields.io/pypi/pyversions/PyLibMS)](https://pypi.org/project/PyLibMS/) 
+
+[![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)
 
-PyLibMS is a library built in Python 3.10 and above for reading and writing of libMessageStudio (LMS) proprietary file formats from Nintendo. 
+PyLibMS is a library built in Python 3.10 and above for reading and writing of libMessageStudio (LMS) proprietary file
+formats from Nintendo.
 
 The following is supported
 | Format | Read | Write | Configuration Support                                                                     |
@@ -11,7 +14,9 @@ The following is supported
 | `MSBF`        | ✅    | ✅     | Support for custom node definitions, attaching names and descriptions to nodes. Altering parameter datatypes for flexibility between games.  |
 | `MSBP`        | ✅    | ❌     | Generating configuration files for use with `MSBT` files.                                                                                       |
 
-This library is designed to support LMS revision >=3.0. These include files generated for late **Wii** titles, **Nintendo 3DS**, **Wii U**, **Mobile**, **Nintendo Switch** and **Nintendo Switch 2** games.
+
+This library is designed to support LMS revision >=3.0. These include files generated for late **Wii** titles,
+**Nintendo 3DS**, **Wii U**, **Mobile**, **Nintendo Switch** and **Nintendo Switch 2** games.
 
 # Features and Usage
 
@@ -29,25 +34,27 @@ msbt = read_msbt_path("Text.msbt")
 ```
 
 ### MSBP
+
 ```py
 from lms.project.msbpread import read_msbp_path
 
 msbp = read_msbp_path("Project.msbp")
 ```
 
-
 ### MSBF
+
 ```py
 from lms.flowchart.msbfio import read_msbf_path
 
 msbf = read_msbf_path("Flowchart.msbf")
 ```
 
-
 ## Writing
+
 There is no writing for `MSBP` files as most of the time it acts as leftover metadata and not actually loaded by games.
 
 ### MSBT
+
 ```py
 from lms.message.msbtio import write_msbt_path
 
@@ -55,6 +62,7 @@ write_msbt_path("Out_text.msbt")
 ```
 
 ### MSBF
+
 ```py
 from lms.flowchart.msbfio import write_msbf_path
 
@@ -86,7 +94,9 @@ pip install -e .
 ```
 
 # Credits & Sources
-* [SS-Decomp](https://github.com/zeldaret/ss): Referenced some parts of their MSBF decomp when adding the format to [Nintendo-File-Formats](https://nintendo-formats.com) and this library.
+
+* [SS-Decomp](https://github.com/zeldaret/ss): Referenced some parts of their MSBF decomp when adding the format
+  to [Nintendo-File-Formats](https://nintendo-formats.com) and this library.
 * [Nintendo-File-Formats](https://nintendo-formats.com) by Kinnay: For existing information on the MSBT and MSBP file
   formats.
 * [Trippixyz](https://github.com/Trippixyz): For helping me get started general decompilation of the formats and general

{pylibms-4.2.3 → pylibms-4.2.5}/lms/common/field/io.py

@@ -1,15 +1,22 @@
 from typing import Callable
 
-from lms.common.field.lms_datatype import (LMS_DataType, is_bool_datatype,
-                                           is_bytes_datatype, is_list_datatype,
-                                           is_number_datatype)
+from lms.common.field.lms_datatype import (
+    LMS_DataType,
+    is_bool_datatype,
+    is_bytes_datatype,
+    is_list_datatype,
+    is_number_datatype,
+)
 from lms.common.field.lms_field import LMS_Field
 from lms.fileio.io import FileReader, FileWriter
 from lms.titleconfig.definitions.value import ValueDefinition
 
 
-def read_field(reader: FileReader, definition: ValueDefinition,
-               read_variable_width_value: Callable | None = None) -> LMS_Field:
+def read_field(
+    reader: FileReader,
+    definition: ValueDefinition,
+    read_variable_width_value: Callable | None = None,
+) -> LMS_Field:
     # String is excluded as their reading varies between MSBT/MSBF
     match definition.datatype:
         case LMS_DataType.UINT8:
@@ -43,7 +50,11 @@ def read_field(reader: FileReader, definition: ValueDefinition,
     return LMS_Field(value, definition)  # type: ignore
 
 
-def write_field(writer: FileWriter, field: LMS_Field, write_variable_width_value: Callable | None = None) -> None:
+def write_field(
+    writer: FileWriter,
+    field: LMS_Field,
+    write_variable_width_value: Callable | None = None,
+) -> None:
     if is_number_datatype(field.value, field.datatype):
         write_functions: dict[LMS_DataType, Callable] = {
             LMS_DataType.UINT8: writer.write_uint8,

{pylibms-4.2.3 → pylibms-4.2.5}/lms/common/field/lms_datatype.py

@@ -119,9 +119,7 @@ class LMS_DataType(Enum):
         try:
             return sizes[self]
         except KeyError:
-            raise TypeError(
-                f"Stream size is not defined for '{self.to_string()}'."
-            )
+            raise TypeError(f"Stream size is not defined for '{self.to_string()}'.")
 
     @classmethod
     def from_string(cls, string: str):
@@ -138,8 +136,8 @@ class LMS_DataType(Enum):
 
 
 def verify_number_from_datatype(
-        value: int | float,
-        datatype: LMS_DataType,
+    value: int | float,
+    datatype: LMS_DataType,
 ):
     if datatype is LMS_DataType.FLOAT32:
         max_value = FLOAT32_MAX
@@ -150,7 +148,7 @@ def verify_number_from_datatype(
             max_value = 2 ** (bits - 1)
             min_value = -max_value
         else:
-            min_value, max_value = 0, (2 ** bits) - 1
+            min_value, max_value = 0, (2**bits) - 1
 
     if not min_value <= value <= max_value:
         raise ValueError(

{pylibms-4.2.3 → pylibms-4.2.5}/lms/common/field/lms_field.py

@@ -36,20 +36,28 @@ class LMS_FieldMap:
         """Converts the field map to a regular dictionary."""
         return {field.name: field.value for field in self.fields.values()}
 
-    @classmethod
-    def create_default_map(cls, definitions: list[ValueDefinition]):
-        field_map = {}
+    @staticmethod
+    def create_default_dict_map(
+        definitions: list[ValueDefinition],
+    ) -> dict[str, FieldValue]:
+        map = {}
         for definition in definitions:
             match definition.datatype:
+                case LMS_DataType.STRING:
+                    map[definition.name] = ""
                 case LMS_DataType.LIST:
-                    field_map[definition.name] = definition.list_items[0]
+                    map[definition.name] = definition.list_items[0]
                 case LMS_DataType.BOOL:
-                    field_map[definition.name] = False
+                    map[definition.name] = False
                 case LMS_DataType.FLOAT32:
-                    field_map[definition.name] = 0.0
+                    map[definition.name] = 0.0
                 case _:
-                    field_map[definition.name] = 0
-        return cls.from_dict(field_map, definitions)
+                    map[definition.name] = 0
+        return map
+
+    @classmethod
+    def create_default_map(cls, definitions: list[ValueDefinition]):
+        return cls.from_dict(LMS_FieldMap.create_default_map(definitions), definitions)
 
     @classmethod
     def from_dict(cls, data: dict[str, FieldValue], definitions: list[ValueDefinition]):
@@ -95,7 +103,9 @@ class LMS_Field:
     """
 
     def __init__(
-            self, value: int | str | float | bytes | bool, definition: ValueDefinition,
+        self,
+        value: int | str | float | bytes | bool,
+        definition: ValueDefinition,
     ):
         _verify_value_from_definition(value, definition)
         self._definition = definition
@@ -139,7 +149,7 @@ class LMS_Field:
 
 
 def _verify_value_from_definition(
-        value: int | str | float | bytes | bool, definition: ValueDefinition
+    value: int | str | float | bytes | bool, definition: ValueDefinition
 ) -> None:
     datatype = definition.datatype
 

{pylibms-4.2.3 → pylibms-4.2.5}/lms/common/lms_constants.py

@@ -3,7 +3,7 @@ PADDING_BYTE = b"\x00"
 
 SIZE_OFFSET = 0x12
 SECTION_DATA_START = 0x20
-SECTION_PADDING_BYTE = b"\xAB"
+SECTION_PADDING_BYTE = b"\xab"
 
 LITTLE_ENDIAN_BOM = b"\xff\xfe"
 BIG_ENDIAN_BOM = b"\xfe\xff"

{pylibms-4.2.3 → pylibms-4.2.5}/lms/common/stream/fileinfo.py

@@ -1,5 +1,10 @@
 from lms.common import lms_exceptions
-from lms.common.lms_constants import BIG_ENDIAN_BOM, SECTION_DATA_START, LITTLE_ENDIAN_BOM, SIZE_OFFSET
+from lms.common.lms_constants import (
+    BIG_ENDIAN_BOM,
+    SECTION_DATA_START,
+    LITTLE_ENDIAN_BOM,
+    SIZE_OFFSET,
+)
 from lms.common.lms_fileinfo import LMS_FileInfo
 from lms.fileio.encoding import FileEncoding
 from lms.fileio.io import FileReader, FileWriter
@@ -25,7 +30,9 @@ def read_file_info(reader: FileReader, expected_magic: str) -> LMS_FileInfo:
     version = reader.read_uint8()
 
     if version < 3:
-        raise lms_exceptions.LMS_UnsupportedFileVersionError("Only version 3+ files are supported!")
+        raise lms_exceptions.LMS_UnsupportedFileVersionError(
+            "Only version 3+ files are supported!"
+        )
 
     section_count = reader.read_uint16()
 
@@ -34,7 +41,9 @@ def read_file_info(reader: FileReader, expected_magic: str) -> LMS_FileInfo:
 
     reader.seek(0, 2)
     if file_size != (real_size := reader.tell()):
-        raise lms_exceptions.LMS_MisalignedSizeError(f"File size is misaligned!` Got {file_size} expected {real_size}.")
+        raise lms_exceptions.LMS_MisalignedSizeError(
+            f"File size is misaligned!` Got {file_size} expected {real_size}."
+        )
 
     reader.seek(SECTION_DATA_START)
 

{pylibms-4.2.3 → pylibms-4.2.5}/lms/common/stream/hashtable.py

@@ -27,7 +27,12 @@ def read_labels(reader: FileReader) -> tuple[dict, int]:
     return sorted_labels, slot_count
 
 
-def write_labels(writer: FileWriter, labels: list[str], slot_count: int, index_map: dict[str, int] = None) -> None:
+def write_labels(
+    writer: FileWriter,
+    labels: list[str],
+    slot_count: int,
+    index_map: dict[str, int] = None,
+) -> None:
     writer.write_uint32(slot_count)
 
     hash_slots = {}

{pylibms-4.2.3 → pylibms-4.2.5}/lms/common/stream/section.py

@@ -2,12 +2,12 @@ from typing import Any, Callable, Generator
 
 from lms.fileio.io import FileReader, FileWriter
 
-SECTION_PADDING_BYTE = b"\xAB"
+SECTION_PADDING_BYTE = b"\xab"
 SECTION_ALIGNMENT = 16
 
 
 def read_section_data(
-        reader: FileReader, section_count: int
+    reader: FileReader, section_count: int
 ) -> Generator[tuple[str, int], Any, None]:
     reader.seek(0x20)
     for _ in range(section_count):
@@ -24,11 +24,11 @@ def read_section_data(
 
 
 def write_section(
-        writer: FileWriter,
-        magic: str,
-        section_call: Callable,
-        data: list[Any],
-        *write_arguments: Any,
+    writer: FileWriter,
+    magic: str,
+    section_call: Callable,
+    data: list[Any],
+    *write_arguments: Any,
 ) -> None:
     writer.write_string(magic)
     size_offset = writer.tell()

{pylibms-4.2.3 → pylibms-4.2.5}/lms/fileio/encoding.py

@@ -10,7 +10,7 @@ class FileEncoding(IntEnum):
     UTF32 = 0x02
 
     def to_string_format(
-            self, is_big_endian: bool = False
+        self, is_big_endian: bool = False
     ) -> Literal["UTF-8", "UTF-16-BE", "UTF-16-LE", "UTF-32-BE", "UTF-32-LE"]:
         """Converts the FileEncoding to string format."""
         match self:

{pylibms-4.2.3 → pylibms-4.2.5}/lms/fileio/io.py

@@ -106,7 +106,7 @@ class FileReader:
     def read_encoded_string(self):
         message = b""
         while (
-                raw_char := self.read_bytes(self.encoding.width)
+            raw_char := self.read_bytes(self.encoding.width)
         ) != self.encoding.terminator:
             message += raw_char
         return message.decode(self.encoding.to_string_format(self.is_big_endian))

{pylibms-4.2.3 → pylibms-4.2.5}/lms/flowchart/definitions/flowchart.py

@@ -7,7 +7,9 @@ from lms.flowchart.definitions.node import LMS_EntryNode, LMS_BranchNode, LMS_Ba
 class LMS_Flowchart:
     """Class that represents a flowchart in a MSBF file."""
 
-    def __init__(self, entry_point: LMS_EntryNode, id_generator: Callable[[], int]) -> None:
+    def __init__(
+            self, entry_point: LMS_EntryNode, id_generator: Callable[[], int]
+    ) -> None:
         self._entry_node = entry_point
         self._nodes: dict[int, LMS_BaseNode] = {}
         self._id_generator = id_generator
@@ -16,7 +18,6 @@ class LMS_Flowchart:
             for node in entry_point.get_descendents():
                 self._nodes[node.id] = node
 
-
     def __iter__(self) -> Iterator[LMS_BaseNode]:
         return iter(self._nodes.values())
 
@@ -28,7 +29,7 @@ class LMS_Flowchart:
 
     @property
     def name(self) -> str:
-        """The name of the flowchart. """
+        """The name of the flowchart."""
         return self._entry_node.flowchart_name
 
     @name.setter
@@ -41,7 +42,7 @@ class LMS_Flowchart:
         return self._entry_node
 
     @property
-    def nodes(self) -> MappingProxyType[LMS_BaseNode]:
+    def nodes(self) -> MappingProxyType[int, LMS_BaseNode]:
         """All nodes in the flowchart instance."""
         return MappingProxyType(self._nodes)
 
@@ -52,10 +53,14 @@ class LMS_Flowchart:
         :param node: the node to add.
         """
         if not isinstance(node, LMS_BaseNode):
-            raise TypeError(f"Node type '{type(node).__name__}' is not a child of LMS_BaseNode!")
+            raise TypeError(
+                f"Node type '{type(node).__name__}' is not a child of LMS_BaseNode!"
+            )
 
         if node in self._nodes.values():
-            raise ValueError(f"Node of ID '{node.id}' is already registered to this flowchart!")
+            raise ValueError(
+                f"Node of ID '{node.id}' is already registered to this flowchart!"
+            )
 
         node.id = self._id_generator()
         self._nodes[node.id] = node