Release History

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning

1.0.0

Added

• Custom API caching backend to replace dependency on requests-cache package. Currently only supports SQLite backend. More backends can be implemented in future if desired.

• Cache settings for specific GET request endpoints on SpotifyAPI replacing need for per method use_cache parameter.

Changed

• Replaced authorise method from APIAuthoriser with __call__ method for class.

• Dependency injection pattern for RequestHandler and RemoteAPI. Now takes APIAuthoriser and ResponseCache objects for instantiation instead of kwargs for APIAuthoriser.

• APIAuthoriser kwargs given to SpotifyAPI now merge with default kwargs.

• Moved remote_wrangler attribute from MusifyCollection to LocalCollection. This attribute was only needed by LocalCollection branch of child classes.

• Moved logger attribute from Library to RemoteLibrary.

• Switch some dependencies to be optional for groups of operation: progress bars, images, musicbee

Fixed

• Added missing variables to __slots__ definitions

• Correctly applied __slots__ pattern to child classes. Now works as expected.

• LocalTrack now copies tags as expected when calling copy.copy()

Removed

• use_cache parameter from all RemoteAPI related methods. Cache settings now handled by ResponseCache

0.9.2

Added

• REMOTE_SOURCES global variable in the libraries.remote module which lists the names of all the fully supported remote sources. Also, added the SOURCE_NAME global variable for the Spotify module.

Changed

• FilterComparers now accepts a single Comparer on the comparers argument.

• MusicBee class attributes were renamed to classify that full paths are also valid, not just filenames.

• ItemDownloadHelper urls init arg now has default arg of empty tuple.

Documentation

• Fixed error in ‘sync data’ how-to.

Fixed

• Comparer now considers strings as converted on first pass when converting expected values.

• Printing of new line at the end of RemoteLibrary.extend()

0.9.1

Fixed

• Bug in ItemMatcher.match() where operations always returned the last item in the given list of results

0.9.0

Added

• RemoteAPI methods now accept RemoteResponse objects as input, refreshing them automatically

• Property ‘kind’ to all objects which have an associated RemoteObjectType

• Introduced MusifyItemSettable class to allow distinction between items that can have their properties set and those that can’t

• Extend FilterMatcher with group_by tag functionality

• Now fully supports parsing of processors relating to XAutoPF objects with full I/O of settings to/from their related XML files on disk

• Now supports creating new XAutoPF files from scratch without the file needing to already exist For XML values not directly controlled by Musify, users can use the ‘default_xml’ class attribute to control the initial default values applied in this scenario

• ‘length’ property on MusifyCollection and implementation on all subclasses

Changed

• Major refactoring and restructuring to all modules to improve modularity and add composition

• The following classes and methods have been modified to implement concurrency to improve performance:

  • LocalLibrary.load_tracks()

  • LocalLibrary.save_tracks()

  • LocalLibrary.load_playlists()

  • LocalLibrary.save_playlists()

  • LocalLibrary.json() + optimisation for extracting JSON data from tracks

  • ItemMatcher

  • RemoteItemChecker

  • RemoteItemSearcher

• Made load_tracks() and load_playlists() utility functions more DRY

• Move TagReader.load() from LocalTrack to super class TagReader

• SpotifyAPI.extend_items() now skips on responses that are already fully extended

• SpotifyArtist.load() now uses the base load method from SpotifyCollectionLoader meaning it now takes full advantage of the item filtering this method offers. As part of this, the base method was made more generic to accommodate all SpotifyObject types

• Renamed ‘kind’ property on LocalTrack to ‘type’ to avoid clashing property names

• ItemMatcher, RemoteItemChecker, and RemoteItemSearcher now accept all MusifyItem types that may have their URI property set manually

• RemoteItemChecker and RemoteItemSearcher no longer inherit from ItemMatcher. Composite pattern used instead.

• ItemSorter now shuffles randomly on unsupported types + prioritises fields settings over shuffle settings

• Comparer._in_range() now uses inclusive range i.e. a <= x <= b where x is the value to compare and a and b are the limits. Previously used exclusive range i.e. a < x < b

• Removed from_xml and to_xml methods from all MusicBeeProcessor subclasses. Moved this logic to XMLPlaylistParser as distinct ‘get’ methods for each processor type

• Moved loading of XML file logic from XAutoPF to XMLPlaylistParser. XMLPlaylistParser is now solely responsible for all XML parsing and handling for XAutoPF files

Fixed

• Comparer dynamic processor methods which process string values now cast expected types before processing

Removed

• Redundant ShuffleBy enum and related arguments from ItemSorter

• ItemProcessor and MusicBeeProcessor abstraction layers. No longer needed after some refactoring

• get_filtered_playlists method from Library. This contained author specific logic and was not appropriate for general use

Documentation

• Added info on lint checking for the contributing page

0.8.1

Changed

• ItemSorter now accepts shuffle_weight between -1 and 1 instead of 0 and 1. This parameter’s logic has not yet been implemented so no changes to functionality have been made yet

• Move get_filepaths() from LocalTrack to super class File

Documentation

• References to python objects now link correctly

Fixed

• Comments from LocalTrack metadata loading no longer gets wiped after setting URI on init

• Tweaked assignment of description of IDv3 comment tags for MP3

• align_string() function now handles combining unicode characters properly for fixed-width fonts

• LocalTrack.get_filepaths() on LocalTrack no longer returns paths from $RECYCLE.BIN folders. These are deleted files and were causing the package to crash when trying to load them

• PrettyPrinter.json() and PrettyPrinter._to_str() converts attribute keys to string to ensure safe json/str/repr output

• FilterMatcher and FilterComparers now correctly import conditions from XML playlist files. Previously, these filters could not import nested match conditions from files. Changes to logic also made to Comparer.from_xml() to accommodate

• XMLLibraryParser now handles empty arrays correctly. Previously would crash

• Fixed Comparer dynamic process method alternate names for in_the_last and not_in_the_last

Removed

• Abstract uri.setter method on Item

0.8.0

Added

• Add debug log for error failure reason when loading tracks

• MusifyCollection.intersection() and MusifyCollection.difference() methods

• Playlist.merge() and Library.merge_playlists() methods

Changed

• Generating folders for a LocalLibrary now uses folder names as relative to the library folders of the LocalLibrary. This now supports nested folder structures better

• Writing date tags to LocalTrack now supports partial dates of only YYYY-MM

• Writing date tags to LocalTrack skips writing year, month, day tags if date tag already written

Removed

• set_compilation_tags method removed from LocalFolder. This contained author specific logic and was not appropriate for general use

Fixed

• ConnectionError catch in RequestHandler now handles correctly

• Added safe characters and replacements for path conversion in MusicBee XMLLibraryParser. Now converts path to expected XML format correctly

• FilterMatcher now handles ‘&’ character correctly

• SpotifyAPI now only requests batches of up to 20 items when getting albums. Now matches Spotify Web API specifications better

• Loading of logging yaml config uses UTF-8 encoding now

• Removed dependency on pytest-lazy-fixture. Package is broken for pytest >8.0. Replaced functionality with forked version of code

0.7.6

Fixed

• Rename __max_str in local/collection.py to _max_str - functions could not see variable

• Add default value of 0 to sort_key in ItemSorter.sort_by_field()

• Fixed RemoteItemChecker _pause() logic to only get playlist name when input is not False-y

0.7.5

Added

• Add the ItemDownloadHelper general processor

Changed

• Factor out logging handlers to their own script to avoid circular import issues

• Abstract away input methods of RemoteItemChecker to InputProcessor base class

• Factor out patch_input method to function in InputProcessor derived tests

Fixed

• Captured stdout assertions in RemoteItemChecker tests re-enabled, now fixed

• Surround RemoteAPI ‘user’ properties in try-except block so they can still be pretty printed even if API is not authorised

Documentation

• Fix redirect/broken links

• Change notes text to proper rst syntax

0.7.4

Fixed

• Fix bug in LocalLibrary.restore_tracks() method on library due to ‘images’ tag name not being present in track properties

Documentation

• Expand docstrings across entire package

• Expand documentation with how to section, release history, and contributions pages

0.7.3

Changed

• Remove x10 factor on bar threshold on _get_items_multi function in SpotifyAPI

Fixed

• LocalTrack would break when trying to save tags for unmapped tag names, now handles correctly

0.7.2

Fixed

• MusifyLogger would not get file_paths for parent loggers when propagate == True, now it does

0.7.1

Changed

• Remove automatic assignment of absolute path to package root for relative paths on CurrentTimeRotatingFileHandler

Fixed

• CurrentTimeRotatingFileHandler now creates dirs for new log directories

0.7.0

Added

Initial release! 🎉