autobpm: Add `--force` and `--quiet` options; Deprecate `overwrite` by JOJ0 · Pull Request #6481 · beetbox/beets

JOJ0 · 2026-03-31T06:37:47Z

Description

Reveal the overwrite config setting to the CLI and at the same time deprecate the option name. It should be named force to streamline with other beets configs of the same kind.

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.)

github-actions · 2026-03-31T06:38:06Z

Thank you for the PR! The changelog has not been updated, so here is a friendly reminder to check if you need to add an entry.

codecov · 2026-03-31T06:57:04Z

Codecov Report

❌ Patch coverage is 60.00000% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 70.01%. Comparing base (712bada) to head (80fcbe6).
✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
beetsplug/autobpm.py	60.00%	5 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #6481      +/-   ##
==========================================
- Coverage   70.01%   70.01%   -0.01%     
==========================================
  Files         146      146              
  Lines       18505    18514       +9     
  Branches     3010     3012       +2     
==========================================
+ Hits        12957    12962       +5     
- Misses       4920     4923       +3     
- Partials      628      629       +1

Files with missing lines	Coverage Δ
beetsplug/autobpm.py	`71.69% <60.00%> (-3.31%)`	⬇️

🚀 New features to boost your workflow:

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

and refactor docs.

When batch bpm computing, the plugin's output is very noisy. This change allows hiding "BPM already exists for item" logs with a new `--quiet` option (or config setting)

beetsplug/autobpm.py

jackwilsdon · 2026-03-31T21:39:19Z

beetsplug/autobpm.py

+        )

    def imported(self, _, task: ImportTask) -> None:
        self.calculate_bpm(task.imported_items())


Should this also obey force and quiet from the config?

good point! will fix!

docs/plugins/autobpm.rst

Copilot

Pull request overview

This PR update autobpm plugin so user can overwrite existing BPM via new force name (config + CLI), and hide “already has bpm” message via quiet. It also start deprecate old overwrite config name.

Changes:

Add --force/-f and --quiet/-q flags to beet autobpm, and thread force/quiet through BPM calculation.
Add config keys force and quiet, and deprecate overwrite (with user warning).
Update docs and changelog to mention new options and deprecation.

Reviewed changes

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

File	Description
`beetsplug/autobpm.py`	Add `force/quiet` config + CLI flags; deprecate `overwrite` and map it to `force`; adjust logging/skip logic.
`docs/plugins/autobpm.rst`	Document new config defaults; add `force/quiet`; mark `overwrite` deprecated.
`docs/changelog.rst`	Add Unreleased changelog bullets for new `force` + `--quiet`.

beetsplug/autobpm.py

Copilot · 2026-04-01T07:09:45Z

beetsplug/autobpm.py

+    def command(self, lib: Library, opts, args: list[str]) -> None:
+        force = self.config["force"].get(bool) or opts.force
+        quiet = self.config["quiet"].get(bool) or opts.quiet
+        self.calculate_bpm(
+            list(lib.items(args)),
+            write=should_write(),
+            force=force,
+            quiet=quiet,
+        )

    def imported(self, _, task: ImportTask) -> None:
-        self.calculate_bpm(task.imported_items())
+        self.calculate_bpm(
+            task.imported_items(),
+            force=self.config["force"].get(bool),
+            quiet=self.config["quiet"].get(bool),
+        )

-    def calculate_bpm(self, items: list[Item], write: bool = False) -> None:
+    def calculate_bpm(
+        self,
+        items: list[Item],
+        write: bool = False,
+        force: bool = False,
+        quiet: bool = False,
+    ) -> None:
        for item in items:
            path = item.filepath
            if bpm := item.bpm:
-                self._log.info("BPM for {} already exists: {}", path, bpm)
-                if not self.config["overwrite"]:
+                if not quiet:
+                    self._log.info("BPM for {} already exists: {}", path, bpm)
+                if not force:
                    continue


grug see new force/quiet behavior and deprecated overwrite path, but tests not check: (1) --force overwrites existing bpm, (2) --quiet suppresses log, (3) overwrite config still works + warns. please add regression tests in existing test/plugins/test_autobpm.py so behavior not break later.

docs/plugins/autobpm.rst

JOJ0 · 2026-04-01T07:19:12Z

Docs render and relevant parts look like this (first time I actually use the conf directives and the deprecations features. Very nice stuff! Love it @snejus) Hope I did it correctly since it doesnt state which version we will throw it out? (The logs say that this is with 3.0.0, so i guess when we deprecate something we will always until next major release which is allowed to include breaking changes, right?)

@jackwilsdon appreciate a final review :-)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

jackwilsdon

Looks good 👍

JOJ0 requested a review from a team as a code owner March 31, 2026 06:37

JOJ0 marked this pull request as draft March 31, 2026 06:38

JOJ0 force-pushed the autobpm_force_option branch from 79fa4e2 to 4b75c68 Compare March 31, 2026 20:39

JOJ0 changed the title ~~autobpm: Support --force for overwrite config~~ autobpm: Support --force and deprecate overwrite setting Mar 31, 2026

JOJ0 changed the title ~~autobpm: Support --force and deprecate overwrite setting~~ autobpm: Support --force and deprecate overwrite setting Mar 31, 2026

JOJ0 added a commit that referenced this pull request Mar 31, 2026

Add changelog for #6481 autobpm force option

227b179

JOJ0 added 2 commits March 31, 2026 22:47

autobpm: Option --force for overwrite setting

1b19a41

autobpm: Rename and deprecate overwrite setting

2b5f637

and refactor docs.

JOJ0 added a commit that referenced this pull request Mar 31, 2026

Add changelog for #6481 autobpm force option

8621fa8

JOJ0 force-pushed the autobpm_force_option branch from 227b179 to 8621fa8 Compare March 31, 2026 20:48

JOJ0 marked this pull request as ready for review March 31, 2026 20:48

Add changelog for #6481 autobpm force option

2832cc5

JOJ0 force-pushed the autobpm_force_option branch from 8621fa8 to 2832cc5 Compare March 31, 2026 21:09

JOJ0 and others added 2 commits March 31, 2026 23:13

Changelog for PR 6480 autobpm

ad057ec

autobpm: Add quiet option and config

9ff3310

JOJ0 mentioned this pull request Mar 31, 2026

autobpm: Allow hiding '"BPM already exists" log with --quiet #6480

Merged

3 tasks

autobpm: Allow hiding '"BPM already exists" log with --quiet (#6480)

6df5f4d

When batch bpm computing, the plugin's output is very noisy. This change allows hiding "BPM already exists for item" logs with a new `--quiet` option (or config setting)

jackwilsdon reviewed Mar 31, 2026

View reviewed changes

autobpm: Fix force flag conf fallback

e72497c

JOJ0 marked this pull request as draft March 31, 2026 22:10

JOJ0 added 2 commits April 1, 2026 08:51

autobpm: Obey force,quiet configs on import

0470351

autobpm: Document quiet option

2931073

JOJ0 changed the title ~~autobpm: Support --force and deprecate overwrite setting~~ autobpm: Add --force and --quiet options; Deprecate overwrite Apr 1, 2026

JOJ0 marked this pull request as ready for review April 1, 2026 07:06

JOJ0 requested review from Copilot and jackwilsdon April 1, 2026 07:06

Copilot started reviewing on behalf of JOJ0 April 1, 2026 07:06 View session

Copilot AI reviewed Apr 1, 2026

View reviewed changes

autobpm: Improve --quiet help text

48bf094

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

JOJ0 force-pushed the autobpm_force_option branch from e5f66e8 to 48bf094 Compare April 1, 2026 07:26

autobpm: State --quiet/force flags in docs too

80fcbe6

jackwilsdon approved these changes Apr 2, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

autobpm: Add `--force` and `--quiet` options; Deprecate `overwrite`#6481

autobpm: Add `--force` and `--quiet` options; Deprecate `overwrite`#6481
JOJ0 wants to merge 11 commits intomasterfrom
autobpm_force_option

JOJ0 commented Mar 31, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Mar 31, 2026

Uh oh!

codecov bot commented Mar 31, 2026 •

edited

Loading

Uh oh!

Uh oh!

jackwilsdon Mar 31, 2026

Uh oh!

JOJ0 Mar 31, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Apr 1, 2026

Uh oh!

Uh oh!

Uh oh!

JOJ0 commented Apr 1, 2026

Uh oh!

jackwilsdon left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

JOJ0 commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

github-actions bot commented Mar 31, 2026

Uh oh!

codecov bot commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

jackwilsdon Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

JOJ0 Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

JOJ0 commented Apr 1, 2026

Uh oh!

jackwilsdon left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

JOJ0 commented Mar 31, 2026 •

edited

Loading

codecov bot commented Mar 31, 2026 •

edited

Loading