"""Show comments functionality."""
from typing import overload
from urllib.parse import quote
from config.api import DEFAULT_LIMIT, DEFAULT_MAX_PAGES, effective_limit
from config.endpoints import TRAKT_ENDPOINTS
from models.types import CommentResponse
from models.types.pagination import PaginatedResponse
from models.types.sort import ShowCommentSort
from utils.api.errors import handle_api_errors
from ..base import BaseClient
class ShowCommentsClient(BaseClient):
"""Client for show comments operations."""
@overload
async def get_show_comments(
self,
show_id: str,
limit: int = DEFAULT_LIMIT,
page: None = None,
sort: ShowCommentSort = "newest",
max_pages: int = DEFAULT_MAX_PAGES,
) -> list[CommentResponse]: ...
@overload
async def get_show_comments(
self,
show_id: str,
limit: int = DEFAULT_LIMIT,
page: int = ...,
sort: ShowCommentSort = "newest",
max_pages: int = DEFAULT_MAX_PAGES,
) -> PaginatedResponse[CommentResponse]: ...
@handle_api_errors
async def get_show_comments(
self,
show_id: str,
limit: int = DEFAULT_LIMIT,
page: int | None = None,
sort: ShowCommentSort = "newest",
max_pages: int = DEFAULT_MAX_PAGES,
) -> list[CommentResponse] | PaginatedResponse[CommentResponse]:
"""Get comments for a show.
Args:
show_id: The Trakt show ID
limit: Controls result size based on pagination mode:
- Auto-pagination (page=None): Maximum TOTAL comments to return
- Single page (page=N): Comments per page in the response
Use limit=0 with page=None to fetch all available results.
page: Page number for single-page mode, or None for auto-pagination.
sort: Sort order for comments
max_pages: Maximum pages to fetch (safety guard for auto-pagination)
Returns:
If page is None: List of up to 'limit' show comments
If page specified: Paginated response with metadata for that page
"""
endpoint = (
TRAKT_ENDPOINTS["comments_show"]
.replace(":id", quote(show_id, safe=""))
.replace(":sort", sort)
)
if page is None:
eff = effective_limit(limit)
return await self.auto_paginate(
endpoint,
response_type=CommentResponse,
params={"limit": eff.api_limit},
max_pages=max_pages,
max_items=eff.max_items,
)
else:
# Single page with metadata
return await self._make_paginated_request(
endpoint,
response_type=CommentResponse,
params={"page": page, "limit": limit},
)
