Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,172 @@ | ||
| from __future__ import annotations | ||
|
|
||
| from typing import TYPE_CHECKING, Literal | ||
|
|
||
| from mipac.abstract.action import AbstractAction | ||
| from mipac.http import HTTPClient, Route | ||
| from mipac.models.hashtag import Hashtag, TrendHashtag | ||
| from mipac.models.user import MeDetailed, UserDetailedNotMe, packed_user | ||
| from mipac.types.hashtag import IHashtag, ITrendHashtag | ||
| from mipac.types.user import IMeDetailedSchema, IUserDetailedNotMeSchema | ||
|
|
||
| if TYPE_CHECKING: | ||
| from mipac.client import ClientManager | ||
|
|
||
|
|
||
| class HashtagActions(AbstractAction): | ||
| def __init__(self, *, session: HTTPClient, client: ClientManager): | ||
| self.__session: HTTPClient = session | ||
| self.__client: ClientManager = client | ||
|
|
||
| async def get_list( | ||
| self, | ||
| sort: Literal[ | ||
| "+mentionedUsers", | ||
|
Check warning on line 24 in mipac/actions/hashtag.py
|
||
| "-mentionedUsers", | ||
| "+mentionedLocalUsers", | ||
| "-mentionedLocalUsers", | ||
| "+mentionedRemoteUsers", | ||
| "-mentionedRemoteUsers", | ||
| "+attachedUsers", | ||
| "-attachedUsers", | ||
| "+attachedLocalUsers", | ||
| "-attachedLocalUsers", | ||
| "+attachedRemoteUsers", | ||
| "-attachedRemoteUsers", | ||
| ], | ||
| limit: int = 10, | ||
| attached_to_user_only: bool = False, | ||
| attached_to_local_user_only: bool = False, | ||
| attached_to_remote_user_only: bool = False, | ||
| ) -> list[Hashtag]: | ||
| """ハッシュタグのリストを取得します。 | ||
| Parameters | ||
| ---------- | ||
| sort: Literal[ | ||
| "+mentionedUsers", | ||
| "-mentionedUsers", | ||
| "+mentionedLocalUsers", | ||
| "-mentionedLocalUsers", | ||
| "+mentionedRemoteUsers", | ||
| "-mentionedRemoteUsers", | ||
| "+attachedUsers", | ||
| "-attachedUsers", | ||
| "+attachedLocalUsers", | ||
| "-attachedLocalUsers", | ||
| "+attachedRemoteUsers", | ||
| "-attachedRemoteUsers", | ||
| ] | ||
| ソートの方法を指定します。 | ||
| limit: int, optional | ||
| 取得するハッシュタグの数を指定します, default=10 | ||
| attached_to_user_only: bool, optional | ||
| ユーザーに添付されたハッシュタグのみを取得するかどうかを指定します, default=False | ||
| attached_to_local_user_only: bool, optional | ||
| ローカルユーザーに添付されたハッシュタグのみを取得するかどうかを指定します, default=False | ||
| attached_to_remote_user_only: bool, optional | ||
| リモートユーザーに添付されたハッシュタグのみを取得するかどうかを指定します, default=False | ||
| Returns | ||
| ------- | ||
| list[Hashtag] | ||
| 取得したハッシュタグのリストです。 | ||
| """ | ||
| body = { | ||
| "limit": limit, | ||
| "attachedToUserOnly": attached_to_user_only, | ||
| "attachedToLocalUserOnly": attached_to_local_user_only, | ||
| "attachedToRemoteUserOnly": attached_to_remote_user_only, | ||
| "sort": sort, | ||
| } | ||
|
|
||
| raw_hashtags: list[IHashtag] = await self.__session.request( | ||
| Route("POST", "/api/hashtags/list"), json=body | ||
| ) | ||
|
|
||
| return [ | ||
| Hashtag(raw_hashtag=raw_hashtag, client=self.__client) for raw_hashtag in raw_hashtags | ||
| ] | ||
|
|
||
| async def search(self, query: str, limit: int = 10, offset: int = 0) -> list[str]: | ||
| """ハッシュタグを検索します | ||
| Parameters | ||
| ---------- | ||
| query: str | ||
| 検索するクエリを指定します。 | ||
| limit: int, optional | ||
| 取得するハッシュタグの数を指定します, default=10 | ||
| offset: int, optional | ||
| オフセットを指定します, default=0 | ||
| Returns | ||
| ------- | ||
| list[Hashtag] | ||
| 取得したハッシュタグのリストです。 | ||
| """ | ||
|
|
||
| body = {"query": query, "limit": limit, "offset": offset} | ||
|
|
||
| raw_hashtags: list[str] = await self.__session.request( | ||
| Route("POST", "/api/hashtags/search"), | ||
| json=body, | ||
| lower=False, # 戻り値がarrayのstrなのでlowerするとエラーになる | ||
| ) | ||
|
|
||
| return raw_hashtags | ||
|
|
||
| async def show(self, tag: str): | ||
| """ハッシュタグの情報を取得します。 | ||
| Parameters | ||
| ---------- | ||
| tag: str | ||
| 取得するハッシュタグの名前です。 | ||
| Returns | ||
| ------- | ||
| Hashtag | ||
| 取得したハッシュタグの情報です。 | ||
| """ | ||
| body = {"tag": tag} | ||
|
|
||
| raw_hashtag: IHashtag = await self.__session.request( | ||
| Route("POST", "/api/hashtags/show"), json=body | ||
| ) | ||
|
|
||
| return Hashtag(raw_hashtag=raw_hashtag, client=self.__client) | ||
|
|
||
| async def get_trend(self): | ||
| """トレンドのハッシュタグを取得します。 | ||
| Returns | ||
| ------- | ||
| list[TrendHashtag] | ||
| 取得したハッシュタグのリストです。 | ||
| """ | ||
| raw_trend_hashtags: list[ITrendHashtag] = await self.__session.request( | ||
| Route("GET", "/api/hashtags/trend") | ||
| ) | ||
|
|
||
| return [ | ||
| TrendHashtag(raw_trend_hashtag=raw_trend_hashtag, client=self.__client) | ||
| for raw_trend_hashtag in raw_trend_hashtags | ||
| ] | ||
|
|
||
| async def get_users( | ||
| self, | ||
| tag: str, | ||
| sort: Literal[ | ||
| "+follower", "-follower", "+createdAt", "-createdAt", "+updatedAt", "-updatedAt" | ||
|
Check warning on line 161 in mipac/actions/hashtag.py
|
||
| ], | ||
| state: Literal["all", "alive"] = "all", | ||
|
Check warning on line 163 in mipac/actions/hashtag.py
|
||
| origin: Literal["combined", "local", "remote"] = "local", | ||
|
Check warning on line 164 in mipac/actions/hashtag.py
|
||
| ) -> list[UserDetailedNotMe | MeDetailed]: | ||
| body = {"tag": tag, "sort": sort, "state": state, "origin": origin} | ||
|
|
||
| raw_users: list[ | ||
| IUserDetailedNotMeSchema | IMeDetailedSchema | ||
| ] = await self.__session.request(Route("POST", "/api/hashtags/users"), json=body) | ||
|
|
||
| return [packed_user(raw_user, client=self.__client) for raw_user in raw_users] | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| from __future__ import annotations | ||
| from typing import TYPE_CHECKING | ||
|
|
||
| from mipac.abstract.manager import AbstractManager | ||
| from mipac.http import HTTPClient | ||
| from mipac.actions.hashtag import HashtagActions | ||
|
|
||
| if TYPE_CHECKING: | ||
| from mipac.manager.client import ClientManager | ||
|
|
||
|
|
||
| class HashtagManager(AbstractManager): | ||
| def __init__(self, *, session: HTTPClient, client: ClientManager): | ||
| self.__session: HTTPClient = session | ||
| self.__client: ClientManager = client | ||
|
|
||
| @property | ||
| def action(self) -> HashtagActions: | ||
| return HashtagActions(session=self.__session, client=self.__client) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| from __future__ import annotations | ||
|
|
||
| from typing import TYPE_CHECKING, Any | ||
|
|
||
| from mipac.types.hashtag import IHashtag, ITrendHashtag | ||
|
|
||
| if TYPE_CHECKING: | ||
| from mipac.manager.client import ClientManager | ||
|
|
||
|
|
||
| class Hashtag: | ||
| def __init__(self, *, raw_hashtag: IHashtag, client: ClientManager) -> None: | ||
| self.__client: ClientManager = client | ||
| self.__raw_hashtag: IHashtag = raw_hashtag | ||
|
|
||
| @property | ||
| def tag(self): | ||
| return self.__raw_hashtag["tag"] | ||
|
|
||
| @property | ||
| def mentioned_users_count(self): | ||
| return self.__raw_hashtag["mentioned_users_count"] | ||
|
|
||
| @property | ||
| def mentioned_local_users_count(self): | ||
| return self.__raw_hashtag["mentioned_local_users_count"] | ||
|
|
||
| @property | ||
| def mentioned_remote_users_count(self): | ||
| return self.__raw_hashtag["mentioned_remote_users_count"] | ||
|
|
||
| @property | ||
| def attached_users_count(self): | ||
| return self.__raw_hashtag["attached_users_count"] | ||
|
|
||
| @property | ||
| def attached_local_users_count(self): | ||
| return self.__raw_hashtag["attached_local_users_count"] | ||
|
|
||
| @property | ||
| def attached_remote_users_count(self): | ||
| return self.__raw_hashtag["attached_remote_users_count"] | ||
|
|
||
| def _get(self, key: str) -> Any | None: | ||
| """生のレスポンスデータに直接アクセスすることができます | ||
| Returns | ||
| ------- | ||
| Any | None | ||
| 生のレスポンスデータ | ||
| """ | ||
| return self.__raw_hashtag.get(key) | ||
|
|
||
|
|
||
| class TrendHashtag: | ||
| def __init__(self, *, raw_trend_hashtag: ITrendHashtag, client: ClientManager) -> None: | ||
| self.__raw_trend_hashtag: ITrendHashtag = raw_trend_hashtag | ||
| self.__client: ClientManager = client | ||
|
|
||
| @property | ||
| def tag(self): | ||
| """ハッシュタグ | ||
| Returns | ||
| ------- | ||
| str | ||
| ハッシュタグ | ||
| """ | ||
| return self.__raw_trend_hashtag["tag"] | ||
|
|
||
| @property | ||
| def chart(self): | ||
| """チャート | ||
| Returns | ||
| ------- | ||
| list[int] | ||
| チャート | ||
| """ | ||
| return self.__raw_trend_hashtag["chart"] | ||
|
|
||
| @property | ||
| def users_count(self): | ||
| """ユーザー数 | ||
| Returns | ||
| ------- | ||
| int | ||
| ユーザー数 | ||
| """ | ||
| return self.__raw_trend_hashtag["users_count"] | ||
|
|
||
| def _get(self, key: str) -> Any | None: | ||
| """生のレスポンスデータに直接アクセスすることができます | ||
| Returns | ||
| ------- | ||
| Any | None | ||
| 生のレスポンスデータ | ||
| """ | ||
| return self.__raw_trend_hashtag.get(key) |
Oops, something went wrong.