feat(ftintitle): hook metadata events, fixing mbsync by treyturner · Pull Request #6726 · beetbox/beets

treyturner · 2026-06-10T10:12:19Z

Depends on #6732.

Summary

This PR integrates ftintitle with metadata fetched through beets’ metadata-received events, so commands like mbsync apply already-normalized metadata when ftintitle is enabled.

Addresses #1153.

Changes

Register ftintitle listeners for trackinfo_received and albuminfo_received when ftintitle.auto is enabled.
Rewrite fetched TrackInfo metadata before mbsync applies it, avoiding unnecessary re-sync churn.
Preserve existing manual command and import behavior while sharing the same rewrite logic.
Handle artist_credit, cached Info properties, empty titles, and no-op configurations consistently.
Update ftintitle docs for the expanded auto behavior.

To Do

Documentation. (If you've added a new command-line flag, for example, find the appropriate page under docs/ to describe it.)
Changelog. (Add an entry to docs/changelog.rst to the bottom of one of the lists near the top of the document.)
Tests. (Very much encouraged but not strictly required.)

codecov · 2026-06-10T10:27:10Z

Codecov Report

❌ Patch coverage is 95.52239% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 74.91%. Comparing base (37e2a8b) to head (109c61b).
⚠️ Report is 40 commits behind head on master.
✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
beetsplug/ftintitle.py	95.52%	2 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #6726      +/-   ##
==========================================
+ Coverage   74.85%   74.91%   +0.05%     
==========================================
  Files         163      163              
  Lines       20947    20998      +51     
  Branches     3299     3307       +8     
==========================================
+ Hits        15680    15730      +50     
+ Misses       4510     4508       -2     
- Partials      757      760       +3

Files with missing lines	Coverage Δ
beetsplug/ftintitle.py	`92.74% <95.52%> (+3.30%)`	⬆️

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:

📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

snejus

Let's split the following into a separate PR:

Define each configuration option as a @cached_property to remove the need to send them through each function. See 34772d2 where I did the same for convert plugin.

This will remove a big chunk of the current PR diff and make it easier to review the functionality that you added.

treyturner · 2026-06-12T17:34:55Z

The cached properties are now in #6732 on which this PR is based. The remaining changes can be seen in the single subsequent commit:

ff085e4 (this PR)

Pre-factor for #6726. Make `ftintitle`'s config `@cached_property` attributes instead of passing them through the call stack. Modeled after similar recent changes in `convert`. ## Changes - Add cached plugin properties for `auto`, `drop`, `format`, `keep_in_artist`, `preserve_album_artist`, and `custom_words`, keeping the existing cached `bracket_keywords` property I forgot I added a while back. - `commands()`, `imported()`, `ft_in_title()`, and `update_metadata()` are cleaned up to read these directly. - Don't read `auto` during plugin init; the import stage remains registered and `imported()` checks `auto` when invoked.

snejus · 2026-06-13T16:34:48Z

Now rebase it on master and I'll review it again :)

snejus · 2026-06-19T18:40:21Z

Now just rebase it again since your fix has been merged!

snejus

Had the first review - will have another look once these comments are addressed!

treyturner · 2026-06-20T20:21:13Z

I /think/ these are all addressed, but yes please have another look as updates were quite scattered. I really appreciate the reviews and help. Every few months when I get time to pick up more beets work I have to remember everything I learned about the data model and then forgot since the last hiatus 🤤

snejus · 2026-06-23T09:14:40Z

I have to remember everything I learned about the data model and then forgot since the last hiatus 🤤

It's also been regularly changing as we've been refactoring it... 😆

snejus

Another quick review round: as I mentioned in the comments, inclusion of artist_credit will have unintended side-effects and we'd rather this separately.

Will have a final review once it's updated!

snejus · 2026-06-28T02:19:48Z

+    def _strip_featured_from_field(
+        self,
+        metadata: Info | Item,
+        field: FeaturedField,
+        for_artist: bool = True,
+    ) -> None:
+        if value := metadata.get(field):
+            stripped, _ = split_on_feat(
+                value, for_artist=for_artist, custom_words=self.custom_words
+            )
+            metadata[field] = stripped


Why was this method introduced? This is applied within update_info_metadata, but isn't applied within update_item_metadata.

Furthermore, this method edits the structure that was passed into it - not a good idea. Best to remove it

snejus · 2026-06-28T02:21:21Z

+
+        return changed
+
+    def update_info_metadata(self, info: Info, feat_part: str) -> bool:


Why are Item and Info updated using separate methods? Is there any difference in the logic?

It seems like we should be able to use a single update_metadata method instead.

snejus · 2026-06-28T02:45:02Z

+        for track_info in info.tracks:
+            self.ft_in_info(track_info, albumartist)

    def ft_in_title(self, item: Item) -> bool:


I see you've taken the right direction and defined ft_in_title and ft_in_info to be very similar to each other. We don't need a second method here - just define

def ft_in_title(self, item: Item | Info, albumartist: str) -> bool:

and remove ft_in_info.

Note you will probably need to guard this line in ft_in_title implementation with hasattr("filepath") or something, since filepath is not defined on Info.

self._log.info("{.filepath}", item)

snejus · 2026-06-28T02:52:06Z

+        assert info.item_data["artist"] == "Alice"
+        assert info.item_data["title"] == "Song feat. Bob"


No need to assert these two since they don't seem to be functionally related to your changes.

snejus · 2026-06-28T02:55:55Z

    """
+    if not albumartist:
+        _, feat_part = split_on_feat(
+            artist, for_artist=True, custom_words=custom_words


Why is this method adjusted?

snejus · 2026-06-28T03:03:12Z

+    def test_trackinfo_received_preserves_collaborative_artist_credit(
+        self,
+    ) -> None:
+        self.config["artist_credit"] = False
+        info = TrackInfo(
+            artist="Alice feat. Bob",
+            artist_credit="Alice & Bobby",
+            title="Song",
+        )
+
+        with self.configure_plugin({"auto": True}):
+            plugins.send("trackinfo_received", info=info)
+
+        assert info.artist == "Alice"
+        assert info.artist_credit == "Alice & Bobby"
+        assert info.title == "Song feat. Bob"
+


This is essentially a copy of test_trackinfo_received_preserves_artist_credit_when_disabled.

Suggested change

def test_trackinfo_received_preserves_collaborative_artist_credit(

self,

) -> None:

self.config["artist_credit"] = False

info = TrackInfo(

artist="Alice feat. Bob",

artist_credit="Alice & Bobby",

title="Song",

)

with self.configure_plugin({"auto": True}):

plugins.send("trackinfo_received", info=info)

assert info.artist == "Alice"

assert info.artist_credit == "Alice & Bobby"

assert info.title == "Song feat. Bob"

snejus · 2026-06-28T03:04:46Z

+    def test_command_preserves_artist_credit_when_enabled(self) -> None:
+        self.config["artist_credit"] = True
+        item = self.add_item(
+            path="/",
+            artist="Alice feat. Bob",
+            artist_credit="Alice feat. Bobby",
+            title="Song",
+            albumartist="Alice",
+        )
+
+        with self.configure_plugin({"auto": True}):
+            self.run_command("ftintitle")
+
+        item.load()
+        assert item.artist == "Alice"
+        assert item.artist_credit == "Alice feat. Bobby"
+        assert item.title == "Song feat. Bob"
+
+    def test_command_preserves_artist_credit_when_disabled(self) -> None:
+        self.config["artist_credit"] = False
+        item = self.add_item(
+            path="/",
+            artist="Alice feat. Bob",
+            artist_credit="Alice feat. Bobby",
+            title="Song",
+            albumartist="Alice",
+        )
+
+        with self.configure_plugin({"auto": True}):
+            self.run_command("ftintitle")
+
+        item.load()
+        assert item.artist == "Alice"
+        assert item.artist_credit == "Alice feat. Bobby"
+        assert item.title == "Song feat. Bob"
+


We removed artist_credit handling.

Suggested change

def test_command_preserves_artist_credit_when_enabled(self) -> None:

self.config["artist_credit"] = True

item = self.add_item(

path="/",

artist="Alice feat. Bob",

artist_credit="Alice feat. Bobby",

title="Song",

albumartist="Alice",

)

with self.configure_plugin({"auto": True}):

self.run_command("ftintitle")

item.load()

assert item.artist == "Alice"

assert item.artist_credit == "Alice feat. Bobby"

assert item.title == "Song feat. Bob"

def test_command_preserves_artist_credit_when_disabled(self) -> None:

self.config["artist_credit"] = False

item = self.add_item(

path="/",

artist="Alice feat. Bob",

artist_credit="Alice feat. Bobby",

title="Song",

albumartist="Alice",

)

with self.configure_plugin({"auto": True}):

self.run_command("ftintitle")

item.load()

assert item.artist == "Alice"

assert item.artist_credit == "Alice feat. Bobby"

assert item.title == "Song feat. Bob"

The tests aimed to make the current behavior explicit and support subsequent discussion or possible upcoming changes you hinted around mutating artist_credit, but I'll remove them 👍

github-actions Bot added ftintitle ftintitle plugin mbsync mbsync plugin labels Jun 10, 2026

treyturner force-pushed the feat/ftintitle-hook-metadata-events branch from 38e0446 to 8839b95 Compare June 10, 2026 10:16

treyturner force-pushed the feat/ftintitle-hook-metadata-events branch 4 times, most recently from ff4a62f to 06da57e Compare June 10, 2026 11:20

treyturner marked this pull request as ready for review June 10, 2026 11:32

treyturner requested a review from a team as a code owner June 10, 2026 11:32

treyturner force-pushed the feat/ftintitle-hook-metadata-events branch from 06da57e to 9e8f19c Compare June 11, 2026 21:55

snejus requested changes Jun 12, 2026

View reviewed changes

Comment thread beetsplug/ftintitle.py Outdated

treyturner mentioned this pull request Jun 12, 2026

refactor(ftintitle): cache config options #6732

Merged

3 tasks

treyturner force-pushed the feat/ftintitle-hook-metadata-events branch 3 times, most recently from 3719e23 to ff085e4 Compare June 12, 2026 17:11

treyturner requested a review from snejus June 12, 2026 17:35

treyturner force-pushed the feat/ftintitle-hook-metadata-events branch from ff085e4 to 7bfb1a7 Compare June 13, 2026 01:18

treyturner force-pushed the feat/ftintitle-hook-metadata-events branch 2 times, most recently from 7b4d06a to 146715c Compare June 19, 2026 02:01

treyturner force-pushed the feat/ftintitle-hook-metadata-events branch 2 times, most recently from 2202df0 to ca2dcce Compare June 20, 2026 03:44

snejus requested changes Jun 20, 2026

View reviewed changes

treyturner requested a review from snejus June 20, 2026 20:22

treyturner force-pushed the feat/ftintitle-hook-metadata-events branch from 0074e86 to e94329a Compare June 20, 2026 20:23

treyturner force-pushed the feat/ftintitle-hook-metadata-events branch from e94329a to a42a3a3 Compare June 20, 2026 20:27

snejus requested changes Jun 23, 2026

View reviewed changes

Comment thread beetsplug/ftintitle.py Outdated

Comment thread beetsplug/ftintitle.py Outdated

Comment thread beetsplug/ftintitle.py Outdated

Comment thread beetsplug/ftintitle.py Outdated

treyturner force-pushed the feat/ftintitle-hook-metadata-events branch from a42a3a3 to baeeff0 Compare June 27, 2026 17:38

treyturner added 5 commits June 27, 2026 13:28

feat(ftintitle): hook metadata events, fixing mbsync

3455108

fix(hooks): remove cached property invalidation

487c8a5

fix(ftintitle): rename to _strip_featured_from_field

f739ab9

fix(ftintitle): use Item type and type featured field

16b457b

fix(ftintitle): defer inclusion of artist_credit, review cleanup

109c61b

treyturner force-pushed the feat/ftintitle-hook-metadata-events branch from 03551ef to 109c61b Compare June 27, 2026 18:29

treyturner requested a review from snejus June 27, 2026 18:54

snejus requested changes Jun 28, 2026

View reviewed changes


		return changed

		def update_info_metadata(self, info: Info, feat_part: str) -> bool:

		assert info.item_data["artist"] == "Alice"
		assert info.item_data["title"] == "Song feat. Bob"

Uh oh!

Conversation

treyturner commented Jun 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

To Do

Uh oh!

codecov Bot commented Jun 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

snejus left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

treyturner commented Jun 12, 2026

Uh oh!

snejus commented Jun 13, 2026

Uh oh!

snejus commented Jun 19, 2026

Uh oh!

snejus left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

treyturner commented Jun 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

snejus commented Jun 23, 2026

Uh oh!

snejus left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

treyturner commented Jun 10, 2026 •

edited

Loading

codecov Bot commented Jun 10, 2026 •

edited

Loading

treyturner commented Jun 20, 2026 •

edited

Loading