fetch_cheermotes and pubsub bits corrections

fetch_cheermotes color attribute corrected
PubSubBitsMessage, PubSubBitsBadgeMessage now all return correct data and models
Added some Optional typings for user friendliness

Author: chillymosh

docs/changelog.rst

@@ -9,14 +9,18 @@ Massive documentation updates
     - Fix bug where # prefixed channel names in initial_channels would not trigger :func:`twitchio.Client.event_ready`
     - :func:`User.create_clip` has been fixed by converting bool to string in http request
     - Poll endpoints added :func:`User.fetch_polls` :func:`User.create_poll` and :func:`User.end_poll`
+    - :func:`Client.fetch_cheermotes` color attribute corrected
 
 - ext.commands
     - :func:`Bot.handle_commands` now also invokes on threads / replies
     - Cooldowns are now handled correctly per bucket.
     - Fix issue with :func:`Bot.reload_module` where module is reloaded incorrectly if exception occurs
 
 - ext.pubsub
-    - Channel subscription model fixes.
+    - Channel subscription model fixes and additional type hints for Optional return values
+    - PubSubBitsMessage model updated to return correct data and updated typing
+    - PubSubBitsBadgeMessage model updated to return correct data and updated typing
+    - PubSubChatMessage now correctly returns a string rather than int for the Bits Events
 
 2.2.0
 =====

twitchio/ext/pubsub/models.py

@@ -79,7 +79,7 @@ class PubSubChatMessage:
 
     def __init__(self, content: str, id: str, type: str):
         self.content = content
-        self.id = int(id)
+        self.id = id
         self.type = type
 
 
@@ -133,8 +133,8 @@ class PubSubBitsMessage(PubSubMessage):
         The amount of bits used.
     channel_id: :class:`int`
         The channel the bits were given to.
-    user: :class:`twitchio.PartialUser`
-        The user giving the bits.
+    user: Optional[:class:`twitchio.PartialUser`]
+        The user giving the bits. Can be None if anonymous.
     version: :class:`str`
         The event version.
     """
@@ -144,16 +144,21 @@ class PubSubBitsMessage(PubSubMessage):
     def __init__(self, client: Client, topic: str, data: dict):
         super().__init__(client, topic, data)
 
-        self.message = PubSubChatMessage(data["chat_message"], data["message_id"], data["message_type"])
+        data = data["message"]
+        self.message = PubSubChatMessage(data["data"]["chat_message"], data["message_id"], data["message_type"])
         self.badge_entitlement = (
-            PubSubBadgeEntitlement(data["badge_entitlement"]["new_version"], data["badge_entitlement"]["old_version"])
-            if data["badge_entitlement"]
+            PubSubBadgeEntitlement(
+                data["data"]["badge_entitlement"]["new_version"], data["data"]["badge_entitlement"]["old_version"]
+            )
+            if data["data"]["badge_entitlement"]
             else None
         )
-        self.bits_used: int = data["bits_used"]
-        self.channel_id: int = int(data["channel_id"])
+        self.bits_used: int = data["data"]["bits_used"]
+        self.channel_id: int = int(data["data"]["channel_id"])
         self.user = (
-            PartialUser(client._http, data["user_id"], data["user_name"]) if data["user_id"] is not None else None
+            PartialUser(client._http, data["data"]["user_id"], data["data"]["user_name"])
+            if data["data"]["user_id"]
+            else None
         )
         self.version: str = data["version"]
 
@@ -180,6 +185,7 @@ class PubSubBitsBadgeMessage(PubSubMessage):
 
     def __init__(self, client: Client, topic: str, data: dict):
         super().__init__(client, topic, data)
+        data = data["message"]
         self.user = PartialUser(client._http, data["user_id"], data["user_name"])
         self.channel: Channel = client.get_channel(data["channel_name"]) or Channel(
             name=data["channel_name"], websocket=client._connection
@@ -349,15 +355,15 @@ class PubSubChannelSubscribe(PubSubMessage):
         Channel that has been subscribed or subgifted.
     context: :class:`str`
         Event type associated with the subscription product.
-    user: :class:`twitchio.PartialUser`
-        The person who subscribed or sent a gift subscription.
+    user: Optional[:class:`twitchio.PartialUser`]
+        The person who subscribed or sent a gift subscription. Can be None if anonymous.
     message: :class:`str`
         Message sent with the sub/resub.
-    emotes: List[:class:`dict`]
+    emotes: Optional[List[:class:`dict`]]
         Message sent with the sub/resub.
     is_gift: :class:`bool`
         If this sub message was caused by a gift subscription.
-    recipient: :class:`twitchio.PartialUser`
+    recipient: Optional[:class:`twitchio.PartialUser`]
         The person the who received the gift subscription.
     sub_plan: :class:`str`
         Subscription Plan ID.
@@ -367,9 +373,9 @@ class PubSubChannelSubscribe(PubSubMessage):
         Time when the subscription or gift was completed. RFC 3339 format.
     cumulative_months: :class:`int`
         Cumulative number of tenure months of the subscription.
-    streak_months: :class:`int`
+    streak_months: Optional[:class:`int`]
         Denotes the user's most recent (and contiguous) subscription tenure streak in the channel.
-    multi_month_duration: :class:`int`
+    multi_month_duration: Optional[:class:`int`]
         Number of months gifted as part of a single, multi-month gift OR number of months purchased as part of a multi-month subscription.
     """
 
@@ -398,21 +404,18 @@ def __init__(self, client: Client, topic: str, data: dict):
             name=subscription["channel_name"], websocket=client._connection
         )
         self.context: str = subscription["context"]
-
         try:
             self.user = PartialUser(client._http, int(subscription["user_id"]), subscription["user_name"])
         except KeyError:
             self.user = None
 
         self.message: str = subscription["sub_message"]["message"]
-
         try:
             self.emotes = subscription["sub_message"]["emotes"]
         except KeyError:
             self.emotes = None
 
         self.is_gift: bool = subscription["is_gift"]
-
         try:
             self.recipient = PartialUser(
                 client._http, int(subscription["recipient_id"]), subscription["recipient_user_name"]
@@ -423,9 +426,18 @@ def __init__(self, client: Client, topic: str, data: dict):
         self.sub_plan: str = subscription["sub_plan"]
         self.sub_plan_name: str = subscription["sub_plan_name"]
         self.time = parse_timestamp(subscription["time"])
-        self.cumulative_months: int = int(subscription["cumulative_months"])
-        self.streak_months = int(subscription["streak_months"])
-        self.multi_month_duration = int(subscription["multi_month_duration"])
+        try:
+            self.cumulative_months = int(subscription["cumulative_months"])
+        except KeyError:
+            self.cumulative_months = None
+        try:
+            self.streak_months = int(subscription["streak_months"])
+        except KeyError:
+            self.streak_months = None
+        try:
+            self.multi_month_duration = int(subscription["multi_month_duration"])
+        except KeyError:
+            self.multi_month_duration = None
 
 
 class PubSubModerationActionModeratorAdd(PubSubMessage):

twitchio/models.py

@@ -121,12 +121,12 @@ class CheerEmoteTier:
         Indicates whether twitch hides the emote from the bits card.
     """
 
-    __slots__ = "min_bits", "id", "colour", "images", "can_cheer", "show_in_bits_card"
+    __slots__ = "min_bits", "id", "color", "images", "can_cheer", "show_in_bits_card"
 
     def __init__(self, data: dict):
         self.min_bits: int = data["min_bits"]
         self.id: str = data["id"]
-        self.colour: str = data["colour"]
+        self.color: str = data["color"]
         self.images = data["images"]  # TODO types
         self.can_cheer: bool = data["can_cheer"]
         self.show_in_bits_card: bool = data["show_in_bits_card"]