Fixed video pagination. New exceptions for error handling. Improved model relation links. Resource pagination (wip).

Author: PetterKraabol

setup.py

@@ -39,6 +39,6 @@
     test_suite='tests',
     tests_require=test_requirements,
     url='https://github.com/PetterKraabol/Twitch-Python',
-    version='0.0.10',
+    version='0.0.11',
     zip_safe=True,
 )

twitch/__init__.py

@@ -2,7 +2,6 @@
 from .helix import Helix
 from .v5 import V5
 
-
 name = "twitch"
 
 __all__ = [Helix, V5, Chat]

twitch/cache.py

@@ -10,9 +10,8 @@ def __init__(self, duration: timedelta = None):
         self._duration: timedelta = duration or timedelta(minutes=30)
 
     def get(self, key: str, ignore_expiration: bool = False) -> Optional[dict]:
-        if self.has(key):
-            if ignore_expiration or self.expired(key):
-                return self._store[key]['value']
+        if self.has(key) and (ignore_expiration or self.expired(key)):
+            return self._store[key]['value']
 
     def set(self, key: str, value: dict, duration: timedelta = None) -> datetime:
         expiration: datetime = datetime.now() + (duration or self._duration)

twitch/helix/__init__.py

@@ -5,9 +5,9 @@
 from .models import Stream, User, Video, Game
 
 # Resources
-from .streams import Streams
+from .streams import Streams, StreamNotFound
 from .users import Users
 from .videos import Videos
 from .games import Games
 
-__all__ = [Helix, Stream, User, Video, Streams, Users, Videos]
+__all__ = [Helix, Stream, User, Video, Streams, Users, Videos, StreamNotFound]

twitch/helix/games.py

@@ -15,4 +15,5 @@ def __init__(self, api: API, **kwargs: Optional):
                           self._api.get(self._path, params=kwargs)['data']]
 
     def top(self, **kwargs) -> List['helix.Game']:
-        return [helix.Game(api=self._api, data=game) for game in self._api.get('games/top', params=kwargs)['data']]
+        return [helix.Game(api=self._api, data=game) for game in
+                self._api.get(f'{self._path}/top', params=kwargs)['data']]

twitch/helix/helix.py

@@ -1,5 +1,5 @@
 from datetime import timedelta
-from typing import List, Union
+from typing import List, Union, Optional
 
 import twitch.helix as helix
 from twitch.api import API
@@ -9,11 +9,21 @@ class Helix:
     BASE_URL: str = 'https://api.twitch.tv/helix/'
 
     def __init__(self, client_id: str, client_secret: str = None, use_cache: bool = False,
-                 cache_duration: timedelta = timedelta(minutes=30), rate_limit: int = 30):
+                 cache_duration: Optional[timedelta] = None, rate_limit: int = 30):
+        """
+        Helix API (New Twitch API)
+        https://dev.twitch.tv/docs/api/
+
+        :param client_id: Twitch client ID
+        :param client_secret: Twitch client secret
+        :param use_cache: Cache API requests (recommended)
+        :param cache_duration: Cache duration
+        :param rate_limit: API rate limit
+        """
         self.client_id: str = client_id
         self.client_secret: str = client_secret
         self.use_cache: bool = use_cache
-        self.cache_duration: timedelta = cache_duration
+        self.cache_duration: Optional[timedelta] = cache_duration
         self.rate_limit: int = rate_limit
 
     def api(self) -> API:
@@ -25,9 +35,9 @@ def users(self, *args) -> 'helix.Users':
     def user(self, user: Union[str, int]) -> 'helix.User':
         return self.users(user)[0]
 
-    def videos(self, video_ids: Union[str, int, List[Union[str, int]]], **kwargs) -> 'helix.Videos':
-        if type(video_ids) != list:
-            video_ids = [video_ids]
+    def videos(self, video_ids: Union[str, int, List[Union[str, int]]] = None, **kwargs) -> 'helix.Videos':
+        if video_ids and type(video_ids) != list:
+            video_ids = [int(video_ids)]
         return helix.Videos(self.api(), video_ids=video_ids, **kwargs)
 
     def video(self, video_id: Union[str, int] = None, **kwargs) -> 'helix.Video':

twitch/helix/models/game.py

@@ -1,3 +1,4 @@
+import twitch.helix as helix
 from twitch.api import API
 
 
@@ -19,3 +20,6 @@ def __init__(self, api: API, data: dict):
 
     def __str__(self):
         return self.name
+
+    def videos(self, **kwargs) -> 'helix.Videos':
+        return helix.Videos(self._api, game_id=self.id, **kwargs)

twitch/helix/models/stream.py

@@ -28,7 +28,7 @@ def __init__(self, api: API, data: dict):
             self.__dict__[key] = value
 
     def user(self) -> 'helix.User':
-        return helix.Users(self._api, self.user_id)[0]
+        return helix.Users(self._api, int(self.user_id))[0]
 
     def __str__(self):
         return self.title

twitch/helix/models/user.py

@@ -29,7 +29,7 @@ def __str__(self):
         return self.login
 
     def videos(self, **kwargs) -> 'helix.Videos':
-        return helix.Videos(api=self._api, user_id=self.id, **kwargs)
+        return helix.Videos(api=self._api, user_id=int(self.id), **kwargs)
 
     def stream(self) -> 'helix.Stream':
-        return helix.Streams(api=self._api, user_id=self.id)[0]
+        return helix.Streams(api=self._api, user_id=int(self.id))[0]

twitch/helix/models/video.py

@@ -34,8 +34,8 @@ def comments(self) -> 'v5.Comments':
                      use_cache=self._api.use_cache,
                      cache_duration=self._api.cache_duration).comments(self.id)
 
-    def user(self) -> 'helix.Users':
-        return helix.Users(self._api, self.user_id)
+    def user(self) -> 'helix.User':
+        return helix.Users(self._api, int(self.user_id))[0]
 
     def __str__(self):
         return self.title