Add Route to docs and make public.

Author: EvieePy

docs/references/utils.rst

@@ -38,3 +38,12 @@ Helpers
 .. autofunction:: twitchio.utils.parse_timestamp
 
 .. autofunction:: twitchio.utils.setup_logging
+
+
+HTTP
+----
+
+.. attributetable:: twitchio.Route
+
+.. autoclass:: twitchio.Route()
+

twitchio/__init__.py

@@ -28,13 +28,18 @@
 __copyright__ = "Copyright 2017-Present (c) TwitchIO, PythonistaGuild"
 __version__ = "3.0.0dev"
 
-from . import types_ as types
-
-from . import authentication as authentication, eventsub as eventsub, utils as utils, web as web
+from . import (  # noqa: F401
+    authentication as authentication,
+    eventsub as eventsub,
+    types_ as types,
+    utils as utils,
+    web as web,
+)
 from .assets import Asset as Asset
 from .authentication import Scopes as Scopes
 from .client import Client as Client
 from .exceptions import *
+from .http import HTTPAsyncIterator as HTTPAsyncIterator, Route as Route
 from .models import *
 from .payloads import *
 from .user import *

twitchio/http.py

@@ -176,6 +176,28 @@ async def json_or_text(resp: aiohttp.ClientResponse) -> dict[str, Any] | str:
 
 
 class Route:
+    """Route class used by TwitchIO to prepare HTTP requests to Twitch.
+
+    .. warning::
+
+        You should not change or instantiate this class manually, as it is used internally.
+
+    Attributes
+    ----------
+    params: dict[str, Any]
+        A mapping of parameters used in the request.
+    json: dict[Any, Any]
+        The JSON used in the body of the request. Could be an empty :class:`dict`.
+    headers: dict[str, str]
+        The headers used in the request.
+    token_for: str
+        The User ID that was used to gather a token for authentication. Could be an empty :class:`str`.
+    method: Literal['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS', 'HEAD', 'CONNECT', 'TRACE']
+        The request method used.
+    path: str
+        The API endpoint requested.
+    """
+
     __slots__ = (
         "_base_url",
         "_url",
@@ -258,10 +280,12 @@ def encode(cls, value: str, /, safe: str = "", plus: bool = False) -> str:
 
     @property
     def url(self) -> str:
+        """Property returning the URL used to make a request. Could include query parameters."""
         return self._url
 
     @property
     def base_url(self) -> str:
+        """Property returning the URL used to make a request without query parameters."""
         return self._base_url
 
     def update_params(self, params: ParamMapping, *, remove_none: bool = True) -> str: