SIMNet/simnet/models/starrail/chronicle/notes.py

75 lines
2.7 KiB
Python
Raw Normal View History

2023-05-01 12:50:48 +00:00
from datetime import timedelta, datetime
from typing import List, Literal, Sequence
2023-07-20 05:57:45 +00:00
from pydantic import Field
2023-05-01 12:50:48 +00:00
from simnet.models.base import APIModel
class StarRailExpedition(APIModel):
"""Represents a StarRail Expedition.
Attributes:
avatars (List[str]): A list of avatar names participating in the expedition.
status (Literal["Ongoing", "Finished"]): The status of the expedition.
remaining_time (timedelta): The time remaining for the expedition to finish.
name (str): The name of the expedition.
"""
avatars: List[str]
status: Literal["Ongoing", "Finished"]
remaining_time: timedelta
name: str
@property
def finished(self) -> bool:
"""Returns whether the expedition has finished."""
return self.remaining_time <= timedelta(0)
@property
def completion_time(self) -> datetime:
"""Returns the time at which the expedition will be completed."""
return datetime.now().astimezone() + self.remaining_time
class StarRailNote(APIModel):
"""Represents a StarRail Note.
Attributes:
current_stamina (int): The current stamina of the user.
max_stamina (int): The maximum stamina of the user.
stamina_recover_time (timedelta): The time it takes for one stamina to recover.
accepted_epedition_num (int): The number of expeditions the user has accepted.
total_expedition_num (int): The total number of expeditions the user has participated in.
expeditions (Sequence[StarRailExpedition]): A list of expeditions the user has participated in.
2023-07-20 05:57:45 +00:00
current_train_score (int): The current daily training activity.
max_train_score (int): The max daily training activity.
current_rogue_score (int): The current simulated universe weekly points.
max_rogue_score (int): The max simulated universe weekly points.
remaining_weekly_discounts (int): The remaining echo of war rewards.
max_weekly_discounts (int): The echo of war attempt limit.
2023-05-01 12:50:48 +00:00
"""
current_stamina: int
max_stamina: int
stamina_recover_time: timedelta
accepted_epedition_num: int
total_expedition_num: int
expeditions: Sequence[StarRailExpedition]
2023-07-20 05:57:45 +00:00
current_train_score: int
"""Current daily training activity"""
max_train_score: int
"""Max daily training activity"""
current_rogue_score: int
"""Current simulated universe weekly points"""
max_rogue_score: int
"""Max simulated universe weekly points"""
remaining_weekly_discounts: int = Field(alias="weekly_cocoon_cnt")
"""Remaining echo of war rewards"""
max_weekly_discounts: int = Field(alias="weekly_cocoon_limit")
"""Echo of war attempt limit"""