Add hidden discover methods

Author: meisnate12

VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

tmdbapis/api3.py

@@ -1,10 +1,8 @@
 import logging
 from json.decoder import JSONDecodeError
 from typing import Dict, Optional, Union
-
 from requests import Session, Response
 from requests.exceptions import RequestException
-
 from tmdbapis.api4 import API4
 from tmdbapis.exceptions import TMDbException, NotFound, Unauthorized, WritePermission, PrivateResource, Authentication
 
@@ -821,6 +819,8 @@ def discover_movie_discover(self, **kwargs) -> Dict:
                 with_runtime.gte (Optional[int]): Filter and only include movies that have a runtime that is greater or equal to a value.
                 with_runtime.lte (Optional[int]): Filter and only include movies that have a runtime that is less than or equal to a value.
                 with_original_language (Optional[str]): Specify an ISO 639-1 string to filter results by their original language value.
+                with_title_translation (Optional[str]): Specify a Primary Translation string to filter results by their title translation value.
+                with_overview_translation (Optional[str]): Specify a Primary Translation string to filter results by their overview translation value.
                 with_watch_providers (Optional[str]): A comma or pipe separated list of watch provider ID's. Combine this filter with ``watch_region`` in order to filter your results by a specific watch provider in a specific region.
                 watch_region (Optional[str]): An ISO 3166-1 code. Combine this filter with ``with_watch_providers`` in order to filter your results by a specific watch provider in a specific region.
                 with_watch_monetization_types (Optional[str]): In combination with ``watch_region``, you can filter by monetization type. Allowed Values: ``flatrate``, ``free``, ``ads``, ``rent``, ``buy``
@@ -869,6 +869,8 @@ def discover_tv_discover(self, **kwargs) -> Dict:
                 screened_theatrically (Optional[bool]): Filter results to include items that have been screened theatrically.
                 with_companies (Optional[str]): A comma separated list of production company ID's. Only include movies that have one of the ID's added as a production company.
                 with_keywords (Optional[str]): A comma separated list of keyword ID's. Only includes TV shows that have one of the ID's added as a keyword.
+                with_name_translation (Optional[str]): Specify a Primary Translation string to filter results by their name translation value.
+                with_overview_translation (Optional[str]): Specify a Primary Translation string to filter results by their overview translation value.
                 with_watch_providers (Optional[str]): A comma or pipe separated list of watch provider ID's. Combine this filter with ``watch_region`` in order to filter your results by a specific watch provider in a specific region.
                 watch_region (Optional[str]): An ISO 3166-1 code. Combine this filter with ``with_watch_providers`` in order to filter your results by a specific watch provider in a specific region.
                 with_watch_monetization_types (Optional[str]): In combination with ``watch_region``, you can filter by monetization type. Allowed Values: ``flatrate``, ``free``, ``ads``, ``rent``, ``buy``

tmdbapis/api4.py

@@ -1,12 +1,10 @@
 import logging
 from json.decoder import JSONDecodeError
 from typing import Dict, Optional, Union, List
-
 from requests import Session, Response
 from requests.exceptions import RequestException
-
-from tmdbapis import util
-from tmdbapis.exceptions import TMDbException, NotFound, Unauthorized, WritePermission, PrivateResource, Authentication
+from tmdbapis.exceptions import TMDbException, NotFound, Unauthorized, WritePermission, PrivateResource, \
+    Authentication, Invalid
 
 logger = logging.getLogger(__name__)
 
@@ -389,6 +387,16 @@ def list_delete_list(self, list_id: int) -> Dict:
         """
         return self._delete(f"/list/{list_id}")
 
+    def _items(self, items, comment=False):
+        json = {"items": []}
+        for item in items:
+            if "media_type" not in item or "media_id" not in item or item["media_type"] not in ["movie", "tv"] or \
+                    (comment and "comment" not in item):
+                error = "'media_type', 'media_id', and 'comment'" if comment else "'media_type' and 'media_id'"
+                raise Invalid(f"Each object must have {error}. 'media_type' must be either 'movie' or 'tv'")
+            json["items"].append({"media_type": item["media_type"], "media_id": int(item["media_id"])})
+        return json
+
     def list_add_items(self, list_id: int, items: List[Dict[str, Union[str, int]]]) -> Dict:
         """ `List Add Items <https://developers.themoviedb.org/4/list/add-items>`__
 
@@ -406,7 +414,7 @@ def list_add_items(self, list_id: int, items: List[Dict[str, Union[str, int]]])
                 list_id (int): List ID
                 items (List[Dict[str, Union[str, int]]]): List of items to add. Each item is a dictionary with the format {"media_type": str, "media_id": int}. ``media_type`` can either be ``movie`` or ``tv``.
         """
-        return self._post(f"/list/{list_id}/items", json=util.validate_items(items))
+        return self._post(f"/list/{list_id}/items", json=self._items(items))
 
     def list_update_items(self, list_id: int, items: List[Dict[str, Union[str, int]]]) -> Dict:
         """ `List Update Items <https://developers.themoviedb.org/4/list/update-items>`__
@@ -419,7 +427,7 @@ def list_update_items(self, list_id: int, items: List[Dict[str, Union[str, int]]
                 list_id (int): List ID
                 items (List[Dict[str, Union[str, int]]]): List of items to update. Each item is a dictionary with the format {"media_type": str, "media_id": int, "comment": str}. ``media_type`` can either be ``movie`` or ``tv``.
         """
-        return self._put(f"/list/{list_id}/items", json=util.validate_items(items, comment=True))
+        return self._put(f"/list/{list_id}/items", json=self._items(items, comment=True))
 
     def list_remove_items(self, list_id: int, items: List[Dict[str, Union[str, int]]]) -> Dict:
         """ `List Remove Items <https://developers.themoviedb.org/4/list/remove-items>`__
@@ -432,7 +440,7 @@ def list_remove_items(self, list_id: int, items: List[Dict[str, Union[str, int]]
                 list_id (int): List ID
                 items (List[Dict[str, Union[str, int]]]): List of items to remove. Each item is a dictionary with the format {"media_type": str, "media_id": int}. ``media_type`` can either be ``movie`` or ``tv``.
         """
-        return self._delete(f"/list/{list_id}/items", json=util.validate_items(items))
+        return self._delete(f"/list/{list_id}/items", json=self._items(items))
 
     def list_check_item_status(self, list_id: int, media_id: int, media_type: str) -> Dict:
         """ `List Check Item Status <https://developers.themoviedb.org/4/list/check-item-status>`__

tmdbapis/objs/mixin.py

@@ -1,5 +1,4 @@
 from abc import ABC, abstractmethod
-
 from tmdbapis.exceptions import Invalid
 from tmdbapis.objs.base import TMDbObj
 

tmdbapis/objs/pagination.py

@@ -4,9 +4,12 @@
 
 from tmdbapis.objs.base import TMDbObj
 from tmdbapis.objs.reload import Movie, TVShow
-from tmdbapis import util
 from tmdbapis.exceptions import NotFound, Invalid
 
+v3_sorts = ["created_at.asc", "created_at.desc"]
+v4_movie_sorts = ["created_at.asc", "created_at.desc", "release_date.asc", "release_date.desc", "title.asc", "title.desc", "vote_average.asc", "vote_average.desc"]
+v4_show_sorts = ["created_at.asc", "created_at.desc", "first_air_date.asc", "first_air_date.desc", "name.asc", "name.desc", "vote_average.asc", "vote_average.desc"]
+v4_list_sorts = ["original_order.asc", "original_order.desc", "vote_average.asc", "vote_average.desc", "primary_release_date.asc", "primary_release_date.desc", "title.asc", "title.desc"]
 
 class TMDbPagination(TMDbObj):
     """ Represents a Pagination Object. The standard iterator only loops through the current page.
@@ -118,6 +121,18 @@ def get_results(self, amount: int):
                 results.extend(self.results[:amount-len(results)])
         return results
 
+    def _sort(self, sort_by, v3, is_movie):
+        if not sort_by:
+            return None
+        elif v3 and sort_by not in v3_sorts:
+            raise Invalid(f"sort_by not in {v3_sorts}")
+        elif not v3 and is_movie and sort_by not in v4_movie_sorts:
+            raise Invalid(f"sort_by not in {v4_movie_sorts}")
+        elif not v3 and not is_movie and sort_by not in v4_show_sorts:
+            raise Invalid(f"sort_by not in {v4_show_sorts}")
+        else:
+            return sort_by
+
 
 class CreatedLists(TMDbPagination):
     """ Paginated Object of the lists created by an account. Will include private lists if you are the owner. """
@@ -165,7 +180,7 @@ class FavoriteMovies(TMDbPagination):
     def __init__(self, tmdb, sort_by=None, v3=False):
         self._v3 = v3 or tmdb._api4 is None
         self._loading = True
-        self.sort_by = util.validate_sort(sort_by, self._v3, True)
+        self.sort_by = self._sort(sort_by, self._v3, True)
         self._loading = False
         super().__init__(tmdb, None, "movie", "FavoriteMovies")
 
@@ -185,7 +200,7 @@ class FavoriteTVShows(TMDbPagination):
     def __init__(self, tmdb, sort_by=None, v3=False):
         self._v3 = v3 or tmdb._api4 is None
         self._loading = True
-        self.sort_by = util.validate_sort(sort_by, self._v3, False)
+        self.sort_by = self._sort(sort_by, self._v3, False)
         self._loading = False
         super().__init__(tmdb, None, "tv", "FavoriteTVShows")
 
@@ -204,7 +219,7 @@ class RatedEpisodes(TMDbPagination):
     """
     def __init__(self, tmdb, sort_by=None):
         self._loading = True
-        self.sort_by = util.validate_sort(sort_by, True, False)
+        self.sort_by = self._sort(sort_by, True, False)
         self._loading = False
         super().__init__(tmdb, None, "episode", "RatedEpisodes")
 
@@ -221,7 +236,7 @@ class RatedMovies(TMDbPagination):
     def __init__(self, tmdb, sort_by=None, v3=False):
         self._v3 = v3 or tmdb._api4 is None
         self._loading = True
-        self.sort_by = util.validate_sort(sort_by, self._v3, True)
+        self.sort_by = self._sort(sort_by, self._v3, True)
         self._loading = False
         super().__init__(tmdb, None, "movie", "RatedMovies")
 
@@ -241,7 +256,7 @@ class RatedTVShows(TMDbPagination):
     def __init__(self, tmdb, sort_by=None, v3=False):
         self._v3 = v3 or tmdb._api4 is None
         self._loading = True
-        self.sort_by = util.validate_sort(sort_by, self._v3, False)
+        self.sort_by = self._sort(sort_by, self._v3, False)
         self._loading = False
         super().__init__(tmdb, None, "tv", "RatedTVShows")
 
@@ -276,7 +291,7 @@ class MovieRecommendations(TMDbPagination):
     """
     def __init__(self, tmdb, sort_by=None):
         self._loading = True
-        self.sort_by = util.validate_sort(sort_by, False, True)
+        self.sort_by = self._sort(sort_by, False, True)
         self._loading = False
         super().__init__(tmdb, None, "movie", "MovieRecommendations")
 
@@ -309,7 +324,7 @@ class MovieWatchlist(TMDbPagination):
     def __init__(self, tmdb, sort_by=None, v3=False):
         self._v3 = v3 or tmdb._api4 is None
         self._loading = True
-        self.sort_by = util.validate_sort(sort_by, self._v3, True)
+        self.sort_by = self._sort(sort_by, self._v3, True)
         self._loading = False
         super().__init__(tmdb, None, "movie", "MovieWatchlist")
 
@@ -739,8 +754,8 @@ def update(self, name: Optional[str] = None, description: Optional[str] = None,
         """
         if name is None and description is None and public is None and sort_by is None:
             raise Invalid("Must have at least one parameter to update (name, description, public, or sort_by)")
-        if sort_by and sort_by not in util.v4_list_sorts:
-            raise Invalid(f"sort_by not in {util.v4_list_sorts}")
+        if sort_by and sort_by not in v4_list_sorts:
+            raise Invalid(f"sort_by not in {v4_list_sorts}")
         self._tmdb._v4_check().list_update_list(
             self.id,
             name=name,
@@ -920,7 +935,7 @@ class TVShowRecommendations(TMDbPagination):
     """
     def __init__(self, tmdb, sort_by=None):
         self._loading = True
-        self.sort_by = util.validate_sort(sort_by, False, False)
+        self.sort_by = self._sort(sort_by, False, False)
         self._loading = False
         super().__init__(tmdb, None, "tv", "TVShowRecommendations")
 
@@ -955,7 +970,7 @@ class TVShowWatchlist(TMDbPagination):
     def __init__(self, tmdb, sort_by=None, v3=False):
         self._v3 = v3 or tmdb._api4 is None
         self._loading = True
-        self.sort_by = util.validate_sort(sort_by, self._v3, False)
+        self.sort_by = self._sort(sort_by, self._v3, False)
         self._loading = False
         super().__init__(tmdb, None, "tv", "TVShowWatchlist")
 

tmdbapis/objs/reload.py

@@ -1,6 +1,5 @@
 from abc import abstractmethod
 from typing import Optional, Union
-
 from tmdbapis.objs.base import TMDbObj
 from tmdbapis.objs.mixin import Favorite, Rate, Watchlist