Merge pull request #906 from hkhanna/write-always-flag

Add --force flag for write subcommand

Author: sampsyo

beets/ui/commands.py

@@ -1415,7 +1415,7 @@ def move_func(lib, opts, args):
 
 # write: Write tags into files.
 
-def write_items(lib, query, pretend):
+def write_items(lib, query, pretend, force):
     """Write tag information from the database to the respective files
     in the filesystem.
     """
@@ -1440,20 +1440,24 @@ def write_items(lib, query, pretend):
 
         # Check for and display changes.
         changed = ui.show_model_changes(item, clean_item,
-                                        library.Item._media_fields)
-        if changed and not pretend:
+                                        library.Item._media_fields, force)
+        if (changed or force) and not pretend:
             item.try_write()
 
 
 def write_func(lib, opts, args):
-    write_items(lib, decargs(args), opts.pretend)
+    write_items(lib, decargs(args), opts.pretend, opts.force)
 
 
 write_cmd = ui.Subcommand('write', help='write tag information to files')
 write_cmd.parser.add_option(
     '-p', '--pretend', action='store_true',
     help="show all changes but do nothing"
 )
+write_cmd.parser.add_option(
+    '-f', '--force', action='store_true',
+    help="write tags even if the existing tags match the database"
+)
 write_cmd.func = write_func
 default_commands.append(write_cmd)
 

docs/reference/cli.rst

@@ -284,19 +284,22 @@ write
 `````
 ::
 
-    beet write [-p] [QUERY]
+    beet write [-pf] [QUERY]
 
 Write metadata from the database into files' tags.
 
 When you make changes to the metadata stored in beets' library database
 (during import or with the :ref:`modify-cmd` command, for example), you often
 have the option of storing changes only in the database, leaving your files
 untouched. The ``write`` command lets you later change your mind and write the
-contents of the database into the files.
+contents of the database into the files. By default, this writes the changes only if there is a difference between the database and the tags in the file.
+
+You can think of this command as the opposite of :ref:`update-cmd`.
 
 The ``-p`` option previews metadata changes without actually applying them.
 
-You can think of this command as the opposite of :ref:`update-cmd`.
+The ``-f`` option forces a write to the file, even if the file tags match the database. This is useful for making sure that enabled plugins that run on write (e.g., the Scrub and Zero plugins) are run on the file. 
+
 
 
 .. _stats-cmd: