deezer-python-gql 0.19.0__tar.gz → 0.20.0__tar.gz

{deezer_python_gql-0.19.0/deezer_python_gql.egg-info → deezer_python_gql-0.20.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deezer-python-gql
-Version: 0.19.0
+Version: 0.20.0
 Summary: Async typed Python client for Deezer's Pipe GraphQL API.
 Author-email: Julian Daberkow <jdaberkow@users.noreply.github.com>
 License: Apache-2.0
@@ -22,7 +22,7 @@ Requires-Dist: pre-commit-hooks==6.0.0; extra == "test"
 Requires-Dist: pytest==9.1.1; extra == "test"
 Requires-Dist: pytest-asyncio==1.4.0; extra == "test"
 Requires-Dist: pytest-cov==7.1.0; extra == "test"
-Requires-Dist: ruff==0.16.8; extra == "test"
+Requires-Dist: ruff==0.16.9; extra == "test"
 Provides-Extra: dev
 Requires-Dist: ariadne-codegen[subscriptions]; extra == "dev"
 Dynamic: license-file
@@ -136,6 +136,7 @@ asyncio.run(main())
 | `get_banned_tracks(first, after)`             | Tracks banned from recommendations, with ban date               |
 | `get_banned_artists(first, after)`            | Artists banned from recommendations, with ban date              |
 | `get_flow_tuner()`                            | Flow tuner: `DEFAULT` or `DISCOVERY`                            |
+| `get_family()`                                | Deezer Family members, with `isLoggableAs` for usable profiles  |
 
 ### Music Together (Collaborative Playlists)
 
@@ -286,6 +287,21 @@ If the ARL is rejected (bad or expired), the client raises
 `GraphQLClientAuthError` — catch it to prompt for a new ARL instead of retrying.
 Transient server errors raise `GraphQLClientHttpError` instead.
 
+### Deezer Family profiles
+
+Profiles of a Deezer Family have no ARL of their own, they share the login of the
+Family admin. Pass `account_id` to act as one of them:
+
+```python
+family = (await client.get_family()).family
+profile = next(m for m in family.linked if m.permissions.is_loggable_as)
+profile_client = DeezerGQLClient(arl="ADMIN_ARL", account_id=profile.id)
+```
+
+Members with their own login (independent accounts) are not loggable, they need their
+own ARL. If Deezer does not sign in as the profile, the client raises
+`GraphQLClientAuthError`.
+
 ## License
 
 Apache-2.0

{deezer_python_gql-0.19.0 → deezer_python_gql-0.20.0}/README.md

@@ -107,6 +107,7 @@ asyncio.run(main())
 | `get_banned_tracks(first, after)`             | Tracks banned from recommendations, with ban date               |
 | `get_banned_artists(first, after)`            | Artists banned from recommendations, with ban date              |
 | `get_flow_tuner()`                            | Flow tuner: `DEFAULT` or `DISCOVERY`                            |
+| `get_family()`                                | Deezer Family members, with `isLoggableAs` for usable profiles  |
 
 ### Music Together (Collaborative Playlists)
 
@@ -257,6 +258,21 @@ If the ARL is rejected (bad or expired), the client raises
 `GraphQLClientAuthError` — catch it to prompt for a new ARL instead of retrying.
 Transient server errors raise `GraphQLClientHttpError` instead.
 
+### Deezer Family profiles
+
+Profiles of a Deezer Family have no ARL of their own, they share the login of the
+Family admin. Pass `account_id` to act as one of them:
+
+```python
+family = (await client.get_family()).family
+profile = next(m for m in family.linked if m.permissions.is_loggable_as)
+profile_client = DeezerGQLClient(arl="ADMIN_ARL", account_id=profile.id)
+```
+
+Members with their own login (independent accounts) are not loggable, they need their
+own ARL. If Deezer does not sign in as the profile, the client raises
+`GraphQLClientAuthError`.
+
 ## License
 
 Apache-2.0

{deezer_python_gql-0.19.0 → deezer_python_gql-0.20.0}/deezer_python_gql/base_client.py

@@ -123,6 +123,9 @@ class DeezerBaseClient:
     :param url: GraphQL endpoint URL (defaults to Pipe API).
     :param session: Optional pre-configured aiohttp.ClientSession.
         If provided, the caller is responsible for closing it.
+    :param account_id: Optional Deezer Family profile to act as. A profile has no
+        ARL of its own; it signs in with the ARL of the Family admin. Only profiles
+        that ``get_family()`` marks as ``isLoggableAs`` can be used.
     """
 
     PIPE_URL = "https://pipe.deezer.com/api"
@@ -136,9 +139,11 @@ class DeezerBaseClient:
         arl: str,
         url: str = PIPE_URL,
         session: ClientSession | None = None,
+        account_id: str | None = None,
     ) -> None:
         self.url = url
         self._arl = arl
+        self._account_id = account_id
         self._session = session
         self._owns_session = session is None
         # An external session may be shared by clients for different Deezer accounts.
@@ -347,12 +352,18 @@ class DeezerBaseClient:
 
             logger.debug("JWT expired or missing, refreshing from ARL")
             params = {"jo": "p", "rto": "c", "i": "c"}
+            body = None
+            if self._account_id:
+                # A Family profile signs in with the admin's ARL and its own id
+                params["i"] = "p"
+                body = {"arl": self._arl, "account_id": self._account_id}
 
             session = self._get_session()
             async with session.post(
                 self.AUTH_URL,
                 params=params,
                 cookies=self._request_cookies(self.AUTH_URL, include_arl=True),
+                json=body,
                 timeout=ClientTimeout(total=10),
             ) as resp:
                 self._store_cookies(resp)
@@ -383,6 +394,10 @@ class DeezerBaseClient:
                 msg = "Unexpected response from auth.deezer.com (invalid or missing JWT)"
                 raise GraphQLClientAuthError(msg) from exc
 
+            if self._account_id and str(payload.get("userId")) != self._account_id:
+                msg = f"auth.deezer.com did not sign in as Family profile {self._account_id}"
+                raise GraphQLClientAuthError(msg)
+
             self._jwt = jwt
             self._jwt_expires_at = expires_at
             logger.debug("JWT acquired, expires at %s", self._jwt_expires_at)

{deezer_python_gql-0.19.0 → deezer_python_gql-0.20.0}/deezer_python_gql/generated/__init__.py

@@ -86,6 +86,8 @@ from .fragments import (
     AudiobookFieldsContributorsEdges,
     AudiobookFieldsContributorsEdgesNodeArtist,
     AudiobookFieldsCover,
+    FamilyProfileFields,
+    FamilyProfileFieldsPermissions,
     LivestreamFields,
     LivestreamFieldsCover,
     LivestreamFieldsMedia,
@@ -205,6 +207,13 @@ from .get_charts import (
     GetChartsChartsCountryTracksEdgesNode,
     GetChartsChartsCountryTracksPageInfo,
 )
+from .get_family import (
+    GetFamily,
+    GetFamilyMe,
+    GetFamilyMeFamily,
+    GetFamilyMeFamilyLinked,
+    GetFamilyMeFamilyMain,
+)
 from .get_favorite_albums import (
     GetFavoriteAlbums,
     GetFavoriteAlbumsMe,
@@ -759,6 +768,8 @@ __all__ = [
     "DeletePlaylistDeletePlaylist",
     "DiscoveryTuner",
     "DiscoveryTunerInput",
+    "FamilyProfileFields",
+    "FamilyProfileFieldsPermissions",
     "GetAlbum",
     "GetAlbumAlbum",
     "GetAlbumAlbumFallback",
@@ -837,6 +848,11 @@ __all__ = [
     "GetChartsChartsCountryTracksEdges",
     "GetChartsChartsCountryTracksEdgesNode",
     "GetChartsChartsCountryTracksPageInfo",
+    "GetFamily",
+    "GetFamilyMe",
+    "GetFamilyMeFamily",
+    "GetFamilyMeFamilyLinked",
+    "GetFamilyMeFamilyMain",
     "GetFavoriteAlbums",
     "GetFavoriteAlbumsMe",
     "GetFavoriteAlbumsMeUserFavorites",

{deezer_python_gql-0.19.0 → deezer_python_gql-0.20.0}/deezer_python_gql/generated/base_client.py

@@ -125,6 +125,9 @@ class DeezerBaseClient:
     :param url: GraphQL endpoint URL (defaults to Pipe API).
     :param session: Optional pre-configured aiohttp.ClientSession.
         If provided, the caller is responsible for closing it.
+    :param account_id: Optional Deezer Family profile to act as. A profile has no
+        ARL of its own; it signs in with the ARL of the Family admin. Only profiles
+        that ``get_family()`` marks as ``isLoggableAs`` can be used.
     """
 
     PIPE_URL = "https://pipe.deezer.com/api"
@@ -138,9 +141,11 @@ class DeezerBaseClient:
         arl: str,
         url: str = PIPE_URL,
         session: ClientSession | None = None,
+        account_id: str | None = None,
     ) -> None:
         self.url = url
         self._arl = arl
+        self._account_id = account_id
         self._session = session
         self._owns_session = session is None
         # An external session may be shared by clients for different Deezer accounts.
@@ -349,12 +354,18 @@ class DeezerBaseClient:
 
             logger.debug("JWT expired or missing, refreshing from ARL")
             params = {"jo": "p", "rto": "c", "i": "c"}
+            body = None
+            if self._account_id:
+                # A Family profile signs in with the admin's ARL and its own id
+                params["i"] = "p"
+                body = {"arl": self._arl, "account_id": self._account_id}
 
             session = self._get_session()
             async with session.post(
                 self.AUTH_URL,
                 params=params,
                 cookies=self._request_cookies(self.AUTH_URL, include_arl=True),
+                json=body,
                 timeout=ClientTimeout(total=10),
             ) as resp:
                 self._store_cookies(resp)
@@ -385,6 +396,10 @@ class DeezerBaseClient:
                 msg = "Unexpected response from auth.deezer.com (invalid or missing JWT)"
                 raise GraphQLClientAuthError(msg) from exc
 
+            if self._account_id and str(payload.get("userId")) != self._account_id:
+                msg = f"auth.deezer.com did not sign in as Family profile {self._account_id}"
+                raise GraphQLClientAuthError(msg)
+
             self._jwt = jwt
             self._jwt_expires_at = expires_at
             logger.debug("JWT acquired, expires at %s", self._jwt_expires_at)

{deezer_python_gql-0.19.0 → deezer_python_gql-0.20.0}/deezer_python_gql/generated/client.py

@@ -65,6 +65,7 @@ from .get_audiobook_chapter import (
 from .get_banned_artists import GetBannedArtists, GetBannedArtistsMe
 from .get_banned_tracks import GetBannedTracks, GetBannedTracksMe
 from .get_charts import GetCharts, GetChartsCharts
+from .get_family import GetFamily, GetFamilyMe
 from .get_favorite_albums import GetFavoriteAlbums, GetFavoriteAlbumsMe
 from .get_favorite_artists import GetFavoriteArtists, GetFavoriteArtistsMe
 from .get_favorite_audiobooks import GetFavoriteAudiobooks, GetFavoriteAudiobooksMe
@@ -1475,6 +1476,38 @@ class DeezerGQLClient(DeezerBaseClient):
         data = self.get_data(response)
         return GetCharts.model_validate(data).charts
 
+    async def get_family(self, **kwargs: Any) -> Optional[GetFamilyMe]:
+        query = gql("""
+            query GetFamily {
+              me {
+                id
+                family {
+                  main {
+                    ...FamilyProfileFields
+                  }
+                  linked {
+                    ...FamilyProfileFields
+                  }
+                }
+              }
+            }
+
+            fragment FamilyProfileFields on FamilyUser {
+              id
+              name
+              caption
+              permissions {
+                isLoggableAs
+              }
+            }
+            """)
+        variables: dict[str, object] = {}
+        response = await self.execute(
+            query=query, operation_name="GetFamily", variables=variables, **kwargs
+        )
+        data = self.get_data(response)
+        return GetFamily.model_validate(data).me
+
     async def get_favorite_albums(
         self,
         first: Union[Optional[int], UnsetType] = UNSET,

{deezer_python_gql-0.19.0 → deezer_python_gql-0.20.0}/deezer_python_gql/generated/fragments.py

@@ -132,6 +132,17 @@ class AudiobookFieldsContributorsEdgesNodeArtist(BaseModel):
     name: str
 
 
+class FamilyProfileFields(BaseModel):
+    id: str
+    name: str
+    caption: str
+    permissions: "FamilyProfileFieldsPermissions"
+
+
+class FamilyProfileFieldsPermissions(BaseModel):
+    is_loggable_as: bool = Field(alias="isLoggableAs")
+
+
 class LivestreamFields(BaseModel):
     id: str
     name: str
@@ -292,6 +303,7 @@ AlbumFields.model_rebuild()
 ArtistFields.model_rebuild()
 AudiobookChapterFields.model_rebuild()
 AudiobookFields.model_rebuild()
+FamilyProfileFields.model_rebuild()
 LivestreamFields.model_rebuild()
 PageInfoFields.model_rebuild()
 PlaylistFields.model_rebuild()

deezer_python_gql-0.20.0/deezer_python_gql/generated/get_family.py

@@ -0,0 +1,34 @@
+# Generated by ariadne-codegen
+# Source: queries
+
+from typing import Optional
+
+from .base_model import BaseModel
+from .fragments import FamilyProfileFields
+
+
+class GetFamily(BaseModel):
+    me: Optional["GetFamilyMe"]
+
+
+class GetFamilyMe(BaseModel):
+    id: str
+    family: Optional["GetFamilyMeFamily"]
+
+
+class GetFamilyMeFamily(BaseModel):
+    main: "GetFamilyMeFamilyMain"
+    linked: list["GetFamilyMeFamilyLinked"]
+
+
+class GetFamilyMeFamilyMain(FamilyProfileFields):
+    pass
+
+
+class GetFamilyMeFamilyLinked(FamilyProfileFields):
+    pass
+
+
+GetFamily.model_rebuild()
+GetFamilyMe.model_rebuild()
+GetFamilyMeFamily.model_rebuild()

{deezer_python_gql-0.19.0 → deezer_python_gql-0.20.0/deezer_python_gql.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deezer-python-gql
-Version: 0.19.0
+Version: 0.20.0
 Summary: Async typed Python client for Deezer's Pipe GraphQL API.
 Author-email: Julian Daberkow <jdaberkow@users.noreply.github.com>
 License: Apache-2.0
@@ -22,7 +22,7 @@ Requires-Dist: pre-commit-hooks==6.0.0; extra == "test"
 Requires-Dist: pytest==9.1.1; extra == "test"
 Requires-Dist: pytest-asyncio==1.4.0; extra == "test"
 Requires-Dist: pytest-cov==7.1.0; extra == "test"
-Requires-Dist: ruff==0.16.8; extra == "test"
+Requires-Dist: ruff==0.16.9; extra == "test"
 Provides-Extra: dev
 Requires-Dist: ariadne-codegen[subscriptions]; extra == "dev"
 Dynamic: license-file
@@ -136,6 +136,7 @@ asyncio.run(main())
 | `get_banned_tracks(first, after)`             | Tracks banned from recommendations, with ban date               |
 | `get_banned_artists(first, after)`            | Artists banned from recommendations, with ban date              |
 | `get_flow_tuner()`                            | Flow tuner: `DEFAULT` or `DISCOVERY`                            |
+| `get_family()`                                | Deezer Family members, with `isLoggableAs` for usable profiles  |
 
 ### Music Together (Collaborative Playlists)
 
@@ -286,6 +287,21 @@ If the ARL is rejected (bad or expired), the client raises
 `GraphQLClientAuthError` — catch it to prompt for a new ARL instead of retrying.
 Transient server errors raise `GraphQLClientHttpError` instead.
 
+### Deezer Family profiles
+
+Profiles of a Deezer Family have no ARL of their own, they share the login of the
+Family admin. Pass `account_id` to act as one of them:
+
+```python
+family = (await client.get_family()).family
+profile = next(m for m in family.linked if m.permissions.is_loggable_as)
+profile_client = DeezerGQLClient(arl="ADMIN_ARL", account_id=profile.id)
+```
+
+Members with their own login (independent accounts) are not loggable, they need their
+own ARL. If Deezer does not sign in as the profile, the client raises
+`GraphQLClientAuthError`.
+
 ## License
 
 Apache-2.0

{deezer_python_gql-0.19.0 → deezer_python_gql-0.20.0}/deezer_python_gql.egg-info/SOURCES.txt

@@ -37,6 +37,7 @@ deezer_python_gql/generated/get_audiobook_chapter.py
 deezer_python_gql/generated/get_banned_artists.py
 deezer_python_gql/generated/get_banned_tracks.py
 deezer_python_gql/generated/get_charts.py
+deezer_python_gql/generated/get_family.py
 deezer_python_gql/generated/get_favorite_albums.py
 deezer_python_gql/generated/get_favorite_artists.py
 deezer_python_gql/generated/get_favorite_audiobooks.py

{deezer_python_gql-0.19.0 → deezer_python_gql-0.20.0}/deezer_python_gql.egg-info/requires.txt

@@ -13,4 +13,4 @@ pre-commit-hooks==6.0.0
 pytest==9.1.1
 pytest-asyncio==1.4.0
 pytest-cov==7.1.0
-ruff==0.16.8
+ruff==0.16.9

{deezer_python_gql-0.19.0 → deezer_python_gql-0.20.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "deezer-python-gql"
-version = "0.19.0"
+version = "0.20.0"
 description = "Async typed Python client for Deezer's Pipe GraphQL API."
 readme = "README.md"
 requires-python = ">=3.12"
@@ -30,7 +30,7 @@ test = [
     "pytest==9.1.1",
     "pytest-asyncio==1.4.0",
     "pytest-cov==7.1.0",
-    "ruff==0.16.8",
+    "ruff==0.16.9",
 ]
 dev = [
     "ariadne-codegen[subscriptions]",
@@ -179,3 +179,8 @@ warn_unused_ignores = true
 [tool.pytest.ini_options]
 addopts = "--cov deezer_python_gql"
 asyncio_mode = "auto"
+
+[tool.uv]
+override-dependencies = [
+    "ruff==0.16.9",
+]

{deezer_python_gql-0.19.0 → deezer_python_gql-0.20.0}/tests/test_client.py

@@ -57,6 +57,7 @@ from deezer_python_gql.generated.get_audiobook_chapter import GetAudiobookChapte
 from deezer_python_gql.generated.get_banned_artists import GetBannedArtists
 from deezer_python_gql.generated.get_banned_tracks import GetBannedTracks
 from deezer_python_gql.generated.get_charts import GetCharts
+from deezer_python_gql.generated.get_family import GetFamily
 from deezer_python_gql.generated.get_favorite_albums import GetFavoriteAlbums
 from deezer_python_gql.generated.get_favorite_artists import GetFavoriteArtists
 from deezer_python_gql.generated.get_favorite_audiobooks import GetFavoriteAudiobooks
@@ -147,11 +148,14 @@ def _load_fixture(name: str) -> dict[str, Any]:
     return result
 
 
-def _make_jwt(exp: float | None = None, subject: str | None = None) -> str:
+def _make_jwt(
+    exp: float | None = None, subject: str | None = None, user_id: str | None = None
+) -> str:
     """
     Build a fake JWT with a configurable expiration timestamp.
 
     :param exp: Unix timestamp for JWT expiry. Defaults to 6 min from now.
+    :param user_id: Optional ``userId`` claim, which Deezer sets to the account id.
     """
     if exp is None:
         exp = time.time() + 360  # 6 min, matching Deezer's real TTL
@@ -159,6 +163,8 @@ def _make_jwt(exp: float | None = None, subject: str | None = None) -> str:
     payload_data: dict[str, float | str] = {"exp": exp}
     if subject is not None:
         payload_data["sub"] = subject
+    if user_id is not None:
+        payload_data["userId"] = user_id
     payload = base64.urlsafe_b64encode(json.dumps(payload_data).encode()).rstrip(b"=").decode()
     return f"{header}.{payload}.fake_signature"
 
@@ -525,6 +531,39 @@ async def test_auth_sends_arl_cookie_to_correct_domain() -> None:
     assert auth_call.kwargs["cookies"] == {"arl": "my_secret_arl"}
 
 
+@pytest.mark.asyncio
+async def test_auth_family_profile_signs_in_with_account_id() -> None:
+    """Verify a Family profile sends the admin's ARL and its id in the payload."""
+    client = DeezerBaseClient(arl="admin_arl", account_id="456")
+
+    with patch("deezer_python_gql.base_client.ClientSession") as mock_cls:
+        mock_instance = MagicMock()
+        mock_instance.post = MagicMock(return_value=_mock_auth_cm(_make_jwt(user_id="456")))
+        mock_instance.close = AsyncMock()
+        mock_cls.return_value = mock_instance
+
+        await client._ensure_jwt()  # noqa: SLF001
+
+    auth_call = mock_instance.post.call_args
+    assert auth_call.kwargs["params"]["i"] == "p"
+    assert auth_call.kwargs["json"] == {"arl": "admin_arl", "account_id": "456"}
+
+
+@pytest.mark.asyncio
+async def test_auth_family_profile_rejects_a_token_for_another_account() -> None:
+    """Verify a token for another account is never used for a Family profile."""
+    client = DeezerBaseClient(arl="admin_arl", account_id="456")
+
+    with patch("deezer_python_gql.base_client.ClientSession") as mock_cls:
+        mock_instance = MagicMock()
+        mock_instance.post = MagicMock(return_value=_mock_auth_cm(_make_jwt(user_id="123")))
+        mock_instance.close = AsyncMock()
+        mock_cls.return_value = mock_instance
+
+        with pytest.raises(GraphQLClientAuthError, match="Family profile 456"):
+            await client._ensure_jwt()  # noqa: SLF001
+
+
 @pytest.mark.parametrize(("first_arl", "second_arl"), [("arl-a", "arl-b"), ("arl-b", "arl-a")])
 @pytest.mark.asyncio
 async def test_shared_session_keeps_account_cookies_isolated(
@@ -1969,3 +2008,16 @@ def test_smoke_get_infinite_track_mix() -> None:
     data = _load_fixture("get_infinite_track_mix.json")
     mix = GetInfiniteTrackMix.model_validate(data).raw_infinite_track_mix
     assert [t.id for t in mix.tracks] == ["3135554", "3155977", "10284909"]
+
+
+def test_smoke_get_family() -> None:
+    """Verify GetFamily fixture parses the admin, a profile and an independent account."""
+    data = _load_fixture("get_family.json")
+    me = GetFamily.model_validate(data).me
+    assert me is not None
+    assert me.family is not None
+    assert me.family.main.id == me.id
+    assert [(m.id, m.permissions.is_loggable_as) for m in me.family.linked] == [
+        ("2002", True),
+        ("3003", False),
+    ]