Cosmetic (delimit better what are overrides)

Author: frou

src/blame.py

@@ -12,7 +12,7 @@
 
 class Blame(BaseBlame, sublime_plugin.TextCommand):
 
-    # Overrides --------------------------------------------------
+    # Overrides begin ------------------------------------------------------------------
 
     def __init__(self, view):
         super().__init__(view)
@@ -126,15 +126,15 @@ def extra_cli_args(self, line_num, sha_skip_list):
             args.extend(["--ignore-rev", skipped_sha])
         return args
 
-    # ------------------------------------------------------------
+    # Overrides end --------------------------------------------------------------------
 
     def phantom_exists_for_region(self, region):
         return any(p.region == region for p in self.phantom_set.phantoms)
 
 
 class BlameInsertCommitDescription(sublime_plugin.TextCommand):
 
-    # Overrides --------------------------------------------------
+    # Overrides begin ------------------------------------------------------------------
 
     def run(self, edit, desc, scratch_view_name):
         view = self.view
@@ -143,3 +143,5 @@ def run(self, edit, desc, scratch_view_name):
         view.insert(edit, 0, desc)
         view.set_name(scratch_view_name)
         view.set_read_only(True)
+
+    # Overrides end --------------------------------------------------------------------

src/blame_all.py

@@ -16,7 +16,7 @@ class BlameShowAll(BaseBlame, sublime_plugin.TextCommand):
 
     HORIZONTAL_SCROLL_DELAY_MS = 100
 
-    # Overrides --------------------------------------------------
+    # Overrides begin ------------------------------------------------------------------
 
     def __init__(self, view):
         super().__init__(view)
@@ -88,11 +88,11 @@ def _view(self):
     def extra_cli_args(self, **kwargs):
         return []
 
-    # ------------------------------------------------------------
-
     def handle_phantom_close_button(self):
         self.view.run_command("blame_erase_all")
 
+    # Overrides end --------------------------------------------------------------------
+
     def phantom_region(self, line_number):
         line_begins_pt = self.view.text_point(line_number - 1, 0)
         return sublime.Region(line_begins_pt)
@@ -116,36 +116,39 @@ def horizontal_scroll_to_limit(self, *, left):
 
 class BlameEraseAll(sublime_plugin.TextCommand):
 
-    # Overrides --------------------------------------------------
+    # Overrides begin ------------------------------------------------------------------
 
     def run(self, edit):
-        """Erases the blame results."""
         sublime.status_message("The git blame result is cleared.")
         self.view.erase_phantoms(PHANTOM_KEY_ALL)
         self.view.settings().erase(VIEW_SETTING_PHANTOM_ALL_DISPLAYED)
         self.view.run_command("blame_restore_rulers")
 
+    # Overrides end --------------------------------------------------------------------
+
 
 class BlameEraseAllListener(sublime_plugin.ViewEventListener):
 
-    # Overrides --------------------------------------------------
+    # Overrides begin ------------------------------------------------------------------
 
     @classmethod
     def is_applicable(cls, settings):
-        """Checks if the blame_erase_all command is applicable."""
         return settings.get(VIEW_SETTING_PHANTOM_ALL_DISPLAYED, False)
 
     def on_modified_async(self):
-        """Automatically erases the blame results to prevent mismatches."""
         self.view.run_command("blame_erase_all")
 
+    # Overrides end --------------------------------------------------------------------
+
 
 class BlameRestoreRulers(sublime_plugin.TextCommand):
 
-    # Overrides --------------------------------------------------
+    # Overrides begin ------------------------------------------------------------------
 
     def run(self, edit):
         self.view.settings().set(
             VIEW_SETTING_RULERS,
             self.view.settings().get(VIEW_SETTING_RULERS_PREV),
         )
+
+    # Overrides end --------------------------------------------------------------------

src/blame_inline.py

@@ -18,6 +18,22 @@ class BlameInlineListener(BaseBlame, sublime_plugin.ViewEventListener):
 
     pkg_setting_callback_added = False
 
+    # Overrides begin ------------------------------------------------------------------
+
+    def __init__(self, view):
+        super().__init__(view)
+        self.phantom_set = sublime.PhantomSet(view, INLINE_BLAME_PHANTOM_SET_KEY)
+        self.timer = None
+        self.delay_seconds = (
+            pkg_settings().get(PKG_SETTINGS_KEY_INLINE_BLAME_DELAY) / 1000
+        )
+        # Show it immediately for the initially selected line.
+        self.show_inline_blame()
+
+    def run(self, edit):
+        # Unlike the other BaseBlame subclasses, we are reactive, not a sublime_plugin.Command
+        pass
+
     @classmethod
     def is_applicable(cls, view_settings):
         if not cls.pkg_setting_callback_added:
@@ -29,6 +45,27 @@ def is_applicable(cls, view_settings):
 
         return cls.determine_enablement(view_settings)
 
+    def on_selection_modified_async(self):
+        self.show_inline_blame_handler()
+
+    def on_post_save_async(self):
+        # Redisplay the blame after the file is saved, because there will be
+        # no call to on_selection_modified_async after save.
+        self.show_inline_blame_handler()
+
+    def extra_cli_args(self, line_num):
+        args = ["-L", "{0},{0}".format(line_num), "--date=relative"]
+        return args
+
+    def _view(self):
+        return self.view
+
+    def handle_phantom_close_button(self):
+        # Inline Blame phantoms close automatically when appropriate.
+        pass
+
+    # Overrides end --------------------------------------------------------------------
+
     @classmethod
     def determine_enablement(cls, view_settings):
         enabled = view_settings.get(
@@ -61,30 +98,12 @@ def on_pkg_setting_changed(cls):
             view.settings().set(cls.__name__, "")
             view.settings().erase(cls.__name__)
 
-    def __init__(self, view):
-        super().__init__(view)
-        self.phantom_set = sublime.PhantomSet(view, INLINE_BLAME_PHANTOM_SET_KEY)
-        self.timer = None
-        self.delay_seconds = (
-            pkg_settings().get(PKG_SETTINGS_KEY_INLINE_BLAME_DELAY) / 1000
-        )
-        # Show it immediately for the initially selected line.
-        self.show_inline_blame()
-
-    def extra_cli_args(self, line_num):
-        args = ["-L", "{0},{0}".format(line_num), "--date=relative"]
-        return args
-
-    def _view(self):
-        return self.view
-
-    def handle_phantom_close_button(self):
-        # Inline Blame phantoms close automatically when appropriate.
-        pass
-
-    def run(self, edit):
-        # Unlike the other BaseBlame subclasses, we are reactive, not a sublime_plugin.Command
-        pass
+    def show_inline_blame_handler(self):
+        self.view.erase_phantoms(INLINE_BLAME_PHANTOM_SET_KEY)
+        if self.timer:
+            self.timer.cancel()
+        self.timer = threading.Timer(self.delay_seconds, self.show_inline_blame)
+        self.timer.start()
 
     def show_inline_blame(self):
         if self.view.is_dirty():
@@ -145,21 +164,6 @@ def maybe_insert_phantoms(self, phantoms):
         if not self.view.is_dirty():
             self.phantom_set.update(phantoms)
 
-    def show_inline_blame_handler(self):
-        self.view.erase_phantoms(INLINE_BLAME_PHANTOM_SET_KEY)
-        if self.timer:
-            self.timer.cancel()
-        self.timer = threading.Timer(self.delay_seconds, self.show_inline_blame)
-        self.timer.start()
-
-    def on_selection_modified_async(self):
-        self.show_inline_blame_handler()
-
-    def on_post_save_async(self):
-        # Redisplay the blame after the file is saved, because there will be
-        # no call to on_selection_modified_async after save.
-        self.show_inline_blame_handler()
-
 
 class ToggleInlineGitBlame(sublime_plugin.TextCommand):