deezer-python-gql 0.21.0__tar.gz → 0.22.1__tar.gz

{deezer_python_gql-0.21.0/deezer_python_gql.egg-info → deezer_python_gql-0.22.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deezer-python-gql
-Version: 0.21.0
+Version: 0.22.1
 Summary: Async typed Python client for Deezer's Pipe GraphQL API.
 Author-email: Julian Daberkow <jdaberkow@users.noreply.github.com>
 License: Apache-2.0
@@ -16,13 +16,13 @@ Requires-Dist: pydantic>=2.0.0
 Requires-Dist: yarl>=1.22.0
 Provides-Extra: test
 Requires-Dist: codespell==2.4.3; extra == "test"
-Requires-Dist: mypy==2.4.0; extra == "test"
+Requires-Dist: mypy==2.4.1; extra == "test"
 Requires-Dist: pre-commit==4.7.0; extra == "test"
 Requires-Dist: pre-commit-hooks==6.0.0; extra == "test"
-Requires-Dist: pytest==9.1.1; extra == "test"
-Requires-Dist: pytest-asyncio==1.4.1; extra == "test"
+Requires-Dist: pytest==9.2.0; extra == "test"
+Requires-Dist: pytest-asyncio==1.4.1.post1; extra == "test"
 Requires-Dist: pytest-cov==7.1.0; extra == "test"
-Requires-Dist: ruff==0.17.2; extra == "test"
+Requires-Dist: ruff==0.17.3; extra == "test"
 Provides-Extra: dev
 Requires-Dist: ariadne-codegen[subscriptions]; extra == "dev"
 Dynamic: license-file

{deezer_python_gql-0.21.0 → deezer_python_gql-0.22.1}/deezer_python_gql/base_client.py

@@ -11,6 +11,7 @@ from dataclasses import dataclass
 from typing import TYPE_CHECKING, Any, ClassVar, Self, cast
 
 from aiohttp import ClientSession, ClientTimeout
+from pydantic_core import to_jsonable_python
 from yarl import URL
 
 if TYPE_CHECKING:
@@ -227,8 +228,11 @@ class DeezerBaseClient:
             # Inline import avoids depending on generated code at module level.
             from deezer_python_gql.generated.base_model import UnsetType  # noqa: PLC0415
 
+            # input types are pydantic models, sent under their GraphQL field names
             payload["variables"] = {
-                k: v for k, v in variables.items() if not isinstance(v, UnsetType)
+                k: to_jsonable_python(v, by_alias=True)
+                for k, v in variables.items()
+                if not isinstance(v, UnsetType)
             }
 
         session = self._get_session()

{deezer_python_gql-0.21.0 → deezer_python_gql-0.22.1}/deezer_python_gql/generated/__init__.py

@@ -63,10 +63,12 @@ from .enums import (
     AudiobookContributorRoles,
     DiscoveryTuner,
     DiscoveryTunerInput,
+    MediaTypeInput,
     MusicTogetherRefreshSuggestedTracklistMoodInput,
     MusicTogetherSuggestedTracklistMoodInput,
     PodcastEpisodeOrder,
     PodcastType,
+    RepeatModeInput,
     TrackContributorRoles,
 )
 from .fragments import (
@@ -551,6 +553,12 @@ from .get_user_playlists import (
     GetUserPlaylistsMePlaylistsEdgesNode,
     GetUserPlaylistsMePlaylistsPageInfo,
 )
+from .input_types import (
+    PushQueueContextInput,
+    PushQueueMediaInput,
+    PushQueueStateClientDetailsInput,
+    PushQueueStateInput,
+)
 from .mark_as_not_played_podcast_episode import (
     MarkAsNotPlayedPodcastEpisode,
     MarkAsNotPlayedPodcastEpisodeMarkAsNotPlayedPodcastEpisode,
@@ -599,6 +607,13 @@ from .music_together_update_group_settings import (
     MusicTogetherUpdateGroupSettingsMusicTogetherUpdateGroupSettingsMusicTogetherUpdateGroupSettingsOutput,
     MusicTogetherUpdateGroupSettingsMusicTogetherUpdateGroupSettingsMusicTogetherUpdateGroupSettingsOutputGroup,
 )
+from .push_queue_state import (
+    PushQueueState,
+    PushQueueStatePushQueueStatePushQueueStateError,
+    PushQueueStatePushQueueStatePushQueueStateErrorConflict,
+    PushQueueStatePushQueueStatePushQueueStateErrorConflictCurrent,
+    PushQueueStatePushQueueStatePushQueueStateOutput,
+)
 from .remove_album_from_favorite import (
     RemoveAlbumFromFavorite,
     RemoveAlbumFromFavoriteRemoveAlbumFromFavorite,
@@ -1147,6 +1162,7 @@ __all__ = [
     "MarkAsPlayedPodcastEpisode",
     "MarkAsPlayedPodcastEpisodeMarkAsPlayedPodcastEpisode",
     "MarkAsPlayedPodcastEpisodeMarkAsPlayedPodcastEpisodeBookmark",
+    "MediaTypeInput",
     "MoveTrackInPlaylist",
     "MoveTrackInPlaylistMoveTrackInPlaylist",
     "MusicTogetherCreateGroup",
@@ -1185,6 +1201,15 @@ __all__ = [
     "PodcastFields",
     "PodcastFieldsCover",
     "PodcastType",
+    "PushQueueContextInput",
+    "PushQueueMediaInput",
+    "PushQueueState",
+    "PushQueueStateClientDetailsInput",
+    "PushQueueStateInput",
+    "PushQueueStatePushQueueStatePushQueueStateError",
+    "PushQueueStatePushQueueStatePushQueueStateErrorConflict",
+    "PushQueueStatePushQueueStatePushQueueStateErrorConflictCurrent",
+    "PushQueueStatePushQueueStatePushQueueStateOutput",
     "RemoveAlbumFromFavorite",
     "RemoveAlbumFromFavoriteRemoveAlbumFromFavorite",
     "RemoveAlbumFromFavoriteRemoveAlbumFromFavoriteAlbum",
@@ -1204,6 +1229,7 @@ __all__ = [
     "RemoveTrackFromFavoriteRemoveTrackFromFavoriteTrack",
     "RemoveTracksFromPlaylist",
     "RemoveTracksFromPlaylistRemoveTracksFromPlaylist",
+    "RepeatModeInput",
     "Search",
     "SearchFlows",
     "SearchFlowsSearch",

{deezer_python_gql-0.21.0 → deezer_python_gql-0.22.1}/deezer_python_gql/generated/base_client.py

@@ -13,6 +13,7 @@ from dataclasses import dataclass
 from typing import TYPE_CHECKING, Any, ClassVar, Self, cast
 
 from aiohttp import ClientSession, ClientTimeout
+from pydantic_core import to_jsonable_python
 from yarl import URL
 
 if TYPE_CHECKING:
@@ -229,8 +230,11 @@ class DeezerBaseClient:
             # Inline import avoids depending on generated code at module level.
             from deezer_python_gql.generated.base_model import UnsetType  # noqa: PLC0415
 
+            # input types are pydantic models, sent under their GraphQL field names
             payload["variables"] = {
-                k: v for k, v in variables.items() if not isinstance(v, UnsetType)
+                k: to_jsonable_python(v, by_alias=True)
+                for k, v in variables.items()
+                if not isinstance(v, UnsetType)
             }
 
         session = self._get_session()

{deezer_python_gql-0.21.0 → deezer_python_gql-0.22.1}/deezer_python_gql/generated/client.py

@@ -119,6 +119,7 @@ from .get_track_mix import GetTrackMix, GetTrackMixTrackMix
 from .get_tracks_by_ids import GetTracksByIds, GetTracksByIdsTracksByIds
 from .get_user_charts import GetUserCharts, GetUserChartsMe
 from .get_user_playlists import GetUserPlaylists, GetUserPlaylistsMe
+from .input_types import PushQueueStateInput
 from .mark_as_not_played_podcast_episode import (
     MarkAsNotPlayedPodcastEpisode,
     MarkAsNotPlayedPodcastEpisodeMarkAsNotPlayedPodcastEpisode,
@@ -160,6 +161,11 @@ from .music_together_update_group_settings import (
     MusicTogetherUpdateGroupSettingsMusicTogetherUpdateGroupSettingsMusicTogetherUpdateGroupSettingsError,
     MusicTogetherUpdateGroupSettingsMusicTogetherUpdateGroupSettingsMusicTogetherUpdateGroupSettingsOutput,
 )
+from .push_queue_state import (
+    PushQueueState,
+    PushQueueStatePushQueueStatePushQueueStateError,
+    PushQueueStatePushQueueStatePushQueueStateOutput,
+)
 from .remove_album_from_favorite import (
     RemoveAlbumFromFavorite,
     RemoveAlbumFromFavoriteRemoveAlbumFromFavorite,
@@ -4469,6 +4475,37 @@ class DeezerGQLClient(DeezerBaseClient):
         data = self.get_data(response)
         return MoveTrackInPlaylist.model_validate(data).move_track_in_playlist
 
+    async def push_queue_state(
+        self, input: PushQueueStateInput, **kwargs: Any
+    ) -> Union[
+        PushQueueStatePushQueueStatePushQueueStateOutput,
+        PushQueueStatePushQueueStatePushQueueStateError,
+    ]:
+        query = gql("""
+            mutation PushQueueState($input: PushQueueStateInput!) {
+              pushQueueState(input: $input) {
+                __typename
+                ... on PushQueueStateOutput {
+                  version
+                }
+                ... on PushQueueStateError {
+                  isBadRequest
+                  conflict {
+                    current {
+                      version
+                    }
+                  }
+                }
+              }
+            }
+            """)
+        variables: dict[str, object] = {"input": input}
+        response = await self.execute(
+            query=query, operation_name="PushQueueState", variables=variables, **kwargs
+        )
+        data = self.get_data(response)
+        return PushQueueState.model_validate(data).push_queue_state
+
     async def ban_track_from_recommendation(
         self, track_id: str, **kwargs: Any
     ) -> BanTrackFromRecommendationBanTrackFromRecommendation:

{deezer_python_gql-0.21.0 → deezer_python_gql-0.22.1}/deezer_python_gql/generated/enums.py

@@ -46,6 +46,20 @@ class PodcastEpisodeOrder(str, Enum):
     LATEST = "LATEST"
 
 
+class MediaTypeInput(str, Enum):
+    TRACK = "TRACK"
+    EPISODE = "EPISODE"
+    CHAPTER = "CHAPTER"
+    LIVE = "LIVE"
+    RAW_URL = "RAW_URL"
+
+
+class RepeatModeInput(str, Enum):
+    NONE = "NONE"
+    ONE = "ONE"
+    ALL = "ALL"
+
+
 class DiscoveryTuner(str, Enum):
     DEFAULT = "DEFAULT"
     DISCOVERY = "DISCOVERY"

deezer_python_gql-0.22.1/deezer_python_gql/generated/input_types.py

@@ -0,0 +1,62 @@
+# Generated by ariadne-codegen
+# Source: schema.graphql
+
+from typing import Optional
+
+from pydantic import Field
+
+from .base_model import BaseModel
+from .enums import MediaTypeInput, RepeatModeInput
+
+
+class PushQueueStateInput(BaseModel):
+    client_details: "PushQueueStateClientDetailsInput" = Field(alias="clientDetails")
+    "Details about the client pushing the queue state"
+    media_list: list["PushQueueMediaInput"] = Field(alias="mediaList")
+    "List of all media in the queue in playing order"
+    position: int
+    "Zero based index of the current playback position in the queue"
+    progress_ms: Optional[int] = Field(alias="progressMS", default=None)
+    "Progress in the current media in ms"
+    previous_version: Optional[str] = Field(alias="previousVersion", default=None)
+    "Previous known queue state version\nNote: Except when there is no queue state available, this version MUST be provided otherwise you'll get a conflict error"
+    queue_configuration: str = Field(alias="queueConfiguration")
+    "Queue's configuration"
+    repeat_mode: RepeatModeInput = Field(alias="repeatMode")
+    "Queue repeat mode"
+    contexts: Optional[list["PushQueueContextInput"]] = None
+    "The list of unique contexts referenced by mediaList.contextId"
+
+
+class PushQueueMediaInput(BaseModel):
+    """Details of media that belongs to the pushed queue"""
+
+    id: str
+    "The media id"
+    type_: MediaTypeInput = Field(alias="type")
+    "The media type"
+    context_id: Optional[str] = Field(alias="contextId", default=None)
+    'The context identifier, it should correspond to an entry in "PushQueueStateInput.contexts"\nEach media can have its own context or share multiple time the same context by using the same contextId'
+    local_queue_item_id: Optional[str] = Field(alias="localQueueItemId", default=None)
+    "Item identifier used on client side"
+    unshuffled_position: int = Field(alias="unshuffledPosition")
+    "The position within the unshuffled version of the queue"
+
+
+class PushQueueContextInput(BaseModel):
+    id: str
+    "Context identifier"
+    content: str
+    "The context content itself"
+
+
+class PushQueueStateClientDetailsInput(BaseModel):
+    """Details about the client that wants to push the queue state"""
+
+    local_queue_id: str = Field(alias="localQueueID")
+    "Identifier of the client's local queue, doesn't necessarily match a real queue id"
+    locally_updated_at: str = Field(alias="locallyUpdatedAt")
+    "Date in ISO-8601 format including milliseconds when update was made on client"
+
+
+PushQueueStateInput.model_rebuild()

deezer_python_gql-0.22.1/deezer_python_gql/generated/push_queue_state.py

@@ -0,0 +1,39 @@
+# Generated by ariadne-codegen
+# Source: queries
+
+from typing import Literal, Optional, Union
+
+from pydantic import Field
+
+from .base_model import BaseModel
+
+
+class PushQueueState(BaseModel):
+    push_queue_state: Union[
+        "PushQueueStatePushQueueStatePushQueueStateOutput",
+        "PushQueueStatePushQueueStatePushQueueStateError",
+    ] = Field(alias="pushQueueState", discriminator="typename__")
+
+
+class PushQueueStatePushQueueStatePushQueueStateOutput(BaseModel):
+    typename__: Literal["PushQueueStateOutput"] = Field(alias="__typename")
+    version: str
+
+
+class PushQueueStatePushQueueStatePushQueueStateError(BaseModel):
+    typename__: Literal["PushQueueStateError"] = Field(alias="__typename")
+    is_bad_request: bool = Field(alias="isBadRequest")
+    conflict: Optional["PushQueueStatePushQueueStatePushQueueStateErrorConflict"]
+
+
+class PushQueueStatePushQueueStatePushQueueStateErrorConflict(BaseModel):
+    current: Optional["PushQueueStatePushQueueStatePushQueueStateErrorConflictCurrent"]
+
+
+class PushQueueStatePushQueueStatePushQueueStateErrorConflictCurrent(BaseModel):
+    version: str
+
+
+PushQueueState.model_rebuild()
+PushQueueStatePushQueueStatePushQueueStateError.model_rebuild()
+PushQueueStatePushQueueStatePushQueueStateErrorConflict.model_rebuild()

{deezer_python_gql-0.21.0 → deezer_python_gql-0.22.1/deezer_python_gql.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deezer-python-gql
-Version: 0.21.0
+Version: 0.22.1
 Summary: Async typed Python client for Deezer's Pipe GraphQL API.
 Author-email: Julian Daberkow <jdaberkow@users.noreply.github.com>
 License: Apache-2.0
@@ -16,13 +16,13 @@ Requires-Dist: pydantic>=2.0.0
 Requires-Dist: yarl>=1.22.0
 Provides-Extra: test
 Requires-Dist: codespell==2.4.3; extra == "test"
-Requires-Dist: mypy==2.4.0; extra == "test"
+Requires-Dist: mypy==2.4.1; extra == "test"
 Requires-Dist: pre-commit==4.7.0; extra == "test"
 Requires-Dist: pre-commit-hooks==6.0.0; extra == "test"
-Requires-Dist: pytest==9.1.1; extra == "test"
-Requires-Dist: pytest-asyncio==1.4.1; extra == "test"
+Requires-Dist: pytest==9.2.0; extra == "test"
+Requires-Dist: pytest-asyncio==1.4.1.post1; extra == "test"
 Requires-Dist: pytest-cov==7.1.0; extra == "test"
-Requires-Dist: ruff==0.17.2; extra == "test"
+Requires-Dist: ruff==0.17.3; extra == "test"
 Provides-Extra: dev
 Requires-Dist: ariadne-codegen[subscriptions]; extra == "dev"
 Dynamic: license-file

{deezer_python_gql-0.21.0 → deezer_python_gql-0.22.1}/deezer_python_gql.egg-info/SOURCES.txt

@@ -83,6 +83,7 @@ deezer_python_gql/generated/music_together_join_group.py
 deezer_python_gql/generated/music_together_leave_group.py
 deezer_python_gql/generated/music_together_refresh_suggested_tracklist.py
 deezer_python_gql/generated/music_together_update_group_settings.py
+deezer_python_gql/generated/push_queue_state.py
 deezer_python_gql/generated/remove_album_from_favorite.py
 deezer_python_gql/generated/remove_artist_from_favorite.py
 deezer_python_gql/generated/remove_audiobook_from_favorite.py

{deezer_python_gql-0.21.0 → deezer_python_gql-0.22.1}/deezer_python_gql.egg-info/requires.txt

@@ -7,10 +7,10 @@ ariadne-codegen[subscriptions]
 
 [test]
 codespell==2.4.3
-mypy==2.4.0
+mypy==2.4.1
 pre-commit==4.7.0
 pre-commit-hooks==6.0.0
-pytest==9.1.1
-pytest-asyncio==1.4.1
+pytest==9.2.0
+pytest-asyncio==1.4.1.post1
 pytest-cov==7.1.0
-ruff==0.17.2
+ruff==0.17.3

{deezer_python_gql-0.21.0 → deezer_python_gql-0.22.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "deezer-python-gql"
-version = "0.21.0"
+version = "0.22.1"
 description = "Async typed Python client for Deezer's Pipe GraphQL API."
 readme = "README.md"
 requires-python = ">=3.12"
@@ -24,13 +24,13 @@ text = "Apache-2.0"
 [project.optional-dependencies]
 test = [
     "codespell==2.4.3",
-    "mypy==2.4.0",
+    "mypy==2.4.1",
     "pre-commit==4.7.0",
     "pre-commit-hooks==6.0.0",
-    "pytest==9.1.1",
-    "pytest-asyncio==1.4.1",
+    "pytest==9.2.0",
+    "pytest-asyncio==1.4.1.post1",
     "pytest-cov==7.1.0",
-    "ruff==0.17.2",
+    "ruff==0.17.3",
 ]
 dev = [
     "ariadne-codegen[subscriptions]",
@@ -182,5 +182,5 @@ asyncio_mode = "auto"
 
 [tool.uv]
 override-dependencies = [
-    "ruff==0.17.2",
+    "ruff==0.17.3",
 ]

{deezer_python_gql-0.21.0 → deezer_python_gql-0.22.1}/tests/test_client.py

@@ -48,7 +48,7 @@ from deezer_python_gql.generated.ban_track_from_recommendation import (
 from deezer_python_gql.generated.bookmark_podcast_episode import BookmarkPodcastEpisode
 from deezer_python_gql.generated.create_playlist import CreatePlaylist
 from deezer_python_gql.generated.delete_playlist import DeletePlaylist
-from deezer_python_gql.generated.enums import PodcastType
+from deezer_python_gql.generated.enums import MediaTypeInput, PodcastType, RepeatModeInput
 from deezer_python_gql.generated.get_album import GetAlbum
 from deezer_python_gql.generated.get_artist import GetArtist
 from deezer_python_gql.generated.get_artist_mix import GetArtistMix
@@ -99,6 +99,11 @@ from deezer_python_gql.generated.get_track_mix import GetTrackMix
 from deezer_python_gql.generated.get_tracks_by_ids import GetTracksByIds
 from deezer_python_gql.generated.get_user_charts import GetUserCharts
 from deezer_python_gql.generated.get_user_playlists import GetUserPlaylists
+from deezer_python_gql.generated.input_types import (
+    PushQueueMediaInput,
+    PushQueueStateClientDetailsInput,
+    PushQueueStateInput,
+)
 from deezer_python_gql.generated.mark_as_not_played_podcast_episode import (
     MarkAsNotPlayedPodcastEpisode,
 )
@@ -114,6 +119,11 @@ from deezer_python_gql.generated.music_together_generate_group_name import (
 )
 from deezer_python_gql.generated.music_together_join_group import MusicTogetherJoinGroup
 from deezer_python_gql.generated.music_together_leave_group import MusicTogetherLeaveGroup
+from deezer_python_gql.generated.push_queue_state import (
+    PushQueueState,
+    PushQueueStatePushQueueStatePushQueueStateError,
+    PushQueueStatePushQueueStatePushQueueStateOutput,
+)
 from deezer_python_gql.generated.remove_album_from_favorite import RemoveAlbumFromFavorite
 from deezer_python_gql.generated.remove_artist_from_favorite import RemoveArtistFromFavorite
 from deezer_python_gql.generated.remove_audiobook_from_favorite import (
@@ -378,6 +388,7 @@ def test_client_has_generated_methods() -> None:
         "get_latest_podcast_episodes",
         "get_tracks_by_ids",
         "set_flow_discovery_tuner",
+        "push_queue_state",
     ]
     for method in expected_methods:
         assert hasattr(client, method), f"Missing method: {method}"
@@ -2030,3 +2041,64 @@ def test_smoke_get_family() -> None:
         ("2002", True),
         ("3003", False),
     ]
+
+
+def test_smoke_push_queue_state() -> None:
+    """Verify PushQueueState fixture parses the new queue state version."""
+    data = _load_fixture("push_queue_state.json")
+    result = PushQueueState.model_validate(data).push_queue_state
+    assert isinstance(result, PushQueueStatePushQueueStatePushQueueStateOutput)
+    assert result.version == "01a1a613-c68c-731f-8677-15d9c535adbb"
+
+
+def test_smoke_push_queue_state_conflict() -> None:
+    """Verify a PushQueueState conflict parses the version it conflicts with."""
+    data = _load_fixture("push_queue_state_conflict.json")
+    result = PushQueueState.model_validate(data).push_queue_state
+    assert isinstance(result, PushQueueStatePushQueueStatePushQueueStateError)
+    assert result.is_bad_request is False
+    assert result.conflict is not None
+    assert result.conflict.current is not None
+    assert result.conflict.current.version == "01a1a63d-1f5b-7d29-ae26-099eb9c20ab7"
+
+
+@pytest.mark.asyncio
+async def test_execute_sends_input_types_by_their_graphql_names() -> None:
+    """Verify an input type variable is sent as JSON with the API's field names."""
+    client = DeezerGQLClient(arl="test_arl")
+    client._jwt = _make_jwt(exp=time.time() + 600)  # noqa: SLF001
+    client._jwt_expires_at = time.time() + 600  # noqa: SLF001
+    state = PushQueueStateInput(
+        clientDetails=PushQueueStateClientDetailsInput(
+            localQueueID="queue", locallyUpdatedAt="2026-11-04T10:21:16.223Z"
+        ),
+        mediaList=[PushQueueMediaInput(id="1", type=MediaTypeInput.TRACK, unshuffledPosition=0)],
+        position=0,
+        queueConfiguration="{}",
+        repeatMode=RepeatModeInput.NONE,
+    )
+    gql_cm = _mock_post_context_manager(
+        json.dumps({"data": _load_fixture("push_queue_state.json")}).encode()
+    )
+
+    # the generated client runs on the generated copy of the base client
+    with patch("deezer_python_gql.generated.base_client.ClientSession") as mock_cls:
+        mock_instance = MagicMock()
+        mock_instance.post = MagicMock(return_value=gql_cm)
+        mock_instance.close = AsyncMock()
+        mock_cls.return_value = mock_instance
+
+        await client.push_queue_state(input=state)
+
+    sent = mock_instance.post.call_args.kwargs["json"]["variables"]["input"]
+    assert sent["clientDetails"]["localQueueID"] == "queue"
+    assert sent["mediaList"] == [
+        {
+            "id": "1",
+            "type": "TRACK",
+            "contextId": None,
+            "localQueueItemId": None,
+            "unshuffledPosition": 0,
+        }
+    ]
+    assert sent["repeatMode"] == "NONE"

deezer_python_gql-0.21.0/deezer_python_gql/generated/input_types.py

@@ -1,3 +0,0 @@
-# Generated by ariadne-codegen
-# Source: schema.graphql
-