Compare commits
12 Commits
3b2f97ddbd
...
latest
| Author | SHA1 | Date | |
|---|---|---|---|
| 539a6a04f1 | |||
| fc7cc89301 | |||
| ab84144990 | |||
| 636ce6f914 | |||
| ffd6f9288e | |||
| 7cbc08f35f | |||
| 9af7c982eb | |||
| 52ff7d4150 | |||
| 25c7c0fc51 | |||
| 4a8ecdf158 | |||
| 16bd8cabe1 | |||
| a8c21af06e |
@ -1,18 +1,18 @@
|
|||||||
repos:
|
repos:
|
||||||
- repo: https://github.com/crate-ci/typos
|
- repo: https://github.com/crate-ci/typos
|
||||||
rev: v1.36.3
|
rev: v1.42.0
|
||||||
hooks:
|
hooks:
|
||||||
- id: typos
|
- id: typos
|
||||||
|
|
||||||
- repo: https://github.com/astral-sh/ruff-pre-commit
|
- repo: https://github.com/astral-sh/ruff-pre-commit
|
||||||
rev: v0.13.2
|
rev: v0.14.13
|
||||||
hooks:
|
hooks:
|
||||||
- id: ruff
|
- id: ruff
|
||||||
args: [ --fix ]
|
args: [ --fix ]
|
||||||
- id: ruff-format
|
- id: ruff-format
|
||||||
|
|
||||||
- repo: https://github.com/RobertCraigie/pyright-python
|
- repo: https://github.com/RobertCraigie/pyright-python
|
||||||
rev: v1.1.405
|
rev: v1.1.408
|
||||||
hooks:
|
hooks:
|
||||||
- id: pyright
|
- id: pyright
|
||||||
|
|
||||||
|
|||||||
170
README.md
170
README.md
@ -0,0 +1,170 @@
|
|||||||
|
# Twitch Client (Async)
|
||||||
|
|
||||||
|
An internal **async Twitch API client** built on top of **AioHTTPX**, providing typed access to the Twitch **Helix API** and **OAuth2** endpoints with built-in rate limiting and optional caching.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## What it provides
|
||||||
|
|
||||||
|
* `TwitchAPIClient` — async client for Twitch **Helix API**
|
||||||
|
* `TwitchAuthClient` — async client for Twitch **OAuth2**
|
||||||
|
* Built on **AioHTTPX** (aiohttp transport, Redis rate limiting & caching)
|
||||||
|
* Strongly typed responses using **Pydantic models**
|
||||||
|
* Automatic request parameter cleanup (`None` values removed)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Installation (internal)
|
||||||
|
|
||||||
|
Configure your private package index, then:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install twitchclient
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Authentication
|
||||||
|
|
||||||
|
### OAuth helper client
|
||||||
|
|
||||||
|
```python
|
||||||
|
from twitchclient.auth import TwitchAuthClient
|
||||||
|
from twitchclient import scopes
|
||||||
|
|
||||||
|
auth = TwitchAuthClient(
|
||||||
|
client_id="CLIENT_ID",
|
||||||
|
client_secret="CLIENT_SECRET",
|
||||||
|
redirect_uri="https://your.app/callback",
|
||||||
|
)
|
||||||
|
|
||||||
|
url = await auth.create_authorization_code_grant_flow_url(
|
||||||
|
scope=[scopes.USER_READ_EMAIL, scopes.CHAT_READ],
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
### App access token
|
||||||
|
|
||||||
|
```python
|
||||||
|
token = await auth.app_access_token()
|
||||||
|
print(token.access_token)
|
||||||
|
```
|
||||||
|
|
||||||
|
### User access token
|
||||||
|
|
||||||
|
```python
|
||||||
|
token = await auth.user_access_token(code="AUTH_CODE")
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## API Client
|
||||||
|
|
||||||
|
```python
|
||||||
|
from twitchclient.api import TwitchAPIClient
|
||||||
|
|
||||||
|
client = TwitchAPIClient(
|
||||||
|
client_id="CLIENT_ID",
|
||||||
|
client_secret="CLIENT_SECRET",
|
||||||
|
redirect_uri="https://your.app/callback",
|
||||||
|
redis_url="redis://localhost:6379", # optional
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
* Base URL: `https://api.twitch.tv/helix`
|
||||||
|
* `Client-Id` header is set automatically
|
||||||
|
* Rate limit defaults to **700 req/min** when Redis is enabled
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Example usage
|
||||||
|
|
||||||
|
### Get channel information
|
||||||
|
|
||||||
|
```python
|
||||||
|
channels = await client.get_channel_information(
|
||||||
|
access_token=token.access_token,
|
||||||
|
broadcaster_id=123456,
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Start a commercial
|
||||||
|
|
||||||
|
```python
|
||||||
|
await client.start_commercial(
|
||||||
|
access_token=token.access_token,
|
||||||
|
broadcaster_id=123456,
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Cached request
|
||||||
|
|
||||||
|
Caching is controlled via the `X-Cache-TTL` header:
|
||||||
|
|
||||||
|
```python
|
||||||
|
streams = await client.get_streams(
|
||||||
|
access_token=token.access_token,
|
||||||
|
game_id=509658,
|
||||||
|
cache_time=30,
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Rate limiting & caching
|
||||||
|
|
||||||
|
* **Redis-backed**
|
||||||
|
* Shared key: `twitch`
|
||||||
|
* Enabled automatically when `redis_url` is provided
|
||||||
|
* Cache TTL is per-request (`X-Cache-TTL` header)
|
||||||
|
|
||||||
|
Implementation is inherited from **AioHTTPX transports** .
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Errors
|
||||||
|
|
||||||
|
All API methods raise typed exceptions:
|
||||||
|
|
||||||
|
* `ClientError(status_code, message)`
|
||||||
|
* `InternalError(status_code, message)`
|
||||||
|
|
||||||
|
Defined in schema module .
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Scopes
|
||||||
|
|
||||||
|
OAuth scopes are defined as constants and typed literals:
|
||||||
|
|
||||||
|
```python
|
||||||
|
from twitchclient import scopes
|
||||||
|
|
||||||
|
scopes.CHANNEL_READ_SUBSCRIPTIONS
|
||||||
|
scopes.CHAT_READ
|
||||||
|
```
|
||||||
|
|
||||||
|
See `scopes.py` for the full list .
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Typed responses
|
||||||
|
|
||||||
|
All successful responses return **Pydantic models**, e.g.:
|
||||||
|
|
||||||
|
* `ChannelsInformation`
|
||||||
|
* `Streams`
|
||||||
|
* `Users`
|
||||||
|
* `EventsubSubscriptions`
|
||||||
|
|
||||||
|
Models live in `schema.py` .
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Notes & limitations
|
||||||
|
|
||||||
|
* Async-only (no sync client)
|
||||||
|
* Internal API, no stability guarantees
|
||||||
|
* Some endpoints still marked TODO (e.g. Guest Star)
|
||||||
|
|
||||||
|
---
|
||||||
|
|||||||
@ -1,16 +1,11 @@
|
|||||||
[project]
|
[project]
|
||||||
name = "twitchclient"
|
name = "twitchclient"
|
||||||
version = "1.0.2"
|
version = "1.1.0"
|
||||||
description = "Client for Twitch API"
|
description = "Client for Twitch API"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
authors = [
|
authors = [{ name = "Miwory", email = "miwory.uwu@gmail.com" }]
|
||||||
{ name = "Miwory", email = "miwory.uwu@gmail.com" }
|
|
||||||
]
|
|
||||||
requires-python = ">=3.13"
|
requires-python = ">=3.13"
|
||||||
dependencies = [
|
dependencies = ["aiohttpx>=1.3,<=2.0", "pydantic>=2.12,<=2.13"]
|
||||||
"aiohttpx>=1.3,<=2.0",
|
|
||||||
"pydantic>=2.12,<=2.13",
|
|
||||||
]
|
|
||||||
|
|
||||||
[build-system]
|
[build-system]
|
||||||
requires = ["uv_build>=0.9.2,<0.10.0"]
|
requires = ["uv_build>=0.9.2,<0.10.0"]
|
||||||
@ -18,10 +13,10 @@ build-backend = "uv_build"
|
|||||||
|
|
||||||
[project.optional-dependencies]
|
[project.optional-dependencies]
|
||||||
dev = [
|
dev = [
|
||||||
"ruff==0.14.9",
|
"ruff==0.14.13",
|
||||||
"pyright==1.1.407",
|
"pyright==1.1.408",
|
||||||
"poethepoet==0.38.0",
|
"poethepoet==0.40.0",
|
||||||
"pre-commit==4.5.0",
|
"pre-commit==4.5.1",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[tool.uv.index]]
|
[[tool.uv.index]]
|
||||||
|
|||||||
@ -13,10 +13,10 @@ from .eventsub import types as sub_type
|
|||||||
class TwitchAPIClient(AioHTTPXClient):
|
class TwitchAPIClient(AioHTTPXClient):
|
||||||
def __init__(
|
def __init__(
|
||||||
self,
|
self,
|
||||||
redis_url: str,
|
|
||||||
client_id: str,
|
client_id: str,
|
||||||
client_secret: str,
|
client_secret: str,
|
||||||
redirect_uri: str,
|
redirect_uri: str,
|
||||||
|
redis_url: str | None = None,
|
||||||
):
|
):
|
||||||
self.base_uri = 'https://api.twitch.tv/helix'
|
self.base_uri = 'https://api.twitch.tv/helix'
|
||||||
self.client_id = client_id
|
self.client_id = client_id
|
||||||
@ -27,8 +27,8 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
base_url=self.base_uri,
|
base_url=self.base_uri,
|
||||||
headers={'Client-Id': self.client_id},
|
headers={'Client-Id': self.client_id},
|
||||||
redis_url=redis_url,
|
redis_url=redis_url,
|
||||||
key='twitch',
|
key='twitch' if redis_url else None,
|
||||||
limit=700,
|
limit=700 if redis_url else None,
|
||||||
logger='Twitch API',
|
logger='Twitch API',
|
||||||
)
|
)
|
||||||
|
|
||||||
@ -631,8 +631,8 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
self,
|
self,
|
||||||
access_token: str,
|
access_token: str,
|
||||||
broadcaster_id: int,
|
broadcaster_id: int,
|
||||||
reward_id: int,
|
reward_id: str,
|
||||||
redemption_id: int | list[int],
|
redemption_id: str | list[str],
|
||||||
status: Literal['CANCELED', 'FULFILLED'],
|
status: Literal['CANCELED', 'FULFILLED'],
|
||||||
):
|
):
|
||||||
req = await self.post(
|
req = await self.post(
|
||||||
@ -702,7 +702,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
@ -728,7 +728,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
cache_time: int | None = None,
|
cache_time: int | None = None,
|
||||||
):
|
):
|
||||||
req = await self.get(
|
req = await self.get(
|
||||||
'/chatters',
|
'/chat/chatters',
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
{
|
{
|
||||||
'broadcaster_id': broadcaster_id,
|
'broadcaster_id': broadcaster_id,
|
||||||
@ -740,7 +740,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
@ -767,7 +767,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params={'broadcaster_id': broadcaster_id},
|
params={'broadcaster_id': broadcaster_id},
|
||||||
@ -791,7 +791,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
@ -818,7 +818,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params={'emote_set_id': emote_set_id},
|
params={'emote_set_id': emote_set_id},
|
||||||
@ -846,7 +846,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params={'broadcaster_id': broadcaster_id},
|
params={'broadcaster_id': broadcaster_id},
|
||||||
@ -870,7 +870,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
@ -898,7 +898,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -931,7 +931,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params={'broadcaster_id': broadcaster_id},
|
params={'broadcaster_id': broadcaster_id},
|
||||||
@ -961,7 +961,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -1146,7 +1146,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params={'user_id': user_id},
|
params={'user_id': user_id},
|
||||||
@ -1231,7 +1231,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -1273,7 +1273,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -1308,7 +1308,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
@ -1390,7 +1390,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -1498,7 +1498,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -1570,7 +1570,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {jwt_token}',
|
'Authorization': f'Bearer {jwt_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -1703,7 +1703,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -1737,7 +1737,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {jwt_token}',
|
'Authorization': f'Bearer {jwt_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params={'extension_id': extension_id},
|
params={'extension_id': extension_id},
|
||||||
@ -1814,7 +1814,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {jwt_token}',
|
'Authorization': f'Bearer {jwt_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -1848,7 +1848,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -1881,7 +1881,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -2023,7 +2023,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -2061,7 +2061,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -2097,7 +2097,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -2131,7 +2131,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params={'broadcaster_id': broadcaster_id},
|
params={'broadcaster_id': broadcaster_id},
|
||||||
@ -2161,7 +2161,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params={'broadcaster_id': broadcaster_id},
|
params={'broadcaster_id': broadcaster_id},
|
||||||
@ -2189,7 +2189,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params={'broadcaster_id': broadcaster_id},
|
params={'broadcaster_id': broadcaster_id},
|
||||||
@ -2248,7 +2248,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params={
|
params={
|
||||||
@ -2509,7 +2509,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -2632,7 +2632,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -2669,7 +2669,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -2750,7 +2750,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -2867,7 +2867,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params={
|
params={
|
||||||
@ -2941,7 +2941,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -3045,7 +3045,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -3201,7 +3201,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -3239,7 +3239,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params={'broadcaster_id': broadcaster_id},
|
params={'broadcaster_id': broadcaster_id},
|
||||||
@ -3409,7 +3409,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -3442,7 +3442,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -3477,7 +3477,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params={'broadcaster_id': broadcaster_id},
|
params={'broadcaster_id': broadcaster_id},
|
||||||
@ -3512,7 +3512,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -3553,7 +3553,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -3623,7 +3623,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -3664,7 +3664,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -3700,7 +3700,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -3733,7 +3733,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params={'broadcaster_id': broadcaster_id},
|
params={'broadcaster_id': broadcaster_id},
|
||||||
@ -3762,7 +3762,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict({'name': name, 'id': team_id}),
|
params=self.clean_dict({'name': name, 'id': team_id}),
|
||||||
@ -3791,7 +3791,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict({'id': user_id, 'login': login}),
|
params=self.clean_dict({'id': user_id, 'login': login}),
|
||||||
@ -3840,7 +3840,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params={'user_id': user_id},
|
params={'user_id': user_id},
|
||||||
@ -3875,7 +3875,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
@ -3960,7 +3960,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
@ -3987,7 +3987,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params={'user_id': user_id},
|
params={'user_id': user_id},
|
||||||
@ -4044,7 +4044,7 @@ class TwitchAPIClient(AioHTTPXClient):
|
|||||||
headers=self.clean_dict(
|
headers=self.clean_dict(
|
||||||
{
|
{
|
||||||
'Authorization': f'Bearer {access_token}',
|
'Authorization': f'Bearer {access_token}',
|
||||||
'X-Cache-TTL': cache_time,
|
'X-Cache-TTL': str(cache_time),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
params=self.clean_dict(
|
params=self.clean_dict(
|
||||||
|
|||||||
@ -10,10 +10,10 @@ from . import scopes
|
|||||||
class TwitchAuthClient(AioHTTPXClient):
|
class TwitchAuthClient(AioHTTPXClient):
|
||||||
def __init__(
|
def __init__(
|
||||||
self,
|
self,
|
||||||
redis_url: str,
|
|
||||||
client_id: str,
|
client_id: str,
|
||||||
client_secret: str,
|
client_secret: str,
|
||||||
redirect_uri: str,
|
redirect_uri: str,
|
||||||
|
redis_url: str | None = None,
|
||||||
):
|
):
|
||||||
self.base_uri = 'https://id.twitch.tv/oauth2'
|
self.base_uri = 'https://id.twitch.tv/oauth2'
|
||||||
self.client_id = client_id
|
self.client_id = client_id
|
||||||
@ -23,8 +23,8 @@ class TwitchAuthClient(AioHTTPXClient):
|
|||||||
super().__init__(
|
super().__init__(
|
||||||
base_url=self.base_uri,
|
base_url=self.base_uri,
|
||||||
redis_url=redis_url,
|
redis_url=redis_url,
|
||||||
key='twitch',
|
key='twitch' if redis_url else None,
|
||||||
limit=700,
|
limit=700 if redis_url else None,
|
||||||
logger='Twitch Auth',
|
logger='Twitch Auth',
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
@ -309,7 +309,7 @@ class CustomReward(BaseSchema):
|
|||||||
broadcaster_id: int
|
broadcaster_id: int
|
||||||
broadcaster_login: str
|
broadcaster_login: str
|
||||||
broadcaster_name: str
|
broadcaster_name: str
|
||||||
id: int
|
id: str
|
||||||
title: str
|
title: str
|
||||||
prompt: str
|
prompt: str
|
||||||
cost: int
|
cost: int
|
||||||
@ -1263,6 +1263,7 @@ class Stream(BaseSchema):
|
|||||||
type: Literal['live']
|
type: Literal['live']
|
||||||
title: str
|
title: str
|
||||||
tags: list[str]
|
tags: list[str]
|
||||||
|
tag_ids: list[str] = Field(..., deprecated=True)
|
||||||
viewer_count: int
|
viewer_count: int
|
||||||
started_at: datetime
|
started_at: datetime
|
||||||
language: str
|
language: str
|
||||||
@ -1389,6 +1390,7 @@ class User(BaseSchema):
|
|||||||
offline_image_url: str
|
offline_image_url: str
|
||||||
email: str | None = None
|
email: str | None = None
|
||||||
created_at: datetime
|
created_at: datetime
|
||||||
|
view_count: int = Field(..., deprecated=True)
|
||||||
|
|
||||||
|
|
||||||
class Users(BaseSchema):
|
class Users(BaseSchema):
|
||||||
|
|||||||
Reference in New Issue
Block a user