Merge branch 'main' into feature/conduits

Author: EvieePy

pyproject.toml

@@ -60,7 +60,7 @@ docs = [
     "sphinxcontrib_trio",
 ]
 starlette = ["starlette", "uvicorn"]
-dev = ["ruff==0.11.2", "pyright==1.1.398", "isort"]
+dev = ["ruff==0.11.2", "pyright==1.1.402", "isort"]
 
 [tool.ruff]
 line-length = 125
@@ -119,7 +119,7 @@ skip-magic-trailing-comma = false
 line-ending = "auto"
 
 [tool.pyright]
-exclude = ["venv", "docs", "examples", "twitchio/__main__.py"]
+exclude = [".venv", "venv", "docs", "examples", "twitchio/__main__.py"]
 useLibraryCodeForTypes = true
 typeCheckingMode = "strict"
 reportImportCycles = false

twitchio/authentication/payloads.py

@@ -100,9 +100,14 @@ class UserTokenPayload(BasePayload):
         A ``str`` or ``list[str]`` containing the scopes the user authenticated with.
     token_type: str
         The type of token provided. Usually ``bearer``.
+    user_id: str | None
+        An optional :class:`str` representing the ID of the User who authorized your application. This could be ``None``.
+    user_login: str | None
+        An optional :class:`str` representing the user name of the User who authorized your application.
+        This could be ``None``.
     """
 
-    __slots__ = ("access_token", "expires_in", "refresh_token", "scope", "token_type")
+    __slots__ = ("_user_id", "_user_login", "access_token", "expires_in", "refresh_token", "scope", "token_type")
 
     def __init__(self, raw: UserTokenResponse, /) -> None:
         super().__init__(raw)
@@ -112,6 +117,24 @@ def __init__(self, raw: UserTokenResponse, /) -> None:
         self.expires_in: int = raw["expires_in"]
         self.scope: str | list[str] = raw["scope"]
         self.token_type: str = raw["token_type"]
+        self._user_id: str | None = None
+        self._user_login: str | None = None
+
+    @property
+    def user_id(self) -> str | None:
+        return self._user_id
+
+    @user_id.setter
+    def user_id(self, other: str) -> None:
+        self._user_id = other
+
+    @property
+    def user_login(self) -> str | None:
+        return self._user_login
+
+    @user_login.setter
+    def user_login(self, other: str) -> None:
+        self._user_login = other
 
 
 class ClientCredentialsPayload(BasePayload):

twitchio/client.py

@@ -222,7 +222,7 @@ def tokens(self) -> MappingProxyType[str, TokenMappingData]:
 
             This method returns sensitive information such as user-tokens. You should take care not to expose these tokens.
         """
-        return MappingProxyType(self._http._tokens)
+        return MappingProxyType(dict(self._http._tokens))
 
     @property
     def bot_id(self) -> str | None:
@@ -434,7 +434,7 @@ async def login(self, *, token: str | None = None, load_tokens: bool = True, sav
                 await self.load_tokens()
 
         if self._bot_id:
-            logger.debug("Fetching Clients self user for %r", self)
+            logger.debug("Fetching Clients self user for %r", self.__class__.__name__)
             partial = PartialUser(id=self._bot_id, http=self._http)
             self._user = await partial.user() if self._fetch_self else partial
 
@@ -628,7 +628,7 @@ async def close(self) -> None:
 
         self._http.cleanup()
         self.__waiter.set()
-        logger.debug("Cleanup completed on %r.", self)
+        logger.debug("Cleanup completed on %r.", self.__class__.__name__)
 
     async def wait_until_ready(self) -> None:
         """|coro|

twitchio/ext/commands/bot.py

@@ -32,6 +32,7 @@
 from typing import TYPE_CHECKING, Any, TypeAlias, Unpack
 
 from twitchio.client import AutoClient, Client
+from twitchio.user import PartialUser
 
 from ...utils import _is_submodule
 from .context import Context
@@ -43,10 +44,11 @@
 if TYPE_CHECKING:
     from collections.abc import Callable, Coroutine, Iterable, Mapping
 
+    from twitchio.authentication.payloads import ClientCredentialsPayload, ValidateTokenPayload
     from twitchio.eventsub.subscriptions import SubscriptionPayload
     from twitchio.models.eventsub_ import ChannelPointsRedemptionAdd, ChannelPointsRedemptionUpdate, ChatMessage
     from twitchio.types_.eventsub import SubscriptionResponse
-    from twitchio.user import PartialUser
+    from twitchio.user import User
 
     from .components import Component
     from .types_ import AutoBotOptions, BotOptions
@@ -176,6 +178,7 @@ def __init__(
         self._components: dict[str, Component] = {}
         self._base_converter: _BaseConverter = _BaseConverter(self)
         self.__modules: dict[str, types.ModuleType] = {}
+        self._owner: User | None = None
 
     @property
     def bot_id(self) -> str:
@@ -204,6 +207,64 @@ def owner_id(self) -> str | None:
         """
         return self._owner_id
 
+    @property
+    def owner(self) -> User | None:
+        """Property which returns the :class:`~twitchio.User` associated with with the User who owns this bot.
+
+        Could be ``None`` if no ``owner_id`` was passed to the Bot constructor or the request failed.
+        Passing a ``owner_id`` is highly recommended.
+
+        .. important::
+
+            If ``owner_id`` has not been passed to the constructor of this :class:`.Bot` this will return ``None``.
+        """
+        return self._owner
+
+    async def login(self, *, token: str | None = None, load_tokens: bool = True, save_tokens: bool = True) -> None:
+        if self._login_called:
+            return
+
+        self._login_called = True
+        self._save_tokens = save_tokens
+
+        if not self._http.client_id:
+            raise RuntimeError('Expected a valid "client_id", instead received: %s', self._http.client_id)
+
+        if not token and not self._http.client_secret:
+            raise RuntimeError(f'Expected a valid "client_secret", instead received: {self._http.client_secret}')
+
+        if not token:
+            payload: ClientCredentialsPayload = await self._http.client_credentials_token()
+            validated: ValidateTokenPayload = await self._http.validate_token(payload.access_token)
+            token = payload.access_token
+
+            logger.info("Generated App Token for Client-ID: %s", validated.client_id)
+
+        self._http._app_token = token
+
+        if load_tokens:
+            async with self._http._token_lock:
+                await self.load_tokens()
+
+        if self._bot_id:
+            logger.debug("Fetching Clients self user for %r", self.__class__.__name__)
+            partial = PartialUser(id=self._bot_id, http=self._http)
+            self._user = await partial.user() if self._fetch_self else partial
+
+        if self._owner_id:
+            logger.debug("Fetching owner User for %r", self.__class__.__name__)
+            partial = PartialUser(id=self._owner_id, http=self._http)
+
+            try:
+                user = await partial.user()
+            except Exception:
+                logger.warning("Failed to retrieve the Owner User during startup. Owner will be None.")
+            else:
+                self._owner = user
+
+        await self.setup_hook()
+        self._setup_called = True
+
     async def close(self, **options: Any) -> None:
         for module in tuple(self.__modules):
             try:

twitchio/web/aio_adapter.py

@@ -33,6 +33,8 @@
 
 from aiohttp import web
 
+from twitchio.authentication.payloads import ValidateTokenPayload
+
 from ..authentication import Scopes
 from ..eventsub.subscriptions import _SUB_MAPPING
 from ..exceptions import HTTPException
@@ -44,7 +46,7 @@
 if TYPE_CHECKING:
     from ssl import SSLContext
 
-    from ..authentication import AuthorizationURLPayload, UserTokenPayload
+    from ..authentication import AuthorizationURLPayload, UserTokenPayload, ValidateTokenPayload
     from ..client import Client
     from ..types_.eventsub import EventSubHeaders
 
@@ -324,7 +326,12 @@ async def fetch_token(self, request: web.Request) -> FetchTokenPayload:
             status: int = e.status
             return FetchTokenPayload(status=status, response=web.Response(status=status), exception=e)
 
+        validated: ValidateTokenPayload = await self.client._http.validate_token(resp.access_token)
+        resp._user_id = validated.user_id
+        resp._user_login = validated.login
+
         self.client.dispatch(event="oauth_authorized", payload=resp)
+
         return FetchTokenPayload(
             status=20,
             response=web.Response(body="Success. You can leave this page.", status=200),

twitchio/web/starlette_adapter.py

@@ -47,7 +47,7 @@
 if TYPE_CHECKING:
     from starlette.requests import Request
 
-    from ..authentication import AuthorizationURLPayload, UserTokenPayload
+    from ..authentication import AuthorizationURLPayload, UserTokenPayload, ValidateTokenPayload
     from ..client import Client
     from ..types_.eventsub import EventSubHeaders
 
@@ -347,7 +347,12 @@ async def fetch_token(self, request: Request) -> FetchTokenPayload:
             status: int = e.status
             return FetchTokenPayload(status=status, response=Response(status_code=status), exception=e)
 
+        validated: ValidateTokenPayload = await self.client._http.validate_token(resp.access_token)
+        resp._user_id = validated.user_id
+        resp._user_login = validated.login
+
         self.client.dispatch(event="oauth_authorized", payload=resp)
+
         return FetchTokenPayload(
             status=200,
             response=Response(content="Success. You can leave this page.", status_code=200),