Add paginated User.get_watched_movies extraction from #113

Author: Copilot

tests/test_users.py

@@ -1,4 +1,9 @@
 # -*- coding: utf-8 -*-
+from copy import deepcopy
+from urllib.parse import parse_qs, urlsplit
+
+import pytest
+import trakt
 from trakt.movies import Movie
 from trakt.people import Person
 from trakt.tv import TVEpisode, TVSeason, TVShow
@@ -132,6 +137,67 @@ def test_get_watched_movies():
     assert all([isinstance(m, Movie) for m in watched_movies])
 
 
+def test_watched_movies_pagination():
+    sean = User('sean')
+    client = trakt.core.api()
+    request_calls = []
+    original_request = client.request
+
+    def request(method, uri, data=None):
+        request_calls.append((method, uri, data))
+        if uri.startswith('users/sean/watched/movies?'):
+            query = parse_qs(urlsplit(f'https://api.trakt.tv/{uri}').query)
+            if query.get('limit') == ['1']:
+                response = original_request('GET', 'users/sean/watched/movies')
+                return deepcopy(response[:1])
+        if uri == 'users/sean/watched/movies':
+            response = original_request('GET', 'users/sean/watched/movies')
+            return deepcopy(response)
+        return original_request(method, uri, data)
+
+    client.request = request
+    try:
+        expected_uri = 'users/sean/watched/movies?page=2&limit=1'
+        watched_movies = sean.get_watched_movies(page=2, limit=1)
+        assert request_calls[-1] == ('get', expected_uri, None)
+        assert len(watched_movies) == 1
+        assert all([isinstance(movie, Movie) for movie in watched_movies])
+
+        watched_movies = sean.get_watched_movies(limit=1)
+        expected_uri = 'users/sean/watched/movies?limit=1'
+        assert request_calls[-1] == ('get', expected_uri, None)
+        assert len(watched_movies) == 1
+        assert all([isinstance(movie, Movie) for movie in watched_movies])
+
+        watched_movies = sean.watched_movies
+        assert request_calls[-1] == ('get', 'users/sean/watched/movies', None)
+        assert all([isinstance(movie, Movie) for movie in watched_movies])
+    finally:
+        client.request = original_request
+
+
+def test_watched_movies_pagination_validation():
+    sean = User('sean')
+
+    with pytest.raises(ValueError, match='page must be a positive integer'):
+        sean.get_watched_movies(page=0)
+
+    with pytest.raises(ValueError, match='page must be a positive integer'):
+        sean.get_watched_movies(page=-1)
+
+    with pytest.raises(ValueError, match='page must be a valid integer'):
+        sean.get_watched_movies(page='invalid')
+
+    with pytest.raises(ValueError, match='limit must be a positive integer'):
+        sean.get_watched_movies(limit=0)
+
+    with pytest.raises(ValueError, match='limit must be a positive integer'):
+        sean.get_watched_movies(limit=-1)
+
+    with pytest.raises(ValueError, match='limit must be a valid integer'):
+        sean.get_watched_movies(limit='invalid')
+
+
 def test_stats():
     sean = User('sean')
     assert isinstance(sean.get_stats(), dict)

trakt/users.py

@@ -3,13 +3,15 @@
 
 from dataclasses import dataclass, fields
 from typing import Any, NamedTuple, Optional, Union
+from urllib.parse import urlencode
 
 from trakt.core import delete, get, post
 from trakt.mixins import DataClassMixin, IdsMixin
 from trakt.movies import Movie
 from trakt.people import Person
 from trakt.tv import TVEpisode, TVSeason, TVShow
-from trakt.utils import slugify
+from trakt.utils import (slugify,
+                         validate_pagination_param)
 
 __author__ = 'Jon Nappi'
 __all__ = ['User', 'UserList', 'PublicList', 'Request', 'follow', 'get_all_requests',
@@ -523,15 +525,22 @@ def _build_watched_movies(self, data):
         return watched_movies
 
     @get
-    def get_watched_movies(self):
+    def get_watched_movies(self, page=None, limit=None):
         """Watched progress for all :class:`Movie` objects for this
         :class:`User`.
 
         :return: List of :class:`Movie` instances
         """
-        data = yield 'users/{user}/watched/movies'.format(
-            user=slugify(self.username)
-        )
+        uri = 'users/{user}/watched/movies'.format(user=slugify(self.username))
+        params = {}
+        if page is not None:
+            params['page'] = validate_pagination_param('page', page)
+        if limit is not None:
+            params['limit'] = validate_pagination_param('limit', limit)
+        if params:
+            uri += '?' + urlencode(params)
+
+        data = yield uri
         yield self._build_watched_movies(data)
 
     @property

trakt/utils.py

@@ -4,7 +4,8 @@
 from datetime import datetime, timezone
 
 __author__ = 'Jon Nappi'
-__all__ = ['slugify', 'airs_date', 'now', 'timestamp', 'extract_ids']
+__all__ = ['slugify', 'airs_date', 'now', 'timestamp', 'extract_ids',
+           'validate_pagination_param']
 
 
 def slugify(value):
@@ -56,3 +57,22 @@ def extract_ids(id_dict):
     """
     id_dict.update(id_dict.pop('ids', {}))
     return id_dict
+
+
+def validate_pagination_param(name, value):
+    """Validate and coerce a pagination parameter to a positive integer.
+
+    :param name: Parameter name used in error messages.
+    :param value: Value to validate.
+    :return: The validated integer value.
+    :raises ValueError: If value is not a valid positive integer.
+    """
+    try:
+        value = int(value)
+    except (TypeError, ValueError):
+        raise ValueError(f'{name} must be a valid integer')
+
+    if value < 1:
+        raise ValueError(f'{name} must be a positive integer')
+
+    return value