update the lib to use a proper iso parser. Properly type the User class

Author: IAmTomahawkx

requirements.txt

@@ -1 +1,2 @@
-aiohttp>=3.6.0,<3.8.0
+aiohttp>=3.6.0,<3.8.0
+iso8601

twitchio/__init__.py

@@ -39,3 +39,4 @@
 from .message import Message
 from .models import *
 from .rewards import *
+from .utils import *

twitchio/ext/commands/core.py

@@ -459,14 +459,16 @@ def get_user(self, name: str) -> Optional[Union[PartialUser, User]]:
 
         return None
 
+C = TypeVar("C", bound="Command")
+G = TypeVar("G", bound="Group")
 
 def command(
-    *, name: str = None, aliases: Union[list, tuple] = None, cls=Command, no_global_checks=False
-) -> Callable[[Callable], Command]:
+    *, name: str = None, aliases: Union[list, tuple] = None, cls: C = Command, no_global_checks=False
+) -> Callable[[Callable], C]:
     if cls and not inspect.isclass(cls):
         raise TypeError(f"cls must be of type <class> not <{type(cls)}>")
 
-    def decorator(func: Callable) -> cls:
+    def decorator(func: Callable) -> C:
         fname = name or func.__name__
         return cls(
             name=fname,
@@ -482,14 +484,14 @@ def group(
     *,
     name: str = None,
     aliases: Union[list, tuple] = None,
-    cls=Group,
+    cls: G = Group,
     no_global_checks=False,
     invoke_with_subcommand=False,
-) -> Callable[[Callable], Group]:
+) -> Callable[[Callable], G]:
     if cls and not inspect.isclass(cls):
         raise TypeError(f"cls must be of type <class> not <{type(cls)}>")
 
-    def decorator(func: Callable) -> cls:
+    def decorator(func: Callable) -> G:
         fname = name or func.__name__
         return cls(
             name=fname,

twitchio/ext/eventsub/models.py

@@ -7,7 +7,7 @@
 
 from aiohttp import web
 
-from twitchio import CustomReward, PartialUser
+from twitchio import CustomReward, PartialUser, parse_timestamp as _parse_datetime
 
 if TYPE_CHECKING:
     from .server import EventSubClient
@@ -29,11 +29,6 @@ def _loads(s: str) -> dict:
 logger = logging.getLogger("twitchio.ext.eventsub")
 
 
-def _parse_datetime(time: str) -> datetime.datetime:
-    # Exemple time: 2021-06-19T04:12:39.407371633Z
-    return datetime.datetime.strptime(time[:26], "%Y-%m-%dT%H:%M:%S.%f")
-
-
 class EmptyObject:
     def __init__(self, **kwargs):
         self.__dict__.update(kwargs)

twitchio/ext/pubsub/models.py

@@ -25,7 +25,7 @@
 import datetime
 from typing import List, Optional
 
-from twitchio import PartialUser, Client, Channel, CustomReward
+from twitchio import PartialUser, Client, Channel, CustomReward, parse_timestamp
 
 
 __all__ = (
@@ -185,7 +185,7 @@ def __init__(self, client: Client, topic: str, data: dict):
         )
         self.badge_tier: int = data["badge_tier"]
         self.message: str = data["chat_message"]
-        self.timestamp = datetime.datetime.strptime(data["time"][0:25] + data["time"][28:], "%Y-%m-%dT%H:%M:%S.%fZ")
+        self.timestamp = parse_timestamp(data["time"])
 
 
 class PubSubChannelPointsMessage(PubSubMessage):
@@ -217,9 +217,7 @@ def __init__(self, client: Client, topic: str, data: dict):
 
         redemption = data["message"]["data"]["redemption"]
 
-        self.timestamp = datetime.datetime.strptime(
-            redemption["redeemed_at"][0:25] + redemption["redeemed_at"][28:], "%Y-%m-%dT%H:%M:%S.%fZ"
-        )
+        self.timestamp = parse_timestamp(redemption["redeemed_at"])
         self.channel_id: int = int(redemption["channel_id"])
         self.id: str = redemption["id"]
         self.user = PartialUser(client._http, redemption["user"]["id"], redemption["user"]["display_name"])
@@ -336,16 +334,10 @@ def __init__(self, client: Client, topic: str, data: dict):
 
         self.expires_at = self.updated_at = None
         if data["message"]["data"]["expires_at"]:
-            self.expires_at = datetime.datetime.strptime(
-                data["message"]["data"]["expires_at"][0:25] + data["message"]["data"]["expires_at"][28:],
-                "%Y-%m-%dT%H:%M:%S.%fZ",
-            )
+            self.expires_at = parse_timestamp(data["message"]["data"]["expires_at"])
 
         if data["message"]["data"]["updated_at"]:
-            self.updated_at = datetime.datetime.strptime(
-                data["message"]["data"]["updated_at"][0:25] + data["message"]["data"]["updated_at"][28:],
-                "%Y-%m-%dT%H:%M:%S.%fZ",
-            )
+            self.updated_at = parse_timestamp(data["message"]["data"]["expires_at"])
 
 
 class PubSubModerationActionModeratorAdd(PubSubMessage):

twitchio/models.py

@@ -26,6 +26,7 @@
 from typing import Optional, Union, TYPE_CHECKING, List, Dict
 
 from . import enums
+from .utils import parse_timestamp
 from .user import BitLeaderboardUser, PartialUser, User
 
 if TYPE_CHECKING:
@@ -117,7 +118,7 @@ def __init__(self, http: "TwitchHTTP", data: dict):
         self.tiers = [CheerEmoteTier(x) for x in data["tiers"]]
         self.type: str = data["type"]
         self.order: str = data["order"]
-        self.last_updated = datetime.datetime.strptime(data["last_updated"], "%Y-%m-%dT%H:%M:%SZ")
+        self.last_updated = parse_timestamp(data["last_updated"])
         self.charitable: bool = data["is_charitable"]
 
     def __repr__(self):
@@ -152,7 +153,7 @@ def __init__(self, http: "TwitchHTTP", data: dict):
         self.language = data["language"]
         self.title = data["title"]
         self.views = data["view_count"]
-        self.created_at = datetime.datetime.strptime(data["created_at"], "%Y-%m-%dT%H:%M:%SZ")
+        self.created_at = parse_timestamp(data["created_at"])
         self.thumbnail_url = data["thumbnail_url"]
 
     def __repr__(self):
@@ -197,12 +198,10 @@ def __init__(self, http: "TwitchHTTP", data: dict):
         self.type: str = data["event_type"]
         self.version: str = data["version"]
         self.broadcaster = PartialUser(http, id=data["event_data"]["broadcaster_id"], name=None)
-        self.timestamp = datetime.datetime.strptime(data["event_timestamp"], "%Y-%m-%dT%H:%M:%SZ")
-        self.cooldown_end_time = datetime.datetime.strptime(
-            data["event_data"]["cooldown_end_time"], "%Y-%m-%dT%H:%M:%SZ"
-        )
-        self.expiry = datetime.datetime.strptime(data["expires_at"], "%Y-%m-%dT%H:%M:%SZ")
-        self.started_at = datetime.datetime.strptime(data["event_data"]["started_at"], "%Y-%m-%dT%H:%M:%SZ")
+        self.timestamp = parse_timestamp(data["event_timestamp"])
+        self.cooldown_end_time = parse_timestamp(data["event_data"]["cooldown_end_time"])
+        self.expiry = parse_timestamp(data["expires_at"])
+        self.started_at = parse_timestamp(data["event_data"]["started_at"])
         self.last_contribution = HypeTrainContribution(http, data["event_data"]["last_contribution"])
         self.level: int = data["event_data"]["level"]
         self.top_contributions = [HypeTrainContribution(http, x) for x in data["event_data"]["top_contributions"]]
@@ -219,14 +218,14 @@ class BanEvent:
     def __init__(self, http: "TwitchHTTP", data: dict, broadcaster: Optional[Union[PartialUser, User]]):
         self.id: str = data["id"]
         self.type: str = data["event_type"]
-        self.timestamp = datetime.datetime.strptime(data["event_timestamp"], "%Y-%m-%dT%H:%M:%SZ")
+        self.timestamp = parse_timestamp(data["event_timestamp"])
         self.version: float = float(data["version"])
         self.broadcaster = broadcaster or PartialUser(
             http, data["event_data"]["broadcaster_id"], data["event_data"]["broadcaster_name"]
         )
         self.user = PartialUser(http, data["event_data"]["user_id"], data["event_data"]["user_name"])
         self.expires_at = (
-            datetime.datetime.strptime(data["event_data"]["expires_at"], "%Y-%m-%dT%H:%M:%SZ")
+            parse_timestamp(data["event_data"]["expires_at"])
             if data["event_data"]["expires_at"]
             else None
         )
@@ -248,7 +247,7 @@ def __init__(
     ):
         self.from_user = from_ or PartialUser(http, data["from_id"], data["from_name"])
         self.to_user = to or PartialUser(http, data["to_id"], data["to_name"])
-        self.followed_at = datetime.datetime.strptime(data["followed_at"], "%Y-%m-%dT%H:%M:%SZ")
+        self.followed_at = parse_timestamp(data["followed_at"])
 
     def __repr__(self):
         return f"<FollowEvent from_user={self.from_user} to_user={self.to_user} followed_at={self.followed_at}>"
@@ -284,7 +283,7 @@ class Marker:
 
     def __init__(self, data: dict):
         self.id: int = data["id"]
-        self.created_at = datetime.datetime.strptime(data["created_at"], "%Y-%m-%dT%H:%M:%SZ")
+        self.created_at = parse_timestamp(data["created_at"])
         self.description: str = data["description"]
         self.position: int = data["position_seconds"]
         self.url: Optional[str] = data.get("URL")
@@ -342,7 +341,7 @@ class ModEvent:
     def __init__(self, http: "TwitchHTTP", data: dict, broadcaster: Union[PartialUser, User]):
         self.id: int = data["id"]
         self.type = enums.ModEventEnum(value=data["event_type"])
-        self.timestamp = datetime.datetime.strptime(data["event_timestamp"], "%Y-%m-%dT%H:%M:%SZ")
+        self.timestamp = parse_timestamp(data["event_timestamp"])
         self.version: str = data["version"]
         self.broadcaster = broadcaster
         self.user = PartialUser(http, data["event_data"]["user_id"], data["event_data"]["user_name"])
@@ -487,8 +486,8 @@ def __init__(self, http: "TwitchHTTP", data: dict, user: Union[PartialUser, User
         self.user = user or PartialUser(http, data["user_id"], data["user_name"])
         self.title: str = data["title"]
         self.description: str = data["description"]
-        self.created_at = datetime.datetime.strptime(data["created_at"], "%Y-%m-%dT%H:%M:%SZ")
-        self.published_at = datetime.datetime.strptime(data["published_at"], "%Y-%m-%dT%H:%M:%SZ")
+        self.created_at = parse_timestamp(data["created_at"])
+        self.published_at = parse_timestamp(data["published_at"])
         self.url: str = data["url"]
         self.thumbnail_url: str = data["thumbnail_url"]
         self.viewable: str = data["viewable"]
@@ -533,7 +532,7 @@ class WebhookSubscription:
 
     def __init__(self, data: dict):
         self.callback: str = data["callback"]
-        self.expires_at = datetime.datetime.strptime(data["expires_at"], "%Y-%m-%dT%H:%M:%SZ")
+        self.expires_at = parse_timestamp(data["expired_at"])
         self.topic: str = data["topic"]
 
     def __repr__(self):
@@ -565,7 +564,7 @@ def __init__(self, http: "TwitchHTTP", data: dict):
         self.type: str = data["type"]
         self.title: str = data["title"]
         self.viewer_count: int = data["viewer_count"]
-        self.started_at = datetime.datetime.strptime(data["started_at"], "%Y-%m-%dT%H:%M:%SZ")
+        self.started_at = parse_timestamp(data["started_at"])
         self.language: str = data["language"]
         self.thumbnail_url: str = data["thumbnail_url"]
         self.tag_ids: List[str] = data["tag_ids"]
@@ -682,11 +681,11 @@ class ScheduleSegment:
 
     def __init__(self, data: dict):
         self.id: str = data["id"]
-        self.start_time = datetime.datetime.strptime(data["start_time"], "%Y-%m-%dT%H:%M:%SZ")
-        self.end_time = datetime.datetime.strptime(data["end_time"], "%Y-%m-%dT%H:%M:%SZ")
+        self.start_time = parse_timestamp(data["start_time"])
+        self.end_time = parse_timestamp(data["end_time"])
         self.title: str = data["title"]
         self.canceled_until = (
-            datetime.datetime.strptime(data["canceled_until"], "%Y-%m-%dT%H:%M:%SZ") if data["canceled_until"] else None
+            parse_timestamp(data["canceled_until"]) if data["canceled_until"] else None
         )
         self.category = ScheduleCategory(data["category"]) if data["category"] else None
         self.is_recurring: bool = data["is_recurring"]
@@ -712,8 +711,8 @@ class ScheduleVacation:
     __slots__ = ("start_time", "end_time")
 
     def __init__(self, data: dict):
-        self.start_time = datetime.datetime.strptime(data["start_time"], "%Y-%m-%dT%H:%M:%SZ")
-        self.end_time = datetime.datetime.strptime(data["end_time"], "%Y-%m-%dT%H:%M:%SZ")
+        self.start_time = parse_timestamp(data["start_time"])
+        self.end_time = parse_timestamp(data["end_time"])
 
     def __repr__(self):
         return f"<ScheduleVacation start_time={self.start_time} end_time={self.end_time}>"

twitchio/user.py

@@ -24,11 +24,12 @@
 
 import datetime
 import time
-from typing import TYPE_CHECKING, List, Optional, Union
+from typing import TYPE_CHECKING, List, Optional, Union, Tuple
 
 from .enums import BroadcasterTypeEnum, UserTypeEnum
 from .errors import HTTPException, Unauthorized
 from .rewards import CustomReward
+from .utils import parse_timestamp
 
 
 if TYPE_CHECKING:
@@ -844,16 +845,16 @@ class User(PartialUser):
     def __init__(self, http: "TwitchHTTP", data: dict):
         self._http = http
         self.id = int(data["id"])
-        self.name = data["login"]
-        self.display_name = data["display_name"]
+        self.name: str = data["login"]
+        self.display_name: str = data["display_name"]
         self.type = UserTypeEnum(data["type"])
         self.broadcaster_type = BroadcasterTypeEnum(data["broadcaster_type"])
-        self.description = data["description"]
-        self.profile_image = data["profile_image_url"]
-        self.offline_image = data["offline_image_url"]
-        self.view_count = (data["view_count"],)
-        self.created_at = data["created_at"]
-        self.email = data.get("email")
+        self.description: str = data["description"]
+        self.profile_image: str = data["profile_image_url"]
+        self.offline_image: str = data["offline_image_url"]
+        self.view_count: Tuple[int] = (data["view_count"],) # this isn't supposed to be a tuple but too late to fix it!
+        self.created_at = parse_timestamp(data["created_at"])
+        self.email: Optional[str] = data.get("email")
         self._cached_rewards = None
 
     def __repr__(self):

twitchio/utils.py

@@ -0,0 +1,22 @@
+import datetime
+import iso8601
+
+__all__ = (
+    "parse_timestamp",
+)
+
+def parse_timestamp(timestamp: str) -> datetime.datetime:
+    """
+
+    Parameters
+    ----------
+    timestamp: :class:`str`
+        The timestamp to be parsed, in an iso8601 format.
+
+    Returns
+    -------
+    :class:`datetime.datetime`
+        The parsed timestamp.
+
+    """
+    return iso8601.parse_date(timestamp, datetime.timezone.utc)