ocrd 3.5.1__py3-none-any.whl → 3.7.0__py3-none-any.whl

ocrd/cli/workspace.py

@@ -5,7 +5,6 @@ OCR-D CLI: workspace management
     :prog: ocrd workspace
     :nested: full
 """
-import os
 from os import rmdir, unlink
 from os.path import dirname, relpath, normpath, exists, join, isabs, isdir
 from pathlib import Path
@@ -19,7 +18,16 @@ import click
 
 from ocrd import Resolver, Workspace, WorkspaceValidator, WorkspaceBackupManager
 from ocrd.mets_server import OcrdMetsServer
-from ocrd_utils import getLogger, initLogging, pushd_popd, EXT_TO_MIME, safe_filename, parse_json_string_or_file, partition_list, DEFAULT_METS_BASENAME
+from ocrd_utils import (
+    getLogger,
+    initLogging,
+    pushd_popd,
+    EXT_TO_MIME,
+    safe_filename,
+    parse_json_string_or_file,
+    partition_list,
+    DEFAULT_METS_BASENAME,
+)
 from ocrd.decorators import mets_find_options
 from . import command_with_replaced_help
 from ocrd_models.constants import METS_PAGE_DIV_ATTRIBUTE
@@ -32,8 +40,8 @@ class WorkspaceCtx():
         if mets_basename:
             self.log.warning(DeprecationWarning('--mets-basename is deprecated. Use --mets/--directory instead.'))
         self.resolver = Resolver()
-        self.directory, self.mets_url, self.mets_basename, self.mets_server_url \
-                = self.resolver.resolve_mets_arguments(directory, mets_url, mets_basename, mets_server_url)
+        self.directory, self.mets_url, self.mets_basename, self.mets_server_url = \
+            self.resolver.resolve_mets_arguments(directory, mets_url, mets_basename, mets_server_url)
         self.automatic_backup = automatic_backup
 
     def workspace(self):
@@ -44,20 +52,24 @@ class WorkspaceCtx():
             automatic_backup=self.automatic_backup,
             mets_server_url=self.mets_server_url,
         )
+
     def backup_manager(self):
         return WorkspaceBackupManager(self.workspace())
 
 
 pass_workspace = click.make_pass_decorator(WorkspaceCtx)
 
+
 # ----------------------------------------------------------------------
 # ocrd workspace
 # ----------------------------------------------------------------------
 
 @click.group("workspace")
-@click.option('-d', '--directory', envvar='WORKSPACE_DIR', type=click.Path(file_okay=False), metavar='WORKSPACE_DIR', help='Changes the workspace folder location [default: METS_URL directory or .]"')
+@click.option('-d', '--directory', envvar='WORKSPACE_DIR', type=click.Path(file_okay=False), metavar='WORKSPACE_DIR',
+              help='Changes the workspace folder location [default: METS_URL directory or .]"')
 @click.option('-M', '--mets-basename', default=None, help='METS file basename. Deprecated, use --mets/--directory')
-@click.option('-m', '--mets', default=None, help='The path/URL of the METS file [default: WORKSPACE_DIR/mets.xml]', metavar="METS_URL")
+@click.option('-m', '--mets', default=None, metavar="METS_URL",
+              help='The path/URL of the METS file [default: WORKSPACE_DIR/mets.xml]')
 @click.option('-U', '--mets-server-url', 'mets_server_url', help="TCP host URI or UDS path of METS server")
 @click.option('--backup', default=False, help="Backup mets.xml whenever it is saved.", is_flag=True)
 @click.pass_context
@@ -67,7 +79,7 @@ def workspace_cli(ctx, directory, mets, mets_basename, mets_server_url, backup):
 
     A workspace comprises a METS file and a directory as point of reference.
 
-    Operates on the file system directly or via a METS server 
+    Operates on the file system directly or via a METS server
     (already running via some prior `server start` subcommand).
     """
     initLogging()
@@ -79,6 +91,7 @@ def workspace_cli(ctx, directory, mets, mets_basename, mets_server_url, backup):
         automatic_backup=backup
     )
 
+
 # ----------------------------------------------------------------------
 # ocrd workspace validate
 # ----------------------------------------------------------------------
@@ -88,10 +101,12 @@ def workspace_cli(ctx, directory, mets, mets_basename, mets_server_url, backup):
 @pass_workspace
 @click.option('-a', '--download', is_flag=True, help="Download all files")
 @click.option('-s', '--skip', help="Tests to skip", default=[], multiple=True, type=click.Choice(
-    ['imagefilename', 'alternativeimage_filename', 'alternativeimage_comments', 'dimension', 'pixel_density', 'page', 'page_xsd',
-     'url', 'mets_fileid_page_pcgtsid', 'mets_unique_identifier', 'mets_files', 'mets_xsd']))
-@click.option('--page-textequiv-consistency', '--page-strictness', help="How strict to check PAGE multi-level textequiv consistency", type=click.Choice(['strict', 'lax', 'fix', 'off']), default='strict')
-@click.option('--page-coordinate-consistency', help="How fierce to check PAGE multi-level coordinate consistency", type=click.Choice(['poly', 'baseline', 'both', 'off']), default='poly')
+    ['imagefilename', 'alternativeimage_filename', 'alternativeimage_comments', 'dimension', 'pixel_density',
+     'page', 'page_xsd', 'url', 'mets_fileid_page_pcgtsid', 'mets_unique_identifier', 'mets_files', 'mets_xsd']))
+@click.option('--page-textequiv-consistency', '--page-strictness', type=click.Choice(['strict', 'lax', 'fix', 'off']),
+              default='strict', help="How strict to check PAGE multi-level textequiv consistency")
+@click.option('--page-coordinate-consistency', help="How fierce to check PAGE multi-level coordinate consistency",
+              type=click.Choice(['poly', 'baseline', 'both', 'off']), default='poly')
 @click.argument('mets_url', default=None, required=False)
 def workspace_validate(ctx, mets_url, download, skip, page_textequiv_consistency, page_coordinate_consistency):
     """
@@ -105,7 +120,8 @@ def workspace_validate(ctx, mets_url, download, skip, page_textequiv_consistency
     """
     LOG = getLogger('ocrd.cli.workspace.validate')
     if mets_url:
-        LOG.warning(DeprecationWarning("Use 'ocrd workspace --mets METS init' instead of argument 'METS_URL' ('%s')" % mets_url))
+        LOG.warning(DeprecationWarning("Use 'ocrd workspace --mets METS init' instead of "
+                                       "argument 'METS_URL' ('%s')" % mets_url))
     else:
         mets_url = ctx.mets_url
     report = WorkspaceValidator.validate(
@@ -121,6 +137,7 @@ def workspace_validate(ctx, mets_url, download, skip, page_textequiv_consistency
     if not report.is_valid:
         sys.exit(128)
 
+
 # ----------------------------------------------------------------------
 # ocrd workspace clone
 # ----------------------------------------------------------------------
@@ -128,13 +145,15 @@ def workspace_validate(ctx, mets_url, download, skip, page_textequiv_consistency
 @workspace_cli.command('clone', cls=command_with_replaced_help(
     (r' \[WORKSPACE_DIR\]', ''))) # XXX deprecated argument
 @click.option('-f', '--clobber-mets', help="Overwrite existing METS file", default=False, is_flag=True)
-@click.option('-a', '--download', is_flag=True, help="Download all selected files and add local path references in METS file afterwards")
+@click.option('-a', '--download', is_flag=True, help="Download all selected files and add local FLocat "
+              "path references in METS file afterwards")
 @click.argument('mets_url')
 @mets_find_options
 # XXX deprecated
 @click.argument('workspace_dir', default=None, required=False)
 @pass_workspace
-def workspace_clone(ctx, clobber_mets, download, file_grp, file_id, page_id, mimetype, include_fileGrp, exclude_fileGrp, mets_url, workspace_dir):
+def workspace_clone(ctx, clobber_mets, download, file_grp, file_id, page_id, mimetype,
+                    include_fileGrp, exclude_fileGrp, mets_url, workspace_dir):
     """
     Create a workspace from METS_URL and return the directory
 
@@ -146,7 +165,8 @@ def workspace_clone(ctx, clobber_mets, download, file_grp, file_id, page_id, mim
     """
     LOG = getLogger('ocrd.cli.workspace.clone')
     if workspace_dir:
-        LOG.warning(DeprecationWarning("Use 'ocrd workspace --directory DIR clone' instead of argument 'WORKSPACE_DIR' ('%s')" % workspace_dir))
+        LOG.warning(DeprecationWarning("Use 'ocrd workspace --directory DIR clone' instead of "
+                                       "argument 'WORKSPACE_DIR' ('%s')" % workspace_dir))
         ctx.directory = workspace_dir
 
     assert not ctx.mets_server_url, \
@@ -167,6 +187,7 @@ def workspace_clone(ctx, clobber_mets, download, file_grp, file_id, page_id, mim
     workspace.save_mets()
     print(workspace.directory)
 
+
 # ----------------------------------------------------------------------
 # ocrd workspace init
 # ----------------------------------------------------------------------
@@ -184,7 +205,8 @@ def workspace_init(ctx, clobber_mets, directory):
     """
     LOG = getLogger('ocrd.cli.workspace.init')
     if directory:
-        LOG.warning(DeprecationWarning("Use 'ocrd workspace --directory DIR init' instead of argument 'DIRECTORY' ('%s')" % directory))
+        LOG.warning(DeprecationWarning("Use 'ocrd workspace --directory DIR init' instead of "
+                                       "argument 'DIRECTORY' ('%s')" % directory))
         ctx.directory = directory
     assert not ctx.mets_server_url, \
         f"init cannot be performed with METS Server - stop server, rerun without -U {ctx.mets_server_url}"
@@ -196,6 +218,7 @@ def workspace_init(ctx, clobber_mets, directory):
     workspace.save_mets()
     print(workspace.directory)
 
+
 # ----------------------------------------------------------------------
 # ocrd workspace add
 # ----------------------------------------------------------------------
@@ -203,11 +226,13 @@ def workspace_init(ctx, clobber_mets, directory):
 @workspace_cli.command('add')
 @click.option('-G', '--file-grp', help="fileGrp USE", required=True, metavar='FILE_GRP')
 @click.option('-i', '--file-id', help="ID for the file", required=True, metavar='FILE_ID')
-@click.option('-m', '--mimetype', help="Media type of the file. Guessed from extension if not provided", required=False, metavar='TYPE')
+@click.option('-m', '--mimetype', help="Media type of the file. Guessed from extension if not provided",
+              required=False, metavar='TYPE')
 @click.option('-g', '--page-id', help="ID of the physical page", metavar='PAGE_ID')
 @click.option('-C', '--check-file-exists', help="Whether to ensure FNAME exists", is_flag=True, default=False)
 @click.option('--ignore', help="Do not check whether file exists.", default=False, is_flag=True)
-@click.option('--force', help="If file with ID already exists, replace it. No effect if --ignore is set.", default=False, is_flag=True)
+@click.option('--force', help="If file with ID already exists, replace it. No effect if --ignore is set.",
+              default=False, is_flag=True)
 @click.argument('fname', required=True)
 @pass_workspace
 def workspace_add_file(ctx, file_grp, file_id, mimetype, page_id, ignore, check_file_exists, force, fname):
@@ -223,7 +248,8 @@ def workspace_add_file(ctx, file_grp, file_id, mimetype, page_id, ignore, check_
             mimetype = EXT_TO_MIME[Path(fname).suffix]
             log.info("Guessed mimetype to be %s" % mimetype)
         except KeyError:
-            log.error("Cannot guess mimetype from extension '%s' for '%s'. Set --mimetype explicitly" % (Path(fname).suffix, fname))
+            log.error("Cannot guess mimetype from extension '%s' for '%s'. "
+                      "Set --mimetype explicitly" % (Path(fname).suffix, fname))
 
     log.debug("Adding '%s'", fname)
     local_filename = None
@@ -260,27 +286,34 @@ def workspace_add_file(ctx, file_grp, file_id, mimetype, page_id, ignore, check_
     workspace.add_file(file_grp, **kwargs)
     workspace.save_mets()
 
+
 # ----------------------------------------------------------------------
 # ocrd workspace bulk-add
 # ----------------------------------------------------------------------
 
 # pylint: disable=broad-except
 @workspace_cli.command('bulk-add')
-@click.option('-r', '--regex', help="Regular expression matching the FILE_GLOB filesystem paths to define named captures usable in the other parameters", required=True)
+@click.option('-r', '--regex', help="Regular expression matching the FILE_GLOB filesystem paths "
+              "to define named captures usable in the other parameters", required=True)
 @click.option('-m', '--mimetype', help="Media type of the file. If not provided, guess from filename", required=False)
 @click.option('-g', '--page-id', help="physical page ID of the file", required=False)
 @click.option('-i', '--file-id', help="ID of the file. If not provided, derive from fileGrp and filename", required=False)
 @click.option('-u', '--url', help="Remote URL of the file", required=False)
-@click.option('-l', '--local-filename', help="Local filesystem path in the workspace directory (copied from source file if different)", required=False)
+@click.option('-l', '--local-filename', help="Local filesystem path in the workspace directory "
+              "(copied from source file if different)", required=False)
 @click.option('-G', '--file-grp', help="File group USE of the file", required=True)
-@click.option('-n', '--dry-run', help="Don't actually do anything to the METS or filesystem, just preview", default=False, is_flag=True)
-@click.option('-S', '--source-path', 'src_path_option', help="File path to copy from (if different from FILE_GLOB values)", required=False)
+@click.option('-n', '--dry-run', help="Don't actually do anything to the METS or filesystem, just preview",
+              default=False, is_flag=True)
+@click.option('-S', '--source-path', 'src_path_option', help="File path to copy from (if different from FILE_GLOB values)",
+              required=False)
 @click.option('-I', '--ignore', help="Disable checking for existing file entries (faster)", default=False, is_flag=True)
-@click.option('-f', '--force', help="Replace existing file entries with the same ID (no effect when --ignore is set, too)", default=False, is_flag=True)
+@click.option('-f', '--force', help="Replace existing file entries with the same ID (no effect when --ignore is set, too)",
+              default=False, is_flag=True)
 @click.option('-s', '--skip', help="Skip files not matching --regex (instead of failing)", default=False, is_flag=True)
 @click.argument('file_glob', nargs=-1, required=True)
 @pass_workspace
-def workspace_cli_bulk_add(ctx, regex, mimetype, page_id, file_id, url, local_filename, file_grp, dry_run, file_glob, src_path_option, ignore, force, skip):
+def workspace_cli_bulk_add(ctx, regex, mimetype, page_id, file_id, url, local_filename, file_grp, dry_run,
+                           file_glob, src_path_option, ignore, force, skip):
     """
     Add files in bulk to an OCR-D workspace.
 
@@ -321,7 +354,7 @@ def workspace_cli_bulk_add(ctx, regex, mimetype, page_id, file_id, url, local_fi
           -G '{{ filegrp }}' -g '{{ pageid }}' -i '{{ fileid }}' -S '{{ local_filename }}' -
 
     """
-    log = getLogger('ocrd.cli.workspace.bulk-add') # pylint: disable=redefined-outer-name
+    log = getLogger('ocrd.cli.workspace.bulk-add')  # pylint: disable=redefined-outer-name
     workspace = ctx.workspace()
 
     try:
@@ -355,7 +388,12 @@ def workspace_cli_bulk_add(ctx, regex, mimetype, page_id, file_id, url, local_fi
         group_dict = m.groupdict()
 
         # set up file info
-        file_dict = {'local_filename': local_filename, 'url': url, 'mimetype': mimetype, 'file_id': file_id, 'page_id': page_id, 'file_grp': file_grp}
+        file_dict = {'local_filename': local_filename,
+                     'url': url,
+                     'mimetype': mimetype,
+                     'file_id': file_id,
+                     'page_id': page_id,
+                     'file_grp': file_grp}
 
         # Flag to track whether 'local_filename' should be 'src'
         local_filename_is_src = False
@@ -394,7 +432,8 @@ def workspace_cli_bulk_add(ctx, regex, mimetype, page_id, file_id, url, local_fi
             try:
                 file_dict['mimetype'] = EXT_TO_MIME[srcpath.suffix]
             except KeyError:
-                log.error("Cannot guess MIME type from extension '%s' for '%s'. Set --mimetype explicitly" % (srcpath.suffix, srcpath))
+                log.error("Cannot guess MIME type from extension '%s' for '%s'. "
+                          "Set --mimetype explicitly" % (srcpath.suffix, srcpath))
 
         # copy files if src != url
         if local_filename_is_src:
@@ -413,7 +452,7 @@ def workspace_cli_bulk_add(ctx, regex, mimetype, page_id, file_id, url, local_fi
         if dry_run:
             log.info('workspace.add_file(%s)' % file_dict)
         else:
-            workspace.add_file(fileGrp, ignore=ignore, force=force, **file_dict) # pylint: disable=redundant-keyword-arg
+            workspace.add_file(fileGrp, ignore=ignore, force=force, **file_dict)  # pylint: disable=redundant-keyword-arg
 
     # save changes to disk
     workspace.save_mets()
@@ -447,7 +486,8 @@ def workspace_cli_bulk_add(ctx, regex, mimetype, page_id, file_id, url, local_fi
 @click.option('--keep-files', is_flag=True, help="Do not remove downloaded files from the workspace with --undo-download")
 @click.option('--wait', type=int, default=0, help="Wait this many seconds between download requests")
 @pass_workspace
-def workspace_find(ctx, file_grp, mimetype, page_id, file_id, output_field, include_fileGrp, exclude_fileGrp, download, undo_download, keep_files, wait):
+def workspace_find(ctx, file_grp, mimetype, page_id, file_id, output_field,
+                   include_fileGrp, exclude_fileGrp, download, undo_download, keep_files, wait):
     """
     Find files.
 
@@ -467,7 +507,7 @@ def workspace_find(ctx, file_grp, mimetype, page_id, file_id, output_field, incl
                 page_id=page_id,
                 include_fileGrp=include_fileGrp,
                 exclude_fileGrp=exclude_fileGrp,
-            ):
+        ):
             if download and not f.local_filename:
                 workspace.download_file(f)
                 modified_mets = True
@@ -492,13 +532,15 @@ def workspace_find(ctx, file_grp, mimetype, page_id, file_id, output_field, incl
     for fields in ret:
         print('\t'.join(fields))
 
+
 # ----------------------------------------------------------------------
 # ocrd workspace remove
 # ----------------------------------------------------------------------
 
 @workspace_cli.command('remove')
 @click.option('-k', '--keep-file', help="Do not delete file from file system", default=False, is_flag=True)
-@click.option('-f', '--force', help="Continue even if mets:file or file on file system does not exist", default=False, is_flag=True)
+@click.option('-f', '--force', help="Continue even if mets:file or file on file system does not exist",
+              default=False, is_flag=True)
 @click.argument('ID', nargs=-1)
 @pass_workspace
 def workspace_remove_file(ctx, id, force, keep_file):  # pylint: disable=redefined-builtin
@@ -534,13 +576,16 @@ def rename_group(ctx, old, new):
     workspace.rename_file_group(old, new)
     workspace.save_mets()
 
+
 # ----------------------------------------------------------------------
 # ocrd workspace remove-group
 # ----------------------------------------------------------------------
 
 @workspace_cli.command('remove-group')
-@click.option('-r', '--recursive', help="Delete any files in the group before the group itself", default=False, is_flag=True)
-@click.option('-f', '--force', help="Continue removing even if group or containing files not found in METS", default=False, is_flag=True)
+@click.option('-r', '--recursive', help="Delete any files in the group before the group itself",
+              default=False, is_flag=True)
+@click.option('-f', '--force', help="Continue removing even if group or containing files not found in METS",
+              default=False, is_flag=True)
 @click.option('-k', '--keep-files', help="Do not delete files from file system", default=False, is_flag=True)
 @click.argument('GROUP', nargs=-1)
 @pass_workspace
@@ -558,6 +603,7 @@ def remove_group(ctx, group, recursive, force, keep_files):
         workspace.remove_file_group(g, recursive=recursive, force=force, keep_files=keep_files)
     workspace.save_mets()
 
+
 # ----------------------------------------------------------------------
 # ocrd workspace prune-files
 # ----------------------------------------------------------------------
@@ -590,16 +636,19 @@ def prune_files(ctx, file_grp, mimetype, page_id, file_id):
                     workspace.mets.remove_file(f.ID)
             except Exception as e:
                 ctx.log.exception("Error removing %f: %s", f, e)
-                raise(e)
+                raise e
         workspace.save_mets()
 
+
 # ----------------------------------------------------------------------
 # ocrd workspace clean
 # ----------------------------------------------------------------------
 
 @workspace_cli.command('clean')
-@click.option('-n', '--dry-run', help="Don't actually do anything to the filesystem, just preview", default=False, is_flag=True)
-@click.option('-d', '--directories', help="Remove untracked directories in addition to untracked files", default=False, is_flag=True)
+@click.option('-n', '--dry-run', help="Don't actually do anything to the filesystem, just preview",
+              default=False, is_flag=True)
+@click.option('-d', '--directories', help="Remove untracked directories in addition to untracked files",
+              default=False, is_flag=True)
 @click.argument('path_glob', nargs=-1, required=False)
 @pass_workspace
 def clean(ctx, dry_run, directories, path_glob):
@@ -646,6 +695,7 @@ def clean(ctx, dry_run, directories, path_glob):
             else:
                 rmdir(path)
 
+
 # ----------------------------------------------------------------------
 # ocrd workspace list-group
 # ----------------------------------------------------------------------
@@ -659,6 +709,7 @@ def list_groups(ctx):
     workspace = ctx.workspace()
     print("\n".join(workspace.mets.file_groups))
 
+
 # ----------------------------------------------------------------------
 # ocrd workspace list-page
 # ----------------------------------------------------------------------
@@ -669,11 +720,15 @@ def list_groups(ctx):
               show_default=True,
               multiple=True,
               type=click.Choice(METS_PAGE_DIV_ATTRIBUTE.names()))
-@click.option('-f', '--output-format', help="Output format", type=click.Choice(['one-per-line', 'comma-separated', 'json']), default='one-per-line')
-@click.option('-D', '--chunk-number', help="Partition the return value into n roughly equally sized chunks", default=1, type=int)
+@click.option('-f', '--output-format', help="Output format", type=click.Choice(['one-per-line', 'comma-separated', 'json']),
+              default='one-per-line')
+@click.option('-D', '--chunk-number', help="Partition the return value into n roughly equally sized chunks",
+              default=1, type=int)
 @click.option('-C', '--chunk-index', help="Output the nth chunk of results, -1 for all of them.", default=None, type=int)
-@click.option('-r', '--page-id-range', help="Restrict the pages to those matching the provided range, based on the @ID attribute. Separate start/end with ..")
-@click.option('-R', '--numeric-range', help="Restrict the pages to those in the range, in numerical document order. Separate start/end with ..")
+@click.option('-r', '--page-id-range', help="Restrict the pages to those matching the provided range, "
+              "based on the @ID attribute. Separate start/end with ..")
+@click.option('-R', '--numeric-range', help="Restrict the pages to those in the range, in numerical document order. "
+              "Separate start/end with ..")
 @pass_workspace
 def list_pages(ctx, output_field, output_format, chunk_number, chunk_index, page_id_range, numeric_range):
     """
@@ -715,6 +770,7 @@ def list_pages(ctx, output_field, output_format, chunk_number, chunk_index, page
         lines.append(dumps(chunks))
     print('\n'.join(lines))
 
+
 # ----------------------------------------------------------------------
 # ocrd workspace get-id
 # ----------------------------------------------------------------------
@@ -730,6 +786,7 @@ def get_id(ctx):
     if ID:
         print(ID)
 
+
 # ----------------------------------------------------------------------
 # ocrd workspace set-id
 # ----------------------------------------------------------------------
@@ -749,8 +806,10 @@ def set_id(ctx, id):   # pylint: disable=redefined-builtin
     workspace.mets.unique_identifier = id
     workspace.save_mets()
 
+
 @workspace_cli.command('update-page')
-@click.option('--set', 'attr_value_pairs', help=f"set mets:div ATTR to VALUE. possible keys: {METS_PAGE_DIV_ATTRIBUTE.names()}", metavar="ATTR VALUE", nargs=2, multiple=True)
+@click.option('--set', 'attr_value_pairs', help="set mets:div ATTR to VALUE", metavar="ATTR VALUE",
+              type=(click.Choice(METS_PAGE_DIV_ATTRIBUTE.names()), str), nargs=2, multiple=True)
 @click.option('--order', help="[DEPRECATED - use --set ATTR VALUE", metavar='ORDER')
 @click.option('--orderlabel', help="DEPRECATED - use --set ATTR VALUE", metavar='ORDERLABEL')
 @click.option('--contentids', help="DEPRECATED - use --set ATTR VALUE", metavar='ORDERLABEL')
@@ -777,6 +836,7 @@ def update_page(ctx, attr_value_pairs, order, orderlabel, contentids, page_id):
         print(f"Error: {err}")
         sys.exit(1)
 
+
 # ----------------------------------------------------------------------
 # ocrd workspace merge
 # ----------------------------------------------------------------------
@@ -784,17 +844,21 @@ def update_page(ctx, attr_value_pairs, order, orderlabel, contentids, page_id):
 def _handle_json_option(ctx, param, value):
     return parse_json_string_or_file(value) if value else None
 
+
 @workspace_cli.command('merge')
 @click.argument('METS_PATH')
-@click.option('--overwrite/--no-overwrite', is_flag=True, default=False, help="Overwrite on-disk file in case of file name conflicts with data from METS_PATH")
-@click.option('--force/--no-force', is_flag=True, default=False, help="Overwrite mets:file from --mets with mets:file from METS_PATH if IDs clash")
+@click.option('--overwrite/--no-overwrite', is_flag=True, default=False,
+              help="Overwrite on-disk file in case of file name conflicts with data from METS_PATH")
+@click.option('--force/--no-force', is_flag=True, default=False,
+              help="Overwrite mets:file from --mets with mets:file from METS_PATH if IDs clash")
 @click.option('--copy-files/--no-copy-files', is_flag=True, help="Copy files as well", default=True, show_default=True)
 @click.option('--fileGrp-mapping', help="JSON object mapping src to dest fileGrp", callback=_handle_json_option)
 @click.option('--fileId-mapping', help="JSON object mapping src to dest file ID", callback=_handle_json_option)
 @click.option('--pageId-mapping', help="JSON object mapping src to dest page ID", callback=_handle_json_option)
 @mets_find_options
 @pass_workspace
-def merge(ctx, overwrite, force, copy_files, filegrp_mapping, fileid_mapping, pageid_mapping, file_grp, file_id, page_id, mimetype, include_fileGrp, exclude_fileGrp, mets_path):   # pylint: disable=redefined-builtin
+def merge(ctx, overwrite, force, copy_files, filegrp_mapping, fileid_mapping, pageid_mapping,
+          file_grp, file_id, page_id, mimetype, include_fileGrp, exclude_fileGrp, mets_path):  # pylint: disable=redefined-builtin
     """
     Merges this workspace with the workspace that contains ``METS_PATH``
 
@@ -829,18 +893,20 @@ def merge(ctx, overwrite, force, copy_files, filegrp_mapping, fileid_mapping, pa
     )
     workspace.save_mets()
 
+
 # ----------------------------------------------------------------------
 # ocrd workspace backup
 # ----------------------------------------------------------------------
 
 @workspace_cli.group('backup')
 @pass_workspace
-def workspace_backup_cli(ctx): # pylint: disable=unused-argument
+def workspace_backup_cli(ctx):  # pylint: disable=unused-argument
     """
     Backing and restoring workspaces - dev edition
     """
     assert not ctx.mets_server_url, "Workspace backups currently not interoperable with METS Server"
 
+
 @workspace_backup_cli.command('add')
 @pass_workspace
 def workspace_backup_add(ctx):
@@ -850,6 +916,7 @@ def workspace_backup_add(ctx):
     backup_manager = ctx.backup_manager()
     backup_manager.add()
 
+
 @workspace_backup_cli.command('list')
 @pass_workspace
 def workspace_backup_list(ctx):
@@ -860,9 +927,10 @@ def workspace_backup_list(ctx):
     for b in backup_manager.list():
         print(b)
 
+
 @workspace_backup_cli.command('restore')
 @click.option('-f', '--choose-first', help="Restore first matching version if more than one", is_flag=True)
-@click.argument('bak') #, type=click.Path(dir_okay=False, readable=True, resolve_path=True))
+@click.argument('bak')  # type=click.Path(dir_okay=False, readable=True, resolve_path=True))
 @pass_workspace
 def workspace_backup_restore(ctx, choose_first, bak):
     """
@@ -871,6 +939,7 @@ def workspace_backup_restore(ctx, choose_first, bak):
     backup_manager = ctx.backup_manager()
     backup_manager.restore(bak, choose_first)
 
+
 @workspace_backup_cli.command('undo')
 @pass_workspace
 def workspace_backup_undo(ctx):
@@ -887,34 +956,38 @@ def workspace_backup_undo(ctx):
 
 @workspace_cli.group('server')
 @pass_workspace
-def workspace_serve_cli(ctx): # pylint: disable=unused-argument
+def workspace_serve_cli(ctx):  # pylint: disable=unused-argument
     """Control a METS server for this workspace"""
     assert ctx.mets_server_url, "For METS server commands, you must provide '-U/--mets-server-url'"
 
+
 @workspace_serve_cli.command('stop')
 @pass_workspace
-def workspace_serve_stop(ctx): # pylint: disable=unused-argument
+def workspace_serve_stop(ctx):  # pylint: disable=unused-argument
     """Stop the METS server (saving changes to disk)"""
     workspace = ctx.workspace()
     workspace.mets.stop()
 
+
 @workspace_serve_cli.command('reload')
 @pass_workspace
-def workspace_serve_reload(ctx): # pylint: disable=unused-argument
+def workspace_serve_reload(ctx):  # pylint: disable=unused-argument
     """Reload the METS server from disk"""
     workspace = ctx.workspace()
     workspace.mets.reload()
 
+
 @workspace_serve_cli.command('save')
 @pass_workspace
-def workspace_serve_save(ctx): # pylint: disable=unused-argument
+def workspace_serve_save(ctx):  # pylint: disable=unused-argument
     """Save the METS changes to disk"""
     workspace = ctx.workspace()
     workspace.mets.save()
 
+
 @workspace_serve_cli.command('start')
 @pass_workspace
-def workspace_serve_start(ctx): # pylint: disable=unused-argument
+def workspace_serve_start(ctx):  # pylint: disable=unused-argument
     """
     Start a METS server
 

ocrd/cli/zip.py

@@ -16,6 +16,7 @@ from ..resolver import Resolver
 from ..workspace import Workspace
 from ..workspace_bagger import WorkspaceBagger
 
+
 @click.group("zip")
 def zip_cli():
     """
@@ -23,6 +24,7 @@ def zip_cli():
     """
     initLogging()
 
+
 # ----------------------------------------------------------------------
 # ocrd zip bag
 # ----------------------------------------------------------------------
@@ -43,10 +45,12 @@ def zip_cli():
 @click.option('-i', '--identifier', '--id', help="Ocrd-Identifier", required=True)
 @click.option('-m', '--mets', help="location of mets.xml in the bag's data dir", default=DEFAULT_METS_BASENAME)
 @click.option('-b', '--base-version-checksum', help="Ocrd-Base-Version-Checksum")
-@click.option('-t', '--tag-file', help="Add a non-payload file to bag", type=click.Path(file_okay=True, dir_okay=False, readable=True, resolve_path=True), multiple=True)
+@click.option('-t', '--tag-file', help="Add a non-payload file to bag", multiple=True,
+              type=click.Path(file_okay=True, dir_okay=False, readable=True, resolve_path=True))
 @click.option('-Z', '--skip-zip', help="Create a directory but do not ZIP it", is_flag=True, default=False)
 @click.option('-j', '--processes', help="Number of parallel processes", type=int, default=1)
-def bag(directory, mets_basename, dest, include_fileGrp, exclude_fileGrp, identifier, mets, base_version_checksum, tag_file, skip_zip, processes):
+def bag(directory, mets_basename, dest, include_fileGrp, exclude_fileGrp, identifier, mets,
+        base_version_checksum, tag_file, skip_zip, processes):
     """
     Bag workspace as OCRD-ZIP at DEST
     """
@@ -66,6 +70,7 @@ def bag(directory, mets_basename, dest, include_fileGrp, exclude_fileGrp, identi
         exclude_fileGrp=exclude_fileGrp,
     )
 
+
 # ----------------------------------------------------------------------
 # ocrd zip spill
 # ----------------------------------------------------------------------
@@ -89,6 +94,7 @@ def spill(dest, src):
     workspace = workspace_bagger.spill(src, dest)
     print(workspace)
 
+
 # ----------------------------------------------------------------------
 # ocrd zip validate
 # ----------------------------------------------------------------------
@@ -97,8 +103,10 @@ def spill(dest, src):
 @click.argument('src', type=click.Path(dir_okay=True, readable=True, resolve_path=True), required=True)
 @click.option('-Z', '--skip-unzip', help="Treat SRC as a directory not a ZIP", is_flag=True, default=False)
 @click.option('-B', '--skip-bag', help="Whether to skip all checks of manifests and files", is_flag=True, default=False)
-@click.option('-C', '--skip-checksums', help="Whether to omit checksum checks but still check basic BagIt conformance", is_flag=True, default=False)
-@click.option('-D', '--skip-delete', help="Whether to skip deleting the unpacked OCRD-ZIP dir after valdiation", is_flag=True, default=False)
+@click.option('-C', '--skip-checksums', help="Whether to omit checksum checks but still check basic BagIt conformance",
+              is_flag=True, default=False)
+@click.option('-D', '--skip-delete', help="Whether to skip deleting the unpacked OCRD-ZIP dir after valdiation",
+              is_flag=True, default=False)
 @click.option('-j', '--processes', help="Number of parallel processes", type=int, default=1)
 def validate(src, **kwargs):
     """
@@ -113,6 +121,7 @@ def validate(src, **kwargs):
     if not report.is_valid:
         sys.exit(1)
 
+
 # ----------------------------------------------------------------------
 # ocrd zip update
 # ----------------------------------------------------------------------