MoveOperation bugfix for CLI overrides #36
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Dec 30, 2022
gtronset
commented
Dec 30, 2022
| @@ -333,9 +335,6 @@ def process_artifacts(self, source_files, mapping): | |||
| util.mkdirall(dest_file) | |||
| dest_file = util.bytestring_path(dest_file) | |||
|
|
|||
| # TODO: detect if beets was called with 'move' and override config | |||
There was a problem hiding this comment.
This was a legacy TODO that is now resolved.
The beets.config module provides the current config when referenced and not just the values in config.yml. Fixing when the self.operation is obtained deprecates this TODO.
gtronset
commented
Dec 30, 2022
| @@ -305,10 +314,10 @@ def _list_files(self, startpath): | |||
| for root, _dirs, files in os.walk(path): | |||
| level = root.replace(path, "").count(os.sep) | |||
| indent = self._indenter(level) | |||
| log.debug("%s%s/", indent, os.path.basename(root)) | |||
| log.debug(f"{indent}{os.path.basename(root)}/") | |||
There was a problem hiding this comment.
With how the logger is passed around, %s interpolation doesn't occur.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
As pointed out in #35, certain configuration scenarios can result in the
MoveOperationselection isNone. In that issue, @seanbreckenridge is right that this comes down to when the plugin defines (really, captures) the desired Operation (copy, move, etc.) that is occurring in the import.Previously, this was captured on initialization in the constructor for Filetote. However, due to the lifecycle of
beets, this is called before theimportcommand initializes/runs. As a side effect, any of the overriding CLI options passed along (relevant here,--moveor--copy) would set/override the operation on the media file(s) but, since the operation was defined before this and not updated, the extra files that Filetote would manage would utilize a different operation than the media file.In addition, if the
config.ymlexplicitly did not set an operation (meaning, all werefalse) and if one were to rely on the CLI only, theMoveOperationwould result inNone(the plugin initializes withNonewhich matches theconfig.ymlbut the operation is not updated once the import starts to grab the option provided in the CLI).Other notes
beetsprioritize the operation as the options are mutually exclusive. There are three layers to how this occurs:config.yml, prioritizing in this order (importer.py):movecopylinkhardlinkreflink--moveor--copy):--moveand--copy) are provided, it prioritizescopy(ui/commands.py)There are a few more nuances, but this covers the vast majority of cases.
Changes
This moves the setting of the operation used by Filetote to the
import_beginevent that is triggered at the start of the import process. This also updates/adds tests for operations provided via CLI.This also includes the suggested change from #34 which is, indeed, helpful for debugging.
Big thanks to @seanbreckenridge for running much of this down and documenting their journey in such detail!