SIMNet/simnet/client/components/wish/genshin.py

60 lines
2.5 KiB
Python
Raw Normal View History

2023-05-05 04:06:43 +00:00
from functools import partial
from typing import Optional, List
from simnet.client.components.wish.base import BaseWishClient
2023-05-05 04:06:43 +00:00
from simnet.models.genshin.wish import Wish
2023-12-27 07:09:24 +00:00
from simnet.utils.enums import Game
2023-05-05 04:06:43 +00:00
from simnet.utils.paginator import WishPaginator
__all__ = ("GenshinWishClient",)
class GenshinWishClient(BaseWishClient):
"""The GenshinWishClient class for making requests towards the Wish API."""
2023-05-05 04:06:43 +00:00
async def wish_history(
self,
banner_types: Optional[List[int]] = None,
2023-05-05 04:06:43 +00:00
limit: Optional[int] = None,
lang: Optional[str] = None,
authkey: Optional[str] = None,
end_id: int = 0,
banner_default_name: Optional[str] = "",
2023-05-05 04:06:43 +00:00
) -> List[Wish]:
"""Get the wish history for a list of banner types.
2023-05-05 04:06:43 +00:00
Args:
banner_types (Optional[List[int]], optional): The banner types to get the wish history for.
2023-05-05 04:06:43 +00:00
limit (Optional[int] , optional): The maximum number of wishes to retrieve.
If not provided, all available wishes will be returned.
lang (Optional[str], optional): The language code to use for the request.
If not provided, the class default will be used.
authkey (Optional[str], optional): The authorization key for making the request.
end_id (int, optional): The ending ID of the last wish to retrieve.
banner_default_name (Optional[str], optional): The default name of the banner to use.
2023-05-05 04:06:43 +00:00
Returns:
List[Wish]: A list of GenshinWish objects representing the retrieved wishes.
"""
banner_types = banner_types or [100, 200, 301, 302, 500]
if isinstance(banner_types, int):
banner_types = [banner_types]
2023-05-12 03:24:06 +00:00
banner_names = await self.get_banner_names(game=Game.GENSHIN, lang=lang, authkey=authkey)
wishes = []
for banner_type in banner_types:
paginator = WishPaginator(
end_id,
partial(
self.get_wish_page,
banner_type=banner_type,
game=Game.GENSHIN,
authkey=authkey,
),
)
items = await paginator.get(limit)
banner_name = (
banner_names.get(banner_type, banner_default_name) if banner_type != 400 else banner_names[301]
)
wishes.extend([Wish(**i, banner_name=banner_name) for i in items])
return sorted(wishes, key=lambda wish: wish.time.timestamp())