Merge pull request #134 from yupix/chore/update-docstring

Chore/update docstring

mipac/models/ad.py

@@ -17,16 +17,44 @@ class Ad(PartialAd[IAd]):
 
     @property
     def expires_at(self) -> datetime:
+        """いつ広告が終了するか
+
+        Returns
+        -------
+        datetime
+            いつ広告が終了するか
+        """
         return str_to_datetime(self._raw_ad["expires_at"])
 
     @property
     def starts_at(self) -> datetime:
+        """いつ広告が開始するか
+
+        Returns
+        -------
+        datetime
+            いつ広告が開始するか
+        """
         return str_to_datetime(self._raw_ad["starts_at"])
 
     @property
     def priority(self) -> Literal["high" "middle" "low"]:
+        """広告の優先度
+
+        Returns
+        -------
+        Literal["high" "middle" "low"]
+            広告の優先度
+        """
         return self._raw_ad["priority"]
 
     @property
     def memo(self) -> str | None:
+        """広告のメモ
+
+        Returns
+        -------
+        str | None
+            広告のメモ
+        """
         return self._raw_ad["memo"]

mipac/models/announcement.py

@@ -23,14 +23,37 @@ class Announcement:
 
     @property
     def id(self) -> str:
+        """アナウンスのID
+
+        Returns
+        -------
+        str
+            アナウンスのID
+        """
         return self.__announcement["id"]
 
     @property
     def created_at(self) -> datetime:
+        """アナウンスが作成された日時
+
+        Returns
+        -------
+        datetime
+            アナウンスが作成された日時
+        """
         return str_to_datetime(self.__announcement["created_at"])
 
     @property
     def updated_at(self) -> datetime | None:
+        """アナウンスが更新された日時
+
+        Noneの場合は、アナウンスが更新されていないことを示します。
+
+        Returns
+        -------
+        datetime | None
+            アナウンスが更新された日時
+        """
         return (
             str_to_datetime(self.__announcement["updated_at"])
             if self.__announcement["updated_at"]
@@ -39,10 +62,24 @@ class Announcement:
 
     @property
     def text(self) -> str:
+        """アナウンスの内容
+
+        Returns
+        -------
+        str
+            アナウンスの内容
+        """
         return self.__announcement["text"]
 
     @property
     def title(self) -> str:
+        """アナウンスのタイトル
+
+        Returns
+        -------
+        str
+            アナウンスのタイトル
+        """
         return self.__announcement["title"]
 
     @property

mipac/models/antenna.py

@@ -18,22 +18,57 @@ class Antenna:
 
     @property
     def id(self) -> str:
+        """アンテナのID
+
+        Returns
+        -------
+        str
+            アンテナのID
+        """
         return self.__antenna["id"]
 
     @property
     def created_at(self) -> datetime:
+        """アンテナの作成日時
+
+        Returns
+        -------
+        datetime
+            アンテナの作成日時
+        """
         return str_to_datetime(self.__antenna["created_at"])
 
     @property
     def name(self) -> str:
+        """アンテナ名
+
+        Returns
+        -------
+        str
+            アンテナ名
+        """
         return self.__antenna["name"]
 
     @property
     def keywords(self) -> list[str]:
+        """キーワード
+
+        Returns
+        -------
+        list[str]
+            キーワード
+        """
         return self.__antenna["keywords"]
 
     @property
     def exclude_keywords(self) -> list[str]:
+        """除外キーワード
+
+        Returns
+        -------
+        list[str]
+            除外キーワード
+        """
         return self.__antenna["exclude_keywords"]
 
     @property

mipac/models/drive.py

@@ -61,10 +61,24 @@ class FileProperties:
 
     @property
     def width(self) -> int | None:
+        """ファイルの幅
+
+        Returns
+        -------
+        int | None
+            ファイルの幅
+        """
         return self.__raw_properties.get("width")
 
     @property
     def height(self) -> int | None:
+        """ファイルの高さ
+
+        Returns
+        -------
+        int | None
+            ファイルの高さ
+        """
         return self.__raw_properties.get("height")
 
     @property
@@ -93,30 +107,79 @@ class Folder:
 
     @property
     def id(self) -> str:
+        """フォルダーのID
+
+        Returns
+        -------
+        str
+            フォルダーのID
+        """
         return self.__raw_folder["id"]
 
     @property
     def created_at(self) -> datetime:
+        """フォルダーが作成された日時
+
+        Returns
+        -------
+        datetime
+            フォルダーが作成された日時
+        """
         return str_to_datetime(self.__raw_folder["created_at"])
 
     @property
     def name(self) -> str:
+        """フォルダー名
+
+        Returns
+        -------
+        str
+            フォルダー名
+        """
         return self.__raw_folder["name"]
 
     @property
     def parent_id(self) -> str | None:
+        """親フォルダーのID
+
+        Returns
+        -------
+        str | None
+            親フォルダーのID
+        """
         return self.__raw_folder["parent_id"]
 
     @property
     def folders_count(self) -> int | None:
+        """フォルダー内のフォルダーの数
+
+        Returns
+        -------
+        int | None
+            フォルダー内のフォルダーの数
+        """
         return self.__raw_folder.get("folders_count")
 
     @property
     def files_count(self) -> int | None:
+        """フォルダー内のファイルの数
+
+        Returns
+        -------
+        int | None
+            フォルダー内のファイルの数
+        """
         return self.__raw_folder.get("files_count")
 
     @property
     def parent(self) -> Folder | None:
+        """親フォルダー
+
+        Returns
+        -------
+        Folder | None
+            親フォルダー
+        """
         return (
             Folder(self.__raw_folder["parent"], client=self.__client)
             if "parent" in self.__raw_folder and self.__raw_folder["parent"]
@@ -151,58 +214,156 @@ class File:
 
     @property
     def id(self) -> str:
+        """ファイルのID
+
+        Returns
+        -------
+        str
+            ファイルのID
+        """
         return self.__raw_file["id"]
 
     @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"]
 
     @property
     def md5(self) -> str:
+        """ファイルのMD5ハッシュ
+
+        Returns
+        -------
+        str
+            ファイルのMD5ハッシュ
+        """
         return self.__raw_file["md5"]
 
     @property
     def size(self) -> int:
+        """ファイルのサイズ
+
+        Returns
+        -------
+        int
+            ファイルのサイズ
+        """
         return self.__raw_file["size"]
 
     @property
     def is_sensitive(self) -> bool:
+        """ファイルが閲覧注意（NSFW）であるか
+
+        Returns
+        -------
+        bool
+            ファイルが閲覧注意であるか
+        """
         return self.__raw_file["is_sensitive"]
 
     @property
     def blurhash(self) -> str | None:
+        """ファイルのBlurHash
+
+        Returns
+        -------
+        str | None
+            ファイルのBlurHash
+        """
         return self.__raw_file["blurhash"]
 
     @property
     def properties(self) -> FileProperties:
+        """ファイルのプロパティ
+
+        Returns
+        -------
+        FileProperties
+            ファイルのプロパティ
+        """
         return FileProperties(self.__raw_file["properties"])
 
     @property
     def url(self) -> str:
+        """ファイルのURL
+
+        Returns
+        -------
+        str
+            ファイルのURL
+        """
         return self.__raw_file["url"]
 
     @property
     def thumbnail_url(self) -> str | None:
+        """ファイルのサムネイルURL
+
+        Returns
+        -------
+        str | None
+            ファイルのサムネイルURL
+        """
         return self.__raw_file["thumbnail_url"]
 
     @property
     def comment(self) -> str | None:
+        """ファイルのコメント
+
+        Returns
+        -------
+        str | None
+            ファイルのコメント
+        """
         return self.__raw_file["comment"]
 
     @property
     def folder_id(self) -> str | None:
+        """ファイルが存在するフォルダのID
+
+        Returns
+        -------
+        str | None
+            ファイルが存在するフォルダの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)
             if "folder" in self.__raw_file and self.__raw_file["folder"]
@@ -211,10 +372,24 @@ class File:
 
     @property
     def user_id(self) -> str | None:
+        """ファイルをアップロードしたユーザーのID
+
+        Returns
+        -------
+        str | None
+            ファイルをアップロードしたユーザーの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)
             if "user" in self.__raw_file and self.__raw_file["user"]
@@ -222,17 +397,24 @@ class File:
         )
 
     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:

mipac/models/lite/ad.py

@@ -19,10 +19,24 @@ class PartialAd[T: IPartialAd]:
 
     @property
     def id(self) -> str:
+        """広告のID
+
+        Returns
+        -------
+        str
+            広告のID
+        """
         return self._raw_ad["id"]
 
     @property
     def url(self) -> str:
+        """広告のURL
+
+        Returns
+        -------
+        str
+            広告のURL
+        """
         return self._raw_ad["url"]
 
     @property

mipac/models/lite/instance.py

@@ -10,26 +10,69 @@ class LiteInstance:
 
     @property
     def name(self) -> str | None:
+        """サーバー名
+
+        Returns
+        -------
+        str | None
+            サーバー名
+        """
         return self.__instance["name"]
 
     @property
     def software_name(self) -> str | None:
+        """使用しているソフトウェアの名前
+
+        Returns
+        -------
+        str | None
+            使用しているソフトウェアの名前
+        """
         return self.__instance["software_name"]
 
     @property
     def software_version(self) -> str | None:
+        """使用しているソフトウェアのバージョン
+
+        Returns
+        -------
+        str | None
+            使用しているソフトウェアのバージョン
+        """
         return self.__instance["software_version"]
 
     @property
     def icon_url(self) -> str | None:
+        """アイコンのURL
+
+        Returns
+        -------
+        str | None
+            アイコンのURL
+        """
         return self.__instance["icon_url"]
 
     @property
     def favicon_url(self) -> str | None:
+        """ファビコンのURL
+
+        Returns
+        -------
+        str | None
+            ファビコンのURL
+        """
         return self.__instance["favicon_url"]
 
     @property
     def theme_color(self) -> str | None:
+        """テーマカラー
+
+        Returns
+        -------
+        str | None
+            テーマカラー
+
+        """
         return self.__instance["theme_color"]
 
     def _get(self, key: str) -> Any | None: