Create a per-class PhantomSet key automatically

Author: frou

src/base.py

@@ -146,6 +146,10 @@ def communicate_error(self, e, modal=True):
             # persisted in the console too.
             print(user_msg)  # noqa: T001
 
+    @classmethod
+    def phantom_set_key(cls):
+        return "git-blame" + cls.__name__
+
     # ------------------------------------------------------------
 
     @abstractmethod

src/blame.py

@@ -16,7 +16,7 @@ class Blame(BaseBlame, sublime_plugin.TextCommand):
 
     def __init__(self, view):
         super().__init__(view)
-        self.phantom_set = sublime.PhantomSet(view, "git-blame")
+        self.phantom_set = sublime.PhantomSet(view, self.phantom_set_key())
 
     def run(self, edit, prevving=False, fixed_row_num=None, sha_skip_list=[]):
         if not self.has_suitable_view():

src/blame_all.py

@@ -4,8 +4,6 @@
 from .base import BaseBlame
 from .templates import blame_all_phantom_css, blame_all_phantom_html_template
 
-PHANTOM_KEY_ALL = "git-blame-all"
-
 VIEW_SETTING_PHANTOM_ALL_DISPLAYED = "git-blame-all-displayed"
 
 VIEW_SETTING_RULERS = "rulers"
@@ -20,15 +18,15 @@ class BlameShowAll(BaseBlame, sublime_plugin.TextCommand):
 
     def __init__(self, view):
         super().__init__(view)
-        self.phantom_set = sublime.PhantomSet(self.view, PHANTOM_KEY_ALL)
+        self.phantom_set = sublime.PhantomSet(self.view, self.phantom_set_key())
         self.pattern = None
 
     def run(self, edit):
         if not self.has_suitable_view():
             self.tell_user_to_save()
             return
 
-        self.view.erase_phantoms(PHANTOM_KEY_ALL)
+        self.view.erase_phantoms(self.phantom_set_key())
         phantoms = []  # type: list[sublime.Phantom] # type: ignore[misc]
 
         # If they are currently shown, toggle them off and return.
@@ -125,7 +123,7 @@ class BlameEraseAll(sublime_plugin.TextCommand):
 
     def run(self, edit):
         sublime.status_message("The git blame result is cleared.")
-        self.view.erase_phantoms(PHANTOM_KEY_ALL)
+        self.view.erase_phantoms(BlameShowAll.phantom_set_key())
         self.view.settings().erase(VIEW_SETTING_PHANTOM_ALL_DISPLAYED)
         self.view.run_command("blame_restore_rulers")
 

src/blame_inline.py

@@ -11,8 +11,6 @@
 )
 from .templates import blame_inline_phantom_css, blame_inline_phantom_html_template
 
-INLINE_BLAME_PHANTOM_SET_KEY = "git-blame-inline"
-
 
 class BlameInlineListener(BaseBlame, sublime_plugin.ViewEventListener):
 
@@ -22,7 +20,7 @@ class BlameInlineListener(BaseBlame, sublime_plugin.ViewEventListener):
 
     def __init__(self, view):
         super().__init__(view)
-        self.phantom_set = sublime.PhantomSet(view, INLINE_BLAME_PHANTOM_SET_KEY)
+        self.phantom_set = sublime.PhantomSet(view, self.phantom_set_key())
         self.timer = None
         self.delay_seconds = (
             pkg_settings().get(PKG_SETTINGS_KEY_INLINE_BLAME_DELAY) / 1000
@@ -61,7 +59,7 @@ def _view(self):
         return self.view
 
     def close_by_user_request(self):
-        self.view.erase_phantoms(INLINE_BLAME_PHANTOM_SET_KEY)
+        self.view.erase_phantoms(self.phantom_set_key())
 
     def rerun(self, **kwargs):
         if self.timer:
@@ -98,7 +96,7 @@ def on_pkg_setting_changed(cls):
         for view in all_editor_views:
             ToggleInlineGitBlame.erase_viewlevel_customization(view)
             if not pkg_settings().get(PKG_SETTINGS_KEY_INLINE_BLAME_ENABLED):
-                view.erase_phantoms(INLINE_BLAME_PHANTOM_SET_KEY)
+                view.erase_phantoms(cls.phantom_set_key())
             # Do a dummy modification to the view's settings to induce the ViewEventListener applicability check to happen again.
             view.settings().set(cls.__name__, "")
             view.settings().erase(cls.__name__)
@@ -176,7 +174,7 @@ class ToggleInlineGitBlame(sublime_plugin.TextCommand):
     def run(self, edit):
         enabled = not BlameInlineListener.determine_enablement(self.view.settings())
         if not enabled:
-            self.view.erase_phantoms(INLINE_BLAME_PHANTOM_SET_KEY)
+            self.view.erase_phantoms(BlameInlineListener.phantom_set_key())
         self.view.settings().set(self.VIEW_SETTINGS_KEY_INLINE_BLAME_ENABLED, enabled)
 
     # Overrides end --------------------------------------------------------------------