Make dataclasses frozen, use tuples instead of lists

Author: 7x11x13

setup.py

@@ -10,7 +10,7 @@ def readme():
 
 setup(
     name="soundcloud-v2",
-    version="1.4.2",
+    version="1.5.0",
     description=(
         "Python wrapper for the internal v2 SoundCloud API."
         "Does not require an API key."
@@ -23,7 +23,7 @@ def readme():
     packages=["soundcloud", "soundcloud.resource"],
     package_data={"soundcloud": ["py.typed"]},
     install_requires=[
-        "dacite",
+        "dacite>=1.8.1",
         "python-dateutil>=2.8.2",
         "requests",
         "typing_extensions; python_version<'3.8'",

soundcloud/__init__.py

@@ -64,6 +64,6 @@
 from soundcloud.soundcloud import *
 from soundcloud.soundcloud import __all__ as sc_all
 
-__version__ = "1.4.2"
+__version__ = "1.5.0"
 
 __all__ = sc_all + ex_all + res_all

soundcloud/requests.py

@@ -9,6 +9,7 @@
     Generic,
     List,
     Optional,
+    Tuple,
     Type,
     TypeVar,
     Union,
@@ -67,7 +68,7 @@ def _convert_dict(d, return_type: Type[BaseData]):
 T = TypeVar("T", bound=BaseData)
 
 
-@dataclass
+@dataclass(frozen=True)
 class Request(Generic[T]):
     base = "https://api-v2.soundcloud.com"
     format_url: str
@@ -107,7 +108,7 @@ def __call__(
             return _convert_dict(r.json(), self.return_type)
 
 
-@dataclass
+@dataclass(frozen=True)
 class CollectionRequest(Request, Generic[T]):
     def __call__(
         self,
@@ -149,7 +150,7 @@ def __call__(
                 resource_url = urljoin(resource_url, parsed.path)
 
 
-@dataclass
+@dataclass(frozen=True)
 class ListRequest(Request, Generic[T]):
     """
     Requests the resource list at the given url with
@@ -181,7 +182,7 @@ class DataclassInstance(Protocol):
 Q = TypeVar("Q", bound=DataclassInstance)
 
 
-@dataclass
+@dataclass(frozen=True)
 class GraphQLRequest(Generic[Q, T]):
     base = "https://graph.soundcloud.com/graphql"
     operation_name: str
@@ -322,13 +323,13 @@ def __call__(
 """
 
 
-@dataclass
+@dataclass(frozen=True)
 class UserInteractionsQueryResult(BaseData):
-    user: List[UserInteraction]
-    creator: List[UserInteraction]
+    user: Tuple[UserInteraction, ...]
+    creator: Tuple[UserInteraction, ...]
 
 
-@dataclass
+@dataclass(frozen=True)
 class UserInteractionsQueryParams:
     createdByProfileUrn: str
     interactionTypeUrn: str

soundcloud/resource/base.py

@@ -5,9 +5,11 @@
 from dacite import Config, from_dict
 
 
-@dataclass
+@dataclass(frozen=True)
 class BaseData:
-    dacite_config = Config(type_hooks={datetime.datetime: dateutil.parser.isoparse})
+    dacite_config = Config(
+        type_hooks={datetime.datetime: dateutil.parser.isoparse}, cast=[tuple]
+    )
 
     @classmethod
     def from_dict(cls, d: dict):

soundcloud/resource/base_item.py

@@ -5,7 +5,7 @@
 from soundcloud.resource.base import BaseData
 
 
-@dataclass
+@dataclass(frozen=True)
 class BaseItem(BaseData):
     artwork_url: Optional[str]
     created_at: datetime.datetime

soundcloud/resource/comment.py

@@ -6,12 +6,12 @@
 from soundcloud.resource.user import BasicUser
 
 
-@dataclass
+@dataclass(frozen=True)
 class CommentSelf(BaseData):
     urn: str
 
 
-@dataclass
+@dataclass(frozen=True)
 class BasicComment(BaseData):
     """Comment without a specified track"""
 
@@ -26,7 +26,7 @@ class BasicComment(BaseData):
     user: BasicUser
 
 
-@dataclass
+@dataclass(frozen=True)
 class Comment(BasicComment):
     """Comment with a specified track"""
 

soundcloud/resource/conversation.py

@@ -1,13 +1,13 @@
 import datetime
 from dataclasses import dataclass
-from typing import List, Union
+from typing import Tuple, Union
 
 from soundcloud.resource.base import BaseData
 from soundcloud.resource.message import Message
 from soundcloud.resource.user import BasicUser, MissingUser
 
 
-@dataclass
+@dataclass(frozen=True)
 class Conversation(BaseData):
     """DM conversation between two users"""
 
@@ -16,4 +16,4 @@ class Conversation(BaseData):
     read: bool
     started_at: datetime.datetime
     summary: str
-    users: List[Union[BasicUser, MissingUser]]
+    users: Tuple[Union[BasicUser, MissingUser], ...]

soundcloud/resource/download.py

@@ -3,7 +3,7 @@
 from soundcloud.resource.base import BaseData
 
 
-@dataclass
+@dataclass(frozen=True)
 class OriginalDownload(BaseData):
     """Contains a download link for a track"""
 

soundcloud/resource/graphql.py

@@ -1,27 +1,27 @@
 from dataclasses import dataclass
-from typing import List, Optional
+from typing import Optional, Tuple
 
 from soundcloud.resource.base import BaseData
 from soundcloud.resource.comment import BasicComment
 
 InteractionTypeValue = str
 
 
-@dataclass
+@dataclass(frozen=True)
 class InteractionCount(BaseData):
     count: Optional[int]
     interactionTypeValueUrn: Optional[InteractionTypeValue]
 
 
-@dataclass
+@dataclass(frozen=True)
 class UserInteraction(BaseData):
     targetUrn: Optional[str]
     userInteraction: Optional[InteractionTypeValue]
-    interactionCounts: Optional[List[InteractionCount]]
+    interactionCounts: Optional[Tuple[InteractionCount, ...]]
     interactionTypeUrn: Optional[str]
 
 
-@dataclass
+@dataclass(frozen=True)
 class CommentWithInteractions(BaseData):
     comment: BasicComment
     likes: int

soundcloud/resource/history.py

@@ -4,7 +4,7 @@
 from soundcloud.resource.track import BasicTrack
 
 
-@dataclass
+@dataclass(frozen=True)
 class HistoryItem(BaseData):
     """Item in user's listen history"""
 

soundcloud/resource/like.py

@@ -6,20 +6,20 @@
 from soundcloud.resource.track import BasicTrack
 
 
-@dataclass
+@dataclass(frozen=True)
 class BaseLike(BaseData):
     created_at: datetime.datetime
     kind: str
 
 
-@dataclass
+@dataclass(frozen=True)
 class TrackLike(BaseLike):
     """Like on a track"""
 
     track: BasicTrack
 
 
-@dataclass
+@dataclass(frozen=True)
 class PlaylistLike(BaseLike):
     """Like on a playlist"""
 

soundcloud/resource/message.py

@@ -6,7 +6,7 @@
 from soundcloud.resource.user import BasicUser, MissingUser
 
 
-@dataclass
+@dataclass(frozen=True)
 class Message(BaseData):
     """Single DM between two users"""
 

soundcloud/resource/playlist.py

@@ -1,38 +1,38 @@
 import datetime
 from dataclasses import dataclass
-from typing import List, Optional, Union
+from typing import Optional, Tuple, Union
 
 from soundcloud.resource.base import BaseData
 from soundcloud.resource.base_item import BaseItem
 from soundcloud.resource.track import BasicTrack, MiniTrack
 from soundcloud.resource.user import BasicUser, User
 
 
-@dataclass
+@dataclass(frozen=True)
 class BaseAlbumPlaylist(BaseItem):
     managed_by_feeds: bool
     set_type: str
     is_album: bool
     published_at: Optional[datetime.datetime]
     track_count: int
-    tracks: List[Union[BasicTrack, MiniTrack]]
+    tracks: Tuple[Union[BasicTrack, MiniTrack], ...]
 
 
-@dataclass
+@dataclass(frozen=True)
 class AlbumPlaylist(BaseAlbumPlaylist):
     """Playlist or album with full user info"""
 
     user: User
 
 
-@dataclass
+@dataclass(frozen=True)
 class BasicAlbumPlaylist(BaseAlbumPlaylist):
     """Playlist or album with partial user info"""
 
     user: BasicUser
 
 
-@dataclass
+@dataclass(frozen=True)
 class AlbumPlaylistNoTracks(BaseData):
     """Playlist or album with no track info"""
 

soundcloud/resource/stream.py

@@ -8,7 +8,7 @@
 from soundcloud.resource.user import BasicUser
 
 
-@dataclass
+@dataclass(frozen=True)
 class BaseStreamItem(BaseData):
     created_at: datetime.datetime
     type: str
@@ -17,40 +17,40 @@ class BaseStreamItem(BaseData):
     caption: Optional[str]
 
 
-@dataclass
+@dataclass(frozen=True)
 class Reposted(BaseData):
     target_urn: str
     user_urn: str
     caption: Optional[str]
 
 
-@dataclass
+@dataclass(frozen=True)
 class BaseStreamRepostItem(BaseStreamItem):
     reposted: Optional[Reposted]
 
 
-@dataclass
+@dataclass(frozen=True)
 class TrackStreamItem(BaseStreamItem):
     """Track post in user's feed"""
 
     track: BasicTrack
 
 
-@dataclass
+@dataclass(frozen=True)
 class TrackStreamRepostItem(BaseStreamRepostItem):
     """Track repost in user's feed"""
 
     track: BasicTrack
 
 
-@dataclass
+@dataclass(frozen=True)
 class PlaylistStreamItem(BaseStreamItem):
     """Album or playlist post in user's feed"""
 
     playlist: BasicAlbumPlaylist
 
 
-@dataclass
+@dataclass(frozen=True)
 class PlaylistStreamRepostItem(BaseStreamRepostItem):
     """Album or playlist repost in user's feed"""