From 631fd2b186c3e4926527140be955396bb37fa540 Mon Sep 17 00:00:00 2001 From: yupix Date: Thu, 7 Mar 2024 16:18:49 +0900 Subject: [PATCH] =?UTF-8?q?chore:=20DocString=E3=82=92=E6=9B=B4=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- mipac/models/drive.py | 43 +++++++++++++++++++++++++------------------ 1 file changed, 25 insertions(+), 18 deletions(-) diff --git a/mipac/models/drive.py b/mipac/models/drive.py index 00cfc76e..4a97969d 100644 --- a/mipac/models/drive.py +++ b/mipac/models/drive.py @@ -225,34 +225,34 @@ def id(self) -> str: @property def created_at(self) -> datetime: - """ファイルが作成された日時 + """ファイルの作成日時 Returns ------- datetime - ファイルが作成された日時 + ファイルの作成日時 """ return str_to_datetime(self.__raw_file["created_at"]) @property def name(self) -> str: - """ファイル名 + """拡張子付きのファイル名 Returns ------- str - ファイル名 + 拡張子付きのファイル名 """ return self.__raw_file["name"] @property def type(self) -> str: - """ファイルの拡張子 + """ファイルの種類 (MIME タイプ) Returns ------- str - ファイルの種類 + ファイルの種類 (MIME タイプ) """ return self.__raw_file["type"] @@ -280,12 +280,12 @@ def size(self) -> int: @property def is_sensitive(self) -> bool: - """ファイルがセンシティブかどうか + """ファイルが閲覧注意（NSFW）であるか Returns ------- bool - ファイルがセンシティブかどうか + ファイルが閲覧注意であるか """ return self.__raw_file["is_sensitive"] @@ -346,23 +346,23 @@ def comment(self) -> str | None: @property def folder_id(self) -> str | None: - """フォルダーのID + """ファイルが存在するフォルダのID Returns ------- str | None - フォルダーのID + ファイルが存在するフォルダのID """ return self.__raw_file["folder_id"] @property def folder(self) -> Folder | None: - """フォルダー + """ファイルが存在するフォルダ Returns ------- Folder | None - フォルダー + ファイルが存在するフォルダ """ return ( Folder(self.__raw_file["folder"], client=self.__client) @@ -372,23 +372,23 @@ def folder(self) -> Folder | None: @property def user_id(self) -> str | None: - """ファイルを作成したユーザーのID + """ファイルをアップロードしたユーザーのID Returns ------- str | None - ユーザーのID + ファイルをアップロードしたユーザーのID """ return self.__raw_file["user_id"] @property def user(self) -> PartialUser | None: - """ファイルを作成したユーザー + """ファイルをアップロードしたユーザー Returns ------- PartialUser | None - ユーザー + ファイルをアップロードしたユーザー """ return ( PartialUser(self.__raw_file["user"], client=self.__client) @@ -397,17 +397,24 @@ def user(self) -> PartialUser | None: ) def _get(self, key: str) -> Any | None: - """You can access the raw response data directly by specifying the key + """生のレスポンスデータに直接アクセスすることができます Returns ------- Any | None - raw response data + 生のレスポンスデータ """ return self.__raw_file.get(key) @property def api(self) -> ClientFileManager: + """このファイルに対する操作を行うためのAPIクライアント + + Returns + ------- + ClientFileManager + このファイルに対する操作を行うためのAPIクライアント + """ return self.__client.drive._create_client_file_manager(file_id=self.id) def __eq__(self, __value: object) -> bool: