Habiticalib 0.1.0a2__py3-none-any.whl → 0.2.0a0__py3-none-any.whl

habiticalib/__init__.py

@@ -6,18 +6,20 @@ from .exceptions import (
     HabiticaException,
     NotAuthorizedError,
     NotFoundError,
+    TooManyRequestsError,
 )
 from .lib import Habitica
 from .types import (
     Attributes,
-    Class,
     Direction,
     Frequency,
+    HabiticaClass,
     HabiticaClassSystemResponse,
     HabiticaErrorResponse,
     HabiticaLoginResponse,
     HabiticaResponse,
     HabiticaScoreResponse,
+    HabiticaSleepResponse,
     HabiticaStatsResponse,
     HabiticaTagResponse,
     HabiticaTagsResponse,
@@ -39,17 +41,18 @@ __all__ = [
     "ASSETS_URL",
     "Attributes",
     "BadRequestError",
-    "Class",
     "DEFAULT_URL",
     "Direction",
     "Frequency",
     "Habitica",
+    "HabiticaClass",
     "HabiticaClassSystemResponse",
     "HabiticaErrorResponse",
     "HabiticaException",
     "HabiticaLoginResponse",
     "HabiticaResponse",
     "HabiticaScoreResponse",
+    "HabiticaSleepResponse",
     "HabiticaStatsResponse",
     "HabiticaTagResponse",
     "HabiticaTagsResponse",
@@ -65,5 +68,6 @@ __all__ = [
     "Task",
     "TaskFilter",
     "TaskType",
+    "TooManyRequestsError",
     "UserStyles",
 ]

habiticalib/const.py

@@ -1,6 +1,6 @@
 """Constants for Habiticalib."""
 
-__version__ = "0.1.0a2"
+__version__ = "0.2.0a0"
 
 DEFAULT_URL = "https://habitica.com/"
 ASSETS_URL = "https://habitica-assets.s3.amazonaws.com/mobileApp/images/"

habiticalib/exceptions.py

@@ -1,5 +1,6 @@
 """Exceptions for Habiticalib."""
 
+from datetime import datetime
 from typing import Self
 
 from multidict import CIMultiDictProxy
@@ -17,10 +18,18 @@ class HabiticaException(Exception):  # noqa: N818
     ) -> None:
         """Initialize the Exception."""
         self.error = error
-        self.rate_limit = headers.get("x-ratelimit-limit")
-        self.rate_limit_remaining = headers.get("x-ratelimit-remaining")
-        self.rate_limit_reset = headers.get("x-ratelimit-reset")
-        self.retry_after = headers.get("retry-after")
+        self.rate_limit: int | None = (
+            int(r) if (r := headers.get("x-ratelimit-limit")) else None
+        )
+        self.rate_limit_remaining: int | None = (
+            int(r) if (r := headers.get("x-ratelimit-remaining")) else None
+        )
+        self.rate_limit_reset: datetime | None = (
+            datetime.strptime(r[:33], "%a %b %d %Y %H:%M:%S %Z%z")
+            if (r := headers.get("x-ratelimit-reset"))
+            else None
+        )
+        self.retry_after: int = round(float(headers.get("retry-after", 0)))
 
         super().__init__(error.message)
 

habiticalib/helpers.py

@@ -1,7 +1,10 @@
 """Helper functions for Habiticalib."""
 
-from dataclasses import asdict
+from dataclasses import asdict, is_dataclass
+from datetime import date, datetime
+from enum import Enum
 import platform
+from typing import Any
 import uuid
 
 import aiohttp
@@ -112,3 +115,24 @@ 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 deserialize_task(value: Any) -> Any:  # noqa: PLR0911
+    """Recursively convert Enums to values, dates to ISO strings, UUIDs to strings."""
+
+    if is_dataclass(value) and not isinstance(value, type):
+        # Convert dataclass to dict and recursively deserialize
+        return deserialize_task(asdict(value))
+    if isinstance(value, Enum):
+        return value.value  # Convert Enum to its value
+    if isinstance(value, uuid.UUID):
+        return str(value)  # Convert UUID to string
+    if isinstance(value, datetime | date):
+        return value.isoformat()  # Convert datetime/date to ISO string
+    if isinstance(value, list):
+        # Recursively apply deserialization to each item in the list
+        return [deserialize_task(item) for item in value]
+    if isinstance(value, dict):
+        # Recursively apply deserialization to each key-value pair in the dictionary
+        return {k: deserialize_task(v) for k, v in value.items()}
+    return value  # Return other types unchanged

habiticalib/lib.py

@@ -19,16 +19,23 @@ from .exceptions import (
     NotFoundError,
     TooManyRequestsError,
 )
-from .helpers import extract_user_styles, get_user_agent, get_x_client, join_fields
+from .helpers import (
+    deserialize_task,
+    extract_user_styles,
+    get_user_agent,
+    get_x_client,
+    join_fields,
+)
 from .types import (
     Attributes,
-    Class,
     Direction,
+    HabiticaClass,
     HabiticaClassSystemResponse,
     HabiticaErrorResponse,
     HabiticaLoginResponse,
     HabiticaResponse,
     HabiticaScoreResponse,
+    HabiticaSleepResponse,
     HabiticaStatsResponse,
     HabiticaTagResponse,
     HabiticaTagsResponse,
@@ -378,14 +385,16 @@ class Habitica:
 
         Examples
         --------
-        >>> new_task = Task(name="New Task", ...)
+        >>> new_task = Task(text="New Task", type=TaskType.TODO ...)
         >>> create_response = await habitica.create_task(new_task)
         >>> print(create_response.data)  # Displays the created task information
         """
         url = self.url / "api/v3/tasks/user"
 
+        json = deserialize_task(task)
+
         return HabiticaTaskResponse.from_json(
-            await self._request("post", url=url, json=task.to_dict()),
+            await self._request("post", url=url, json=json),
         )
 
     async def update_task(self, task_id: UUID, task: Task) -> HabiticaTaskResponse:
@@ -421,14 +430,16 @@ class Habitica:
         Examples
         --------
         >>> task_id = UUID("12345678-1234-5678-1234-567812345678")
-        >>> updated_task = Task(name="Updated Task", ...)
+        >>> updated_task = Task(text="Updated Task", ...)
         >>> update_response = await habitica.update_task(task_id, updated_task)
         >>> print(update_response.data)  # Displays the updated task information
         """
         url = self.url / "api/v3/tasks" / str(task_id)
 
+        json = deserialize_task(task)
+
         return HabiticaTaskResponse.from_json(
-            await self._request("put", url=url, json=task.to_dict()),
+            await self._request("put", url=url, json=json),
         )
 
     async def delete_task(self, task_id: UUID) -> HabiticaResponse:
@@ -799,14 +810,14 @@ class Habitica:
 
     async def cast_skill(
         self,
-        spell: Skill,
+        skill: Skill,
         target_id: UUID | None = None,
     ) -> HabiticaUserResponse:
         """Cast a skill (spell) in Habitica, optionally targeting a specific user, task or party.
 
         Parameters
         ----------
-        spell : Skill
+        skill : Skill
             The skill (or spell) to be cast. This should be a valid `Skill` enum value.
         target_id : UUID, optional
             The unique identifier of the target for the skill. If the skill does not require a target,
@@ -832,7 +843,7 @@ class Habitica:
         TimeoutError
             If the connection times out.
         """
-        url = self.url / "api/v3/class/cast" / spell
+        url = self.url / "api/v3/user/class/cast" / skill
         params = {}
 
         if target_id:
@@ -843,12 +854,12 @@ class Habitica:
 
     async def toggle_sleep(
         self,
-    ) -> HabiticaResponse:
+    ) -> HabiticaSleepResponse:
         """Toggles the user's sleep mode in Habitica.
 
         Returns
         -------
-        HabiticaResponse
+        HabiticaSleepResponse
             A response object containing the result of the sleep mode toggle,
             and the new sleep state (True if sleeping, False if not).
 
@@ -865,7 +876,7 @@ class Habitica:
         """
         url = self.url / "api/v3/user/sleep"
 
-        return HabiticaResponse.from_json(await self._request("post", url=url))
+        return HabiticaSleepResponse.from_json(await self._request("post", url=url))
 
     async def revive(
         self,
@@ -889,7 +900,7 @@ class Habitica:
 
         return HabiticaResponse.from_json(await self._request("post", url=url))
 
-    async def change_class(self, Class: Class) -> HabiticaClassSystemResponse:  # noqa: N803
+    async def change_class(self, Class: HabiticaClass) -> HabiticaClassSystemResponse:  # noqa: N803
         """Change the user's class in Habitica.
 
         This method sends a request to the Habitica API to change the user's class
@@ -920,7 +931,7 @@ class Habitica:
 
         Examples
         --------
-        >>> new_class = Class.WARRIOR
+        >>> new_class = HabiticaClass.WARRIOR
         >>> change_response = await habitica.change_class(new_class)
         >>> print(change_response.data.stats)  # Displays the user's stats after class change
         """
@@ -1068,7 +1079,7 @@ class Habitica:
         url = self.url / "api/v3/tags"
 
         return HabiticaTagsResponse.from_json(
-            await self._request("post", url=url),
+            await self._request("get", url=url),
         )
 
     async def get_tag(self, tag_id: UUID) -> HabiticaTagResponse:
@@ -1106,7 +1117,7 @@ class Habitica:
         url = self.url / "api/v3/tags" / str(tag_id)
 
         return HabiticaTagResponse.from_json(
-            await self._request("post", url=url),
+            await self._request("get", url=url),
         )
 
     async def delete_tag(self, tag_id: UUID) -> HabiticaResponse:
@@ -1266,7 +1277,7 @@ class Habitica:
         url = self.url / "api/v3/reorder-tags"
         json = {"tagId": str(tag_id), "to": to}
 
-        return HabiticaTagResponse.from_json(
+        return HabiticaResponse.from_json(
             await self._request("post", url=url, json=json),
         )
 

habiticalib/types.py

@@ -4,13 +4,13 @@
 from __future__ import annotations
 
 from dataclasses import dataclass, field
+import datetime as dt
 from datetime import UTC, datetime
 from enum import Enum, StrEnum
-from typing import Any
+from typing import Any, NotRequired, TypedDict
 from uuid import UUID  # noqa: TCH003
 
 from mashumaro import field_options
-from mashumaro.config import BaseConfig
 from mashumaro.mixins.orjson import DataClassORJSONMixin
 
 
@@ -61,6 +61,7 @@ class LoginData:
     apiToken: str
     newUser: bool
     username: str
+    passwordResetCode: str | None = None
 
 
 @dataclass(kw_only=True)
@@ -74,27 +75,27 @@ class HabiticaLoginResponse(HabiticaResponse):
 class LocalAuth:
     """Auth local data."""
 
-    email: str
-    username: str
-    lowerCaseUsername: str
-    has_password: bool
+    email: str | None = None
+    username: str | None = None
+    lowerCaseUsername: str | None = None
+    has_password: bool | None = None
 
 
 @dataclass(kw_only=True)
 class LocalTimestamps:
     """Timestamps local data."""
 
-    created: datetime
-    loggedin: datetime
-    updated: datetime
+    created: datetime | None = None
+    loggedin: datetime | None = None
+    updated: datetime | None = None
 
 
 @dataclass(kw_only=True)
 class AuthUser:
     """User auth data."""
 
-    local: LocalAuth | None = None
-    timestamps: LocalTimestamps | None = None
+    local: LocalAuth = field(default_factory=LocalAuth)
+    timestamps: LocalTimestamps = field(default_factory=LocalTimestamps)
     facebook: dict | None = None
     google: dict | None = None
     apple: dict | None = None
@@ -628,6 +629,15 @@ class TrainingStats:
     Int: int | None = field(default=None, metadata=field_options(alias="int"))
 
 
+class HabiticaClass(StrEnum):
+    """Habitica's player classes."""
+
+    WARRIOR = "warrior"
+    ROGUE = "rogue"
+    MAGE = "wizard"
+    HEALER = "healer"
+
+
 @dataclass(kw_only=True)
 class StatsUser:
     """Stats user data."""
@@ -639,7 +649,9 @@ class StatsUser:
     exp: int | None = None
     gp: float | None = None
     lvl: int | None = None
-    Class: str = field(default="warrior", metadata=field_options(alias="class"))
+    Class: HabiticaClass | None = field(
+        default=None, metadata=field_options(alias="class")
+    )
     points: int | None = None
     Str: int | None = field(default=None, metadata=field_options(alias="str"))
     con: int | None = None
@@ -650,6 +662,13 @@ class StatsUser:
     Int: int | None = field(default=None, metadata=field_options(alias="int"))
 
 
+field(
+    metadata=field_options(
+        deserialize=serialize_datetime,
+    )
+)
+
+
 @dataclass(kw_only=True)
 class TagsUser:
     """Tags user data."""
@@ -674,10 +693,10 @@ class InboxUser:
 class TasksOrderUser:
     """TasksOrder user data."""
 
-    habits: list[str] = field(default_factory=list)
-    dailys: list[str] = field(default_factory=list)
-    todos: list[str] = field(default_factory=list)
-    rewards: list[str] = field(default_factory=list)
+    habits: list[UUID] = field(default_factory=list)
+    dailys: list[UUID] = field(default_factory=list)
+    todos: list[UUID] = field(default_factory=list)
+    rewards: list[UUID] = field(default_factory=list)
 
 
 @dataclass(kw_only=True)
@@ -717,7 +736,7 @@ class UserData:
 
     id: UUID | None = None
     preferences: PreferencesUser = field(default_factory=PreferencesUser)
-    flags: FlagsUser | None = None
+    flags: FlagsUser = field(default_factory=FlagsUser)
     auth: AuthUser = field(default_factory=AuthUser)
     achievements: AchievementsUser = field(default_factory=AchievementsUser)
     backer: BackerUser = field(default_factory=BackerUser)
@@ -746,8 +765,8 @@ class UserData:
     balance: float | None = None
     lastCron: datetime | None = None
     needsCron: bool | None = None
-    challenges: list[str] = field(default_factory=list)
-    guilds: list[str] = field(default_factory=list)
+    challenges: list[UUID] = field(default_factory=list)
+    guilds: list[UUID] = field(default_factory=list)
     newMessages: dict[str, bool] = field(default_factory=dict)
 
 
@@ -850,38 +869,31 @@ class Frequency(StrEnum):
     YEARLY = "yearly"
 
 
-@dataclass(kw_only=True)
-class Task(DataClassORJSONMixin):
+class Task(TypedDict("Task", {"type": NotRequired[TaskType]}), total=True):
     """Representation of a task."""
 
-    class Config(BaseConfig):
-        """Config."""
-
-        omit_none = True
-
-    text: str | None = None
-    attribute: Attributes | None = None
-    alias: str | None = None
-    notes: str | None = None
-    tags: list[UUID] | None = None
-    collapseChecklist: bool | None = None
-    date: datetime | None = None
-    priority: TaskPriority | None = None
-    reminders: list[Reminders] | None = None
-    checklist: list[str] | None = None
-    Type: TaskType | None = field(default=None, metadata=field_options(alias="type"))
-    up: bool | None = None
-    down: bool | None = None
-    counterUp: int | None = None
-    counterDown: int | None = None
-    startDate: datetime | None = None
-    frequency: Frequency | None = None
-    everyX: int | None = None
-    repeat: Repeat | None = None
-    daysOfMonth: list[int] | None = None
-    weeksOfMonth: list[int] | None = None
-    completed: bool | None = None
-    streak: int | None = None
+    text: NotRequired[str]
+    attribute: NotRequired[Attributes]
+    alias: NotRequired[str]
+    notes: NotRequired[str]
+    tags: NotRequired[list[UUID]]
+    collapseChecklist: NotRequired[bool]
+    date: NotRequired[datetime | dt.date | None]
+    priority: NotRequired[TaskPriority]
+    reminders: NotRequired[list[Reminders]]
+    checklist: NotRequired[list[str]]
+    up: NotRequired[bool]
+    down: NotRequired[bool]
+    counterUp: NotRequired[int]
+    counterDown: NotRequired[int]
+    startDate: NotRequired[datetime | dt.date]
+    frequency: NotRequired[Frequency]
+    everyX: NotRequired[int]
+    repeat: NotRequired[Repeat]
+    daysOfMonth: NotRequired[list[int]]
+    weeksOfMonth: NotRequired[list[int]]
+    completed: NotRequired[bool]
+    streak: NotRequired[int]
 
 
 @dataclass(kw_only=True)
@@ -979,7 +991,7 @@ class StatsUserStyles:
     """Stats user styles data."""
 
     buffs: BuffsUserStyles = field(default_factory=BuffsUserStyles)
-    Class: str = field(default="warrior", metadata=field_options(alias="class"))
+    Class: HabiticaClass = field(default=HabiticaClass.WARRIOR)
 
 
 @dataclass(kw_only=True)
@@ -1052,7 +1064,7 @@ class DropTmpScore:
     canDrop: bool | None = None
     value: int | None = None
     key: str | None = None
-    type: str | None = None
+    Type: str | None = field(default=None, metadata=field_options(alias="type"))
     dialog: str | None = None
 
 
@@ -1064,12 +1076,21 @@ class TmpScore:
     drop: DropTmpScore = field(default_factory=DropTmpScore)
 
 
+@dataclass
+class ScoreData(StatsUser):
+    """Scora data."""
+
+    delta: float | None = None
+    tmp: TmpScore = field(
+        default_factory=TmpScore, metadata=field_options(alias="_tmp")
+    )
+
+
 @dataclass(kw_only=True)
-class HabiticaScoreResponse(StatsUser, DataClassORJSONMixin):
+class HabiticaScoreResponse(HabiticaResponse, DataClassORJSONMixin):
     """Representation of a score response."""
 
-    delta: float | None = None
-    _tmp: TmpScore = field(default_factory=TmpScore)
+    data: ScoreData
 
 
 @dataclass(kw_only=True)
@@ -1107,7 +1128,14 @@ class HabiticaClassSystemResponse(HabiticaResponse, DataClassORJSONMixin):
 class HabiticaTaskOrderResponse(HabiticaResponse):
     """Representation of a reorder task response."""
 
-    data: TasksOrderUser = field(default_factory=TasksOrderUser)
+    data: list[UUID] = field(default_factory=list)
+
+
+@dataclass
+class HabiticaSleepResponse(HabiticaResponse):
+    """Representation of a sleep response."""
+
+    data: bool
 
 
 class TaskFilter(StrEnum):
@@ -1187,15 +1215,6 @@ class Skill(StrEnum):
     PETAL_FREE_POTION = "petalFreePotion"
 
 
-class Class(StrEnum):
-    """Habitica's player classes."""
-
-    WARRIOR = "warrior"
-    ROGUE = "rogue"
-    MAGE = "mage"
-    HEALER = "healer"
-
-
 class Direction(StrEnum):
     """Direction to score a task."""
 

{habiticalib-0.1.0a2.dist-info → habiticalib-0.2.0a0.dist-info}/METADATA

@@ -1,12 +1,11 @@
 Metadata-Version: 2.3
 Name: Habiticalib
-Version: 0.1.0a2
+Version: 0.2.0a0
 Summary: Asynchronous Python client library for the Habitica API
 Project-URL: Documentation, https://tr4nt0r.github.io/habiticalib/
 Project-URL: Source, https://github.com/tr4nt0r/habiticalib
 Author-email: Manfred Dennerlein Rodelo <manfred@dennerlein.name>
 License: MIT License
-License-File: LICENSE
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3 :: Only
@@ -14,7 +13,7 @@ Requires-Python: >=3.12
 Requires-Dist: aiohttp~=3.9
 Requires-Dist: mashumaro~=3.13
 Requires-Dist: orjson~=3.10
-Requires-Dist: pillow~=10.4
+Requires-Dist: pillow~=11.0
 Description-Content-Type: text/markdown
 
 # Habiticalib

habiticalib-0.2.0a0.dist-info/RECORD

@@ -0,0 +1,11 @@
+habiticalib/__init__.py,sha256=gR6mjGbUe7tD3bR5UDSPXgKCtP-rfgknHi-XIP41HLk,1617
+habiticalib/const.py,sha256=tJbptyPWBga1PdjCeDzutNCVsT5BIyvO9nUfFGO1D90,609
+habiticalib/exceptions.py,sha256=oVFCGbHkVn0UpIKIPZPzXfvzs9US4R05ebdEn6cOpqM,1350
+habiticalib/helpers.py,sha256=IRZLYWkDVLI0iVBgBMmvZ6L83KCUl-CnzGhUR_tP6Fg,4576
+habiticalib/lib.py,sha256=JXx7PGrl74fJdTj_TKKzIr84Kl-hgCBDy0yvaMXXgD8,54316
+habiticalib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+habiticalib/types.py,sha256=DAIKNhsc0KWSWBcfVrcP7XeZ3QlbFsuWyxt_326Lrvw,33309
+habiticalib-0.2.0a0.dist-info/METADATA,sha256=d_1DFcqvff_2feSeV1blBEmOlkZ1qChdQMxKirA7ics,4156
+habiticalib-0.2.0a0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+habiticalib-0.2.0a0.dist-info/licenses/LICENSE,sha256=oIinIOSJ49l1iVIRI3XGXFWt6SF7a83kEFBAY8ORwNI,1084
+habiticalib-0.2.0a0.dist-info/RECORD,,

{habiticalib-0.1.0a2.dist-info → habiticalib-0.2.0a0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.25.0
+Generator: hatchling 1.26.3
 Root-Is-Purelib: true
 Tag: py3-none-any

habiticalib-0.1.0a2.dist-info/RECORD

@@ -1,11 +0,0 @@
-habiticalib/__init__.py,sha256=_RUFLOZSqQWr_j3TnhHhtD5szaf59HR-sS7aOpE4NTg,1491
-habiticalib/const.py,sha256=NsbZeJ3Z_OuZcGzFZESInj9vpyYzjjCpJnVhGmu30vw,609
-habiticalib/exceptions.py,sha256=Db7lDDdT97FsK4S9N45gcusiMMWiqeIcab0H8i7xTtE,1032
-habiticalib/helpers.py,sha256=Y7lAlufK2isnNp7ybcqcWLG9xkWltouCiXaBeLOkobg,3479
-habiticalib/lib.py,sha256=F_tqIULUC8mhYXLak2RYGA_AeaFuAQY6Ie8NImslv_g,54130
-habiticalib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-habiticalib/types.py,sha256=zF9HzSXkuUYwuUv9F8fXfg6sxWy0nlfUo9hFqQG8eGA,32825
-habiticalib-0.1.0a2.dist-info/METADATA,sha256=3hI8OP0ECfHdmYPaZ9zGyX0Nx04kRly2635ll4yfrYY,4178
-habiticalib-0.1.0a2.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-habiticalib-0.1.0a2.dist-info/licenses/LICENSE,sha256=oIinIOSJ49l1iVIRI3XGXFWt6SF7a83kEFBAY8ORwNI,1084
-habiticalib-0.1.0a2.dist-info/RECORD,,