Merge branch 'master' into sounds_setters

Author: IAmTomahawkx

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Myst(MysterialPy)
+Copyright (c) 2017 - Present PythonistaGuild
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docs/changelog.rst

@@ -3,9 +3,26 @@
 Master
 ======
 - TwitchIO
+    - Additions
+        - Added :func:`~twitchio.Client.fetch_global_chat_badges`
+        - Added User method :func:`~twitchio.PartialUser.fetch_chat_badges`
+        - Added repr for :class:`~twitchio.SearchUser`
+        - Added two new events
+            - Added :func:`~twitchio.Client.event_notice`
+            - Added :func:`~twitchio.Client.event_raw_notice`
+
+        - Added :class:`~twitchio.message.HypeChatData` for hype chat events
+        - Added :attr:`~twitchio.message.Message.hype_chat_data` for hype chat events
+        - Added :func:`~twitchio.Client.fetch_content_classification_labels` along with :class:`~twitchio.ContentClassificationLabel`
+        - Added :attr:`~twitchio.ChannelInfo.content_classification_labels` and :attr:`~twitchio.ChannelInfo.is_branded_content` to :class:`~twitchio.ChannelInfo`
+        - Added new parameters to :func:`~twitchio.PartialUser.modify_stream` for ``is_branded_content`` and ``content_classification_labels``
+            
     - Bug fixes
         - Fix :func:`~twitchio.Client.search_categories` due to :attr:`~twitchio.Game.igdb_id` being added to :class:`~twitchio.Game`
         - Made Chatter :attr:`~twitchio.Chatter.id` property public
+        - :func:`~twitchio.Client.event_token_expired` will now be called correctly when response is ``401 Invalid OAuth token``
+        - Fix reconnect loop when Twitch sends a RECONNECT via IRC websocket
+        - Fix :func:`~twitchio.CustomReward.edit` so it now can enable the reward
 
 
 - ext.sounds

docs/reference.rst

@@ -90,6 +90,22 @@ ChannelTeams
     :members:
     :inherited-members:
 
+ChatBadge
+----------
+.. attributetable:: ChatBadge
+
+.. autoclass:: ChatBadge
+    :members:
+    :inherited-members:
+
+ChatBadgeVersions
+------------------
+.. attributetable:: ChatBadgeVersions
+
+.. autoclass:: ChatBadgeVersions
+    :members:
+    :inherited-members:
+
 ChatSettings
 -------------
 .. attributetable:: ChatSettings
@@ -143,6 +159,14 @@ Clip
     :members:
     :inherited-members:
 
+ContentClassificationLabel
+---------------------------
+.. attributetable:: ContentClassificationLabel
+
+.. autoclass:: ContentClassificationLabel
+    :members:
+    :inherited-members:
+
 CustomReward
 --------------
 .. attributetable:: CustomReward
@@ -207,6 +231,13 @@ Goal
     :members:
     :inherited-members:
 
+HypeChatData
+
+.. attributetable:: HypeChatData
+
+.. autoclass:: HypeChatData
+    :members:
+
 HypeTrainContribution
 -----------------------
 .. attributetable:: HypeTrainContribution

twitchio/__init__.py

@@ -36,7 +36,7 @@
 from .chatter import Chatter, PartialChatter
 from .enums import *
 from .errors import *
-from .message import Message
+from .message import Message, HypeChatData
 from .models import *
 from .rewards import *
 from .utils import *

twitchio/chatter.py

@@ -135,6 +135,9 @@ def __init__(self, websocket: "WSConnection", **kwargs):
         if self._badges:
             self._cached_badges = dict([badge.split("/") for badge in self._badges.split(",")])
 
+    def __repr__(self):
+        return f"<Chatter name: {self._name}, channel: {self._channel}>"
+
     def _bot_is_mod(self):
         cache = self._ws._cache[self._channel.name]  # noqa
         for user in cache:

twitchio/client.py

@@ -814,6 +814,38 @@ async def update_chatter_color(self, token: str, user_id: int, color: str):
         """
         await self._http.put_user_chat_color(token=token, user_id=str(user_id), color=color)
 
+    async def fetch_global_chat_badges(self):
+        """|coro|
+
+        Fetches Twitch's list of chat badges, which users may use in any channel's chat room.
+
+        Returns
+        --------
+        List[:class:`twitchio.ChatBadge`]
+        """
+
+        data = await self._http.get_global_chat_badges()
+        return [models.ChatBadge(x) for x in data]
+
+    async def fetch_content_classification_labels(self, locale: Optional[str] = None):
+        """|coro|
+
+        Fetches information about Twitch content classification labels.
+
+        Parameters
+        -----------
+        locale: Optional[:class:`str`]
+            Locale for the Content Classification Labels.
+            You may specify a maximum of 1 locale. Default: “en-US”
+
+        Returns
+        --------
+        List[:class:`twitchio.ContentClassificationLabel`]
+        """
+        locale = "en-US" if locale is None else locale
+        data = await self._http.get_content_classification_labels(locale)
+        return [models.ContentClassificationLabel(x) for x in data]
+
     async def get_webhook_subscriptions(self):
         """|coro|
 
@@ -1043,3 +1075,54 @@ async def event_channel_join_failure(self, channel: str):
             The channel name that was attempted to be joined.
         """
         logger.error(f'The channel "{channel}" was unable to be joined. Check the channel is valid.')
+
+    async def event_raw_notice(self, data: str):
+        """|coro|
+
+
+        Event called with the raw NOTICE data received by Twitch.
+
+        Parameters
+        ------------
+        data: str
+            The raw NOTICE data received from Twitch.
+
+        Example
+        ---------
+        .. code:: py
+
+            @bot.event()
+            async def event_raw_notice(data):
+                print(data)
+        """
+        pass
+
+    async def event_notice(self, message: str, msg_id: Optional[str], channel: Optional[Channel]):
+        """|coro|
+
+
+        Event called with the NOTICE data received by Twitch.
+
+        .. tip::
+
+            For more information on NOTICE msg_ids visit:
+            https://dev.twitch.tv/docs/irc/msg-id/
+
+        Parameters
+        ------------
+        message: :class:`str`
+            The message of the NOTICE.
+        msg_id: Optional[:class:`str`]
+            The msg_id that indicates what the NOTICE type.
+        channel: Optional[:class:`~twitchio.Channel`]
+            The channel the NOTICE message originated from.
+
+        Example
+        ---------
+        .. code:: py
+
+            @bot.event()
+            async def event_notice(message, msg_id, channel):
+                print(message)
+        """
+        pass

twitchio/ext/commands/core.py

@@ -52,6 +52,25 @@ def _boolconverter(param: str):
 
 
 class Command:
+    """A class for implementing bot commands.
+
+    Parameters
+    ------------
+    name: :class:`str`
+        The name of the command.
+    func: :class:`Callable`
+        The coroutine that executes when the command is invoked.
+
+    Attributes
+    ------------
+    name: :class:`str`
+        The name of the command.
+    cog: :class:`~twitchio.ext.commands.Cog`
+        The cog this command belongs to.
+    aliases: Optional[Union[:class:`list`, :class:`tuple`]]
+        Aliases that can be used to also invoke the command.
+    """
+
     def __init__(self, name: str, func: Callable, **attrs) -> None:
         if not inspect.iscoroutinefunction(func):
             raise TypeError("Command callback must be a coroutine.")
@@ -335,6 +354,36 @@ def decorator(func: Callable):
 
 
 class Context(Messageable):
+    """
+    A class that represents the context in which a command is being invoked under.
+
+    This class contains the meta data to help you understand more about the invocation context.
+    This class is not created manually and is instead passed around to commands as the first parameter.
+
+    Attributes
+    -----------
+    message: :class:`~twitchio.Message`
+        The message that triggered the command being executed.
+    channel: :class:`~twitchio.Channel`
+        The channel the command was invoked in.
+    author: Union[:class:`~twitchio.PartialChatter`, :class:`~twitchio.Chatter`]
+        The Chatter object of the user in chat that invoked the command.
+    prefix: Optional[:class:`str`]
+        The prefix that was used to invoke the command.
+    command: Optional[:class:`~twitchio.ext.commands.Command`]
+        The command that was invoked
+    cog: Optional[:class:`~twitchio.ext.commands.Cog`]
+        The cog that contains the command that was invoked.
+    args: Optional[List[:class:`Any`]]
+        List of arguments that were passed to the command.
+    kwargs: Optional[Dict[:class:`str`, :class:`Any`]]
+        List of kwargs that were passed to the command.
+    view: Optional[:class:`~twitchio.ext.commmands.StringParser`]
+        StringParser object that breaks down the command string received.
+    bot: :class:`~twitchio.ext.commands.Bot`
+        The bot that contains the command that was invoked.
+    """
+
     __messageable_channel__ = True
 
     def __init__(self, message: Message, bot: Bot, **attrs) -> None:

twitchio/ext/pubsub/pool.py

@@ -104,20 +104,32 @@ async def _process_auth_fail(self, nonce: str, node: PubSubWebsocket) -> None:
             logger.error("Error occurred while calling auth_fail_hook.", exc_info=e)
 
     async def auth_fail_hook(self, topics: List[Topic]):
-        """
+        """|coro|
         This is a hook that can be overridden in a subclass.
+        From this hook, you can refresh expired tokens (or prompt a user for new ones), and resubscribe to the events.
+
+        .. note::
+
+            The topics will not be automatically resubscribed to. You must do it yourself by calling :meth:`~PubSubPool.subscribe_topics` with the topics after obtaining new tokens.
+
+        An example of what this method should do:
+
+        .. code:: python
+
+            class MyPubSubPool(pubsub.PubSubPool):
+                async def auth_fail_hook(self, topics: List[pubsub.Topic]):
+                    token = topics[0].token
+                    new_token = await some_imaginary_function_that_refreshes_tokens(token)
 
+                    for topic in topics:
+                        topic.token = new_token
+
+                    await self.subscribe_topics(topics)
 
         Parameters
         ----------
-        node
         topics: List[:class:`Topic`]
-            The topcs that this node has.
-
-        Returns
-        -------
-        List[:class:`Topic`]
-            The list of topics this node should have. Any additions, modifications, or removals will be respected.
+            The topics that have been deauthorized. Typically these will all contain the same token.
         """
 
     async def _process_reconnect_hook(self, node: PubSubWebsocket) -> None:
@@ -145,9 +157,10 @@ async def reconnect_hook(self, node: PubSubWebsocket, topics: List[Topic]) -> Li
 
         Parameters
         ----------
-        node
+        node: :class:`PubSubWebsocket`
+            The node that is reconnecting.
         topics: List[:class:`Topic`]
-            The topcs that this node has.
+            The topics that this node has.
 
         Returns
         -------

twitchio/http.py

@@ -207,14 +207,15 @@ async def _request(self, route, path, headers, utilize_bucket=True):
                         return await resp.json(), False
                     return await resp.text(encoding="utf-8"), True
                 if resp.status == 401:
-                    if "WWW-Authenticate" in resp.headers:
+                    message_json = await resp.json()
+                    if "Invalid OAuth token" in message_json.get("message", ""):
                         try:
                             await self._generate_login()
                         except:
                             raise errors.Unauthorized(
                                 "Your oauth token is invalid, and a new one could not be generated"
                             )
-                    print(resp.reason, await resp.json(), resp)
+                    print(resp.reason, message_json, resp)
                     raise errors.Unauthorized("You're not authorized to use this route.")
                 if resp.status == 429:
                     reason = "Ratelimit Reached"
@@ -420,7 +421,7 @@ async def update_reward(
             "prompt": prompt,
             "cost": cost,
             "background_color": background_color,
-            "enabled": enabled,
+            "is_enabled": enabled,
             "is_user_input_required": input_required,
             "is_max_per_stream_enabled": max_per_stream_enabled,
             "max_per_stream": max_per_stream,
@@ -716,15 +717,30 @@ async def get_channels_new(self, broadcaster_ids: List[int], token: Optional[str
         return await self.request(Route("GET", "channels", query=q, token=token))
 
     async def patch_channel(
-        self, token: str, broadcaster_id: str, game_id: str = None, language: str = None, title: str = None
+        self,
+        token: str,
+        broadcaster_id: str,
+        game_id: str = None,
+        language: str = None,
+        title: str = None,
+        content_classification_labels: List[Dict[str, Union[str, bool]]] = None,
+        is_branded_content: bool = None,
     ):
-        assert any((game_id, language, title))
+        assert any((game_id, language, title, content_classification_labels, is_branded_content))
         body = {
             k: v
-            for k, v in {"game_id": game_id, "broadcaster_language": language, "title": title}.items()
+            for k, v in {
+                "game_id": game_id,
+                "broadcaster_language": language,
+                "title": title,
+                "is_branded_content": is_branded_content,
+            }.items()
             if v is not None
         }
 
+        if content_classification_labels is not None:
+            body["content_classification_labels"] = content_classification_labels
+
         return await self.request(
             Route("PATCH", "channels", query=[("broadcaster_id", broadcaster_id)], body=body, token=token)
         )
@@ -1129,3 +1145,12 @@ async def post_shoutout(self, token: str, broadcaster_id: str, moderator_id: str
             ("to_broadcaster_id", to_broadcaster_id),
         ]
         return await self.request(Route("POST", "chat/shoutouts", query=q, token=token))
+
+    async def get_global_chat_badges(self):
+        return await self.request(Route("GET", "chat/badges/global", ""))
+
+    async def get_channel_chat_badges(self, broadcaster_id: str):
+        return await self.request(Route("GET", "chat/badges", "", query=[("broadcaster_id", broadcaster_id)]))
+
+    async def get_content_classification_labels(self, locale: str):
+        return await self.request(Route("GET", "content_classification_labels", "", query=[("locale", locale)]))