Skip to content

Commit 30ecfa8

Browse files
committed
models: Remove empty collections from repr/serialization
Thanks to tips in msgspec/msgspec#652.
1 parent 9040ab7 commit 30ecfa8

8 files changed

Lines changed: 22 additions & 54 deletions

File tree

‎src/mopidy/internal/models.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ class HistoryState(
3535
"""
3636

3737
# The track history. Read-only.
38-
history: tuple[HistoryTrack, ...] = msgspec.field(default_factory=tuple)
38+
history: tuple[HistoryTrack, ...] = ()
3939

4040

4141
class MixerState(
@@ -104,7 +104,7 @@ class TracklistState(
104104
next_tlid: TracklistId
105105

106106
# The list of tracks. Read-only.
107-
tl_tracks: tuple[TlTrack, ...] = msgspec.field(default_factory=tuple)
107+
tl_tracks: tuple[TlTrack, ...] = ()
108108

109109

110110
class CoreState(

‎src/mopidy/models/__init__.py‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
from typing import ClassVar, Literal, Self
44
from uuid import UUID
55

6-
import msgspec
7-
86
from mopidy.models._base import BaseModel, ModelRegistry
97
from mopidy.types import DateOrYear, DurationMs, NonNegativeInt, TracklistId, Uri
108

@@ -139,7 +137,7 @@ class Album(
139137
name: str | None = None
140138

141139
#: A set of album artists. Read-only.
142-
artists: frozenset[Artist] = msgspec.field(default_factory=frozenset)
140+
artists: frozenset[Artist] = frozenset()
143141

144142
#: The number of tracks in the album. Read-only.
145143
num_tracks: NonNegativeInt | None = None
@@ -169,16 +167,16 @@ class Track(
169167
name: str | None = None
170168

171169
#: A set of track artists. Read-only.
172-
artists: frozenset[Artist] = msgspec.field(default_factory=frozenset)
170+
artists: frozenset[Artist] = frozenset()
173171

174172
#: The track :class:`Album`. Read-only.
175173
album: Album | None = None
176174

177175
#: A set of track composers. Read-only.
178-
composers: frozenset[Artist] = msgspec.field(default_factory=frozenset)
176+
composers: frozenset[Artist] = frozenset()
179177

180178
#: A set of track performers. Read-only.
181-
performers: frozenset[Artist] = msgspec.field(default_factory=frozenset)
179+
performers: frozenset[Artist] = frozenset()
182180

183181
#: The track genre. Read-only.
184182
genre: str | None = None
@@ -257,7 +255,7 @@ class Playlist(
257255
name: str | None = None
258256

259257
#: The playlist's tracks. Read-only.
260-
tracks: tuple[Track, ...] = msgspec.field(default_factory=tuple)
258+
tracks: tuple[Track, ...] = ()
261259

262260
#: The playlist modification time in milliseconds since Unix epoch.
263261
#: Read-only.
@@ -281,10 +279,10 @@ class SearchResult(
281279
uri: Uri | None = None
282280

283281
#: The tracks matching the search query. Read-only.
284-
tracks: tuple[Track, ...] = msgspec.field(default_factory=tuple)
282+
tracks: tuple[Track, ...] = ()
285283

286284
#: The artists matching the search query. Read-only.
287-
artists: tuple[Artist, ...] = msgspec.field(default_factory=tuple)
285+
artists: tuple[Artist, ...] = ()
288286

289287
#: The albums matching the search query. Read-only.
290-
albums: tuple[Album, ...] = msgspec.field(default_factory=tuple)
288+
albums: tuple[Album, ...] = ()

‎tests/models/test_album.py‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,7 @@ def test_invalid_kwarg():
6464

6565

6666
def test_repr_without_artists():
67-
assert (
68-
repr(Album(uri="uri", name="name"))
69-
== "Album(uri='uri', name='name', artists=frozenset())"
70-
)
67+
assert repr(Album(uri="uri", name="name")) == "Album(uri='uri', name='name')"
7168

7269

7370
def test_repr_with_artists():
@@ -82,7 +79,6 @@ def test_serialize_without_artists():
8279
"__model__": "Album",
8380
"uri": "uri",
8481
"name": "name",
85-
"artists": [],
8682
}
8783

8884

‎tests/models/test_legacy.py‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,20 +70,18 @@ def test_invalid_kwarg(self):
7070

7171
def test_repr_without_models(self):
7272
assert (
73-
repr(Playlist(uri="uri", name="name"))
74-
== "Playlist(uri='uri', name='name', tracks=())"
73+
repr(Playlist(uri="uri", name="name")) == "Playlist(uri='uri', name='name')"
7574
)
7675

7776
def test_repr_with_models(self):
7877
assert (
7978
repr(Playlist(uri="uri", name="name", tracks=(Track(name=123),)))
80-
== "Playlist(uri='uri', name='name', tracks=(Track(name=123, "
81-
"artists=frozenset(), composers=frozenset(), performers=frozenset()),))"
79+
== "Playlist(uri='uri', name='name', tracks=(Track(name=123),))"
8280
)
8381

8482
def test_serialize_without_models(self):
8583
self.assertDictEqual(
86-
{"__model__": "Playlist", "name": "name", "tracks": (), "uri": "uri"},
84+
{"__model__": "Playlist", "name": "name", "uri": "uri"},
8785
Playlist(uri="uri", name="name").serialize(),
8886
)
8987

‎tests/models/test_playlist.py‎

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -112,17 +112,13 @@ def test_invalid_kwarg():
112112

113113

114114
def test_repr_without_tracks():
115-
assert (
116-
repr(Playlist(uri="uri", name="name"))
117-
== "Playlist(uri='uri', name='name', tracks=())"
118-
)
115+
assert repr(Playlist(uri="uri", name="name")) == "Playlist(uri='uri', name='name')"
119116

120117

121118
def test_repr_with_tracks():
122119
assert (
123-
repr(Playlist(uri="uri", name="name", tracks=[Track(name="foo")]))
124-
== "Playlist(uri='uri', name='name', tracks=[Track(name='foo', "
125-
"artists=frozenset(), composers=frozenset(), performers=frozenset())])"
120+
repr(Playlist(uri="uri", name="name", tracks=(Track(name="foo"),)))
121+
== "Playlist(uri='uri', name='name', tracks=(Track(name='foo'),))"
126122
)
127123

128124

@@ -131,7 +127,6 @@ def test_serialize_without_tracks():
131127
"__model__": "Playlist",
132128
"uri": "uri",
133129
"name": "name",
134-
"tracks": (),
135130
}
136131

137132

‎tests/models/test_search_result.py‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,17 +40,11 @@ def test_invalid_kwarg():
4040

4141

4242
def test_repr_without_results():
43-
assert (
44-
repr(SearchResult(uri="uri"))
45-
== "SearchResult(uri='uri', tracks=(), artists=(), albums=())"
46-
)
43+
assert repr(SearchResult(uri="uri")) == "SearchResult(uri='uri')"
4744

4845

4946
def test_serialize_without_results():
5047
assert SearchResult(uri="uri").serialize() == {
5148
"__model__": "SearchResult",
5249
"uri": "uri",
53-
"albums": (),
54-
"artists": (),
55-
"tracks": (),
5650
}

‎tests/models/test_tl_track.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,7 @@ def test_iteration():
4545
def test_repr():
4646
assert (
4747
repr(TlTrack(tlid=123, track=Track(uri="uri")))
48-
== "TlTrack(tlid=123, track=Track(uri='uri', artists=frozenset(), "
49-
"composers=frozenset(), performers=frozenset()))"
48+
== "TlTrack(tlid=123, track=Track(uri='uri'))"
5049
)
5150

5251

‎tests/models/test_track.py‎

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -104,28 +104,21 @@ def test_invalid_kwarg():
104104

105105

106106
def test_repr_without_artists():
107-
assert (
108-
repr(Track(uri="uri", name="name")) == "Track(uri='uri', name='name', "
109-
"artists=frozenset(), composers=frozenset(), performers=frozenset())"
110-
)
107+
assert repr(Track(uri="uri", name="name")) == "Track(uri='uri', name='name')"
111108

112109

113110
def test_repr_with_artists():
114111
assert (
115-
repr(Track(uri="uri", name="name", artists=[Artist(name="foo")]))
116-
== "Track(uri='uri', name='name', artists=[Artist(name='foo')], "
117-
"composers=frozenset(), performers=frozenset())"
112+
repr(Track(uri="uri", name="name", artists=frozenset({Artist(name="foo")})))
113+
== "Track(uri='uri', name='name', artists=frozenset({Artist(name='foo')}))"
118114
)
119115

120116

121117
def test_serialize_without_artists():
122118
assert Track(uri="uri", name="name").serialize() == {
123119
"__model__": "Track",
124120
"uri": "uri",
125-
"artists": [],
126121
"name": "name",
127-
"composers": [],
128-
"performers": [],
129122
}
130123

131124

@@ -136,8 +129,6 @@ def test_serialize_with_artists():
136129
"uri": "uri",
137130
"name": "name",
138131
"artists": [artist.serialize()],
139-
"composers": [],
140-
"performers": [],
141132
}
142133

143134

@@ -148,7 +139,4 @@ def test_serialize_with_album():
148139
"uri": "uri",
149140
"name": "name",
150141
"album": album.serialize(),
151-
"artists": [],
152-
"composers": [],
153-
"performers": [],
154142
}

0 commit comments

Comments
 (0)