artemis-model 0.1.115__tar.gz → 0.1.117__tar.gz

{artemis_model-0.1.115 → artemis_model-0.1.117}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: artemis-model
-Version: 0.1.115
+Version: 0.1.117
 Summary: 
 Author: Jukeboxy
 Requires-Python: >=3.10.6,<4.0.0

{artemis_model-0.1.115 → artemis_model-0.1.117}/artemis_model/banned_tracks.py

@@ -6,16 +6,19 @@ from artemis_model.base import AuditMixin, TimeStampMixin, CustomSyncBase, Custo
 
 
 class BannedTracksMixin(TimeStampMixin, AuditMixin):
-    """Banned Tracks per Zone Model"""    
+    """Banned Tracks per Zone Model"""
+
     zone_id: Mapped[int] = mapped_column(Integer, primary_key=True)
     track_id: Mapped[UUID] = mapped_column(UUID(as_uuid=True), primary_key=True)
 
 
 class BannedTracksSync(CustomSyncBase, BannedTracksMixin):
     """Banned Tracks per Zone Model"""
+
     pass
 
 
 class BannedTracks(CustomBase, BannedTracksMixin):
     """Banned Tracks per Zone Model"""
+
     pass

{artemis_model-0.1.115 → artemis_model-0.1.117}/artemis_model/redis/__init__.py

@@ -1,6 +1,6 @@
 """Redis models."""
 
-from .zone_state import ZoneState, NowPlaying, SessionId, BucketId
+from .zone_state import ZoneState, NowPlaying, SessionId, BucketId, PushedPlaylist, PushedPlaylistMetadata, PushedPlaylistDetails
 from .device import ActiveDevice
 from .bucket import RedisTrackBucketItem
 from .play_history import RedisTrackPlayHistoryItem
@@ -19,6 +19,9 @@ __all__ = [
     "SessionId",
     "BucketId",
     "ActiveDevice",
+    "PushedPlaylist",
+    "PushedPlaylistMetadata",
+    "PushedPlaylistDetails",
     "KEY_ZONE_PLAY_HISTORY_TEMPLATE",
     "KEY_ZONE_PUSH_PLAYLIST_BUCKET_TEMPLATE",
     "KEY_ZONE_SCHEDULE_BUCKET_TEMPLATE",

{artemis_model-0.1.115 → artemis_model-0.1.117}/artemis_model/redis/bucket.py

@@ -1,25 +1,16 @@
 """Redis track buckets"""
-import json
+
 from pydantic import BaseModel, Field, ConfigDict
 from typing import Annotated
 from datetime import datetime, timezone
 import uuid
 
 
-TrackId = Annotated[
-    uuid.UUID,
-    Field(description="Track ID (UUID)")
-]
+TrackId = Annotated[uuid.UUID, Field(description="Track ID (UUID)")]
 
-PlaylistId = Annotated[
-    int,
-    Field(description="Playlist ID (integer)")
-]
+PlaylistId = Annotated[int, Field(description="Playlist ID (integer)")]
 
-Timestamp = Annotated[
-    int,
-    Field(description="Unix timestamp")
-]
+Timestamp = Annotated[int, Field(description="Unix timestamp")]
 
 
 class RedisTrackBucketItem(BaseModel):
@@ -34,10 +25,7 @@ class RedisTrackBucketItem(BaseModel):
     playlist_id: PlaylistId
     ts: Timestamp = Field(default_factory=lambda: int(datetime.now(timezone.utc).timestamp()))
 
-    model_config = ConfigDict(
-        json_encoders={uuid.UUID: str},
-        populate_by_name=True
-    )
+    model_config = ConfigDict(json_encoders={uuid.UUID: str}, populate_by_name=True)
 
     def as_redis_entry(self) -> dict[str, int]:
         """
@@ -46,8 +34,7 @@ class RedisTrackBucketItem(BaseModel):
         """
         key = self.model_dump_json(include={"track_id", "playlist_id"})
         return {key: self.ts}
-    
-    
+
     @classmethod
     def from_redis_entry(cls, entry: dict[str, int]) -> "RedisTrackBucketItem":
         """
@@ -58,5 +45,6 @@ class RedisTrackBucketItem(BaseModel):
 
 class RedisTrackBucketItemValue(BaseModel):
     """JSON string format for Redis keys: '{"track_id": "...", "playlist_id": ...}'"""
+
     track_id: TrackId
     playlist_id: PlaylistId

{artemis_model-0.1.115 → artemis_model-0.1.117}/artemis_model/redis/play_history.py

@@ -5,15 +5,9 @@ from typing import Annotated
 from datetime import datetime, timezone
 
 
-TrackId = Annotated[
-    str,
-    Field(description="Track ID (UUID or string)")
-]
+TrackId = Annotated[str, Field(description="Track ID (UUID or string)")]
 
-Timestamp = Annotated[
-    int,
-    Field(description="Unix timestamp")
-]
+Timestamp = Annotated[int, Field(description="Unix timestamp")]
 
 
 class RedisTrackPlayHistoryItem(BaseModel):
@@ -21,6 +15,7 @@ class RedisTrackPlayHistoryItem(BaseModel):
     Represents the value stored in Redis sorted set:
     A string like "track_id#timestamp"
     """
+
     track_id: TrackId
     ts: Timestamp = Field(default_factory=lambda: int(datetime.now(timezone.utc).timestamp()))
 

{artemis_model-0.1.115 → artemis_model-0.1.117}/artemis_model/redis/zone_state.py

@@ -27,6 +27,50 @@ BucketId = Annotated[
 ]
 
 
+class PushedPlaylist(BaseModel):
+    """Pushed playlist schema."""
+
+    id: int = Field(
+        description="The id of the pushed playlist. It's generated as a timestamp value of the current time."
+    )
+    name: str = Field(
+        description="The name of the pushed playlist",
+    )
+
+
+class PushedPlaylistMetadata(BaseModel):
+    """Pushed playlist metadata schema."""
+
+    expire_at: int = Field(
+        description="The expire time of the pushed playlist. It's calculated in set_bucket_track as the timestamp value of the timeslot."
+    )
+    playlists: list[PushedPlaylist] = Field(
+        description="The playlists of the pushed playlist",
+    )
+
+
+class PushedPlaylistDetails(BaseModel):
+    """Player details schema."""
+
+    redis_details: dict[SessionId, BucketId] | None = Field(
+        default_factory=dict,
+        description="""Pushed playlists does exist in Redis with a timestamp.
+        Example: zone_{zone_id}_pp_bucket_{ts}
+        Every pushplaylist action has a session id. Here we map these session ids to the bucket id.
+        """,
+    )
+    metadata: PushedPlaylistMetadata | None = Field(
+        default=None,
+        description="The metadata of the pushed playlist",
+    )
+
+    @field_validator("redis_details", mode="before")
+    @classmethod
+    def default_empty_dict_if_none(cls, v):
+        """Override none value to empty dict."""
+        return v or {}
+
+
 class ZoneState(BaseModel):
     """Zone state schema."""
 
@@ -42,16 +86,18 @@ class ZoneState(BaseModel):
         default=None,
         description="The currently playing track",
     )
-    push_playlist_details: dict[SessionId, BucketId] | None = Field(
-        default_factory=dict,
+    pp_details: PushedPlaylistDetails | None = Field(
+        default=None,
         description="The details of the pushed playlist",
     )
 
-    @field_validator("push_playlist_details", mode="before")
-    @classmethod
-    def default_empty_dict_if_none(cls, v):
-        """Override none value to empty dict."""
-        return v or {}
-
 
-__all__ = ["ZoneState", "NowPlaying", "SessionId", "BucketId"]
+__all__ = [
+    "ZoneState",
+    "NowPlaying",
+    "SessionId",
+    "BucketId",
+    "PushedPlaylist",
+    "PushedPlaylistMetadata",
+    "PushedPlaylistDetails",
+]

{artemis_model-0.1.115 → artemis_model-0.1.117}/artemis_model/zone_activity.py

@@ -39,9 +39,11 @@ class PlayerActivityMixin(TimeStampMixin, AuditMixin):
 
 class PlayerActivitySync(CustomSyncBase, PlayerActivityMixin):
     """Sync model for Player Activity"""
+
     pass
 
 
 class PlayerActivity(CustomBase, PlayerActivityMixin):
     """Base model for Player Activity"""
+
     pass

{artemis_model-0.1.115 → artemis_model-0.1.117}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "artemis-model"
-version = "0.1.115"
+version = "0.1.117"
 description = ""
 authors = ["Jukeboxy"]
 readme = "README.md"