fix bug in comparer + XautoPF match for reference track

Author: geo-martino

docs/info/release-history.rst

@@ -32,6 +32,19 @@ The format is based on `Keep a Changelog <https://keepachangelog.com/en>`_,
 and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_
 
 
+1.1.9
+=====
+
+Changed
+-----
+* :py:class:`.Comparer` now correctly ignores the reference track given when the ``reference_required`` flag is False.
+
+Fixed
+-----
+* Bug in :py:class:`.XAutoPF` which caused it to always add the tracks that matched the associated tags of
+  the last played track when the expected values for the condition are null or empty.
+
+
 1.1.8
 =====
 

musify/processors/compare.py

@@ -26,6 +26,7 @@ class Comparer(DynamicProcessor):
         Types of the values in this list are automatically converted to the type of the item field's value.
     :param field: The field to match on.
     :param reference_required: When True, a reference object of type ``T`` must be passed to the ``compare`` method.
+        When False, reference files given to the ``compare`` method will be ignored.
         An exception will be raised if this is True and reference object is not passed.
     """
 
@@ -97,13 +98,12 @@ def compare[T: Any](self, item: T, reference: T | None = None) -> bool:
         else:
             actual = item
 
-        if reference is None:
-            # convert the expected values to the same type as the actual value if not yet converted
+        if self.reference_required:  # use the values from the reference as the expected values
+            expected = to_collection(reference[tag_name], list)
+        else:  # convert the expected values to the same type as the actual value if not yet converted
             if not self._converted:
                 self._convert_expected(actual)
             expected = self.expected
-        else:  # use the values from the reference as the expected values
-            expected = to_collection(reference[tag_name], list)
 
         if expected:  # special on-the-fly conversions for datetime values
             if isinstance(actual, datetime) and not isinstance(expected[0], datetime):

tests/processors/test_compare.py

@@ -54,7 +54,7 @@ def test_compare_with_reference(self):
         track_1 = random_track()
         track_2 = random_track()
 
-        comparer = Comparer(condition="StartsWith", field=TrackField.ALBUM)
+        comparer = Comparer(condition="StartsWith", field=TrackField.ALBUM, reference_required=True)
         assert comparer._expected is None
         assert not comparer._converted