simple-justwatch-python-api 1.0.2__tar.gz → 1.1.0__tar.gz

{simple_justwatch_python_api-1.0.2 → simple_justwatch_python_api-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simple-justwatch-python-api
-Version: 1.0.2
+Version: 1.1.0
 Summary: A simple JustWatch Python API
 Keywords: justwatch,api,graphql
 Author: Electronic Mango
@@ -72,7 +72,8 @@ This Python library has multiple functions:
     offers in multiple countries
  - `providers` - get data about available providers (e.g., Netflix)
 
-Example outputs from all functions are in [`examples/`](examples) directory.
+Example outputs from all functions are in
+[`examples/`](https://github.com/Electronic-Mango/simple-justwatch-python-api/tree/main/examples).
 
 
 
@@ -90,8 +91,9 @@ for entry in results:
 
 ## License
 
-This library is licensed under **MIT license** ([LICENSE](LICENSE) or
-<https://opensource.org/license/MIT>)
+This library is licensed under **MIT license**
+([LICENSE](https://github.com/Electronic-Mango/simple-justwatch-python-api/blob/main/LICENSE)
+or <https://opensource.org/license/MIT>).
 
 
 

{simple_justwatch_python_api-1.0.2 → simple_justwatch_python_api-1.1.0}/README.md

@@ -44,7 +44,8 @@ This Python library has multiple functions:
     offers in multiple countries
  - `providers` - get data about available providers (e.g., Netflix)
 
-Example outputs from all functions are in [`examples/`](examples) directory.
+Example outputs from all functions are in
+[`examples/`](https://github.com/Electronic-Mango/simple-justwatch-python-api/tree/main/examples).
 
 
 
@@ -62,8 +63,9 @@ for entry in results:
 
 ## License
 
-This library is licensed under **MIT license** ([LICENSE](LICENSE) or
-<https://opensource.org/license/MIT>)
+This library is licensed under **MIT license**
+([LICENSE](https://github.com/Electronic-Mango/simple-justwatch-python-api/blob/main/LICENSE)
+or <https://opensource.org/license/MIT>).
 
 
 

{simple_justwatch_python_api-1.0.2 → simple_justwatch_python_api-1.1.0}/pyproject.toml

@@ -3,7 +3,7 @@ name = "simple-justwatch-python-api"
 authors = [
     { name = "Electronic Mango", email = "78230210+Electronic-Mango@users.noreply.github.com" },
 ]
-version = "1.0.2"
+version = "1.1.0"
 description = "A simple JustWatch Python API"
 readme = "README.md"
 license = "MIT"

{simple_justwatch_python_api-1.0.2 → simple_justwatch_python_api-1.1.0}/src/simplejustwatchapi/exceptions.py

@@ -4,14 +4,7 @@ Exceptions raised by this library.
 All exceptions inherit from [`JustWatchError`]
 [simplejustwatchapi.exceptions.JustWatchError] for easier catching.
 
-Specific exceptions are raised for non-`2xx` HTTP response status codes and GraphQL
-API response errors.
-
-Each exception includes relevant information for why it was raised, but not always in
-any particular parsed format. For example, [`JustWatchApiError`]
-[simplejustwatchapi.exceptions.JustWatchApiError] includes the list of errors from the
-API response, but stored as a `dict`/JSON, as it was received from the API.
-
+Specific exceptions are raised for HTTP-related errors and GraphQL API response errors.
 """
 
 
@@ -23,7 +16,7 @@ class JustWatchApiError(JustWatchError):
     """
     Raised when JustWatch API returned errors in JSON response.
 
-    If this error is raised, then API responded with status code `2xx`, but there are
+    If this error is raised, then no HTTP-related error occurred, but there are
     listed errors in the internal JSON response. It can happen for too high complexity
     of request, invalid node ID in functions like [`details`]
     [simplejustwatchapi.justwatch.details], or invalid country or language codes.
@@ -43,18 +36,8 @@ class JustWatchApiError(JustWatchError):
 
 class JustWatchHttpError(JustWatchError):
     """
-    Raised when JustWatch API returned a non-`2xx` status code.
-
-    Any additional verification is not performed, ony the status code is checked.
-
-    Attributes:
-        code (int): HTTP status code returned by the API.
-        message (str): HTTP message response from the API.
+    Raised when HTTP-related error occurs.
 
+    This is a general exception for any HTTP-related errors, such as non-`2xx` status
+    codes, network errors, timeouts, etc.
     """
-
-    def __init__(self, code: int, message: str) -> None:
-        """Init JustWatchHttpError with status code and message from response."""
-        super().__init__(f"HTTP code {code}: {message}")
-        self.code = code
-        self.message = message

simple_justwatch_python_api-1.1.0/src/simplejustwatchapi/graphql.py

@@ -0,0 +1,379 @@
+"""
+Module responsible for preparing full GraphQL queries.
+
+Queries are usually prepared as main query + needed fragments.
+Specific details are stored as separate GraphQL fragments / Python strings for easier
+reuse and maintainability.
+"""
+
+_GRAPHQL_SEARCH_QUERY = """
+query GetSearchTitles(
+    $searchTitlesFilter: TitleFilter!,
+    $country: Country!,
+    $language: Language!,
+    $first: Int!,
+    $formatPoster: ImageFormat,
+    $formatOfferIcon: ImageFormat,
+    $profile: PosterProfile,
+    $backdropProfile: BackdropProfile,
+    $filter: OfferFilter!,
+    $offset: Int = 0,
+) {
+    popularTitles(
+        country: $country
+        filter: $searchTitlesFilter
+        first: $first
+        sortBy: POPULAR
+        sortRandomSeed: 0
+        offset: $offset
+    ) {
+        edges {
+            node {
+                ...TitleDetails
+                __typename
+            }
+            __typename
+        }
+        __typename
+    }
+}
+"""
+
+_GRAPHQL_POPULAR_QUERY = """
+query GetPopularTitles(
+    $popularTitlesFilter: TitleFilter
+    $country: Country!
+    $language: Language!
+    $first: Int! = 70
+    $formatPoster: ImageFormat,
+    $formatOfferIcon: ImageFormat,
+    $profile: PosterProfile
+    $backdropProfile: BackdropProfile,
+    $filter: OfferFilter!,
+    $offset: Int = 0
+) {
+    popularTitles(
+        country: $country
+        filter: $popularTitlesFilter
+        first: $first
+        sortBy: POPULAR
+        sortRandomSeed: 0
+        offset: $offset
+    ) {
+        __typename
+        edges {
+            node {
+                ...TitleDetails
+                __typename
+            }
+            __typename
+        }
+    }
+}
+"""
+
+_GRAPHQL_DETAILS_QUERY = """
+query GetTitleNode(
+    $nodeId: ID!,
+    $language: Language!,
+    $country: Country!,
+    $formatPoster: ImageFormat,
+    $formatOfferIcon: ImageFormat,
+    $profile: PosterProfile,
+    $backdropProfile: BackdropProfile,
+    $filter: OfferFilter!,
+) {
+    node(id: $nodeId) {
+        ...TitleDetails
+        __typename
+    }
+    __typename
+}
+"""
+
+_GRAPHQL_SEASONS_QUERY = """
+query GetTitleNode(
+    $nodeId: ID!,
+    $language: Language!,
+    $country: Country!,
+    $formatPoster: ImageFormat,
+    $formatOfferIcon: ImageFormat,
+    $profile: PosterProfile,
+    $backdropProfile: BackdropProfile,
+    $filter: OfferFilter!,
+) {
+    node(id: $nodeId) {
+        ... on Show {
+            seasons(sortDirection: ASC) {
+                ...TitleDetails
+            }
+        }
+        __typename
+    }
+    __typename
+}
+"""
+
+_GRAPHQL_EPISODES_QUERY = """
+query GetTitleNode(
+    $nodeId: ID!,
+    $language: Language!,
+    $country: Country!,
+    $formatPoster: ImageFormat,
+    $formatOfferIcon: ImageFormat,
+    $profile: PosterProfile,
+    $backdropProfile: BackdropProfile,
+    $filter: OfferFilter!,
+) {
+    node(id: $nodeId) {
+        ... on Season {
+            episodes(sortDirection: ASC) {
+                ...TitleDetails
+            }
+        }
+        __typename
+    }
+    __typename
+}
+"""
+
+_GRAPHQL_PROVIDERS_QUERY = """
+query GetProviders(
+    $country: Country!,
+    $formatOfferIcon: ImageFormat
+) {
+    packages(
+        country: $country
+        platform: WEB
+        includeAddons: true
+    ) {
+        ...PackageDetails
+    }
+    __typename
+}
+"""
+
+_GRAPHQL_OFFERS_BY_COUNTRY_QUERY = """
+query GetTitleOffers(
+    $nodeId: ID!,
+    $language: Language!,
+    $formatOfferIcon: ImageFormat,
+    $filter: OfferFilter!,
+) {{
+    node(id: $nodeId) {{
+        ... on MovieOrShowOrSeasonOrEpisode {{
+            {country_entries}
+            __typename
+        }}
+        __typename
+    }}
+    __typename
+}}
+"""
+
+_GRAPHQL_DETAILS_FRAGMENT = """
+fragment TitleDetails on MovieOrShowOrSeasonOrEpisode {
+    id
+    objectId
+    objectType
+    content(country: $country, language: $language) {
+        ...ContentDetails
+        __typename
+    }
+    ...StreamingChartInfoFragment
+    ... on Show {
+        totalSeasonCount
+    }
+    ... on Season {
+        totalEpisodeCount
+    }
+    offers(country: $country, platform: WEB, filter: $filter) {
+        ...TitleOffer
+    }
+    __typename
+}
+
+fragment StreamingChartInfoFragment on MovieOrShowOrSeason {
+    streamingCharts(country: $country) {
+        edges {
+            streamingChartInfo {
+                rank
+                trend
+                trendDifference
+                daysInTop3
+                daysInTop10
+                daysInTop100
+                daysInTop1000
+                topRank
+                updatedAt
+                __typename
+            }
+            __typename
+        }
+        __typename
+    }
+}
+
+fragment ContentDetails on MovieOrShowOrSeasonOrEpisodeContent {
+    title
+    originalReleaseYear
+    originalReleaseDate
+    runtime
+    shortDescription
+    ...FullContentDetails
+    ... on MovieOrShowContent {
+        ageCertification
+    }
+    ... on SeasonContent {
+        seasonNumber
+    }
+    ... on EpisodeContent {
+        seasonNumber
+        episodeNumber
+    }
+}
+
+fragment FullContentDetails on MovieOrShowOrSeasonContent {
+    fullPath
+    genres {
+        shortName
+        __typename
+    }
+    externalIds {
+        imdbId
+        tmdbId
+        __typename
+    }
+    posterUrl(profile: $profile, format: $formatPoster)
+    backdrops(profile: $backdropProfile, format: $formatPoster) {
+        backdropUrl
+        __typename
+    }
+    scoring {
+        imdbScore
+        imdbVotes
+        tmdbPopularity
+        tmdbScore
+        tomatoMeter
+        certifiedFresh
+        jwRating
+        __typename
+    }
+    interactions {
+        likelistAdditions
+        dislikelistAdditions
+        __typename
+    }
+}
+"""
+
+_GRAPHQL_OFFER_FRAGMENT = """
+fragment TitleOffer on Offer {
+    id
+    monetizationType
+    presentationType
+    retailPrice(language: $language)
+    retailPriceValue
+    currency
+    lastChangeRetailPriceValue
+    type
+    package {
+        ...PackageDetails
+    }
+    standardWebURL
+    elementCount
+    availableTo
+    deeplinkRoku: deeplinkURL(platform: ROKU_OS)
+    subtitleLanguages
+    videoTechnology
+    audioTechnology
+    audioLanguages
+    __typename
+}
+"""
+
+_GRAPHQL_PACKAGE_FRAGMENT = """
+fragment PackageDetails on Package {
+    id
+    packageId
+    clearName
+    technicalName
+    shortName
+    slug
+    monetizationTypes
+    icon(profile: S100, format: $formatOfferIcon)
+    __typename
+}
+"""
+
+_GRAPHQL_COUNTRY_OFFERS_ENTRY = """
+{country_code}: offers(country: {country_code}, platform: WEB, filter: $filter) {{
+    ...TitleOffer
+    __typename
+}}
+"""
+
+GRAPHQL_SEARCH_QUERY = (
+    _GRAPHQL_SEARCH_QUERY
+    + _GRAPHQL_DETAILS_FRAGMENT
+    + _GRAPHQL_OFFER_FRAGMENT
+    + _GRAPHQL_PACKAGE_FRAGMENT
+)
+
+GRAPHQL_POPULAR_QUERY = (
+    _GRAPHQL_POPULAR_QUERY
+    + _GRAPHQL_DETAILS_FRAGMENT
+    + _GRAPHQL_OFFER_FRAGMENT
+    + _GRAPHQL_PACKAGE_FRAGMENT
+)
+
+GRAPHQL_PROVIDERS_QUERY = _GRAPHQL_PROVIDERS_QUERY + _GRAPHQL_PACKAGE_FRAGMENT
+
+GRAPHQL_DETAILS_QUERY = (
+    _GRAPHQL_DETAILS_QUERY
+    + _GRAPHQL_DETAILS_FRAGMENT
+    + _GRAPHQL_OFFER_FRAGMENT
+    + _GRAPHQL_PACKAGE_FRAGMENT
+)
+
+GRAPHQL_SEASONS_QUERY = (
+    _GRAPHQL_SEASONS_QUERY
+    + _GRAPHQL_DETAILS_FRAGMENT
+    + _GRAPHQL_OFFER_FRAGMENT
+    + _GRAPHQL_PACKAGE_FRAGMENT
+)
+
+GRAPHQL_EPISODES_QUERY = (
+    _GRAPHQL_EPISODES_QUERY
+    + _GRAPHQL_DETAILS_FRAGMENT
+    + _GRAPHQL_OFFER_FRAGMENT
+    + _GRAPHQL_PACKAGE_FRAGMENT
+)
+
+
+def graphql_offers_for_countries_query(countries: set[str]) -> str:
+    """
+    Prepare GraphQL query with a list of offers from specified countries.
+
+    The full query is `GetTitleOffers` query with a list of offers per country.
+    No additional information is returned, only offers.
+    Can be used for all entry types - movies, shows, seasons, episodes.
+
+    The input is a set of 2-letter country codes. This function assumes that codes are
+    valid length and the set is not empty; it performs no verification on its own.
+
+    Args:
+        countries (set[str]): 2-letter country codes.
+
+    Returns:
+        (str): GraphQL `GetTitleOffers` query with available offers per country code.
+
+    """
+    offer_requests = [
+        _GRAPHQL_COUNTRY_OFFERS_ENTRY.format(country_code=country_code.upper())
+        for country_code in countries
+    ]
+    main_query = _GRAPHQL_OFFERS_BY_COUNTRY_QUERY.format(
+        country_entries="\n".join(offer_requests)
+    )
+    return main_query + _GRAPHQL_OFFER_FRAGMENT + _GRAPHQL_PACKAGE_FRAGMENT

{simple_justwatch_python_api-1.0.2 → simple_justwatch_python_api-1.1.0}/src/simplejustwatchapi/justwatch.py

@@ -41,13 +41,13 @@ Each function can raise two exceptions:
 | Exception | Cause |
 |-----------|-------|
 | [`JustWatchHttpError`][simplejustwatchapi.exceptions.JustWatchHttpError] | \
-    JustWatch API responded with non-`2xx` code. |
+    HTTP error occurred, e.g., JustWatch API responded with non-`2xx` status code. |
 | [`JustWatchApiError`][simplejustwatchapi.exceptions.JustWatchApiError] | \
-    JSON response from JustWatch API contains errors (e.g., due to invalid language or \
-    country code). If this exception is raised, then API responded with `2xx` code. |
+    JSON response from JustWatch API contains errors, e.g., due to invalid language or \
+    country code. |
 """
 
-from httpx import post
+from httpx import HTTPError, post
 
 from simplejustwatchapi.exceptions import JustWatchHttpError
 from simplejustwatchapi.query import (
@@ -154,7 +154,8 @@ def search(
     Raises:
         exceptions.JustWatchApiError: JSON response from API has internal errors, e.g.,
             due to invalid language or country code.
-        exceptions.JustWatchHttpError: JustWatch API didn't respond with `2xx` code.
+        exceptions.JustWatchHttpError: HTTP error occurred, e.g., JustWatch API
+            responded with non-`2xx` status code.
 
     """
     request = prepare_search_request(
@@ -238,7 +239,8 @@ def popular(
     Raises:
         exceptions.JustWatchApiError: JSON response from API has internal errors, e.g.,
             due to invalid language or country code.
-        exceptions.JustWatchHttpError: JustWatch API didn't respond with `2xx` code.
+        exceptions.JustWatchHttpError: HTTP error occurred, e.g., JustWatch API
+            responded with non-`2xx` status code.
 
     """
     request = prepare_popular_request(
@@ -307,7 +309,8 @@ def details(
     Raises:
         exceptions.JustWatchApiError: JSON response from API has internal errors, e.g.,
             due to invalid language or country code.
-        exceptions.JustWatchHttpError: JustWatch API didn't respond with `2xx` code.
+        exceptions.JustWatchHttpError: HTTP error occurred, e.g., JustWatch API
+            responded with non-`2xx` status code.
 
     """
     request = prepare_details_request(node_id, country, language, best_only)
@@ -355,7 +358,8 @@ def seasons(
     Raises:
         exceptions.JustWatchApiError: JSON response from API has internal errors, e.g.,
             due to invalid language or country code.
-        exceptions.JustWatchHttpError: JustWatch API didn't respond with `2xx` code.
+        exceptions.JustWatchHttpError: HTTP error occurred, e.g., JustWatch API
+            responded with non-`2xx` status code.
 
     """
     request = prepare_seasons_request(show_id, country, language, best_only)
@@ -404,7 +408,8 @@ def episodes(
     Raises:
         exceptions.JustWatchApiError: JSON response from API has internal errors, e.g.,
             due to invalid language or country code.
-        exceptions.JustWatchHttpError: JustWatch API didn't respond with `2xx` code.
+        exceptions.JustWatchHttpError: HTTP error occurred, e.g., JustWatch API
+            responded with non-`2xx` status code.
 
     """
     request = prepare_episodes_request(season_id, country, language, best_only)
@@ -472,7 +477,8 @@ def offers_for_countries(
     Raises:
         exceptions.JustWatchApiError: JSON response from API has internal errors, e.g.,
             due to invalid language or country code.
-        exceptions.JustWatchHttpError: JustWatch API didn't respond with `2xx` code.
+        exceptions.JustWatchHttpError: HTTP error occurred, e.g., JustWatch API
+            responded with non-`2xx` status code.
 
     """
     if not countries:
@@ -506,7 +512,8 @@ def providers(country: str = "US") -> list[OfferPackage]:
     Raises:
         exceptions.JustWatchApiError: JSON response from API has internal errors, e.g.,
             due to invalid language or country code.
-        exceptions.JustWatchHttpError: JustWatch API didn't respond with `2xx` code.
+        exceptions.JustWatchHttpError: HTTP error occurred, e.g., JustWatch API
+            responded with non-`2xx` status code.
 
     """
     request = prepare_providers_request(country)
@@ -525,10 +532,12 @@ def _post_to_jw_graphql_api(request_json: dict) -> dict:
         (dict): JSON response from the API.
 
     Raises:
-        exceptions.JustWatchHttpError: JustWatch API didn't respond with `2xx` code.
+        exceptions.JustWatchHttpError: HTTP-related error occurred.
 
     """
-    response = post(_GRAPHQL_API_URL, json=request_json)
-    if not response.is_success:
-        raise JustWatchHttpError(response.status_code, response.text)
+    try:
+        response = post(_GRAPHQL_API_URL, json=request_json)
+        response.raise_for_status()
+    except HTTPError as e:
+        raise JustWatchHttpError(str(e)) from e
     return response.json()

{simple_justwatch_python_api-1.0.2 → simple_justwatch_python_api-1.1.0}/src/simplejustwatchapi/query.py

@@ -4,7 +4,7 @@ Module responsible for creating requests to and parsing responses from JustWatch
 Functions are prepared in pairs - prepare request and parse response for specific
 operation. "Request" functions do no verification of input data; "parse" functions check
 if returned JSON/`dict` contain `error` key. In such case a [`JustWatchApiError`]
-[simplejustwatchapi.erxceptions.JustWatchApiError] is raised.
+[simplejustwatchapi.exceptions.JustWatchApiError] is raised.
 
 All "parse" functions convert JSON returned by API into request-specific Python
 [`NamedTuple`][typing.NamedTuple].
@@ -14,13 +14,13 @@ from typing import Any
 
 from simplejustwatchapi.exceptions import JustWatchApiError, JustWatchError
 from simplejustwatchapi.graphql import (
-    graphql_details_query,
-    graphql_episodes_query,
+    GRAPHQL_DETAILS_QUERY,
+    GRAPHQL_EPISODES_QUERY,
+    GRAPHQL_POPULAR_QUERY,
+    GRAPHQL_PROVIDERS_QUERY,
+    GRAPHQL_SEARCH_QUERY,
+    GRAPHQL_SEASONS_QUERY,
     graphql_offers_for_countries_query,
-    graphql_popular_query,
-    graphql_providers_query,
-    graphql_search_query,
-    graphql_seasons_query,
 )
 from simplejustwatchapi.tuples import (
     Episode,
@@ -84,7 +84,7 @@ def prepare_search_request(
             **_locale_variables(country, language),
             "offset": offset or None,
         },
-        "query": graphql_search_query(),
+        "query": GRAPHQL_SEARCH_QUERY,
     }
 
 
@@ -157,7 +157,7 @@ def prepare_popular_request(
             **_locale_variables(country, language),
             "offset": offset or None,
         },
-        "query": graphql_popular_query(),
+        "query": GRAPHQL_POPULAR_QUERY,
     }
 
 
@@ -220,7 +220,7 @@ def prepare_details_request(
             **_common_variables(best_only),
             **_locale_variables(country, language),
         },
-        "query": graphql_details_query(),
+        "query": GRAPHQL_DETAILS_QUERY,
     }
 
 
@@ -279,7 +279,7 @@ def prepare_seasons_request(
             **_common_variables(best_only),
             **_locale_variables(country, language),
         },
-        "query": graphql_seasons_query(),
+        "query": GRAPHQL_SEASONS_QUERY,
     }
 
 
@@ -338,7 +338,7 @@ def prepare_episodes_request(
             **_common_variables(best_only),
             **_locale_variables(country, language),
         },
-        "query": graphql_episodes_query(),
+        "query": GRAPHQL_EPISODES_QUERY,
     }
 
 
@@ -469,7 +469,7 @@ def prepare_providers_request(country: str) -> dict[str, Any]:
             "country": country.upper(),
             "formatOfferIcon": "PNG",
         },
-        "query": graphql_providers_query(),
+        "query": GRAPHQL_PROVIDERS_QUERY,
     }
 
 
@@ -711,5 +711,14 @@ def _parse_package(json: Any) -> OfferPackage:
     name = json.get("clearName")
     technical_name = json.get("technicalName")
     short_name = json.get("shortName")
+    monetization_types = json.get("monetizationTypes", [])
     icon = _IMAGES_URL + icon if (icon := json.get("icon")) else ""
-    return OfferPackage(platform_id, package_id, name, technical_name, short_name, icon)
+    return OfferPackage(
+        platform_id,
+        package_id,
+        name,
+        technical_name,
+        short_name,
+        monetization_types,
+        icon,
+    )

{simple_justwatch_python_api-1.0.2 → simple_justwatch_python_api-1.1.0}/src/simplejustwatchapi/tuples.py

@@ -24,12 +24,14 @@ class OfferPackage(NamedTuple):
     function to return data about all available providers.
 
     Attributes:
-        id (str): ID of the provider/plaform for this offer.
+        id (str): ID of the provider/platform for this offer.
         package_id (int): Package ID. I'm not sure how it's different from regular `id`.
         name (str): Name of the platform in format suited to display for users.
         technical_name (str): Technical name of the platform,
             usually all lowercase with no whitespaces.
         short_name (str): 3-letter provider name.
+        monetization_types (list[str]): List of monetization types available for this
+            provider (e.g., `ADS`, `FLATRATE` (streaming), `RENT`).
         icon (str): Platform icon URL.
 
     """
@@ -39,6 +41,7 @@ class OfferPackage(NamedTuple):
     name: str
     technical_name: str
     short_name: str
+    monetization_types: list[str]
     icon: str
 
 

simple_justwatch_python_api-1.0.2/src/simplejustwatchapi/graphql.py

@@ -1,492 +0,0 @@
-"""
-Module responsible for preparing full GraphQL queries.
-
-Queries are usually prepared as main query + needed fragments.
-Specific details are stored as separate GraphQL fragments / Python strings for easier
-reuse and maintainability.
-
-In the long term these queries should be moved to dedicated GraphQL resource files
-to allow for formatting and syntax checking. However, the functions used for
-constructing full queries shouldn't change.
-"""
-
-# TODO: Convert these strings into resources, e.g.,:
-#       https://docs.python.org/3/library/importlib.resources.html
-
-_GRAPHQL_SEARCH_QUERY = """
-query GetSearchTitles(
-  $searchTitlesFilter: TitleFilter!,
-  $country: Country!,
-  $language: Language!,
-  $first: Int!,
-  $formatPoster: ImageFormat,
-  $formatOfferIcon: ImageFormat,
-  $profile: PosterProfile,
-  $backdropProfile: BackdropProfile,
-  $filter: OfferFilter!,
-  $offset: Int = 0,
-) {
-  popularTitles(
-    country: $country
-    filter: $searchTitlesFilter
-    first: $first
-    sortBy: POPULAR
-    sortRandomSeed: 0
-    offset: $offset
-  ) {
-    edges {
-      node {
-        ...TitleDetails
-        __typename
-      }
-      __typename
-    }
-    __typename
-  }
-}
-"""
-
-_GRAPHQL_POPULAR_QUERY = """
-query GetPopularTitles(
-  $popularTitlesFilter: TitleFilter
-  $country: Country!
-  $language: Language!
-  $first: Int! = 70
-  $formatPoster: ImageFormat,
-  $formatOfferIcon: ImageFormat,
-  $profile: PosterProfile
-  $backdropProfile: BackdropProfile,
-  $filter: OfferFilter!,
-  $offset: Int = 0
-) {
-  popularTitles(
-    country: $country
-    filter: $popularTitlesFilter
-    first: $first
-    sortBy: POPULAR
-    sortRandomSeed: 0
-    offset: $offset
-  ) {
-    __typename
-    edges {
-      node {
-        ...TitleDetails
-        __typename
-      }
-      __typename
-    }
-  }
-}
-"""
-
-_GRAPHQL_DETAILS_QUERY = """
-query GetTitleNode(
-  $nodeId: ID!,
-  $language: Language!,
-  $country: Country!,
-  $formatPoster: ImageFormat,
-  $formatOfferIcon: ImageFormat,
-  $profile: PosterProfile,
-  $backdropProfile: BackdropProfile,
-  $filter: OfferFilter!,
-) {
-  node(id: $nodeId) {
-    ...TitleDetails
-    __typename
-  }
-  __typename
-}
-"""
-
-_GRAPHQL_SEASONS_QUERY = """
-query GetTitleNode(
-  $nodeId: ID!,
-  $language: Language!,
-  $country: Country!,
-  $formatPoster: ImageFormat,
-  $formatOfferIcon: ImageFormat,
-  $profile: PosterProfile,
-  $backdropProfile: BackdropProfile,
-  $filter: OfferFilter!,
-) {
-  node(id: $nodeId) {
-    ...on Show {
-      seasons(sortDirection: ASC) {
-        ...TitleDetails
-      }
-    }
-    __typename
-  }
-  __typename
-}
-"""
-
-_GRAPHQL_EPISODES_QUERY = """
-query GetTitleNode(
-  $nodeId: ID!,
-  $language: Language!,
-  $country: Country!,
-  $formatPoster: ImageFormat,
-  $formatOfferIcon: ImageFormat,
-  $profile: PosterProfile,
-  $backdropProfile: BackdropProfile,
-  $filter: OfferFilter!,
-) {
-  node(id: $nodeId) {
-    ...on Season {
-      episodes(sortDirection: ASC) {
-        ...TitleDetails
-      }
-    }
-    __typename
-  }
-  __typename
-}
-"""
-
-_GRAPHQL_PROVIDERS_QUERY = """
-query GetProviders(
-  $country: Country!,
-  $formatOfferIcon: ImageFormat
-) {
-  packages(
-    country: $country
-    platform: WEB
-    includeAddons: true
-  ) {
-    ... PackageDetails
-  }
-  __typename
-}
-"""
-
-_GRAPHQL_OFFERS_BY_COUNTRY_QUERY = """
-query GetTitleOffers(
-  $nodeId: ID!,
-  $language: Language!,
-  $formatOfferIcon: ImageFormat,
-  $filter: OfferFilter!,
-) {{
-  node(id: $nodeId) {{
-    ... on MovieOrShowOrSeasonOrEpisode {{
-      {country_entries}
-      __typename
-    }}
-    __typename
-  }}
-  __typename
-}}
-"""
-
-_GRAPHQL_DETAILS_FRAGMENT = """
-fragment TitleDetails on MovieOrShowOrSeasonOrEpisode {
-  id
-  objectId
-  objectType
-  content(country: $country, language: $language) {
-    ...ContentDetails
-    __typename
-  }
-  ...StreamingChartInfoFragment
-  ...on Show {
-    totalSeasonCount
-  }
-  ...on Season {
-    totalEpisodeCount
-  }
-  offers(country: $country, platform: WEB, filter: $filter) {
-    ...TitleOffer
-  }
-  __typename
-}
-
-fragment StreamingChartInfoFragment on MovieOrShowOrSeason {
-  streamingCharts(country: $country) {
-    edges {
-      streamingChartInfo {
-        rank
-        trend
-        trendDifference
-        daysInTop3
-        daysInTop10
-        daysInTop100
-        daysInTop1000
-        topRank
-        updatedAt
-        __typename
-      }
-      __typename
-    }
-    __typename
-  }
-}
-
-fragment ContentDetails on MovieOrShowOrSeasonOrEpisodeContent {
-  title
-  originalReleaseYear
-  originalReleaseDate
-  runtime
-  shortDescription
-  ...FullContentDetails
-  ...on MovieOrShowContent {
-    ageCertification
-  }
-  ...on SeasonContent {
-    seasonNumber
-  }
-  ...on EpisodeContent {
-    seasonNumber
-    episodeNumber
-  }
-}
-
-fragment FullContentDetails on MovieOrShowOrSeasonContent {
-  fullPath
-  genres {
-    shortName
-    __typename
-  }
-  externalIds {
-    imdbId
-    tmdbId
-    __typename
-  }
-  posterUrl(profile: $profile, format: $formatPoster)
-  backdrops(profile: $backdropProfile, format: $formatPoster) {
-    backdropUrl
-    __typename
-  }
-  scoring {
-    imdbScore
-    imdbVotes
-    tmdbPopularity
-    tmdbScore
-    tomatoMeter
-    certifiedFresh
-    jwRating
-    __typename
-  }
-  interactions {
-    likelistAdditions
-    dislikelistAdditions
-    __typename
-  }
-}
-"""
-
-_GRAPHQL_OFFER_FRAGMENT = """
-fragment TitleOffer on Offer {
-  id
-  monetizationType
-  presentationType
-  retailPrice(language: $language)
-  retailPriceValue
-  currency
-  lastChangeRetailPriceValue
-  type
-  package {
-    ... PackageDetails
-  }
-  standardWebURL
-  elementCount
-  availableTo
-  deeplinkRoku: deeplinkURL(platform: ROKU_OS)
-  subtitleLanguages
-  videoTechnology
-  audioTechnology
-  audioLanguages
-  __typename
-}
-"""
-
-_GRAPHQL_PACKAGE_FRAGMENT = """
-fragment PackageDetails on Package {
-  id
-  packageId
-  clearName
-  technicalName
-  shortName
-  slug
-  icon(profile: S100, format: $formatOfferIcon)
-  __typename
-}
-"""
-
-_GRAPHQL_COUNTRY_OFFERS_ENTRY = """
-      {country_code}: offers(country: {country_code}, platform: WEB, filter: $filter) {{
-        ...TitleOffer
-        __typename
-      }}
-"""
-
-
-def graphql_search_query() -> str:
-    """
-    Prepare GraphQL query used for searching for entries.
-
-    The full query is:
-
-      - `GetSearchTitles` query
-      - `TitleDetails` fragment
-      - `TitleOffer` fragment
-      - `PackageDetails` fragment
-
-    Returns:
-        (str): Full GraphQL `GetSearchTitles` query.
-
-    """
-    return (
-        _GRAPHQL_SEARCH_QUERY
-        + _GRAPHQL_DETAILS_FRAGMENT
-        + _GRAPHQL_OFFER_FRAGMENT
-        + _GRAPHQL_PACKAGE_FRAGMENT
-    )
-
-
-def graphql_popular_query() -> str:
-    """
-    Prepare GraphQL query used for looking up currently popular titles.
-
-    The full query is:
-
-      - `GetPopularTitles` query
-      - `TitleDetails` fragment
-      - `TitleOffer` fragment
-      - `PackageDetails` fragment
-
-    Returns:
-        (str): Full GraphQL `GetPopularTitles` query.
-
-    """
-    return (
-        _GRAPHQL_POPULAR_QUERY
-        + _GRAPHQL_DETAILS_FRAGMENT
-        + _GRAPHQL_OFFER_FRAGMENT
-        + _GRAPHQL_PACKAGE_FRAGMENT
-    )
-
-
-def graphql_providers_query() -> str:
-    """
-    Prepare GraphQL query used for looking up all providers for a given country.
-
-    The full query is:
-
-      - `GetProviders` query
-      - `PackageDetails` fragment
-
-    Returns:
-      (str): Full GraphQL `GetProviders` query.
-
-    """
-    return _GRAPHQL_PROVIDERS_QUERY + _GRAPHQL_PACKAGE_FRAGMENT
-
-
-def graphql_details_query() -> str:
-    """
-    Prepare GraphQL query used for getting details regarding a single entry.
-
-    The full query is:
-
-      - `GetTitleNode` query
-      - `TitleDetails` fragment
-      - `TitleOffer` fragment
-      - `PackageDetails` fragment
-
-    It is meant for movies and shows, but can be used for seasons and episodes as well,
-    it just won't return full season/episodes list.
-
-    Returns:
-        (str): Full GraphQL `GetTitleNode` query.
-
-    """
-    return (
-        _GRAPHQL_DETAILS_QUERY
-        + _GRAPHQL_DETAILS_FRAGMENT
-        + _GRAPHQL_OFFER_FRAGMENT
-        + _GRAPHQL_PACKAGE_FRAGMENT
-    )
-
-
-def graphql_seasons_query() -> str:
-    """
-    Prepare GraphQL query used for getting a list of seasons for a single show.
-
-    The full query is:
-
-      - `GetTitleNode` query, but only with a list of seasons
-      - `TitleDetails` fragment
-      - `TitleOffer` fragment
-      - `PackageDetails` fragment
-
-    It will only return data for shows with a list of all available seasons, ascending.
-    `TitleDetails` query itself matches [`graphql_details_query`]
-    [simplejustwatchapi.graphql.graphql_details_query], its conditions will return all
-    relevant data for seasons.
-
-    Returns:
-        (str): GraphQL `GetTitleNode` query with a list of seasons.
-
-    """
-    return (
-        _GRAPHQL_SEASONS_QUERY
-        + _GRAPHQL_DETAILS_FRAGMENT
-        + _GRAPHQL_OFFER_FRAGMENT
-        + _GRAPHQL_PACKAGE_FRAGMENT
-    )
-
-
-def graphql_episodes_query() -> str:
-    """
-    Prepare GraphQL query used for getting a list of episodes for a single show season.
-
-    The full query is:
-
-      - `GetTitleNode` query, but only with a list of episodes
-      - `TitleDetails` fragment
-      - `TitleOffer` fragment
-      - `PackageDetails` fragment
-
-    It will only return data for show seasons with a list of all available episodes,
-    ascending. `TitleDetails` query itself matches [`graphql_details_query`]
-    [simplejustwatchapi.graphql.graphql_details_query], its conditions will return all
-    relevant data for episodes.
-
-    Returns:
-        (str): GraphQL `GetTitleNode` query with a list of episods.
-
-    """
-    return (
-        _GRAPHQL_EPISODES_QUERY
-        + _GRAPHQL_DETAILS_FRAGMENT
-        + _GRAPHQL_OFFER_FRAGMENT
-        + _GRAPHQL_PACKAGE_FRAGMENT
-    )
-
-
-def graphql_offers_for_countries_query(countries: set[str]) -> str:
-    """
-    Prepare GraphQL query with a list of offers from specified countries.
-
-    The full query is `GetTitleOffers` query with a list of offers per country.
-    No additional information is returned, only offers.
-    Can be used for all entry types - movies, shows, seasons, episodes.
-
-    The input is a set of 2-letter country codes. This function assumes that codes are
-    valid length and the set is not empty; it performs no verification on its own.
-
-    Args:
-        countries (set[str]): 2-letter country codes.
-
-    Returns:
-        (str): GraphQL `GetTitleOffers` query with available offers per country code.
-
-    """
-    offer_requests = [
-        _GRAPHQL_COUNTRY_OFFERS_ENTRY.format(country_code=country_code.upper())
-        for country_code in countries
-    ]
-    main_query = _GRAPHQL_OFFERS_BY_COUNTRY_QUERY.format(
-        country_entries="\n".join(offer_requests)
-    )
-    return main_query + _GRAPHQL_OFFER_FRAGMENT + _GRAPHQL_PACKAGE_FRAGMENT