beetbox/beets v2.4.0

Release v2.4.0

on GitHub

New features

• Discogs Plugin: Add configurable search_limit option to limit the number of results returned by the Discogs metadata search queries.
• Discogs Plugin: Implement track_for_id method to allow retrieving singletons by their Discogs ID. 🐛 (#4661)
• Duplicates Plugin: Add --remove option, allowing to remove from the library without deleting media files. 🐛 (#5832)
• MPDStats Plugin: Add new configuration option, played_ratio_threshold, to allow configuring the percentage the song must be played for it to be counted as played instead of skipped.
• MusicBrainz Collection Plugin: When getting the user collections, only consider collections of releases, and ignore collections of other entity types.
• MusicBrainz Plugin: The MusicBrainz autotagger has been moved to a separate plugin. The default plugins includes MusicBrainz Plugin, but if you've customized your plugins list in your configuration, you'll need to explicitly add MusicBrainz Plugin to continue using this functionality. Configuration option musicbrainz.enabled has thus been deprecated. 🐛 (#2686) 🐛 (#4605)
• Playlist Plugin: Support files with the .m3u8 extension. 🐛 (#5829)
• Replace Plugin: Add new plugin.
• Spotify Plugin Deezer Plugin: Add new configuration option search_limit to limit the number of results returned by search queries.
• Web Plugin: Display artist and album as part of the search results.
• Web Plugin: Show notifications when a track plays. This uses the Media Session API to customize media notifications.

Bug fixes

• Fix HiddenFileTest by using bytestring_path().
• Fix an issue where calling Library.add would cause the database_change event to be sent twice, not once. 🐛 (#5560)
• Fixed regression with ListenBrainz Plugin where the plugin could not be loaded 🐛 (#5975)
• Chromaprint/Acoustid Plugin: AcoustID lookup HTTP requests will now time out after 10 seconds, rather than hanging the entire import process.
• Deezer Plugin: Fix the issue with that every query to deezer was ascii encoded. This resulted in bad matches for queries that contained special e.g. non latin characters as 盗作. If you want to keep the legacy behavior set the config option deezer.search_query_ascii: yes. 🐛 (#5860)
• Discogs Plugin: Beets will no longer crash if a release has been deleted, and returns a 404.
• LastGenre Plugin: Fix the issue introduced in Beets 2.3.0 where non-whitelisted last.fm genres were not canonicalized to parent genres. 🐛 (#5930)
• MusicBrainz Plugin: Fix the MusicBrainz search not taking into account the album/recording aliases
• MusicBrainz Plugin: fix regression where user configured extra_tags have been read incorrectly. 🐛 (#5788)
• Spotify Plugin: Fix the issue with that every query to spotify was ascii encoded. This resulted in bad matches for queries that contained special e.g. non latin characters as 盗作. If you want to keep the legacy behavior set the config option spotify.search_query_ascii: yes. 🐛 (#5699)
• tests: Fix library tests failing on Windows when run from outside D:/. 🐛 (#5802)
• tests: Fix tests failing without langdetect (by making it required). 🐛 (#5797)

For packagers

• Loosened typing_extensions dependency in pyproject.toml to apply to every python version.
• Optional extra_tags parameter has been removed from BeetsPlugin.candidates method signature since it is never passed in. If you override this method in your plugin, feel free to remove this parameter.

For plugin developers

• The FetchArt Plugin plugins has seen a few changes to function signatures and source registration in the process of introducing typings to the code. Custom art sources might need to be adapted.

• We split the responsibilities of plugins into two base classes

  1. beets.plugins.BeetsPlugin is the base class for all plugins, any plugin needs to inherit from this class.
  2. beets.metadata_plugin.MetadataSourcePlugin allows plugins to act like metadata sources. E.g. used by the MusicBrainz plugin. All plugins in the beets repo are opted into this class where applicable. If you are maintaining a plugin that acts like a metadata source, i.e. you expose any of track_for_id, album_for_id, candidates, item_candidates, album_distance, track_distance methods, please update your plugin to inherit from the new baseclass, as otherwise your plugin will stop working with the next major release.

• Several definitions have been moved:

  • BLOB_TYPE constant, PathQuery and SingletonQuery queries have moved from beets.library to beets.dbcore.query module
  • DateType, DurationType, PathType types and MusicalKey class have moved from beets.library to beets.dbcore.types module.
  • Distance has moved from beets.autotag to beets.autotag.distance module.
  • beets.autotag.current_metadata has been renamed to beets.util.get_most_common_tags.

  Old imports are now deprecated and will be removed in version 3.0.0.

• beets.ui.decargs is deprecated and will be removed in version 3.0.0.

• Beets is now PEP 561 compliant, which means that it provides type hints for all public APIs. This allows IDEs to provide better autocompletion and type checking for downstream users of the beets API.

• plugins.find_plugins function does not anymore load plugins. You need to explicitly call plugins.load_plugins() to load them.

• plugins.load_plugins function does not anymore accept the list of plugins to load. Instead, it loads all plugins that are configured by plugins configuration.

• Flexible fields, which can be used by plugins to store additional metadata, now also support list values. Previously, beets would throw an error while storing the data in the SQL database due to missing type conversion. 🐛 (#5698)

Other changes

• Added a test to check that all plugins can be imported without errors.
• Documentation structure for auto generated API references changed slightly. Autogenerated API references are now located in the docs/api subdirectory.
• Refactor: Split responsibilities of Plugins into MetaDataPlugins and general Plugins.
• Refactored library.py file by splitting it into multiple modules within the beets/library directory.
• UI: Update default text_diff_added color from bold red to bold green.
• UI: Use text_diff_added and text_diff_removed colors in all diff comparisons, including case differences.
• Getting Started: Add instructions to install beets on Void Linux.
• LastGenre Plugin: Refactor loading whitelist and canonicalization file. 🐛 (#5979)
• LastGenre Plugin: Updated and streamlined the genre whitelist and canonicalization tree 🐛 (#5977)
• Substitute Plugin: Fix rST formatting for example cases so that each case is shown on separate lines.