mirror_maker
/
mipac
mirror of https://github.com/yupix/mipac
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

🎨 chore: type hint等の書き方を変更

Browse Source
pull/26/head
yupix 2 years ago
parent 33b7188922
commit 0e0d573e86
No known key found for this signature in database
GPG Key ID: 2FF705F5C56D9C06
22 changed files with 174 additions and 176 deletions
Show Stats Download Patch File Download Diff File

4
mipac/actions/admin/moderator.py
Unescape View File

@ -28,7 +28,7 @@ class AdminModeratorActions(AbstractAction):
Parameters Parameters
---------- ----------
user_id : Optional[str], default=None user_id : str | None, default=None
ユーザーのID ユーザーのID
Returns Returns
@ -53,7 +53,7 @@ class AdminModeratorActions(AbstractAction):
Parameters Parameters
---------- ----------
user_id : Optional[str], default=None user_id : str | None, default=None
ユーザーのID ユーザーのID
Returns Returns

8
mipac/actions/chat.py
Unescape View File

@ -133,13 +133,13 @@ class ChatAction(BaseChatAction):
Parameters Parameters
---------- ----------
text : Optional[str], default=None text : str | None, default=None
Chat content Chat content
file_id : Optional[str], default=None file_id : str | None, default=None
添付するファイルのID 添付するファイルのID
user_id : Optional[str], default=None user_id : str | None, default=None
送信するユーザーのID 送信するユーザーのID
group_id : Optional[str], default=None group_id : str | None, default=None
Destination group id Destination group id
""" """
user_id = user_id or self.__user_id user_id = user_id or self.__user_id

80
mipac/actions/drive.py
Unescape View File

@ -18,7 +18,7 @@ __all__ = ('DriveActions', 'FileActions', 'FolderActions')
class FileActions(AbstractAction): class FileActions(AbstractAction):
def __init__( def __init__(
self, self,
file_id: Optional[str] = None, file_id: str | None = None,
*, *,
session: HTTPClient, session: HTTPClient,
client: ClientActions client: ClientActions
@ -27,17 +27,15 @@ class FileActions(AbstractAction):
self.__client: ClientActions = client self.__client: ClientActions = client
self.__file_id = file_id self.__file_id = file_id
async def show_file( async def show_file(self, file_id: str | None, url: str | None) -> File:
self, file_id: Optional[str], url: Optional[str]
) -> File:
""" """
ファイルの情報を取得します。 ファイルの情報を取得します。
Parameters Parameters
---------- ----------
file_id : Optional[str], default=None file_id : str | None, default=None
ファイルのID ファイルのID
url : Optional[str], default=None url : str | None, default=None
ファイルのURL ファイルのURL
Returns Returns
@ -55,13 +53,13 @@ class FileActions(AbstractAction):
) )
return File(res, client=self.__client) return File(res, client=self.__client)
async def remove_file(self, file_id: Optional[str] = None) -> bool: async def remove_file(self, file_id: str | None = None) -> bool:
""" """
指定したIDのファイルを削除します 指定したIDのファイルを削除します
Parameters Parameters
---------- ----------
file_id : Optional[str], default=None file_id : str | None, default=None
削除するファイルのID 削除するファイルのID
Returns Returns
@ -82,10 +80,10 @@ class FileActions(AbstractAction):
async def get_files( async def get_files(
self, self,
limit: int = 10, limit: int = 10,
since_id: Optional[str] = None, since_id: str | None = None,
until_id: Optional[str] = None, until_id: str | None = None,
folder_id: Optional[str] = None, folder_id: str | None = None,
file_type: Optional[str] = None, file_type: str | None = None,
) -> list[File]: ) -> list[File]:
""" """
ファイルを取得します ファイルを取得します
@ -94,13 +92,13 @@ class FileActions(AbstractAction):
---------- ----------
limit : int, default=10 limit : int, default=10
取得する上限 取得する上限
since_id : Optional[str], default=None since_id : str | None, default=None
指定すると、そのIDを起点としてより新しいファイルを取得します 指定すると、そのIDを起点としてより新しいファイルを取得します
until_id : Optional[str], default=None until_id : str | None, default=None
指定すると、そのIDを起点としてより古いファイルを取得します 指定すると、そのIDを起点としてより古いファイルを取得します
folder_id : Optional[str], default=None folder_id : str | None, default=None
指定すると、そのフォルダーを起点としてファイルを取得します 指定すると、そのフォルダーを起点としてファイルを取得します
file_type : Optional[str], default=None file_type : str | None, default=None
取得したいファイルの拡張子 取得したいファイルの拡張子
""" """
if limit > 100: if limit > 100:
@ -121,9 +119,9 @@ class FileActions(AbstractAction):
async def upload_file( async def upload_file(
self, self,
file: str, file: str,
file_name: Optional[str] = None, file_name: str | None = None,
folder_id: Optional[str] = None, folder_id: str | None = None,
comment: Optional[str] = None, comment: str | None = None,
is_sensitive: bool = False, is_sensitive: bool = False,
force: bool = False, force: bool = False,
) -> File: ) -> File:
@ -134,11 +132,11 @@ class FileActions(AbstractAction):
---------- ----------
file : str file : str
アップロードするファイル アップロードするファイル
file_name : Optional[str], default=None file_name : str | None, default=None
アップロードするファイルの名前 アップロードするファイルの名前
folder_id : Optional[str], default=None folder_id : str | None, default=None
アップロードするフォルダーのID アップロードするフォルダーのID
comment : Optional[str], default=None comment : str | None, default=None
アップロードするファイルのコメント アップロードするファイルのコメント
is_sensitive : bool, default=False is_sensitive : bool, default=False
アップロードするファイルがNSFWかどうか アップロードするファイルがNSFWかどうか
@ -171,7 +169,7 @@ class FileActions(AbstractAction):
class FolderActions(AbstractAction): class FolderActions(AbstractAction):
def __init__( def __init__(
self, self,
folder_id: Optional[str] = None, folder_id: str | None = None,
*, *,
session: HTTPClient, session: HTTPClient,
client: ClientActions client: ClientActions
@ -180,7 +178,7 @@ class FolderActions(AbstractAction):
self.__session: HTTPClient = session self.__session: HTTPClient = session
self.__client: ClientActions = client self.__client: ClientActions = client
async def create(self, name: str, parent_id: Optional[str] = None) -> bool: async def create(self, name: str, parent_id: str | None = None) -> bool:
""" """
フォルダーを作成します フォルダーを作成します
@ -188,7 +186,7 @@ class FolderActions(AbstractAction):
---------- ----------
name : str, default=None name : str, default=None
フォルダーの名前 フォルダーの名前
parent_id : Optional[str], default=None parent_id : str | None, default=None
親フォルダーのID 親フォルダーのID
Returns Returns
@ -207,11 +205,11 @@ class FolderActions(AbstractAction):
) )
return bool(res) return bool(res)
async def delete(self, folder_id: Optional[str] = None) -> bool: async def delete(self, folder_id: str | None = None) -> bool:
""" """
Parameters Parameters
---------- ----------
folder_id : Optional[str] = None folder_id : str | None = None
削除するノートのID 削除するノートのID
Returns Returns
@ -232,10 +230,10 @@ class FolderActions(AbstractAction):
async def get_files( async def get_files(
self, self,
limit: int = 10, limit: int = 10,
since_id: Optional[str] = None, since_id: str | None = None,
until_id: Optional[str] = None, until_id: str | None = None,
folder_id: Optional[str] = None, folder_id: str | None = None,
file_type: Optional[str] = None, file_type: str | None = None,
) -> list[File]: ) -> list[File]:
""" """
ファイルを取得します ファイルを取得します
@ -244,13 +242,13 @@ class FolderActions(AbstractAction):
---------- ----------
limit : int, default=10 limit : int, default=10
取得する上限 取得する上限
since_id : Optional[str], default=None since_id : str | None, default=None
指定すると、そのIDを起点としてより新しいファイルを取得します 指定すると、そのIDを起点としてより新しいファイルを取得します
until_id : Optional[str], default=None until_id : str | None, default=None
指定すると、そのIDを起点としてより古いファイルを取得します 指定すると、そのIDを起点としてより古いファイルを取得します
folder_id : Optional[str], default=None folder_id : str | None, default=None
指定すると、そのフォルダーを起点としてファイルを取得します 指定すると、そのフォルダーを起点としてファイルを取得します
file_type : Optional[str], default=None file_type : str | None, default=None
取得したいファイルの拡張子 取得したいファイルの拡張子
""" """
if limit > 100: if limit > 100:
@ -278,9 +276,9 @@ class DriveActions(AbstractAction):
async def get_folders( async def get_folders(
self, self,
limit: int = 100, limit: int = 100,
since_id: Optional[str] = None, since_id: str | None = None,
until_id: Optional[str] = None, until_id: str | None = None,
folder_id: Optional[str] = None, folder_id: str | None = None,
) -> list[Folder]: ) -> list[Folder]:
""" """
フォルダーの一覧を取得します フォルダーの一覧を取得します
@ -289,11 +287,11 @@ class DriveActions(AbstractAction):
---------- ----------
limit : int, default=10 limit : int, default=10
取得する上限 取得する上限
since_id : Optional[str], default=None since_id : str | None, default=None
指定すると、その投稿を投稿を起点としてより新しい投稿を取得します 指定すると、その投稿を投稿を起点としてより新しい投稿を取得します
until_id : Optional[str], default=None until_id : str | None, default=None
指定すると、その投稿を投稿を起点としてより古い投稿を取得します 指定すると、その投稿を投稿を起点としてより古い投稿を取得します
folder_id : Optional[str], default=None folder_id : str | None, default=None
指定すると、そのフォルダーを起点としてフォルダーを取得します 指定すると、そのフォルダーを起点としてフォルダーを取得します
""" """

92
mipac/actions/note.py
Unescape View File

@ -29,17 +29,17 @@ __all__ = ['NoteActions']
def create_note_body( def create_note_body(
content: Optional[str] = None, content: str | None = None,
visibility: str = 'public', visibility: str = 'public',
visible_user_ids: Optional[list[str]] = None, visible_user_ids: Optional[list[str]] = None,
cw: Optional[str] = None, cw: str | None = None,
local_only: bool = False, local_only: bool = False,
extract_mentions: bool = True, extract_mentions: bool = True,
extract_hashtags: bool = True, extract_hashtags: bool = True,
extract_emojis: bool = True, extract_emojis: bool = True,
reply_id: Optional[str] = None, reply_id: str | None = None,
renote_id: Optional[str] = None, renote_id: str | None = None,
channel_id: Optional[str] = None, channel_id: str | None = None,
files: Optional[list[MiFile | File | str]] = None, files: Optional[list[MiFile | File | str]] = None,
poll: Optional[MiPoll] = None, poll: Optional[MiPoll] = None,
): ):
@ -90,12 +90,12 @@ def create_note_body(
class ClientNoteActions(AbstractAction): class ClientNoteActions(AbstractAction):
def __init__( def __init__(
self, self,
note_id: Optional[str] = None, note_id: str | None = None,
*, *,
session: HTTPClient, session: HTTPClient,
client: ClientActions, client: ClientActions,
): ):
self._note_id: Optional[str] = note_id self._note_id: str | None = note_id
self._session: HTTPClient = session self._session: HTTPClient = session
self._client: ClientActions = client self._client: ClientActions = client
@ -108,18 +108,18 @@ class ClientNoteActions(AbstractAction):
return NoteState(res) return NoteState(res)
async def add_clips( async def add_clips(
self, clip_id: str, note_id: Optional[str] = None self, clip_id: str, note_id: str | None = None
) -> bool: ) -> bool:
""" """
クリップに追加します クリップに追加します
Parameters Parameters
---------- ----------
note_id : Optional[str], default=None note_id : str | None, default=None
追加するノートのID 追加するノートのID
clip_id : str clip_id : str
クリップのID クリップのID
note_id : Optional[str], default=None note_id : str | None, default=None
追加したいノートのID 追加したいノートのID
Returns Returns
@ -137,13 +137,13 @@ class ClientNoteActions(AbstractAction):
) )
) )
async def delete(self, note_id: Optional[str] = None) -> bool: async def delete(self, note_id: str | None = None) -> bool:
""" """
Delete a note Delete a note
Parameters Parameters
---------- ----------
note_id : Optional[str], default=None note_id : str | None, default=None
note id note id
Returns Returns
@ -160,13 +160,13 @@ class ClientNoteActions(AbstractAction):
) )
return bool(res) return bool(res)
async def create_renote(self, note_id: Optional[str] = None) -> Note: async def create_renote(self, note_id: str | None = None) -> Note:
""" """
Renote a note Renote a note
Parameters Parameters
---------- ----------
note_id : Optional[str], default=None note_id : str | None, default=None
note id note id
Returns Returns
@ -184,7 +184,7 @@ class ClientNoteActions(AbstractAction):
return Note(res['created_note'], client=self._client) return Note(res['created_note'], client=self._client)
async def get_reaction( async def get_reaction(
self, reaction: str, note_id: Optional[str] = None self, reaction: str, note_id: str | None = None
) -> list[NoteReaction]: ) -> list[NoteReaction]:
note_id = note_id or self._note_id note_id = note_id or self._note_id
return await self._client.note.reaction.action.get_reaction( return await self._client.note.reaction.action.get_reaction(
@ -193,17 +193,17 @@ class ClientNoteActions(AbstractAction):
async def reply( async def reply(
self, self,
content: Optional[str] = None, content: str | None = None,
visibility: str = 'public', visibility: str = 'public',
visible_user_ids: Optional[list[str]] = None, visible_user_ids: Optional[list[str]] = None,
cw: Optional[str] = None, cw: str | None = None,
local_only: bool = False, local_only: bool = False,
extract_mentions: bool = True, extract_mentions: bool = True,
extract_hashtags: bool = True, extract_hashtags: bool = True,
extract_emojis: bool = True, extract_emojis: bool = True,
files: Optional[list[MiFile | File | str]] = None, files: Optional[list[MiFile | File | str]] = None,
poll: Optional[MiPoll] = None, poll: Optional[MiPoll] = None,
reply_id: Optional[str] = None, reply_id: str | None = None,
) -> Note: ) -> Note:
reply_id = reply_id or self._note_id reply_id = reply_id or self._note_id
@ -231,30 +231,30 @@ class ClientNoteActions(AbstractAction):
async def create_quote( async def create_quote(
self, self,
content: Optional[str] = None, content: str | None = None,
visibility: str = 'public', visibility: str = 'public',
visible_user_ids: Optional[list[str]] = None, visible_user_ids: Optional[list[str]] = None,
cw: Optional[str] = None, cw: str | None = None,
local_only: bool = False, local_only: bool = False,
extract_mentions: bool = True, extract_mentions: bool = True,
extract_hashtags: bool = True, extract_hashtags: bool = True,
extract_emojis: bool = True, extract_emojis: bool = True,
files: Optional[list[MiFile | File | str]] = None, files: Optional[list[MiFile | File | str]] = None,
poll: MiPoll | None = None, poll: MiPoll | None = None,
note_id: Optional[str] = None, note_id: str | None = None,
) -> Note: ) -> Note:
""" """
Create a note quote. Create a note quote.
Parameters Parameters
---------- ----------
content: Optional[str], default=None content: str | None, default=None
text text
visibility: str, default='public' visibility: str, default='public'
Disclosure range Disclosure range
visible_user_ids: Optional[list[str]], default=None visible_user_ids: Optional[list[str]], default=None
List of users to be published List of users to be published
cw: Optional[str], default=None cw: str | None, default=None
Text to be displayed when warning is given Text to be displayed when warning is given
local_only: bool, default=False local_only: bool, default=False
Whether to show only locally or not Whether to show only locally or not
@ -268,7 +268,7 @@ class ClientNoteActions(AbstractAction):
The ID list of files to be attached The ID list of files to be attached
poll: MiPoll | None, default=None poll: MiPoll | None, default=None
Questionnaire to be created Questionnaire to be created
note_id: Optional[str], default=None note_id: str | None, default=None
Note IDs to target for renote and citations Note IDs to target for renote and citations
""" """
@ -298,14 +298,14 @@ class ClientNoteActions(AbstractAction):
@cache(group='translate_note') @cache(group='translate_note')
async def translate( async def translate(
self, note_id: Optional[str] = None, target_lang: str = 'en-US', self, note_id: str | None = None, target_lang: str = 'en-US',
) -> NoteTranslateResult: ) -> NoteTranslateResult:
""" """
Translate a note Translate a note
Parameters Parameters
---------- ----------
note_id : Optional[str], default=None note_id : str | None, default=None
Note ID to target for translation Note ID to target for translation
target_lang : str, default='en' target_lang : str, default='en'
Target language Target language
@ -331,7 +331,7 @@ class ClientNoteActions(AbstractAction):
class NoteActions(ClientNoteActions): class NoteActions(ClientNoteActions):
def __init__( def __init__(
self, self,
note_id: Optional[str] = None, note_id: str | None = None,
*, *,
session: HTTPClient, session: HTTPClient,
client: ClientActions, client: ClientActions,
@ -341,17 +341,17 @@ class NoteActions(ClientNoteActions):
async def send( async def send(
self, self,
content: Optional[str] = None, content: str | None = None,
visibility: str = 'public', visibility: str = 'public',
visible_user_ids: Optional[list[str]] = None, visible_user_ids: Optional[list[str]] = None,
cw: Optional[str] = None, cw: str | None = None,
local_only: bool = False, local_only: bool = False,
extract_mentions: bool = True, extract_mentions: bool = True,
extract_hashtags: bool = True, extract_hashtags: bool = True,
extract_emojis: bool = True, extract_emojis: bool = True,
reply_id: Optional[str] = None, reply_id: str | None = None,
renote_id: Optional[str] = None, renote_id: str | None = None,
channel_id: Optional[str] = None, channel_id: str | None = None,
files: Optional[list[MiFile | File | str]] = None, files: Optional[list[MiFile | File | str]] = None,
poll: MiPoll | None = None, poll: MiPoll | None = None,
) -> Note: ) -> Note:
@ -360,14 +360,14 @@ class NoteActions(ClientNoteActions):
Parameters Parameters
---------- ----------
content : Optional[str], default=None content : str | None, default=None
投稿する内容 投稿する内容
visibility : str, optional visibility : str, optional
公開範囲, by default "public" 公開範囲, by default "public"
Enum: "public" "home" "followers" "specified" Enum: "public" "home" "followers" "specified"
visible_user_ids : Optional[list[str]], optional visible_user_ids : Optional[list[str]], optional
公開するユーザー, by default None 公開するユーザー, by default None
cw : Optional[str], optional cw : str | None, optional
閲覧注意の文字, by default None 閲覧注意の文字, by default None
local_only : bool, optional local_only : bool, optional
ローカルにのみ表示するか, by default False ローカルにのみ表示するか, by default False
@ -377,11 +377,11 @@ class NoteActions(ClientNoteActions):
ハッシュタグを展開するか, by default False ハッシュタグを展開するか, by default False
extract_emojis : bool, optional extract_emojis : bool, optional
絵文字を展開するか, by default False 絵文字を展開するか, by default False
reply_id : Optional[str], optional reply_id : str | None, optional
リプライ先のid, by default None リプライ先のid, by default None
renote_id : Optional[str], optional renote_id : str | None, optional
リノート先のid, by default None リノート先のid, by default None
channel_id : Optional[str], optional channel_id : str | None, optional
チャンネルid, by default None チャンネルid, by default None
files : list[MiFile | File | str], optional files : list[MiFile | File | str], optional
添付するファイルのリスト, by default None 添付するファイルのリスト, by default None
@ -422,13 +422,13 @@ class NoteActions(ClientNoteActions):
return Note(res['created_note'], client=self._client) return Note(res['created_note'], client=self._client)
@cache(group='get_note') @cache(group='get_note')
async def get(self, note_id: Optional[str] = None) -> Note: async def get(self, note_id: str | None = None) -> Note:
""" """
ノートを取得します ノートを取得します
Parameters Parameters
---------- ----------
note_id : Optional[str], default=None note_id : str | None, default=None
ノートのID ノートのID
Returns Returns
@ -446,7 +446,7 @@ class NoteActions(ClientNoteActions):
return Note(res, client=self._client) return Note(res, client=self._client)
@cache(group='get_note', override=True) @cache(group='get_note', override=True)
async def fetch(self, note_id: Optional[str] = None) -> Note: async def fetch(self, note_id: str | None = None) -> Note:
note_id = note_id or self._note_id note_id = note_id or self._note_id
res = await self._session.request( res = await self._session.request(
Route('POST', '/api/notes/show'), Route('POST', '/api/notes/show'),
@ -458,23 +458,23 @@ class NoteActions(ClientNoteActions):
async def get_replies( async def get_replies(
self, self,
since_id: Optional[str] = None, since_id: str | None = None,
until_id: Optional[str] = None, until_id: str | None = None,
limit: int = 10, limit: int = 10,
note_id: Optional[str] = None, note_id: str | None = None,
) -> list[Note]: ) -> list[Note]:
""" """
ノートに対する返信を取得します ノートに対する返信を取得します
Parameters Parameters
--------- ---------
since_id : Optional[str], default=None since_id : str | None, default=None
指定すると、その投稿を投稿を起点としてより新しい投稿を取得します 指定すると、その投稿を投稿を起点としてより新しい投稿を取得します
until_id : Optional[str], default=None until_id : str | None, default=None
指定すると、その投稿を投稿を起点としてより古い投稿を取得します 指定すると、その投稿を投稿を起点としてより古い投稿を取得します
limit : int, default=10 limit : int, default=10
取得する上限 取得する上限
note_id: Optional[str], default=None note_id: str | None, default=None
返信を取得したいノートのID 返信を取得したいノートのID
Returns Returns

18
mipac/actions/user.py
Unescape View File

@ -55,9 +55,9 @@ class UserActions:
@cache(group='get_user') @cache(group='get_user')
async def get( async def get(
self, self,
user_id: Optional[str] = None, user_id: str | None = None,
username: Optional[str] = None, username: str | None = None,
host: Optional[str] = None, host: str | None = None,
) -> UserDetailed: ) -> UserDetailed:
""" """
ユーザーのプロフィールを取得します。一度のみサーバーにアクセスしキャッシュをその後は使います。 ユーザーのプロフィールを取得します。一度のみサーバーにアクセスしキャッシュをその後は使います。
@ -89,9 +89,9 @@ class UserActions:
@cache @cache
async def fetch( async def fetch(
self, self,
user_id: Optional[str] = None, user_id: str | None = None,
username: Optional[str] = None, username: str | None = None,
host: Optional[str] = None, host: str | None = None,
) -> UserDetailed: ) -> UserDetailed:
""" """
サーバーにアクセスし、ユーザーのプロフィールを取得します。基本的には get_userをお使いください。 サーバーにアクセスし、ユーザーのプロフィールを取得します。基本的には get_userをお使いください。
@ -123,11 +123,11 @@ class UserActions:
async def get_notes( async def get_notes(
self, self,
user_id: Optional[str] = None, user_id: str | None = None,
include_replies: bool = True, include_replies: bool = True,
limit: int = 10, limit: int = 10,
since_id: Optional[str] = None, since_id: str | None = None,
until_id: Optional[str] = None, until_id: str | None = None,
since_date: int = 0, since_date: int = 0,
until_date: int = 0, until_date: int = 0,
include_my_renotes: bool = True, include_my_renotes: bool = True,

12
mipac/errors/base.py
Unescape View File

@ -8,14 +8,14 @@ class APIError(Exception):
def __init__(self, data: Union[dict, str], status: int): def __init__(self, data: Union[dict, str], status: int):
self.raw: Union[dict, str] = data self.raw: Union[dict, str] = data
self.status: int = status self.status: int = status
self.code: Optional[str] = None self.code: str | None = None
self.id: Optional[str] = None self.id: str | None = None
self.message: Optional[str] = None self.message: str | None = None
if isinstance(data, dict): if isinstance(data, dict):
error = data.get('error', {}) error = data.get('error', {})
self.code: Optional[str] = error.get('code', '') self.code: str | None = error.get('code', '')
self.id: Optional[str] = error.get('id') self.id: str | None = error.get('id')
self.message: Optional[str] = error.get('message', '') self.message: str | None = error.get('message', '')
super().__init__(self.message or self.raw) super().__init__(self.message or self.raw)
def raise_error(self): def raise_error(self):

22
mipac/file.py
Unescape View File

@ -14,28 +14,28 @@ class MiFile:
def __init__( def __init__(
self, self,
path: Optional[str] = None, path: str | None = None,
file_id: Optional[str] = None, file_id: str | None = None,
name: Optional[str] = None, name: str | None = None,
folder_id: Optional[str] = None, folder_id: str | None = None,
comment: Optional[str] = None, comment: str | None = None,
is_sensitive: bool = False, is_sensitive: bool = False,
force: bool = False, force: bool = False,
): ):
""" """
Parameters Parameters
---------- ----------
path : Optional[str], default=None path : str | None, default=None
path to a local file path to a local file
file_id : Optional[str], default=None file_id : str | None, default=None
ID of the file that exists on the drive ID of the file that exists on the drive
name Optional[str], default=None name str | None, default=None
file name file name
folder_id : Optional[str], default=None folder_id : str | None, default=None
Folder ID Folder ID
comment : Optional[str], default=None comment : str | None, default=None
Comments on files Comments on files
is_sensitive : Optional[str], default=None is_sensitive : str | None, default=None
Whether this item is sensitive Whether this item is sensitive
force : bool, default=False force : bool, default=False
Whether to force overwriting even if it already exists on the drive Whether to force overwriting even if it already exists on the drive

4
mipac/manager/admin/moderator.py
Unescape View File

@ -15,12 +15,12 @@ __all__ = ('AdminModeratorManager',)
class AdminModeratorManager(AbstractManager): class AdminModeratorManager(AbstractManager):
def __init__( def __init__(
self, self,
user_id: Optional[str] = None, user_id: str | None = None,
*, *,
session: HTTPClient, session: HTTPClient,
client: ClientActions client: ClientActions
): ):
self.__user_id: Optional[str] = user_id self.__user_id: str | None = user_id
self.__session: HTTPClient = session self.__session: HTTPClient = session
self.__client: ClientActions = client self.__client: ClientActions = client

18
mipac/manager/admin/user.py
Unescape View File

@ -12,7 +12,7 @@ if TYPE_CHECKING:
class AdminUserManager: class AdminUserManager:
def __init__( def __init__(
self, self,
user_id: Optional[str] = None, user_id: str | None = None,
*, *,
session: HTTPClient, session: HTTPClient,
client: ClientActions client: ClientActions
@ -21,13 +21,13 @@ class AdminUserManager:
self.__session: HTTPClient = session self.__session: HTTPClient = session
self.__client: ClientActions = client self.__client: ClientActions = client
async def delete_account(self, user_id: Optional[str] = None) -> bool: async def delete_account(self, user_id: str | None = None) -> bool:
""" """
Deletes the user with the specified user ID. Deletes the user with the specified user ID.
Parameters Parameters
---------- ----------
user_id : Optional[str], default=None user_id : str | None, default=None
ID of the user to be deleted ID of the user to be deleted
Returns Returns
------- -------
@ -46,13 +46,13 @@ class AdminUserManager:
) )
return bool(res) return bool(res)
async def show_user(self, user_id: Optional[str] = None) -> UserDetailed: async def show_user(self, user_id: str | None = None) -> UserDetailed:
""" """
Shows the user with the specified user ID. Shows the user with the specified user ID.
Parameters Parameters
---------- ----------
user_id : Optional[str], default=None user_id : str | None, default=None
ID of the user to be shown ID of the user to be shown
Returns Returns
@ -70,13 +70,13 @@ class AdminUserManager:
) )
return UserDetailed(res, client=self.__client) return UserDetailed(res, client=self.__client)
async def suspend(self, user_id: Optional[str] = None) -> bool: async def suspend(self, user_id: str | None = None) -> bool:
""" """
Suspends the user with the specified user ID. Suspends the user with the specified user ID.
Parameters Parameters
---------- ----------
user_id : Optional[str], default=None user_id : str | None, default=None
ID of the user to be suspended ID of the user to be suspended
Returns Returns
@ -95,13 +95,13 @@ class AdminUserManager:
) )
return bool(res) return bool(res)
async def unsuspend(self, user_id: Optional[str] = None) -> bool: async def unsuspend(self, user_id: str | None = None) -> bool:
""" """
Unsuspends the user with the specified user ID. Unsuspends the user with the specified user ID.
Parameters Parameters
---------- ----------
user_id : Optional[str], default=None user_id : str | None, default=None
ID of the user to be unsuspended ID of the user to be unsuspended
Returns Returns

4
mipac/manager/drive.py
Unescape View File

@ -15,7 +15,7 @@ __all__ = ['FolderManager', 'FileManager', 'DriveManager']
class FileManager(AbstractManager): class FileManager(AbstractManager):
def __init__( def __init__(
self, self,
file_id: Optional[str] = None, file_id: str | None = None,
*, *,
session: HTTPClient, session: HTTPClient,
client: ClientActions client: ClientActions
@ -44,7 +44,7 @@ class FileManager(AbstractManager):
class FolderManager(AbstractManager): class FolderManager(AbstractManager):
def __init__( def __init__(
self, self,
folder_id: Optional[str] = None, folder_id: str | None = None,
*, *,
session: HTTPClient, session: HTTPClient,
client: ClientActions client: ClientActions

2
mipac/manager/favorite.py
Unescape View File

@ -13,7 +13,7 @@ if TYPE_CHECKING:
class FavoriteManager(AbstractManager): class FavoriteManager(AbstractManager):
def __init__( def __init__(
self, self,
note_id: Optional[str] = None, note_id: str | None = None,
*, *,
session: HTTPClient, session: HTTPClient,
client: ClientActions client: ClientActions

8
mipac/manager/follow.py
Unescape View File

@ -15,12 +15,12 @@ __all__ = ('FollowManager', 'FollowRequestManager')
class FollowManager(AbstractManager): class FollowManager(AbstractManager):
def __init__( def __init__(
self, self,
user_id: Optional[str] = None, user_id: str | None = None,
*, *,
session: HTTPClient, session: HTTPClient,
client: ClientActions client: ClientActions
): ):
self.__user_id: Optional[str] = user_id self.__user_id: str | None = user_id
self.__session: HTTPClient = session self.__session: HTTPClient = session
self.__client: ClientActions = client self.__client: ClientActions = client
self.request: FollowRequestManager = FollowRequestManager( self.request: FollowRequestManager = FollowRequestManager(
@ -39,12 +39,12 @@ class FollowManager(AbstractManager):
class FollowRequestManager(AbstractManager): class FollowRequestManager(AbstractManager):
def __init__( def __init__(
self, self,
user_id: Optional[str] = None, user_id: str | None = None,
*, *,
session: HTTPClient, session: HTTPClient,
client: ClientActions client: ClientActions
): ):
self.__user_id: Optional[str] = user_id self.__user_id: str | None = user_id
self.__session: HTTPClient = session self.__session: HTTPClient = session
self.__client: ClientActions = client self.__client: ClientActions = client

6
mipac/manager/note.py
Unescape View File

@ -48,7 +48,7 @@ class NoteManager(AbstractManager):
def __init__( def __init__(
self, self,
note_id: Optional[str] = None, note_id: str | None = None,
*, *,
session: HTTPClient, session: HTTPClient,
client: ClientActions client: ClientActions
@ -90,8 +90,8 @@ class NoteManager(AbstractManager):
with_files: bool = False, with_files: bool = False,
poll: bool = True, poll: bool = True,
limit: int = 10, limit: int = 10,
since_id: Optional[str] = None, since_id: str | None = None,
until_id: Optional[str] = None, until_id: str | None = None,
): ):
data = { data = {
'local': local, 'local': local,

4
mipac/manager/page.py
Unescape View File

@ -17,8 +17,8 @@ class PagesManager(AbstractManager):
async def get_pages( async def get_pages(
self, self,
limit: int = 100, limit: int = 100,
since_id: Optional[int] = None, since_id: int | None = None,
until_id: Optional[int] = None, until_id: int | None = None,
): ):
data = {'limit': limit, 'since_id': since_id, 'until_id': until_id} data = {'limit': limit, 'since_id': since_id, 'until_id': until_id}
res = await self.__session.request( res = await self.__session.request(

4
mipac/manager/reaction.py
Unescape View File

@ -13,12 +13,12 @@ if TYPE_CHECKING:
class ReactionManager(AbstractManager): class ReactionManager(AbstractManager):
def __init__( def __init__(
self, self,
note_id: Optional[str] = None, note_id: str | None = None,
*, *,
session: HTTPClient, session: HTTPClient,
client: ClientActions client: ClientActions
): ):
self.__note_id: Optional[str] = note_id self.__note_id: str | None = note_id
self.__session: HTTPClient = session self.__session: HTTPClient = session
self.__client: ClientActions = client self.__client: ClientActions = client

4
mipac/models/drive.py
Unescape View File

@ -14,7 +14,7 @@ class FileProperties:
self.__properties: IFileProperties = properties self.__properties: IFileProperties = properties
@property @property
def width(self) -> Optional[int]: def width(self) -> int | None:
return self.__properties['width'] return self.__properties['width']
@property @property
@ -22,7 +22,7 @@ class FileProperties:
return self.__properties['height'] return self.__properties['height']
@property @property
def avg_color(self) -> Optional[str]: def avg_color(self) -> str | None:
return self.__properties['avg_color'] return self.__properties['avg_color']

10
mipac/models/emoji.py
Unescape View File

@ -14,17 +14,17 @@ class CustomEmoji:
""" """
Attributes Attributes
---------- ----------
id : Optional[str] id : str | None
絵文字のID 絵文字のID
aliases : Optional[list[str]] aliases : Optional[list[str]]
絵文字のエイリアス 絵文字のエイリアス
name : Optional[str] name : str | None
絵文字の名前 絵文字の名前
category : Optional[str] category : str | None
絵文字のカテゴリ 絵文字のカテゴリ
host : Optional[str] host : str | None
絵文字のホスト 絵文字のホスト
url : Optional[str] url : str | None
絵文字のURL 絵文字のURL
""" """

2
mipac/types/drive.py
Unescape View File

@ -12,7 +12,7 @@ class IFileProperties(TypedDict):
width: int width: int
height: int height: int
avg_color: Optional[str] avg_color: str | None
class FolderPayload(TypedDict): class FolderPayload(TypedDict):

10
mipac/types/emoji.py
Unescape View File

@ -15,9 +15,9 @@ class ICustomEmoji(ICustomEmojiLite):
class EmojiPayload(TypedDict): class EmojiPayload(TypedDict):
id: Optional[str] id: str | None
aliases: Optional[list[str]] aliases: Optional[list[str]]
name: Optional[str] name: str | None
category: Optional[str] category: str | None
host: Optional[str] host: str | None
url: Optional[str] url: str | None

2
mipac/types/instance.py
Unescape View File

@ -60,7 +60,7 @@ class MetaPayload(OptionalMeta):
uri: str uri: str
description: str description: str
langs: list[str] langs: list[str]
tos_url: Optional[str] tos_url: str | None
repository_url: str repository_url: str
feedback_url: str feedback_url: str
secure: bool secure: bool

30
mipac/types/page.py
Unescape View File

@ -47,23 +47,23 @@ class IPage(IPageRequired, total=False):
class PageContentPayload(TypedDict): class PageContentPayload(TypedDict):
id: str id: str
type: str type: str
text: Optional[str] text: str | None
file_id: Optional[str] file_id: str | None
width: Optional[int] width: int | None
height: Optional[int] height: int | None
note: Optional[str] note: str | None
detailed: Optional[bool] detailed: Optional[bool]
fn: Optional[Any] fn: Optional[Any]
var: Optional[Any] var: Optional[Any]
event: Optional[Any] event: Optional[Any]
action: Optional[str] action: str | None
content: Optional[str] content: str | None
message: Optional[Any] message: Optional[Any]
primary: Optional[bool] primary: Optional[bool]
inc: Optional[int] inc: int | None
canvas_id: Optional[str] canvas_id: str | None
attach_canvas_image: Optional[bool] attach_canvas_image: Optional[bool]
default: Optional[str] default: str | None
value: Optional[list[Any]] value: Optional[list[Any]]
children: Optional['PageContentPayload'] children: Optional['PageContentPayload']
@ -73,7 +73,7 @@ class VariablePayload(TypedDict):
id: str id: str
name: str name: str
type: str type: str
value: Optional[str] value: str | None
class PageFilePayload(TypedDict): class PageFilePayload(TypedDict):
@ -88,8 +88,8 @@ class PageFilePayload(TypedDict):
properties: IFileProperties properties: IFileProperties
url: str url: str
thumbnail_url: str thumbnail_url: str
comment: Optional[str] comment: str | None
folder_id: Optional[str] folder_id: str | None
folder: Any folder: Any
user_id: str user_id: str
user: Any user: Any
@ -113,12 +113,12 @@ class PagePayload(TypedDict):
variable: list[VariablePayload] variable: list[VariablePayload]
title: str title: str
name: str name: str
summary: Optional[str] summary: str | None
hide_title_when_pinned: bool hide_title_when_pinned: bool
align_center: bool align_center: bool
font: str font: str
script: str script: str
eye_catching_image_id: Optional[str] eye_catching_image_id: str | None
eye_catching_image: EyeCatchingImagePayload eye_catching_image: EyeCatchingImagePayload
attached_files: list[AttachedFilePayload] attached_files: list[AttachedFilePayload]
liked_count: int liked_count: int

6
mipac/util.py
Unescape View File

@ -105,7 +105,7 @@ class AuthClient:
description: str, description: str,
permissions: Optional[list[str]] = None, permissions: Optional[list[str]] = None,
*, *,
icon: Optional[str] = None, icon: str | None = None,
use_miauth: bool = False, use_miauth: bool = False,
): ):
""" """
@ -119,7 +119,7 @@ class AuthClient:
アプリケーションの説明 アプリケーションの説明
permissions : Optional[list[str]], default=None permissions : Optional[list[str]], default=None
アプリケーションが要求する権限 アプリケーションが要求する権限
icon: Optional[str], default=None icon: str | None, default=None
アプリケーションのアイコン画像URL アプリケーションのアイコン画像URL
use_miauth: bool, default=False use_miauth: bool, default=False
MiAuthを使用するか MiAuthを使用するか
@ -131,7 +131,7 @@ class AuthClient:
self.__name: str = name self.__name: str = name
self.__description: str = description self.__description: str = description
self.__permissions: list[str] = permissions self.__permissions: list[str] = permissions
self.__icon: Optional[str] = icon self.__icon: str | None = icon
self.__use_miauth: bool = use_miauth self.__use_miauth: bool = use_miauth
self.__session_token: uuid.UUID self.__session_token: uuid.UUID
self.__secret: str self.__secret: str

Write Preview
Loading…
Cancel
Save