fix(files): overall type hint corrections

Author: isHarryh

UnityPy/files/BundleFile.py

@@ -1,7 +1,7 @@
 # TODO: implement encryption for saving files
 from collections import namedtuple
 import re
-from typing import Tuple, Union
+from typing import Optional, Tuple, Union
 
 from . import File
 from ..enums import ArchiveFlags, ArchiveFlagsOld, CompressionFlags
@@ -21,12 +21,12 @@ class BundleFile(File.File):
     signature: str
     version_engine: str
     version_player: str
-    dataflags: Tuple[ArchiveFlags, ArchiveFlagsOld]
-    decryptor: ArchiveStorageManager.ArchiveStorageDecryptor = None
+    dataflags: Union[ArchiveFlags, ArchiveFlagsOld]
+    decryptor: Optional[ArchiveStorageManager.ArchiveStorageDecryptor] = None
     _uses_block_alignment: bool = False
 
     def __init__(
-        self, reader: EndianBinaryReader, parent: File, name: str = None, **kwargs
+        self, reader: EndianBinaryReader, parent: File, name: Optional[str] = None, **kwargs
     ):
         super().__init__(parent=parent, name=name, **kwargs)
         signature = self.signature = reader.read_string_to_null()
@@ -92,7 +92,7 @@ def read_fs(self, reader: EndianBinaryReader):
         # header
         compressedSize = reader.read_u_int()
         uncompressedSize = reader.read_u_int()
-        self.dataflags = reader.read_u_int()
+        dataflagsValue = reader.read_u_int()
 
         version = self.get_version_tuple()
         # https://issuetracker.unity3d.com/issues/files-within-assetbundles-do-not-start-on-aligned-boundaries-breaking-patching-on-nintendo-switch
@@ -105,9 +105,9 @@ def read_fs(self, reader: EndianBinaryReader):
             or (version[0] == 2021 and version < (2021, 3, 2))
             or (version[0] == 2022 and version < (2022, 1, 1))
         ):
-            self.dataflags = ArchiveFlagsOld(self.dataflags)
+            self.dataflags = ArchiveFlagsOld(dataflagsValue)
         else:
-            self.dataflags = ArchiveFlags(self.dataflags)
+            self.dataflags = ArchiveFlags(dataflagsValue)
 
         if self.dataflags & self.dataflags.UsesAssetBundleEncryption:
             self.decryptor = ArchiveStorageManager.ArchiveStorageDecryptor(reader)
@@ -523,6 +523,14 @@ def decompress_data(
     def get_version_tuple(self) -> Tuple[int, int, int]:
         """Returns the version as a tuple."""
         version = self.version_engine
-        if not version or version == "0.0.0":
-            version = config.get_fallback_version()
-        return tuple(map(int, reVersion.match(version).groups()))
+        match = None
+        if version and version != "0.0.0":
+            match = reVersion.match(version)
+            if not match or len(match.groups()) < 3:
+                match = None
+        if not match:
+            match = reVersion.match(config.get_fallback_version())
+            if not match or len(match.groups()) < 3:
+                raise ValueError("Illegal fallback version format")
+        map_ = map(int, match.groups())
+        return (next(map_), next(map_), next(map_))

UnityPy/files/File.py

@@ -95,7 +95,7 @@ def read_files(self, reader: EndianBinaryReader, files: list):
             f.flags = getattr(node, "flags", 0)
             self.files[name] = f
 
-    def get_writeable_cab(self, name: str = None):
+    def get_writeable_cab(self, name: Optional[str] = None):
         """
         Creates a new cab file in the bundle that contains the given data.
         This is useful for asset types that use resource files.

UnityPy/files/ObjectReader.py

@@ -256,7 +256,7 @@ def save_typetree(
         self,
         tree: dict,
         nodes: Optional[Union[TypeTreeNode, List[dict[str, Union[str, int]]]]] = None,
-        writer: EndianBinaryWriter = None,
+        writer: Optional[EndianBinaryWriter] = None,
     ):
         node = self._get_typetree_node(nodes)
         if not writer:

UnityPy/files/SerializedFile.py

@@ -1,8 +1,8 @@
-from __future__ import annotations
+from __future__ import annotations
 
 import re
 from ntpath import basename
-from typing import TYPE_CHECKING, Dict, Generator, List, Optional, Tuple, Union
+from typing import TYPE_CHECKING, Dict, Generator, Iterator, List, Optional, Tuple
 
 from attrs import define
 
@@ -24,7 +24,7 @@ class SerializedFileHeader:
     file_size: int
     version: int
     data_offset: int
-    endian: bytes
+    endian: str
     reserved: bytes
 
     def __init__(self, reader: EndianBinaryReader):
@@ -115,7 +115,7 @@ def IsPatch(self):
 class SerializedType:
     class_id: int
     is_stripped_type: Optional[bool] = None
-    script_type_index: Optional[int] = -1
+    script_type_index: int = -1
     script_id: Optional[bytes] = None  # Hash128
     old_type_hash: Optional[bytes] = None  # Hash128
     node: Optional[TypeTreeNode] = None
@@ -124,7 +124,7 @@ class SerializedType:
     m_NameSpace: Optional[str] = None
     m_AssemblyName: Optional[str] = None
     # 21+
-    type_dependencies: Optional[List[int]] = None
+    type_dependencies: Optional[Tuple[int, ...]] = None
 
     def __init__(
         self,
@@ -215,7 +215,7 @@ def write(
                     writer.write_int_array(self.type_dependencies, True)
 
     @property
-    def nodes(self) -> Union[TypeTreeNode, None]:
+    def nodes(self) -> Optional[TypeTreeNode]:
         # for compatibility with old versions
         return self.node
 
@@ -236,8 +236,7 @@ class SerializedFile(File.File):
     _m_target_platform: int
     big_id_enabled: int
     userInformation: Optional[str]
-    assetbundle: AssetBundle
-    container: ContainerHelper
+    assetbundle: Optional[AssetBundle]
     _cache: Dict[str, Object]
 
     @property
@@ -414,7 +413,7 @@ class FileIdentifierFake:
 
         return cab
 
-    def save(self, packer: str = None) -> bytes:
+    def save(self, packer: Optional[str] = None) -> bytes:
         # 1. header -> has to be delayed until the very end
         # 2. data -> types, objects, scripts, ...
 
@@ -567,7 +566,7 @@ def __setitem__(self, key, value) -> None:
     def __delitem__(self, key) -> None:
         raise NotImplementedError("Deleting from the container is not allowed!")
 
-    def __iter__(self) -> Generator[str, None, None]:
+    def __iter__(self) -> Iterator[str]:
         return iter(self.keys())
 
     def __len__(self) -> int:

UnityPy/files/WebFile.py

@@ -1,4 +1,6 @@
-from . import File
+from typing import Optional
+
+from . import File
 from ..helpers import CompressionHelper
 from ..streams import EndianBinaryReader, EndianBinaryWriter
 
@@ -55,7 +57,7 @@ def __init__(self, reader: EndianBinaryReader, parent: File, name=None, **kwargs
 
     def save(
         self,
-        files: dict = None,
+        files: Optional[dict] = None,
         packer: str = "none",
         signature: str = "UnityWebData1.0",
     ) -> bytes: