add type annotations in ui/commands/import

also add necessary type annotations in `importer/session.py` to prevent
additional mypy errors

Author: amogus07

beets/importer/session.py

@@ -15,7 +15,7 @@
 
 import os
 import time
-from typing import TYPE_CHECKING, Sequence
+from typing import TYPE_CHECKING
 
 from beets import config, dbcore, library, logging, plugins, util
 from beets.importer.tasks import Action
@@ -25,6 +25,10 @@
 from .state import ImportState
 
 if TYPE_CHECKING:
+    from typing import Literal, Sequence
+
+    from beets.autotag import AlbumMatch, TrackMatch
+    from beets.importer.tasks import SingletonImportTask
     from beets.util import PathBytes
 
     from .tasks import ImportTask
@@ -60,7 +64,7 @@ def __init__(
         lib: library.Library,
         loghandler: logging.Handler | None,
         paths: Sequence[PathBytes] | None,
-        query: dbcore.Query | None,
+        query: dbcore.Query | str | list[str] | tuple[str] | None,
     ):
         """Create a session.
 
@@ -173,16 +177,20 @@ def log_choice(self, task: ImportTask, duplicate=False):
             elif task.choice_flag is Action.SKIP:
                 self.tag_log("skip", paths)
 
-    def should_resume(self, path: PathBytes):
+    def should_resume(self, path: PathBytes) -> bool:
         raise NotImplementedError
 
-    def choose_match(self, task: ImportTask):
+    def choose_match(
+        self, task: ImportTask
+    ) -> Literal[Action.ASIS, Action.SKIP] | AlbumMatch | TrackMatch:
         raise NotImplementedError
 
-    def resolve_duplicate(self, task: ImportTask, found_duplicates):
+    def resolve_duplicate(self, task: ImportTask, found_duplicates) -> None:
         raise NotImplementedError
 
-    def choose_item(self, task: ImportTask):
+    def choose_item(
+        self, task: SingletonImportTask
+    ) -> Literal[Action.ASIS, Action.SKIP] | AlbumMatch | TrackMatch:
         raise NotImplementedError
 
     def run(self):

beets/ui/commands/import_/__init__.py

@@ -1,6 +1,9 @@
 """The `import` command: import new music into the library."""
 
+from __future__ import annotations
+
 import os
+from typing import TYPE_CHECKING
 
 from beets import config, logging, plugins
 from beets.ui._common import UserError
@@ -10,11 +13,23 @@
 from .._utils import parse_logfiles
 from .session import TerminalImportSession
 
+if TYPE_CHECKING:
+    from logging import FileHandler
+    from optparse import Values
+
+    from beets.dbcore import Query
+    from beets.library import Library
+
+
 # Global logger.
 log = logging.getLogger("beets")
 
 
-def import_files(lib, paths: list[bytes], query):
+def import_files(
+    lib: Library,
+    paths: list[bytes],
+    query: Query | str | list[str] | tuple[str] | None,
+) -> None:
     """Import the files in the given list of paths or matching the
     query.
     """
@@ -24,7 +39,8 @@ def import_files(lib, paths: list[bytes], query):
 
     # Open the log.
     if config["import"]["log"].get() is not None:
-        logpath = syspath(config["import"]["log"].as_filename())
+        logpath: str = syspath(config["import"]["log"].as_filename())
+        loghandler: FileHandler | None
         try:
             loghandler = logging.FileHandler(logpath, encoding="utf-8")
         except OSError:
@@ -39,39 +55,52 @@ def import_files(lib, paths: list[bytes], query):
     if config["import"]["resume"].get() == "ask" and config["import"]["quiet"]:
         config["import"]["resume"] = False
 
-    session = TerminalImportSession(lib, loghandler, paths, query)
+    session: TerminalImportSession = TerminalImportSession(
+        lib, loghandler, paths, query
+    )
     session.run()
 
     # Emit event.
-    plugins.send("import", lib=lib, paths=paths)
+    _ = plugins.send("import", lib=lib, paths=paths)
 
 
-def import_func(lib, opts, args: list[str]):
+def import_func(
+    lib: Library,
+    opts: Values,
+    args: list[str] | tuple[str],
+) -> None:
     config["import"].set_args(opts)
 
     # Special case: --copy flag suppresses import_move (which would
     # otherwise take precedence).
     if opts.copy:
         config["import"]["move"] = False
 
+    query: Query | str | list[str] | tuple[str] | None
+    byte_paths: list[bytes]
     if opts.library:
         query = args
         byte_paths = []
     else:
         query = None
-        paths = args
+        paths: list[str] | tuple[str] = args
 
         # The paths from the logfiles go into a separate list to allow handling
         # errors differently from user-specified paths.
-        paths_from_logfiles = list(parse_logfiles(opts.from_logfiles or []))
+        paths_from_logfiles: list[str] = list(
+            parse_logfiles(opts.from_logfiles or [])
+        )
 
         if not paths and not paths_from_logfiles:
             raise UserError("no path specified")
 
         byte_paths = [os.fsencode(p) for p in paths]
-        paths_from_logfiles = [os.fsencode(p) for p in paths_from_logfiles]
+        byte_paths_from_logfiles: list[bytes] = [
+            os.fsencode(p) for p in paths_from_logfiles
+        ]
 
         # Check the user-specified directories.
+        path: bytes
         for path in byte_paths:
             if not os.path.exists(syspath(normpath(path))):
                 raise UserError(
@@ -82,7 +111,7 @@ def import_func(lib, opts, args: list[str]):
         # case those paths don't exist. Maybe some of those paths have already
         # been imported and moved separately, so logging a warning should
         # suffice.
-        for path in paths_from_logfiles:
+        for path in byte_paths_from_logfiles:
             if not os.path.exists(syspath(normpath(path))):
                 log.warning(
                     "No such file or directory: {}", displayable_path(path)
@@ -102,177 +131,177 @@ def import_func(lib, opts, args: list[str]):
 import_cmd = Subcommand(
     "import", help="import new music", aliases=("imp", "im")
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "-c",
     "--copy",
     action="store_true",
     default=None,
     help="copy tracks into library directory (default)",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "-C",
     "--nocopy",
     action="store_false",
     dest="copy",
     help="don't copy tracks (opposite of -c)",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "-m",
     "--move",
     action="store_true",
     dest="move",
     help="move tracks into the library (overrides -c)",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "-w",
     "--write",
     action="store_true",
     default=None,
     help="write new metadata to files' tags (default)",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "-W",
     "--nowrite",
     action="store_false",
     dest="write",
     help="don't write metadata (opposite of -w)",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "-a",
     "--autotag",
     action="store_true",
     dest="autotag",
     help="infer tags for imported files (default)",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "-A",
     "--noautotag",
     action="store_false",
     dest="autotag",
     help="don't infer tags for imported files (opposite of -a)",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "-p",
     "--resume",
     action="store_true",
     default=None,
     help="resume importing if interrupted",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "-P",
     "--noresume",
     action="store_false",
     dest="resume",
     help="do not try to resume importing",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "-q",
     "--quiet",
     action="store_true",
     dest="quiet",
     help="never prompt for input: skip albums instead",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "--quiet-fallback",
     type="string",
     dest="quiet_fallback",
     help="decision in quiet mode when no strong match: skip or asis",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "-l",
     "--log",
     dest="log",
     help="file to log untaggable albums for later review",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "-s",
     "--singletons",
     action="store_true",
     help="import individual tracks instead of full albums",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "-t",
     "--timid",
     dest="timid",
     action="store_true",
     help="always confirm all actions",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "-L",
     "--library",
     dest="library",
     action="store_true",
     help="retag items matching a query",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "-i",
     "--incremental",
     dest="incremental",
     action="store_true",
     help="skip already-imported directories",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "-I",
     "--noincremental",
     dest="incremental",
     action="store_false",
     help="do not skip already-imported directories",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "-R",
     "--incremental-skip-later",
     action="store_true",
     dest="incremental_skip_later",
     help="do not record skipped files during incremental import",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "-r",
     "--noincremental-skip-later",
     action="store_false",
     dest="incremental_skip_later",
     help="record skipped files during incremental import",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "--from-scratch",
     dest="from_scratch",
     action="store_true",
     help="erase existing metadata before applying new metadata",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "--flat",
     dest="flat",
     action="store_true",
     help="import an entire tree as a single album",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "-g",
     "--group-albums",
     dest="group_albums",
     action="store_true",
     help="group tracks in a folder into separate albums",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "--pretend",
     dest="pretend",
     action="store_true",
     help="just print the files to import",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "-S",
     "--search-id",
     dest="search_ids",
     action="append",
     metavar="ID",
     help="restrict matching to a specific metadata backend ID",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "--from-logfile",
     dest="from_logfiles",
     action="append",
     metavar="PATH",
     help="read skipped paths from an existing logfile",
 )
-import_cmd.parser.add_option(
+_ = import_cmd.parser.add_option(
     "--set",
     dest="set_fields",
     action="callback",