Feat: Smartplaylist: Add dest_regen option for regenerating destination path

[pierreay]

Problem

1. When items are imported into the library in a don't copy-move mode (-C -M options), they will be registered inside the Beets database using their original paths. However, during subsequent processing (e.g., a convert operation), a path following the Beets path format can be generated.
2. When generating playlists using smartplaylist plugin, only the path registered inside the Beets database (the original path) can be use inside the output playlist. This block the compatibility with other plugins.

Solution

I added a a new optional configuration option known as dest_regen (as well as its equivalent dest-regen on the CLI) to regenerate items' path in the generated playlist instead of using the ones of the library, just like a convert or a move operation would have done. This operation will happen before the relative_to and prefix options, which makes sense to do so and not in another order, otherwise this new option (dest_regen)) would overwrite the desired behavior of the other mentioned options (relative_to and prefix). It is then helpful to generate playlists compatible with the convert plugin.

To Do

• Documentation
• Changelog
• Tests. (I may write one in the future if this PR is considered)

[Copilot]

Pull Request Overview

This PR adds a new configuration option "dest_regen" (with its CLI alias "--dest-regen") to support regenerating the destination path for playlist items, thereby improving compatibility with the convert plugin.

• Introduces a configuration flag "dest_regen" with a default of False.
• Adds a corresponding CLI option "--dest-regen".
• Updates the playlist update logic to optionally use the item's regenerated destination path.

Files not reviewed (2)

• docs/changelog.rst: Language not supported
• docs/plugins/smartplaylist.rst: Language not supported

Comments suppressed due to low confidence (1)

beetsplug/smartplaylist.py:267

• The new dest_regen functionality is not covered by tests; please add tests to ensure that the regenerated destination path is correctly handled under various configurations.

dest_regen = self.config["dest_regen"].get()

[pierreay]

Hello @snejus ! :) Rebasing on master and writing of a test to test the dest_regen feature logic is done!

[pierreay]

Rebased on master for v2.3.0. :) Anything else that I can do?

[snejus]

@pierreay I apologise for such a late review again...

I've rebased this branch - let me know if you're able to resolve the linting issues. If not, I can take it from here

[pierreay]

Hello @snejus , I rebased the branch on master, and added one commit to fix linting issues found with ruff. However, I was unable to fix the documentation formatting with docstrfmt, as I did not had the same result between my computer and what was returned by poe through GitHub Actions. Moreover, it seems that Actions are stuck for an unknown reason -- I see Expected — Waiting for status to be reported on my page.

[snejus]

GitHub had an incident with Actions last night, but this should be resolved now. Try

git commit --no-edit --amend --date=now

And force pushing, let's see whether it works now?

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 69.55%. Comparing base (2c6f239) to head (78bc2d9).
⚠️ Report is 19 commits behind head on master.
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #5621   +/-   ##
=======================================
  Coverage   69.55%   69.55%           
=======================================
  Files         141      141           
  Lines       18494    18498    +4     
  Branches     3025     3026    +1     
=======================================
+ Hits        12863    12867    +4     
  Misses       4995     4995           
  Partials      636      636           

Files with missing lines	Coverage Δ
beetsplug/smartplaylist.py	75.89% <100.00%> (+0.50%)	⬆️

🚀 New features to boost your workflow:

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

[pierreay]

Hi @snejus , this branch has been rebased on master and tests / documentation was reworked to fix all errors and adopt last coding conventions / API change since the last work on it (which was may last year ahah). Everything should be ready to merge IMHO, feel free to raise suggestions if any. Thanks. :)

[snejus]

@pierreay thanks for this! Now that it's all in place I'll have a look at it, starting with Copilot!

[Copilot]

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

[snejus]

Ah, I recently added a new CI check which now failed!

[pierreay]

Sure, the changelog is fixed! Ready to be merged ;)

[snejus]

Thanks!