mirror of
https://github.com/beetbox/beets.git
synced 2025-12-06 16:42:42 +01:00
127 lines
4.2 KiB
Python
127 lines
4.2 KiB
Python
# This file is part of beets.
|
|
# Copyright 2016, Adrian Sampson.
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining
|
|
# a copy of this software and associated documentation files (the
|
|
# "Software"), to deal in the Software without restriction, including
|
|
# without limitation the rights to use, copy, modify, merge, publish,
|
|
# distribute, sublicense, and/or sell copies of the Software, and to
|
|
# permit persons to whom the Software is furnished to do so, subject to
|
|
# the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be
|
|
# included in all copies or substantial portions of the Software.
|
|
|
|
"""Tests the facility that lets plugins add custom field to MediaFile."""
|
|
|
|
import os
|
|
import shutil
|
|
|
|
import mediafile
|
|
import pytest
|
|
|
|
from beets.library import Item
|
|
from beets.plugins import BeetsPlugin
|
|
from beets.test import _common
|
|
from beets.test.helper import BeetsTestCase
|
|
from beets.util import bytestring_path, syspath
|
|
|
|
field_extension = mediafile.MediaField(
|
|
mediafile.MP3DescStorageStyle("customtag"),
|
|
mediafile.MP4StorageStyle("----:com.apple.iTunes:customtag"),
|
|
mediafile.StorageStyle("customtag"),
|
|
mediafile.ASFStorageStyle("customtag"),
|
|
)
|
|
|
|
list_field_extension = mediafile.ListMediaField(
|
|
mediafile.MP3ListDescStorageStyle("customlisttag"),
|
|
mediafile.MP4ListStorageStyle("----:com.apple.iTunes:customlisttag"),
|
|
mediafile.ListStorageStyle("customlisttag"),
|
|
mediafile.ASFStorageStyle("customlisttag"),
|
|
)
|
|
|
|
|
|
class ExtendedFieldTestMixin(BeetsTestCase):
|
|
def _mediafile_fixture(self, name, extension="mp3"):
|
|
name = bytestring_path(f"{name}.{extension}")
|
|
src = os.path.join(_common.RSRC, name)
|
|
target = os.path.join(self.temp_dir, name)
|
|
shutil.copy(syspath(src), syspath(target))
|
|
return mediafile.MediaFile(target)
|
|
|
|
def test_extended_field_write(self):
|
|
plugin = BeetsPlugin()
|
|
plugin.add_media_field("customtag", field_extension)
|
|
|
|
try:
|
|
mf = self._mediafile_fixture("empty")
|
|
mf.customtag = "F#"
|
|
mf.save()
|
|
|
|
mf = mediafile.MediaFile(mf.path)
|
|
assert mf.customtag == "F#"
|
|
|
|
finally:
|
|
delattr(mediafile.MediaFile, "customtag")
|
|
Item._media_fields.remove("customtag")
|
|
|
|
def test_extended_list_field_write(self):
|
|
plugin = BeetsPlugin()
|
|
plugin.add_media_field("customlisttag", list_field_extension)
|
|
|
|
try:
|
|
mf = self._mediafile_fixture("empty")
|
|
mf.customlisttag = ["a", "b"]
|
|
mf.save()
|
|
|
|
mf = mediafile.MediaFile(mf.path)
|
|
assert mf.customlisttag == ["a", "b"]
|
|
|
|
finally:
|
|
delattr(mediafile.MediaFile, "customlisttag")
|
|
Item._media_fields.remove("customlisttag")
|
|
|
|
def test_write_extended_tag_from_item(self):
|
|
plugin = BeetsPlugin()
|
|
plugin.add_media_field("customtag", field_extension)
|
|
|
|
try:
|
|
mf = self._mediafile_fixture("empty")
|
|
assert mf.customtag is None
|
|
|
|
item = Item(path=mf.path, customtag="Gb")
|
|
item.write()
|
|
mf = mediafile.MediaFile(mf.path)
|
|
assert mf.customtag == "Gb"
|
|
|
|
finally:
|
|
delattr(mediafile.MediaFile, "customtag")
|
|
Item._media_fields.remove("customtag")
|
|
|
|
def test_read_flexible_attribute_from_file(self):
|
|
plugin = BeetsPlugin()
|
|
plugin.add_media_field("customtag", field_extension)
|
|
|
|
try:
|
|
mf = self._mediafile_fixture("empty")
|
|
mf.update({"customtag": "F#"})
|
|
mf.save()
|
|
|
|
item = Item.from_path(mf.path)
|
|
assert item["customtag"] == "F#"
|
|
|
|
finally:
|
|
delattr(mediafile.MediaFile, "customtag")
|
|
Item._media_fields.remove("customtag")
|
|
|
|
def test_invalid_descriptor(self):
|
|
with pytest.raises(
|
|
ValueError, match="must be an instance of MediaField"
|
|
):
|
|
mediafile.MediaFile.add_field("somekey", True)
|
|
|
|
def test_overwrite_property(self):
|
|
with pytest.raises(
|
|
ValueError, match='property "artist" already exists'
|
|
):
|
|
mediafile.MediaFile.add_field("artist", mediafile.MediaField())
|