feat: Drive周りのモデルと型を最新の物に追従

Author: yupix

mipac/models/drive.py

@@ -3,6 +3,7 @@
 from typing import TYPE_CHECKING, Any
 
 from mipac.abstract.model import AbstractModel
+from mipac.models.lite.user import PartialUser
 from mipac.types.drive import IDriveStatus
 
 if TYPE_CHECKING:
@@ -42,20 +43,24 @@ def usage(self) -> int:
 
 
 class FileProperties(AbstractModel):
-    def __init__(self, properties: IFileProperties) -> None:
-        self.__properties: IFileProperties = properties
+    def __init__(self, raw_properties: IFileProperties) -> None:
+        self.__raw_properties: IFileProperties = raw_properties
 
     @property
     def width(self) -> int | None:
-        return self.__properties["width"]
+        return self.__raw_properties.get("width")
 
     @property
-    def height(self) -> int:
-        return self.__properties["height"]
+    def height(self) -> int | None:
+        return self.__raw_properties.get("height")
+
+    @property
+    def orientation(self) -> int | None:
+        return self.__raw_properties.get("orientation")
 
     @property
     def avg_color(self) -> str | None:
-        return self.__properties["avg_color"]
+        return self.__raw_properties.get("avg_color")
 
 
 class Folder(AbstractModel):
@@ -65,36 +70,35 @@ def __init__(self, folder: FolderPayload, client: ClientManager):
 
     @property
     def id(self) -> str:
-        """フォルダのID"""
         return self.__folder["id"]
 
     @property
     def created_at(self) -> str:  # TODO: 型
-        """フォルダの作成日時"""
         return self.__folder["created_at"]
 
     @property
     def name(self) -> str:
-        """フォルダ名"""
         return self.__folder["name"]
 
     @property
-    def folders_count(self) -> int:
-        """フォルダ内のフォルダ数"""
-        return self.__folder["folders_count"]
+    def parent_id(self) -> str | None:
+        return self.__folder["parent_id"]
 
     @property
-    def files_count(self) -> int:
-        """フォルダ内のファイル数"""
-        return self.__folder["files_count"]
+    def folders_count(self) -> int | None:
+        return self.__folder.get("folders_count")
 
     @property
-    def parent_id(self) -> str:
-        return self.__folder["parent_id"]
+    def files_count(self) -> int | None:
+        return self.__folder.get("files_count")
 
     @property
-    def parent(self) -> dict[str, Any]:
-        return self.__folder["parent"]
+    def parent(self) -> Folder | None:
+        return (
+            Folder(self.__folder["parent"], client=self.__client)
+            if "parent" in self.__folder and self.__folder["parent"]
+            else None
+        )
 
     @property
     def api(self) -> ClientFolderManager:
@@ -120,41 +124,69 @@ def id(self) -> str:
     def created_at(self):
         return self.__file["created_at"]
 
+    @property
+    def name(self) -> str:
+        return self.__file["name"]
+
+    @property
+    def type(self) -> str:
+        return self.__file["type"]
+
+    @property
+    def md5(self) -> str:
+        return self.__file["md5"]
+
+    @property
+    def size(self) -> int:
+        return self.__file["size"]
+
     @property
     def is_sensitive(self) -> bool:
         return self.__file["is_sensitive"]
 
     @property
-    def name(self) -> str:
-        return self.__file["name"]
+    def blurhash(self) -> str | None:
+        return self.__file["blurhash"]
 
     @property
-    def thumbnail_url(self) -> str:
-        return self.__file["thumbnail_url"]
+    def properties(self) -> FileProperties:
+        return FileProperties(self.__file["properties"])
 
     @property
     def url(self) -> str:
         return self.__file["url"]
 
     @property
-    def type(self) -> str:
-        return self.__file["type"]
+    def thumbnail_url(self) -> str | None:
+        return self.__file["thumbnail_url"]
 
     @property
-    def size(self) -> int:
-        return self.__file["size"]
+    def comment(self) -> str | None:
+        return self.__file["comment"]
 
     @property
-    def md5(self) -> str:
-        return self.__file["md5"]
+    def folder_id(self) -> str | None:
+        return self.__file["folder_id"]
 
     @property
-    def blurhash(self) -> str:
-        return self.__file["blurhash"]
+    def folder(self) -> Folder | None:
+        return (
+            Folder(self.__file["folder"], client=self.__client)
+            if "folder" in self.__file and self.__file["folder"]
+            else None
+        )
 
     @property
-    def properties(self) -> FileProperties:
-        return FileProperties(self.__file["properties"])
+    def user_id(self) -> str | None:
+        return self.__file["user_id"]
+
+    @property
+    def user(self) -> PartialUser | None:
+        return (
+            PartialUser(self.__file["user"], client=self.__client)
+            if "user" in self.__file and self.__file["user"]
+            else None
+        )
 
     @property
     def api(self) -> ClientFileManager:

mipac/types/drive.py

@@ -1,9 +1,16 @@
 from __future__ import annotations
 
-from typing import Any, TypedDict
+from typing import TYPE_CHECKING, Any, Literal, NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    from mipac.models.lite.user import PartialUser
+
 
 __all__ = ("IFileProperties", "FolderPayload", "IDriveFile")
 
+IDriveSort = Literal["+createdAt", "-createdAt", "+name", "-name", "+size", "-size"]
+
+
 class IDriveStatus(TypedDict):
     capacity: int
     usage: int
@@ -14,9 +21,10 @@ class IFileProperties(TypedDict):
     プロパティー情報
     """
 
-    width: int
-    height: int
-    avg_color: str | None
+    width: NotRequired[int]
+    height: NotRequired[int]
+    orientation: NotRequired[int]
+    avg_color: NotRequired[str]
 
 
 class FolderPayload(TypedDict):
@@ -27,10 +35,10 @@ class FolderPayload(TypedDict):
     id: str
     created_at: str
     name: str
-    folders_count: int
-    files_count: int
-    parent_id: str
-    parent: dict[str, Any]
+    parent_id: str | None
+    folders_count: NotRequired[int]
+    files_count: NotRequired[int]
+    parent: NotRequired[FolderPayload | None]
 
 
 class IDriveFile(TypedDict):
@@ -40,12 +48,17 @@ class IDriveFile(TypedDict):
 
     id: str
     created_at: str
-    is_sensitive: bool
     name: str
-    thumbnail_url: str
-    url: str
     type: str
-    size: int
     md5: str
-    blurhash: str
+    size: int
+    is_sensitive: bool
+    blurhash: str | None
     properties: IFileProperties
+    url: str
+    thumbnail_url: str | None
+    comment: str | None
+    folder_id: str | None
+    folder: NotRequired[FolderPayload | None]
+    user_id: str | None
+    user: NotRequired[PartialUser | None]