Merge pull request #145 from DoraFgr/feature/broadcast-search

Author: kraktus

CHANGELOG.rst

@@ -9,6 +9,7 @@ To be released
 
 * Added ``pgn_in_json`` parameter to ``client.games.export``.
 * Implement `broadcasts.get_top()` endpoint; typing fixes and validation.
+* Added ``client.broadcasts.search`` to search for broadcasts.
 * Added ``client.relations.block`` and ``client.relations.unblock`` for blocking/unblocking users.
 * Implemented ``/api/games/export/imports`` under
   ``client.games.export_imported``.

README.rst

@@ -114,6 +114,7 @@ Most of the API is available:
     client.broadcasts.get_pgns
     client.broadcasts.stream_round
     client.broadcasts.get_top
+    client.broadcasts.search
 
     client.bulk_pairings.get_upcoming
     client.bulk_pairings.create

berserk/clients/broadcasts.py

@@ -6,7 +6,7 @@
 from ..formats import PGN
 from .base import BaseClient
 
-from ..types.broadcast import BroadcastPlayer, BroadcastTop
+from ..types.broadcast import BroadcastPlayer, BroadcastTop, PaginatedBroadcasts
 from ..utils import to_str
 
 
@@ -259,3 +259,18 @@ def get_top(
         path = "/api/broadcast/top"
         params = {"page": page, "html": html}
         return cast(BroadcastTop, self._r.get(path, params=params))
+
+    def search(
+        self,
+        query: str,
+        page: int = 1,
+    ) -> PaginatedBroadcasts:
+        """Search for broadcasts.
+
+        :param query: search query text
+        :param page: the page number to fetch (default: 1)
+        :return: paginated list of broadcasts matching the search query
+        """
+        path = "/api/broadcast/search"
+        params = {"q": query, "page": page}
+        return cast(PaginatedBroadcasts, self._r.get(path, params=params))

berserk/types/__init__.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from .account import AccountInformation, Perf, Preferences, Profile, StreamerInfo
-from .broadcast import BroadcastPlayer
+from .broadcast import BroadcastPlayer, BroadcastTop, PaginatedBroadcasts
 from .bulk_pairings import BulkPairing, BulkPairingGame
 from .challenges import ChallengeJson
 from .common import ClockConfig, ExternalEngine, LightUser, OnlineLightUser, VariantKey
@@ -21,6 +21,7 @@
     "AccountInformation",
     "ArenaResult",
     "BroadcastPlayer",
+    "BroadcastTop",
     "BulkPairing",
     "BulkPairingGame",
     "ChallengeJson",
@@ -33,6 +34,7 @@
     "OnlineLightUser",
     "OpeningExplorerRating",
     "OpeningStatistic",
+    "PaginatedBroadcasts",
     "PaginatedTeams",
     "Perf",
     "Preferences",

berserk/types/broadcast.py

@@ -78,7 +78,7 @@ class BroadcastWithLastRound(TypedDict):
     roundToLink: NotRequired[BroadcastRoundInfo]
 
 
-class BroadcastPastPage(TypedDict):
+class PaginatedBroadcasts(TypedDict):
     currentPage: int
     maxPerPage: int
     currentPageResults: List[BroadcastWithLastRound]
@@ -89,4 +89,4 @@ class BroadcastPastPage(TypedDict):
 class BroadcastTop(TypedDict):
     active: List[BroadcastWithLastRound]
     upcoming: List[None]  # deprecated
-    past: BroadcastPastPage
+    past: PaginatedBroadcasts

tests/clients/cassettes/test_broadcasts/TestBroadcasts.test_search.yaml

@@ -1,7 +1,7 @@
 import pytest
 
 from berserk import Client
-from berserk.types.broadcast import BroadcastTop
+from berserk.types import BroadcastTop, PaginatedBroadcasts
 from utils import skip_if_older_3_dot_10, validate
 
 
@@ -11,3 +11,9 @@ class TestBroadcasts:
     def test_get_top(self):
         res = Client().broadcasts.get_top(page=1, html=False)
         validate(BroadcastTop, res)
+
+    @skip_if_older_3_dot_10
+    @pytest.mark.vcr
+    def test_search(self):
+        res = Client().broadcasts.search(query="chess", page=1)
+        validate(PaginatedBroadcasts, res)