chore(ruff): apply and enforce EFBI ruff lint styles

Author: K0lb3

.editorconfig

@@ -10,6 +10,7 @@ quote_type = double
 insert_final_newline = true
 tab_width = 4
 trim_trailing_whitespace = true
+max_line_length = 120
 
 [*.py]
 spaces_around_brackets = none

.github/workflows/test.yml

@@ -25,5 +25,13 @@ jobs:
       - name: Install
         run: pip install .[tests]
 
+      - uses: astral-sh/ruff-action@v3
+
+      - name: Check code (ruff check)
+        run: ruff check
+      
+      - name: Check code style (ruff format)
+        run: ruff format --check
+
       - name: Run tests
         run: python -m pytest -vs ./tests

UnityPy/UnityPyBoost.pyi

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, List, Optional, Union
+from typing import TYPE_CHECKING, Any, List, Literal, Optional, Union
 
 if TYPE_CHECKING:
     from .classes import Object
@@ -19,7 +19,7 @@ def unpack_vertexdata(
 def read_typetree(
     data: Union[bytes, bytearray],
     node: TypeTreeNode,
-    endian: Union["<", ">"],
+    endian: Literal["<", ">"],
     as_dict: bool,
     assetsfile: SerializedFile,
     classes: dict,

UnityPy/classes/Object.py

@@ -31,3 +31,8 @@ def save(self) -> None:
             raise ValueError("ObjectReader not set")
 
         self.object_reader.save_typetree(self)
+
+
+__all__ = [
+    "Object",
+]

UnityPy/classes/PPtr.py

@@ -41,15 +41,15 @@ def read_typetree(self):
         return self.deref_parse_as_dict()
 
     def deref(self, assetsfile: Optional[SerializedFile] = None) -> ObjectReader[T]:
-        assetsfile = assetsfile or self.assetsfile
         if assetsfile is None:
             raise ValueError("PPtr can't deref without an assetsfile!")
 
         if self.m_PathID == 0:
             raise ValueError("PPtr can't deref with m_PathID == 0!")
 
+        assetsfile_dst = None
         if self.m_FileID == 0:
-            pass
+            assetsfile_dst = assetsfile or self.assetsfile
         else:
             # resolve file id to external name
             external_id = self.m_FileID - 1
@@ -61,9 +61,7 @@ def deref(self, assetsfile: Optional[SerializedFile] = None) -> ObjectReader[T]:
             container = assetsfile.parent
             if container is None:
                 # TODO - use default fs
-                raise FileNotFoundError(
-                    f"PPtr points to {external.path} but no container is set!"
-                )
+                raise FileNotFoundError(f"PPtr points to {external.path} but no container is set!")
 
             external_clean_path = external.path
             if external_clean_path.startswith("archive:/"):
@@ -74,26 +72,25 @@ def deref(self, assetsfile: Optional[SerializedFile] = None) -> ObjectReader[T]:
 
             for key, file in container.files.items():
                 if key.lower() == external_clean_path:
-                    assetsfile = file
+                    assetsfile_dst = file
                     break
             else:
                 env = assetsfile.environment
                 cab = env.find_file(external_clean_path)
                 if cab:
-                    assetsfile = cab
+                    assetsfile_dst = cab
                 else:
-                    raise FileNotFoundError(
-                        f"Failed to resolve pointer - {external.path} not found!"
-                    )
+                    raise FileNotFoundError(f"Failed to resolve pointer - {external.path} not found!")
 
-        return cast("ObjectReader[T]", assetsfile.objects[self.m_PathID])
+        if assetsfile_dst is None:
+            raise FileNotFoundError(f"Failed to resolve pointer - {self.m_FileID} not found!")
+
+        return cast("ObjectReader[T]", assetsfile_dst.objects[self.m_PathID])
 
     def deref_parse_as_object(self, assetsfile: Optional[SerializedFile] = None) -> T:
         return self.deref(assetsfile).parse_as_object()
 
-    def deref_parse_as_dict(
-        self, assetsfile: Optional[SerializedFile] = None
-    ) -> dict[str, Any]:
+    def deref_parse_as_dict(self, assetsfile: Optional[SerializedFile] = None) -> dict[str, Any]:
         return self.deref(assetsfile).parse_as_dict()
 
     def __bool__(self):
@@ -106,3 +103,8 @@ def __eq__(self, other: object) -> bool:
         if not isinstance(other, PPtr):
             return False
         return self.m_FileID == other.m_FileID and self.m_PathID == other.m_PathID
+
+
+__all__ = [
+    "PPtr",
+]

UnityPy/classes/UnknownObject.py

@@ -9,7 +9,7 @@ class UnknownObject(Object):
 
     __node__: Optional[TypeTreeNode]
 
-    def __init__(self, __node__: TypeTreeNode = None, **kwargs):
+    def __init__(self, __node__: Optional[TypeTreeNode] = None, **kwargs):
         self.__node__ = __node__
         self.__dict__.update(**kwargs)
 
@@ -23,10 +23,11 @@ def format_value(v):
                 return vstr[:97] + "..."
             return vstr
 
-        inner_str = ", ".join(
-            f"{k}={format_value(v)}"
-            for k, v in self.__dict__.items()
-            if k != "__node__"
-        )
+        inner_str = ", ".join(f"{k}={format_value(v)}" for k, v in self.__dict__.items() if k != "__node__")
 
         return f"<UnknownObject<{self.get_type()}> {inner_str}>"
+
+
+__all__ = [
+    "UnknownObject",
+]

UnityPy/classes/__init__.py

@@ -1,5 +1,28 @@
-from .generated import *
-from .legacy_patch import *
+from .generated import *  # noqa: F403
+from .legacy_patch import (
+    AudioClip as AudioClip,
+)
+from .legacy_patch import (
+    GameObject as GameObject,
+)
+from .legacy_patch import (
+    Mesh as Mesh,
+)
+from .legacy_patch import (
+    Renderer as Renderer,
+)
+from .legacy_patch import (
+    Shader as Shader,
+)
+from .legacy_patch import (
+    Sprite as Sprite,
+)
+from .legacy_patch import (
+    Texture2D as Texture2D,
+)
+from .legacy_patch import (
+    Texture2DArray as Texture2DArray,
+)
 from .Object import Object as Object
 from .PPtr import PPtr as PPtr
 from .UnknownObject import UnknownObject as UnknownObject

UnityPy/classes/legacy_patch/GameObject.py

@@ -23,21 +23,11 @@ def _GameObject_GetComponent(self, type: ClassIDType) -> Union[PPtr[Component],
 
 
 GameObject.m_Components = property(_GameObject_Components)
-GameObject.m_Animator = property(
-    lambda self: _GameObject_GetComponent(self, ClassIDType.Animator)
-)
-GameObject.m_Animation = property(
-    lambda self: _GameObject_GetComponent(self, ClassIDType.Animation)
-)
-GameObject.m_Transform = property(
-    lambda self: _GameObject_GetComponent(self, ClassIDType.Transform)
-)
-GameObject.m_MeshRenderer = property(
-    lambda self: _GameObject_GetComponent(self, ClassIDType.MeshRenderer)
-)
+GameObject.m_Animator = property(lambda self: _GameObject_GetComponent(self, ClassIDType.Animator))
+GameObject.m_Animation = property(lambda self: _GameObject_GetComponent(self, ClassIDType.Animation))
+GameObject.m_Transform = property(lambda self: _GameObject_GetComponent(self, ClassIDType.Transform))
+GameObject.m_MeshRenderer = property(lambda self: _GameObject_GetComponent(self, ClassIDType.MeshRenderer))
 GameObject.m_SkinnedMeshRenderer = property(
     lambda self: _GameObject_GetComponent(self, ClassIDType.SkinnedMeshRenderer)
 )
-GameObject.m_MeshFilter = property(
-    lambda self: _GameObject_GetComponent(self, ClassIDType.MeshFilter)
-)
+GameObject.m_MeshFilter = property(lambda self: _GameObject_GetComponent(self, ClassIDType.MeshFilter))

UnityPy/classes/legacy_patch/Texture2D.py

@@ -26,9 +26,7 @@ def _Texture2d_set_image(
         img = Image.open(img)
 
     platform = self.object_reader.platform if self.object_reader is not None else 0
-    img_data, tex_format = Texture2DConverter.image_to_texture2d(
-        img, target_format, platform, self.m_PlatformBlob
-    )
+    img_data, tex_format = Texture2DConverter.image_to_texture2d(img, target_format, platform, self.m_PlatformBlob)
     self.m_Width = img.width
     self.m_Height = img.height
 
@@ -42,7 +40,7 @@ def _Texture2d_set_image(
             if width < 4 or height < 4:
                 mipmap_count = i + 1
                 break
-            re_img = re_img.resize((width, height), Image.BICUBIC)
+            re_img = re_img.resize((width, height), Image.Resampling.BICUBIC)
             img_data += Texture2DConverter.image_to_texture2d(re_img, target_format)[0]
 
     # disable mipmaps as we don't store them ourselves by default
@@ -53,9 +51,7 @@ def _Texture2d_set_image(
 
     self.image_data = img_data
     # width * height * channel count
-    self.m_CompleteImageSize = len(
-        img_data
-    )  # img.width * img.height * len(img.getbands())
+    self.m_CompleteImageSize = len(img_data)  # img.width * img.height * len(img.getbands())
     self.m_TextureFormat = tex_format
 
     if self.m_StreamData is not None:

UnityPy/classes/legacy_patch/Texture2DArray.py

@@ -1,4 +1,5 @@
 from __future__ import annotations
+
 from typing import TYPE_CHECKING, List
 
 from ...enums.GraphicsFormat import GRAPHICS_TO_TEXTURE_MAP, GraphicsFormat