Move EventType definition to plugins.py and fix test_hook types

Author: snejus

beets/event_types.py

@@ -24,7 +24,7 @@
 from functools import wraps
 from pathlib import Path
 from types import GenericAlias
-from typing import TYPE_CHECKING, Any, ClassVar, TypeVar
+from typing import TYPE_CHECKING, Any, ClassVar, Literal, TypeVar
 
 import mediafile
 from typing_extensions import ParamSpec
@@ -41,7 +41,6 @@
     from beets.dbcore import Query
     from beets.dbcore.db import FieldQueryType
     from beets.dbcore.types import Type
-    from beets.event_types import EventType
     from beets.importer import ImportSession, ImportTask
     from beets.library import Album, Item, Library
     from beets.ui import Subcommand
@@ -66,6 +65,37 @@
 # Plugins using the Last.fm API can share the same API key.
 LASTFM_KEY = "2dc3914abf35f0d9c92d97d8f8e42b43"
 
+EventType = Literal[
+    "after_write",
+    "album_imported",
+    "album_removed",
+    "albuminfo_received",
+    "before_choose_candidate",
+    "before_item_moved",
+    "cli_exit",
+    "database_change",
+    "import",
+    "import_begin",
+    "import_task_apply",
+    "import_task_before_choice",
+    "import_task_choice",
+    "import_task_created",
+    "import_task_files",
+    "import_task_start",
+    "item_copied",
+    "item_hardlinked",
+    "item_imported",
+    "item_linked",
+    "item_moved",
+    "item_reflinked",
+    "item_removed",
+    "library_opened",
+    "mb_album_extract",
+    "mb_track_extract",
+    "pluginload",
+    "trackinfo_received",
+    "write",
+]
 # Global logger.
 log = logging.getLogger("beets")
 

beets/plugins.py

@@ -37,12 +37,14 @@ def _get_hook(self, event: str, command: str) -> dict[str, str]:
 
 
 class HookLogsTest(HookTestCase):
+    HOOK: plugins.EventType = "write"
+
     @contextmanager
     def _configure_logs(self, command: str) -> Iterator[list[str]]:
-        config = {"hooks": [self._get_hook("test_event", command)]}
+        config = {"hooks": [self._get_hook(self.HOOK, command)]}
 
         with self.configure_plugin(config), capture_log("beets.hook") as logs:
-            plugins.send("test_event")
+            plugins.send(self.HOOK)
             yield logs
 
     def test_hook_empty_command(self):
@@ -53,13 +55,13 @@ def test_hook_empty_command(self):
     @unittest.skipIf(sys.platform == "win32", "win32")
     def test_hook_non_zero_exit(self):
         with self._configure_logs('sh -c "exit 1"') as logs:
-            assert "hook: hook for test_event exited with status 1" in logs
+            assert f"hook: hook for {self.HOOK} exited with status 1" in logs
 
     def test_hook_non_existent_command(self):
         with self._configure_logs("non-existent-command") as logs:
             logs = "\n".join(logs)
 
-        assert "hook: hook for test_event failed: " in logs
+        assert f"hook: hook for {self.HOOK} failed: " in logs
         # The error message is different for each OS. Unfortunately the text is
         # different in each case, where the only shared text is the string
         # 'file' and substring 'Err'
@@ -68,13 +70,11 @@ def test_hook_non_existent_command(self):
 
 
 class HookCommandTest(HookTestCase):
-    TEST_HOOK_COUNT = 2
-
-    events = [f"test_event_{i}" for i in range(TEST_HOOK_COUNT)]
+    EVENTS: list[plugins.EventType] = ["write", "after_write"]
 
     def setUp(self):
         super().setUp()
-        self.paths = [str(self.temp_dir_path / e) for e in self.events]
+        self.paths = [str(self.temp_dir_path / e) for e in self.EVENTS]
 
     def _test_command(
         self,
@@ -93,13 +93,14 @@ def _test_command(
         2. Assert that a file has been created under the original path, which proves
            that the configured hook command has been executed.
         """
+        events_with_paths = list(zip(self.EVENTS, self.paths))
         hooks = [
             self._get_hook(e, f"touch {make_test_path(e, p)}")
-            for e, p in zip(self.events, self.paths)
+            for e, p in events_with_paths
         ]
 
         with self.configure_plugin({"hooks": hooks}):
-            for event, path in zip(self.events, self.paths):
+            for event, path in events_with_paths:
                 if send_path_kwarg:
                     plugins.send(event, path=path)
                 else: