Habiticalib 0.3.5__py3-none-any.whl → 0.3.7rc0__py3-none-any.whl

habiticalib/__init__.py

@@ -8,14 +8,45 @@ from .exceptions import (
     NotFoundError,
     TooManyRequestsError,
 )
-from .helpers import deserialize_task
+from .helpers import deserialize_task, extract_avatar
 from .lib import Habitica
-from .types import (
+from .typedefs import (
+    AchievementsUser,
+    AchievmentContent,
+    ActiveFilterTask,
+    AnimalColorAchievementContent,
+    AnimalSetAchievementContent,
     Attributes,
+    AuthUser,
+    Avatar,
+    BackerUser,
+    BuffsStats,
+    BuffsStatsavatar,
+    CardTypes,
+    Challenge,
+    ChallengeAbortedReason,
     ChangeClassData,
+    Checklist,
+    CommonTutorial,
+    CompletedBy,
+    ConsecutivePlan,
     ContentData,
+    ContributorUser,
     Direction,
+    DropTmpScore,
+    EggEntry,
+    EmailNotificationsPreferences,
+    EntryHistory,
+    EquippedGear,
+    FlagsUser,
     Frequency,
+    GearClass,
+    GearContent,
+    GearEntry,
+    GearItems,
+    GearItemsAvatar,
+    GearType,
+    GroupTask,
     HabiticaCastSkillResponse,
     HabiticaClass,
     HabiticaClassSystemResponse,
@@ -36,74 +67,254 @@ from .types import (
     HabiticaUserAnonymizedResponse,
     HabiticaUserExport,
     HabiticaUserResponse,
+    HairPreferences,
+    HatchingPotionEntry,
+    HistoryUser,
+    InboxUser,
+    InventoryItemEntry,
+    InvitationsUser,
+    IosTutorial,
+    ItemListContent,
+    ItemListEntry,
+    ItemsAvatar,
+    ItemsUser,
     Language,
+    LastDropItems,
+    LocalAuth,
+    LocalTimestamps,
     LoginData,
+    NotificationsUser,
+    PartyMember,
+    PartyUser,
+    PermissionsUser,
+    PetEntry,
+    PetSetCompleteAchievsContent,
+    PinnedItemsUser,
+    PlanPurchased,
+    PreferencesAvatar,
+    PreferencesUser,
+    ProfileUser,
+    ProgressQuest,
+    PurchasedUser,
+    PushDevicesUser,
+    PushNotificationsPreferences,
+    QuestBoss,
+    QuestBossRage,
+    QuestCollect,
     QuestData,
+    QuestDrop,
+    QuestItem,
+    QuestParty,
+    QuestsAchievments,
+    QuestsContent,
+    QuestTmpScore,
+    QuestUnlockCondition,
+    Reminders,
     Repeat,
     ScoreData,
     Skill,
+    SpecialItemEntry,
+    SpecialItems,
+    SpellEntry,
+    SpellsClass,
+    StableAchievementContent,
+    StatsAvatar,
     StatsUser,
+    SuppressModalsPreferences,
     TagsUser,
     Task,
     TaskData,
     TaskFilter,
     TaskPriority,
+    TasksOrderUser,
+    TasksPreferences,
+    TasksUserExport,
     TaskType,
+    TmpScore,
+    TourFlags,
+    TrainingStats,
+    TutorialFlags,
+    UltimateGearSetsAchievments,
     UserAnonymizedData,
     UserData,
-    UserStyles,
+    UserTasks,
+    WebhooksOptions,
+    WebhooksType,
+    WebhooksUser,
 )
 
 __all__ = [
     "ASSETS_URL",
     "DEFAULT_URL",
+    "AchievementsUser",
+    "AchievmentContent",
+    "ActiveFilterTask",
+    "AnimalColorAchievementContent",
+    "AnimalSetAchievementContent",
     "Attributes",
+    "AuthUser",
+    "Avatar",
+    "BackerUser",
     "BadRequestError",
+    "BuffsStats",
+    "BuffsStatsavatar",
+    "CardTypes",
+    "Challenge",
+    "ChallengeAbortedReason",
     "ChangeClassData",
+    "ChangeClassData",
+    "Checklist",
+    "Checklist",
+    "CommonTutorial",
+    "CompletedBy",
+    "ConsecutivePlan",
+    "ContentData",
     "ContentData",
+    "ContributorUser",
     "Direction",
+    "DropTmpScore",
+    "EggEntry",
+    "EmailNotificationsPreferences",
+    "EntryHistory",
+    "EquippedGear",
+    "FlagsUser",
     "Frequency",
+    "GearClass",
+    "GearContent",
+    "GearEntry",
+    "GearItems",
+    "GearItemsAvatar",
+    "GearType",
+    "GroupTask",
     "Habitica",
     "HabiticaCastSkillResponse",
+    "HabiticaCastSkillResponse",
     "HabiticaClass",
     "HabiticaClassSystemResponse",
+    "HabiticaClassSystemResponse",
     "HabiticaContentResponse",
+    "HabiticaContentResponse",
+    "HabiticaErrorResponse",
     "HabiticaErrorResponse",
     "HabiticaException",
     "HabiticaGroupMembersResponse",
+    "HabiticaGroupMembersResponse",
+    "HabiticaLoginResponse",
     "HabiticaLoginResponse",
     "HabiticaQuestResponse",
+    "HabiticaQuestResponse",
+    "HabiticaResponse",
     "HabiticaResponse",
     "HabiticaScoreResponse",
+    "HabiticaScoreResponse",
+    "HabiticaSleepResponse",
     "HabiticaSleepResponse",
     "HabiticaStatsResponse",
+    "HabiticaStatsResponse",
+    "HabiticaTagResponse",
     "HabiticaTagResponse",
     "HabiticaTagsResponse",
+    "HabiticaTagsResponse",
     "HabiticaTaskOrderResponse",
+    "HabiticaTaskOrderResponse",
+    "HabiticaTaskResponse",
     "HabiticaTaskResponse",
     "HabiticaTasksResponse",
+    "HabiticaTasksResponse",
+    "HabiticaUserAnonymizedResponse",
     "HabiticaUserAnonymizedResponse",
     "HabiticaUserExport",
+    "HabiticaUserExport",
+    "HabiticaUserResponse",
     "HabiticaUserResponse",
+    "HairPreferences",
+    "HatchingPotionEntry",
+    "HistoryUser",
+    "InboxUser",
+    "InventoryItemEntry",
+    "InvitationsUser",
+    "IosTutorial",
+    "ItemListContent",
+    "ItemListEntry",
+    "ItemsAvatar",
+    "ItemsUser",
     "Language",
+    "LastDropItems",
+    "LocalAuth",
+    "LocalTimestamps",
+    "LoginData",
     "LoginData",
     "NotAuthorizedError",
     "NotFoundError",
+    "NotificationsUser",
+    "PartyMember",
+    "PartyUser",
+    "PermissionsUser",
+    "PetEntry",
+    "PetSetCompleteAchievsContent",
+    "PinnedItemsUser",
+    "PlanPurchased",
+    "PreferencesAvatar",
+    "PreferencesUser",
+    "ProfileUser",
+    "ProgressQuest",
+    "PurchasedUser",
+    "PushDevicesUser",
+    "PushNotificationsPreferences",
+    "QuestBoss",
+    "QuestBossRage",
+    "QuestCollect",
+    "QuestData",
     "QuestData",
+    "QuestDrop",
+    "QuestItem",
+    "QuestParty",
+    "QuestTmpScore",
+    "QuestUnlockCondition",
+    "QuestsAchievments",
+    "QuestsContent",
+    "Reminders",
     "Repeat",
+    "Repeat",
+    "ScoreData",
     "ScoreData",
     "Skill",
+    "SpecialItemEntry",
+    "SpecialItems",
+    "SpellEntry",
+    "SpellsClass",
+    "StableAchievementContent",
+    "StatsAvatar",
     "StatsUser",
+    "StatsUser",
+    "SuppressModalsPreferences",
+    "TagsUser",
     "TagsUser",
     "Task",
     "TaskData",
+    "TaskData",
     "TaskFilter",
     "TaskPriority",
     "TaskType",
+    "TasksOrderUser",
+    "TasksPreferences",
+    "TasksUserExport",
+    "TmpScore",
     "TooManyRequestsError",
+    "TourFlags",
+    "TrainingStats",
+    "TutorialFlags",
+    "UltimateGearSetsAchievments",
+    "UserAnonymizedData",
     "UserAnonymizedData",
     "UserData",
-    "UserStyles",
+    "UserData",
+    "UserTasks",
+    "UserTasks",
+    "WebhooksOptions",
+    "WebhooksType",
+    "WebhooksUser",
     "__version__",
     "deserialize_task",
+    "extract_avatar",
 ]

habiticalib/const.py

@@ -1,6 +1,6 @@
 """Constants for Habiticalib."""
 
-__version__ = "0.3.5"
+__version__ = "0.3.7rc0"
 
 DEFAULT_URL = "https://habitica.com/"
 ASSETS_URL = "https://habitica-assets.s3.amazonaws.com/mobileApp/images/"

habiticalib/exceptions.py

@@ -5,7 +5,7 @@ from typing import Self
 
 from multidict import CIMultiDictProxy
 
-from habiticalib.types import HabiticaErrorResponse
+from .typedefs import HabiticaErrorResponse
 
 
 class HabiticaException(Exception):  # noqa: N818

habiticalib/helpers.py

@@ -10,7 +10,7 @@ import uuid
 import aiohttp
 
 from .const import DEVELOPER_ID, __version__
-from .types import HabiticaUserResponse, UserData, UserStyles
+from .typedefs import Avatar, UserData
 
 
 def join_fields(user_fields: list[str] | str) -> str:
@@ -111,10 +111,10 @@ def get_x_client(x_client: str | None = None) -> str:
     return f"{DEVELOPER_ID} - Habiticalib/{__version__}"
 
 
-def extract_user_styles(user_data: HabiticaUserResponse) -> UserStyles:
-    """Extract user styles from a user data object."""
-    data: UserData = user_data.data
-    return UserStyles.from_dict(asdict(data))
+def extract_avatar(user_data: UserData) -> Avatar:
+    """Extract avatar defs from a user data object."""
+
+    return Avatar.from_dict(user_data.to_dict())
 
 
 def deserialize_task(value: Any) -> Any:  # noqa: PLR0911

habiticalib/lib.py

@@ -29,13 +29,14 @@ from .exceptions import (
 )
 from .helpers import (
     deserialize_task,
-    extract_user_styles,
+    extract_avatar,
     get_user_agent,
     get_x_client,
     join_fields,
 )
-from .types import (
+from .typedefs import (
     Attributes,
+    Avatar,
     Direction,
     HabiticaCastSkillResponse,
     HabiticaClass,
@@ -61,7 +62,6 @@ from .types import (
     Skill,
     Task,
     TaskFilter,
-    UserStyles,
 )
 
 if TYPE_CHECKING:
@@ -1845,12 +1845,12 @@ class Habitica:
     async def generate_avatar(  # noqa: PLR0912, PLR0915
         self,
         fp: str | IO[bytes],
-        user_styles: UserStyles | None = None,
+        avatar: Avatar | None = None,
         fmt: str | None = None,
-    ) -> UserStyles:
-        """Generate an avatar image based on the provided user styles or fetched user data.
+    ) -> Avatar:
+        """Generate an avatar image based on the provided avatar object or fetched user data.
 
-        If no `user_styles` object is provided, the method retrieves user preferences, items, and stats
+        If no `Avatar` object is provided, the method retrieves user preferences, items, and stats
         for the authenticated user and builds the avatar accordingly. The base image is initialized
         as a transparent RGBA image of size (141, 147). A mount offset is applied based on the user's
         current mount status.
@@ -1864,8 +1864,8 @@ class Habitica:
         ----------
         fp : str or IO[bytes]
             The file path or a bytes buffer to store or modify the avatar image.
-        user_styles : UserStyles, optional
-            The user style preferences, items, and stats. If not provided, the method will fetch
+        avatar : Avatar, optional
+            The user avatar preferences, items, and stats. If not provided, the method will fetch
             this data.
         fmt : str
             If a file object is used instead of a filename, the format
@@ -1873,8 +1873,8 @@ class Habitica:
 
         Returns
         -------
-        UserStyles
-            The user styles used to generate the avatar.
+        Avatar
+            The user avatar definitions used to generate the avatar.
 
         Examples
         --------
@@ -1885,13 +1885,15 @@ class Habitica:
         Using a file path:
         >>> await habitica.generate_avatar("/path/to/image/avatar.png")
         """
-        if not user_styles:
-            user_styles = extract_user_styles(
-                await self.get_user(user_fields=["preferences", "items", "stats"]),
+        if not avatar:
+            avatar = extract_avatar(
+                (
+                    await self.get_user(user_fields=["preferences", "items", "stats"])
+                ).data,
             )
-        preferences = user_styles.preferences
-        items = user_styles.items
-        stats = user_styles.stats
+        preferences = avatar.preferences
+        items = avatar.items
+        stats = avatar.stats
         mount_offset_y = 0 if items.currentMount else 24
 
         # Initializing the base image
@@ -2040,7 +2042,7 @@ class Habitica:
         else:
             image.save(fp, fmt)
 
-        return user_styles
+        return avatar
 
     async def habitipy(self) -> HabitipyAsync:
         """Create a Habitipy instance."""