Merge branch 'main' into endpoint/get_auth_user

Author: chillymosh

.github/dependabot.yml

@@ -125,7 +125,7 @@ jobs:
       id-token: write
 
     steps:
-      - uses: actions/download-artifact@v4
+      - uses: actions/download-artifact@v6
 
       - name: Copy artifacts to dist/ folder
         run: |

.github/workflows/coverage_lint_build.yml

@@ -413,3 +413,33 @@ def selected(self) -> list[str]:
     def all(cls) -> Scopes:
         """Classmethod which creates this :class:`.Scopes` object with all scopes selected."""
         return cls([scope for scope in cls.__dict__.values() if isinstance(scope, _scope_property)])
+
+    @classmethod
+    def from_url(cls, url: str) -> Scopes:
+        """Classmethod which attempts to create this :class:`.Scopes` object from a URL containing scopes as a query parameter."""
+        self = cls()
+
+        if not url.startswith("http"):
+            url = url.replace("?scopes=", "")
+            url = f"http://localhost:4343?scopes={url}"
+
+        parsed = urllib.parse.parse_qs(url)
+        scopes: list[str] = []
+
+        for qs in parsed.values():
+            for s in qs:
+                unquoted = urllib.parse.unquote_plus(s)
+                splat = unquoted.split()
+                scopes.extend(splat)
+
+        for scope in scopes:
+            if scope == "openid":
+                continue
+
+            prop = getattr(self, scope.replace(":", "_"), None)
+            if not prop:
+                continue
+
+            self._selected.add(prop)
+
+        return self

twitchio/authentication/scopes.py

@@ -149,12 +149,17 @@ def __init__(
             msg = "If you require the StarletteAdapter please install the required packages: 'pip install twitchio[starlette]'."
             logger.warning(msg)
 
-        adapter: BaseAdapter | type[BaseAdapter] = options.get("adapter", AiohttpAdapter)
+        self._adapter: BaseAdapter[Any] | AiohttpAdapter[Self]
+        adapter: BaseAdapter[Any] | type[BaseAdapter[Any]] | None = options.get("adapter")
+
         if isinstance(adapter, BaseAdapter):
-            adapter.client = self
             self._adapter = adapter
+        elif adapter is None:
+            self._adapter = AiohttpAdapter()
         else:
             self._adapter = adapter()
+
+        if not hasattr(self._adapter, "client"):
             self._adapter.client = self
 
         # Own Client User. Set in login...
@@ -178,12 +183,12 @@ def __init__(
         self._setup_called = False
 
     @property
-    def adapter(self) -> BaseAdapter:
+    def adapter(self) -> BaseAdapter[Any]:
         """Property returning the :class:`~twitchio.AiohttpAdapter` or :class:`~twitchio.StarlettepAdapter` the bot is
         currently running."""
         return self._adapter
 
-    async def set_adapter(self, adapter: BaseAdapter) -> None:
+    async def set_adapter(self, adapter: BaseAdapter[Any]) -> None:
         """|coro|
 
         Method which sets and starts a new web adapter which inherits from either :class:`~twitchio.AiohttpAdapter` or
@@ -202,7 +207,8 @@ async def set_adapter(self, adapter: BaseAdapter) -> None:
             await self._adapter.close(False)
 
         self._adapter = adapter
-        self._adapter.client = self
+        if not hasattr(self._adapter, "client"):
+            self._adapter.client = self
 
         if self._setup_called and not self._adapter._running:
             await self._adapter.run()

twitchio/client.py

@@ -299,6 +299,7 @@ async def _reconnect(self, url: str) -> None:
             client=self._client,
             token_for=self._token_for,
             http=self._http,
+            shard_id=self._shard_id,
         )
 
         socket._subscriptions = self._subscriptions

twitchio/eventsub/websockets.py

@@ -43,7 +43,7 @@ class ClientOptions(TypedDict, total=False):
     redirect_uri: str | None
     scopes: Scopes | None
     session: aiohttp.ClientSession | None
-    adapter: NotRequired[BaseAdapter]
+    adapter: NotRequired[BaseAdapter[Any]]
     fetch_client_user: NotRequired[bool]
 
 

twitchio/types_/options.py

@@ -28,7 +28,7 @@
 import datetime
 import logging
 from collections import deque
-from typing import TYPE_CHECKING, Any, cast
+from typing import TYPE_CHECKING, Any, TypeVar, cast
 from urllib.parse import unquote_plus
 
 from aiohttp import web
@@ -54,10 +54,11 @@
 __all__ = ("AiohttpAdapter",)
 
 
+BT = TypeVar("BT", bound="Client")
 logger: logging.Logger = logging.getLogger(__name__)
 
 
-class AiohttpAdapter(BaseAdapter, web.Application):
+class AiohttpAdapter(BaseAdapter[BT], web.Application):
     """The AiohttpAdapter for OAuth and Webhook based EventSub.
 
     This adapter uses ``aiohttp`` which is a base dependency and should be installed and available with Twitchio.
@@ -113,6 +114,9 @@ class AiohttpAdapter(BaseAdapter, web.Application):
         E.g. ``http://localhost:4343/oauth/callback`` or ``https://mydomain.org/oauth/callback``.
     ssl_context: SSLContext | None
         An optional :class:`SSLContext` passed to the adapter. If SSL is setup via a front-facing web server such as NGINX, you should leave this as None.
+    client: :class:`~twitchio.Client` | None
+        An optional :class:`~twitchio.Client` or any derivative such as :class:`~twitchio.ext.commands.Bot` to set for this
+        adapter. When ``None`` the client will be set automatically after initalization. Defaults to ``None``.
 
     Examples
     --------
@@ -141,7 +145,7 @@ def __init__(self) -> None:
                 super().__init__(adapter=adapter)
     """
 
-    client: Client
+    client: BT
 
     def __init__(
         self,
@@ -154,8 +158,13 @@ def __init__(
         oauth_path: str | None = None,
         redirect_path: str | None = None,
         ssl_context: SSLContext | None = None,
+        client: BT | None = None,
     ) -> None:
         super().__init__()
+
+        if client:
+            self.client = client
+
         self._runner: web.AppRunner | None = None
 
         self._host: str = host or "localhost"
@@ -194,7 +203,7 @@ def __init__(
         self._responded: deque[str] = deque(maxlen=5000)
         self._running: bool = False
 
-    def __init_subclass__(cls: type[AiohttpAdapter]) -> None:
+    def __init_subclass__(cls: type[AiohttpAdapter[BT]]) -> None:
         return
 
     def __repr__(self) -> str:

twitchio/web/aio_adapter.py

@@ -28,7 +28,7 @@
 import datetime
 import logging
 from collections import deque
-from typing import TYPE_CHECKING, Any, cast
+from typing import TYPE_CHECKING, Any, TypeVar, cast
 from urllib.parse import unquote_plus
 
 import uvicorn
@@ -57,10 +57,11 @@
 __all__ = ("StarletteAdapter",)
 
 
+BT = TypeVar("BT", bound="Client")
 logger: logging.Logger = logging.getLogger(__name__)
 
 
-class StarletteAdapter(BaseAdapter, Starlette):
+class StarletteAdapter(BaseAdapter[BT], Starlette):
     """The StarletteAdapter for OAuth and Webhook based EventSub.
 
     This adapter uses ``starlette`` which is an optional dependency and needs to be installed.
@@ -125,6 +126,9 @@ class StarletteAdapter(BaseAdapter, Starlette):
     timeout_graceful_shutdown: int
         An optional :class:`int` which is the maximum amount of time in seconds ``Uvicorn`` should wait before forcefully
         closing. Defaults to ``3``.
+    client: :class:`~twitchio.Client` | None
+        An optional :class:`~twitchio.Client` or any derivative such as :class:`~twitchio.ext.commands.Bot` to set for this
+        adapter. When ``None`` the client will be set automatically after initalization. Defaults to ``None``.
 
     Examples
     --------
@@ -153,7 +157,7 @@ def __init__(self) -> None:
                 super().__init__(adapter=adapter)
     """
 
-    client: Client
+    client: BT
 
     def __init__(
         self,
@@ -170,7 +174,11 @@ def __init__(
         ssl_certfile: str | PathLike[str] | None = None,
         timeout_keep_alive: int = 5,
         timeout_graceful_shutdown: int = 3,
+        client: BT | None = None,
     ) -> None:
+        if client:
+            self.client = client
+
         self._timeout_keep_alive = timeout_keep_alive
         self._timeout_graceful_shutdown = timeout_graceful_shutdown
         self._host: str = host or "localhost"

twitchio/web/starlette_adapter.py

@@ -28,7 +28,7 @@
 import hashlib
 import hmac
 import logging
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Any, Generic, TypeVar
 
 from aiohttp import web
 
@@ -45,6 +45,7 @@
     from ..types_.eventsub import EventSubHeaders
 
 
+BT = TypeVar("BT", bound="Client")
 logger: logging.Logger = logging.getLogger(__name__)
 
 
@@ -82,8 +83,8 @@ def __init__(
         self.exception = exception
 
 
-class BaseAdapter(abc.ABC):
-    client: Client
+class BaseAdapter(abc.ABC, Generic[BT]):
+    client: BT
     _runner_task: asyncio.Task[None] | None
     _eventsub_secret: str | None
     _running: bool