Added deprecation for TerminalImportSession and PromptChoice.

Author: semohr

beets/test/_common.py

@@ -107,7 +107,11 @@ def item(lib=None, **kwargs):
 
 # Dummy import session.
 def import_session(lib=None, loghandler=None, paths=[], query=[], cli=False):
-    cls = commands.TerminalImportSession if cli else importer.ImportSession
+    cls = (
+        commands.import_.session.TerminalImportSession
+        if cli
+        else importer.ImportSession
+    )
     return cls(lib, loghandler, paths, query)
 
 

beets/test/helper.py

@@ -54,7 +54,7 @@
 from beets.importer import ImportSession
 from beets.library import Item, Library
 from beets.test import _common
-from beets.ui.commands import TerminalImportSession
+from beets.ui.commands.import_.session import TerminalImportSession
 from beets.util import (
     MoveOperation,
     bytestring_path,

beets/ui/__init__.py

@@ -1111,76 +1111,9 @@ def show_model_changes(
     return bool(changes)
 
 
-def show_path_changes(path_changes):
-    """Given a list of tuples (source, destination) that indicate the
-    path changes, log the changes as INFO-level output to the beets log.
-    The output is guaranteed to be unicode.
-
-    Every pair is shown on a single line if the terminal width permits it,
-    else it is split over two lines. E.g.,
-
-    Source -> Destination
-
-    vs.
-
-    Source
-      -> Destination
-    """
-    sources, destinations = zip(*path_changes)
-
-    # Ensure unicode output
-    sources = list(map(util.displayable_path, sources))
-    destinations = list(map(util.displayable_path, destinations))
-
-    # Calculate widths for terminal split
-    col_width = (term_width() - len(" -> ")) // 2
-    max_width = len(max(sources + destinations, key=len))
-
-    if max_width > col_width:
-        # Print every change over two lines
-        for source, dest in zip(sources, destinations):
-            color_source, color_dest = colordiff(source, dest)
-            print_(f"{color_source} \n  -> {color_dest}")
-    else:
-        # Print every change on a single line, and add a header
-        title_pad = max_width - len("Source ") + len(" -> ")
-
-        print_(f"Source {' ' * title_pad} Destination")
-        for source, dest in zip(sources, destinations):
-            pad = max_width - len(source)
-            color_source, color_dest = colordiff(source, dest)
-            print_(f"{color_source} {' ' * pad} -> {color_dest}")
-
-
 # Helper functions for option parsing.
 
 
-def _store_dict(option, opt_str, value, parser):
-    """Custom action callback to parse options which have ``key=value``
-    pairs as values. All such pairs passed for this option are
-    aggregated into a dictionary.
-    """
-    dest = option.dest
-    option_values = getattr(parser.values, dest, None)
-
-    if option_values is None:
-        # This is the first supplied ``key=value`` pair of option.
-        # Initialize empty dictionary and get a reference to it.
-        setattr(parser.values, dest, {})
-        option_values = getattr(parser.values, dest)
-
-    try:
-        key, value = value.split("=", 1)
-        if not (key and value):
-            raise ValueError
-    except ValueError:
-        raise UserError(
-            f"supplied argument `{value}' is not of the form `key=value'"
-        )
-
-    option_values[key] = value
-
-
 class CommonOptionsParser(optparse.OptionParser):
     """Offers a simple way to add common formatting options.
 
@@ -1666,7 +1599,7 @@ def parse_csl_callback(
         and subargs[0] == "config"
         and ("-e" in subargs or "--edit" in subargs)
     ):
-        from beets.ui.commands import config_edit
+        from beets.ui.commands.config import config_edit
 
         return config_edit()
 

beets/ui/commands/__init__.py

@@ -32,6 +32,21 @@
 from .version import version_cmd
 from .write import write_cmd
 
+
+def __getattr__(name: str):
+    """Handle deprecated imports."""
+    return deprecate_imports(
+        old_module=__name__,
+        new_module_by_name={
+            "TerminalImportSession": "beets.ui.commands.import_.session",
+            "PromptChoice": "beets.ui.commands.import_.session",
+            # TODO: We might want to add more deprecated imports here
+        },
+        name=name,
+        version="3.0.0",
+    )
+
+
 # The list of default subcommands. This is populated with Subcommand
 # objects that can be fed to a SubcommandsOptionParser.
 default_commands = [

beets/ui/commands/_utils.py

@@ -48,7 +48,7 @@ def completion_script(commands):
     completion data for.
     """
     base_script = os.path.join(
-        os.path.dirname(__file__), "../completion_base.sh"
+        os.path.dirname(__file__), "./completion_base.sh"
     )
     with open(base_script) as base_script:
         yield base_script.read()

beets/ui/commands/completion.py

@@ -2,7 +2,8 @@
 
 import os
 
-from beets import config, ui, util
+from beets import config, ui
+from beets.util import displayable_path, editor_command, interactive_open
 
 
 def config_func(lib, opts, args):
@@ -25,7 +26,7 @@ def config_func(lib, opts, args):
             filenames.insert(0, user_path)
 
         for filename in filenames:
-            ui.print_(util.displayable_path(filename))
+            ui.print_(displayable_path(filename))
 
     # Open in editor.
     elif opts.edit:
@@ -45,11 +46,11 @@ def config_edit():
     An empty config file is created if no existing config file exists.
     """
     path = config.user_config_path()
-    editor = util.editor_command()
+    editor = editor_command()
     try:
         if not os.path.isfile(path):
             open(path, "w+").close()
-        util.interactive_open([path], editor)
+        interactive_open([path], editor)
     except OSError as exc:
         message = f"Could not edit configuration: {exc}"
         if not editor:

beets/ui/completion_base.sh renamed to beets/ui/commands/completion_base.sh

@@ -5,13 +5,47 @@
 from beets import config, logging, plugins, ui
 from beets.util import displayable_path, normpath, syspath
 
-from .._utils import parse_logfiles
 from .session import TerminalImportSession
 
 # Global logger.
 log = logging.getLogger("beets")
 
 
+def paths_from_logfile(path):
+    """Parse the logfile and yield skipped paths to pass to the `import`
+    command.
+    """
+    with open(path, encoding="utf-8") as fp:
+        for i, line in enumerate(fp, start=1):
+            verb, sep, paths = line.rstrip("\n").partition(" ")
+            if not sep:
+                raise ValueError(f"line {i} is invalid")
+
+            # Ignore informational lines that don't need to be re-imported.
+            if verb in {"import", "duplicate-keep", "duplicate-replace"}:
+                continue
+
+            if verb not in {"asis", "skip", "duplicate-skip"}:
+                raise ValueError(f"line {i} contains unknown verb {verb}")
+
+            yield os.path.commonpath(paths.split("; "))
+
+
+def parse_logfiles(logfiles):
+    """Parse all `logfiles` and yield paths from it."""
+    for logfile in logfiles:
+        try:
+            yield from paths_from_logfile(syspath(normpath(logfile)))
+        except ValueError as err:
+            raise ui.UserError(
+                f"malformed logfile {displayable_path(logfile)}: {err}"
+            ) from err
+        except OSError as err:
+            raise ui.UserError(
+                f"unreadable logfile {displayable_path(logfile)}: {err}"
+            ) from err
+
+
 def import_files(lib, paths: list[bytes], query):
     """Import the files in the given list of paths or matching the
     query.
@@ -97,6 +131,32 @@ def import_func(lib, opts, args: list[str]):
     import_files(lib, byte_paths, query)
 
 
+def _store_dict(option, opt_str, value, parser):
+    """Custom action callback to parse options which have ``key=value``
+    pairs as values. All such pairs passed for this option are
+    aggregated into a dictionary.
+    """
+    dest = option.dest
+    option_values = getattr(parser.values, dest, None)
+
+    if option_values is None:
+        # This is the first supplied ``key=value`` pair of option.
+        # Initialize empty dictionary and get a reference to it.
+        setattr(parser.values, dest, {})
+        option_values = getattr(parser.values, dest)
+
+    try:
+        key, value = value.split("=", 1)
+        if not (key and value):
+            raise ValueError
+    except ValueError:
+        raise ui.UserError(
+            f"supplied argument `{value}' is not of the form `key=value'"
+        )
+
+    option_values[key] = value
+
+
 import_cmd = ui.Subcommand(
     "import", help="import new music", aliases=("imp", "im")
 )
@@ -274,7 +334,7 @@ def import_func(lib, opts, args: list[str]):
     "--set",
     dest="set_fields",
     action="callback",
-    callback=ui._store_dict,
+    callback=_store_dict,
     metavar="FIELD=VALUE",
     help="set the given fields to the supplied values",
 )

beets/ui/commands/config.py

@@ -2,16 +2,13 @@
 from collections.abc import Sequence
 from functools import cached_property
 
-from beets import autotag, config, logging, ui
+from beets import autotag, config, ui
 from beets.autotag import hooks
 from beets.util import displayable_path
 from beets.util.units import human_seconds_short
 
 VARIOUS_ARTISTS = "Various Artists"
 
-# Global logger.
-log = logging.getLogger("beets")
-
 
 class ChangeRepresentation:
     """Keeps track of all information needed to generate a (colored) text