Skip to content

Commit 0e6b633

Browse files
committed
models: Remove empty collections from repr/serialization
Thanks to tips in msgspec/msgspec#652.
1 parent d299878 commit 0e6b633

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
@@ -65,10 +65,7 @@ def test_invalid_kwarg():
6565

6666

6767
def test_repr_without_artists():
68-
assert (
69-
repr(Album(uri="uri", name="name"))
70-
== "Album(uri='uri', name='name', artists=frozenset())"
71-
)
68+
assert repr(Album(uri="uri", name="name")) == "Album(uri='uri', name='name')"
7269

7370

7471
def test_repr_with_artists():
@@ -83,7 +80,6 @@ def test_serialize_without_artists():
8380
"__model__": "Album",
8481
"uri": "uri",
8582
"name": "name",
86-
"artists": [],
8783
}
8884

8985

‎tests/models/test_legacy.py‎

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

7272
def test_repr_without_models(self):
7373
assert (
74-
repr(Playlist(uri="uri", name="name"))
75-
== "Playlist(uri='uri', name='name', tracks=())"
74+
repr(Playlist(uri="uri", name="name")) == "Playlist(uri='uri', name='name')"
7675
)
7776

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

8583
def test_serialize_without_models(self):
8684
self.assertDictEqual(
87-
{"__model__": "Playlist", "name": "name", "tracks": (), "uri": "uri"},
85+
{"__model__": "Playlist", "name": "name", "uri": "uri"},
8886
Playlist(uri="uri", name="name").serialize(),
8987
)
9088

‎tests/models/test_playlist.py‎

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

114114

115115
def test_repr_without_tracks():
116-
assert (
117-
repr(Playlist(uri="uri", name="name"))
118-
== "Playlist(uri='uri', name='name', tracks=())"
119-
)
116+
assert repr(Playlist(uri="uri", name="name")) == "Playlist(uri='uri', name='name')"
120117

121118

122119
def test_repr_with_tracks():
123120
assert (
124-
repr(Playlist(uri="uri", name="name", tracks=[Track(name="foo")]))
125-
== "Playlist(uri='uri', name='name', tracks=[Track(name='foo', "
126-
"artists=frozenset(), composers=frozenset(), performers=frozenset())])"
121+
repr(Playlist(uri="uri", name="name", tracks=(Track(name="foo"),)))
122+
== "Playlist(uri='uri', name='name', tracks=(Track(name='foo'),))"
127123
)
128124

129125

@@ -132,7 +128,6 @@ def test_serialize_without_tracks():
132128
"__model__": "Playlist",
133129
"uri": "uri",
134130
"name": "name",
135-
"tracks": (),
136131
}
137132

138133

‎tests/models/test_search_result.py‎

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

4242

4343
def test_repr_without_results():
44-
assert (
45-
repr(SearchResult(uri="uri"))
46-
== "SearchResult(uri='uri', tracks=(), artists=(), albums=())"
47-
)
44+
assert repr(SearchResult(uri="uri")) == "SearchResult(uri='uri')"
4845

4946

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

‎tests/models/test_tl_track.py‎

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

5352

‎tests/models/test_track.py‎

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

106106

107107
def test_repr_without_artists():
108-
assert (
109-
repr(Track(uri="uri", name="name")) == "Track(uri='uri', name='name', "
110-
"artists=frozenset(), composers=frozenset(), performers=frozenset())"
111-
)
108+
assert repr(Track(uri="uri", name="name")) == "Track(uri='uri', name='name')"
112109

113110

114111
def test_repr_with_artists():
115112
assert (
116-
repr(Track(uri="uri", name="name", artists=[Artist(name="foo")]))
117-
== "Track(uri='uri', name='name', artists=[Artist(name='foo')], "
118-
"composers=frozenset(), performers=frozenset())"
113+
repr(Track(uri="uri", name="name", artists=frozenset({Artist(name="foo")})))
114+
== "Track(uri='uri', name='name', artists=frozenset({Artist(name='foo')}))"
119115
)
120116

121117

122118
def test_serialize_without_artists():
123119
assert Track(uri="uri", name="name").serialize() == {
124120
"__model__": "Track",
125121
"uri": "uri",
126-
"artists": [],
127122
"name": "name",
128-
"composers": [],
129-
"performers": [],
130123
}
131124

132125

@@ -137,8 +130,6 @@ def test_serialize_with_artists():
137130
"uri": "uri",
138131
"name": "name",
139132
"artists": [artist.serialize()],
140-
"composers": [],
141-
"performers": [],
142133
}
143134

144135

@@ -149,7 +140,4 @@ def test_serialize_with_album():
149140
"uri": "uri",
150141
"name": "name",
151142
"album": album.serialize(),
152-
"artists": [],
153-
"composers": [],
154-
"performers": [],
155143
}

0 commit comments

Comments
 (0)