mirrors/beets
2
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2026-07-16 14:07:40 -04:00
Code Issues Packages Projects Releases Wiki Activity

discogs: Add descriptions of each possible Tracks

Browse Source
This commit is contained in:
Šarūnas Nejus
2026-07-05 12:22:44 +01:00
parent 66476049e9
commit 8867848612
3 changed files with 131 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
beetsplug/discogs/types.py
View File

@@ -1,6 +1,6 @@
from __future__ import annotations
from typing import TYPE_CHECKING
from typing import TYPE_CHECKING, Literal
from typing_extensions import NotRequired, TypedDict
@@ -24,14 +24,53 @@ class Artist(TypedDict):
resource_url: str
class Track(TypedDict):
class AudioTrack(TypedDict):
"""Represent an audio item or logical segment in a Discogs tracklist.
Discogs uses this shape both for independently addressable media tracks and
for pieces rolled into one physical track. Position syntax and surrounding
index structure determine which interpretation applies.
"""
type_: Literal["track"]
position: str
type_: str
title: str
duration: str
artists: list[Artist]
artists: NotRequired[list[Artist]]
extraartists: NotRequired[list[Artist]]
sub_tracks: NotRequired[list[Track]]
class IndexTrack(TypedDict):
"""Represent a titled musical work containing related subtracks.
The contained entries may be movements stored as separate physical tracks
or logical divisions of one track. Their position syntax determines whether
they remain separate or are coalesced under the work's metadata.
"""
type_: Literal["index"]
position: Literal[""]
title: str
duration: str
sub_tracks: list[AudioTrack]
artists: NotRequired[list[Artist]]
extraartists: NotRequired[list[Artist]]
class HeadingTrack(TypedDict):
"""Represent descriptive tracklist structure rather than an audio item.
A heading labels the following block but is not the title of a musical work.
It must remain structural instead of being treated as an index container.
"""
type_: Literal["heading"]
position: Literal[""]
title: str
duration: str
Track = AudioTrack | IndexTrack | HeadingTrack
class ArtistInfo(TypedDict):

23
test/plugins/factories/discogs.py Normal file
View File

@@ -0,0 +1,23 @@
import factory
class AudioTrackFactory(factory.DictFactory):
type_ = "track"
position = "1"
title = "Track"
duration = ""
class IndexTrackFactory(factory.DictFactory):
type_ = "index"
title = "Index Track"
position = ""
duration = ""
sub_tracks = factory.List([factory.SubFactory(AudioTrackFactory)])
class HeadingTrackFactory(factory.DictFactory):
type_ = "heading"
title = "Heading Track"
position = ""
duration = ""

109
test/plugins/test_discogs.py
View File

@@ -1,6 +1,8 @@
"""Tests for discogs plugin."""
from typing import Any
from __future__ import annotations
from typing import TYPE_CHECKING, Any
import pytest
from discogs_client import Client, Release
@@ -10,6 +12,12 @@ from beets.library import Item
from beets.test.helper import TestHelper
from beetsplug.discogs import ArtistState, DiscogsPlugin
from .factories import discogs as factories
if TYPE_CHECKING:
from beetsplug.discogs import types
_p = pytest.param
@@ -25,13 +33,23 @@ def _artist(name: str, **kwargs):
} | kwargs
def _track(title: str, position: str = "", duration: str = "", **kwargs):
return {
"title": title,
"position": position,
"duration": duration,
"type_": "track",
} | kwargs
def audio_track(
title: str, position: str = "", duration: str = "", **kwargs
) -> types.AudioTrack:
kwargs.update(title=title, position=position, duration=duration)
return factories.AudioTrackFactory.build(**kwargs)
def index_track(
title: str, sub_tracks: list[types.AudioTrack], **kwargs
) -> types.IndexTrack:
kwargs.update(title=title, sub_tracks=sub_tracks)
return factories.IndexTrackFactory.build(**kwargs)
def heading_track(title: str, **kwargs) -> types.HeadingTrack:
kwargs.update(title=title)
return factories.HeadingTrackFactory.build(**kwargs)
def get_release(data: dict[str, Any]) -> Release:
@@ -88,7 +106,7 @@ class DiscogsTestMixin:
def _make_release_from_positions(self, positions):
"""Return discogs_client.Release with tracks at the given positions."""
tracks = [
_track(f"TITLE{i}", position)
audio_track(f"TITLE{i}", position)
for (i, position) in enumerate(positions, start=1)
]
return self._make_release(tracks)
@@ -97,8 +115,8 @@ class DiscogsTestMixin:
class TestDGAlbumInfo(DiscogsTestMixin, TestHelper):
def test_parse_media_for_tracks(self):
tracks = [
_track("TITLE ONE", "1", "01:01"),
_track("TITLE TWO", "2", "02:02"),
audio_track("TITLE ONE", "1", "01:01"),
audio_track("TITLE TWO", "2", "02:02"),
]
release = self._make_release(tracks=tracks)
@@ -184,7 +202,7 @@ class TestDGAlbumInfo(DiscogsTestMixin, TestHelper):
data = {
"id": 123,
"uri": "https://www.discogs.com/release/123456-something",
"tracklist": [_track("A", "1", "01:01")],
"tracklist": [audio_track("A", "1", "01:01")],
"artists": [_artist("ARTIST NAME", id=321)],
"title": "TITLE",
}
@@ -300,27 +318,26 @@ class TestTracklist(DiscogsTestMixin):
_p(
{"index_tracks": False},
[
_track("MEDIUM TITLE"),
_track("TRACK GROUP TITLE"),
_track("TITLE ONE", "1.1"),
_track("TITLE TWO", "1.2"),
heading_track("MEDIUM TITLE"),
audio_track("TITLE ONE", "1.1"),
audio_track("TITLE TWO", "1.2"),
],
1,
[("TRACK GROUP TITLE", "MEDIUM TITLE")],
[("TITLE ONE / TITLE TWO", "MEDIUM TITLE")],
id="flat-logical-subtracks",
),
_p(
{"index_tracks": False},
[
_track("TITLE ONE", "1"),
_track(
audio_track("TITLE ONE", "1"),
index_track(
"TRACK GROUP TITLE",
sub_tracks=[
_track("SUBTITLE ONE", "2.1", "01:01"),
_track("SUBTITLE TWO", "2.2", "02:02"),
[
audio_track("SUBTITLE ONE", "2.1", "01:01"),
audio_track("SUBTITLE TWO", "2.2", "02:02"),
],
),
_track("TITLE THREE", "3"),
audio_track("TITLE THREE", "3"),
],
1,
[
@@ -333,15 +350,15 @@ class TestTracklist(DiscogsTestMixin):
_p(
{"index_tracks": False},
[
_track("TITLE ONE", "1"),
_track(
audio_track("TITLE ONE", "1"),
index_track(
"TRACK GROUP TITLE",
sub_tracks=[
_track("SUBTITLE ONE", "2", "01:01"),
_track("SUBTITLE TWO", "3", "02:02"),
[
audio_track("SUBTITLE ONE", "2", "01:01"),
audio_track("SUBTITLE TWO", "3", "02:02"),
],
),
_track("TITLE FOUR", "4"),
audio_track("TITLE FOUR", "4"),
],
1,
[
@@ -355,15 +372,15 @@ class TestTracklist(DiscogsTestMixin):
_p(
{"index_tracks": True},
[
_track("TITLE ONE", "1"),
_track(
audio_track("TITLE ONE", "1"),
index_track(
"TRACK GROUP TITLE",
sub_tracks=[
_track("SUBTITLE ONE", "2", "01:01"),
_track("SUBTITLE TWO", "3", "02:02"),
[
audio_track("SUBTITLE ONE", "2", "01:01"),
audio_track("SUBTITLE TWO", "3", "02:02"),
],
),
_track("TITLE FOUR", "4"),
audio_track("TITLE FOUR", "4"),
],
1,
[
@@ -377,11 +394,11 @@ class TestTracklist(DiscogsTestMixin):
_p(
{"index_tracks": False},
[
_track("MEDIUM TITLE CD1"),
_track("TITLE ONE", "1-1"),
_track("TITLE TWO", "1-2"),
_track("MEDIUM TITLE CD2"),
_track("TITLE THREE", "2-1"),
heading_track("MEDIUM TITLE CD1"),
audio_track("TITLE ONE", "1-1"),
audio_track("TITLE TWO", "1-2"),
heading_track("MEDIUM TITLE CD2"),
audio_track("TITLE THREE", "2-1"),
],
2,
[
@@ -414,13 +431,15 @@ class TestTracklist(DiscogsTestMixin):
track_artist = "TRACK ARTIST"
group_artist = "GROUP ARTIST"
tracks = [
_track(
index_track(
"TRACK GROUP TITLE",
artists=[_artist(group_artist)],
sub_tracks=[
_track("TRACK ONE", "2", artists=[_artist(track_artist)]),
_track("SUBTITLE TWO", "3"),
[
audio_track(
"TRACK ONE", "2", artists=[_artist(track_artist)]
),
audio_track("SUBTITLE TWO", "3"),
],
artists=[_artist(group_artist)],
)
]
release = self._make_release(tracks)