chore: Code improvements and optimizations

Author: bitst0rm

core/common.py

@@ -30,7 +30,7 @@
 
 class ConfigDict(dict):
     _bypass_restrictions = False
-    _allowed_keys_for_get = ['custom_modules', 'custom_modules_manifest', 'formatters', 'STOP', 'environ', 'quick_options']
+    _allowed_keys_for_get = ['custom_modules', 'custom_modules_manifest', 'formatters', 'environ', 'quick_options']
 
     def get(self, key, *args, **kwargs):  # access via CONFIG.get('key')
         if key in ConfigDict._allowed_keys_for_get:
@@ -94,6 +94,7 @@ def __init__(cls, name, bases, namespace, **kwargs):
 class Module(metaclass=ModuleMeta):
     '''
     API solely for interacting with files located in the 'modules' folder.
+    These methods allow you to create a custom formatter adapter for your plugin.
     '''
 
     def __init__(self, view=None, uid=None, region=None, interpreters=None, executables=None, dotfiles=None, temp_dir=None, type=None, auto_format_config=None, **kwargs):
@@ -108,10 +109,37 @@ def __init__(self, view=None, uid=None, region=None, interpreters=None, executab
         self.auto_format_config = auto_format_config
         self.kwargs = kwargs  # @unused
 
+        # Track temp files created
+        self._tmp_files_created = {}
+
+    def __del__(self):
+        # Clean up automatically if autodel=True for any tmp files
+        for tmp_file, autodel in self._tmp_files_created.items():
+            if autodel:
+                TempFileHandler.remove_tmp_file(tmp_file)
+            else:
+                log.warning(
+                    'Temporary files were created but not removed: %s\n'
+                    'Ensure that all temporary files are manually removed by using "self.remove_tmp_file(tmp_file)"\n'
+                    'Or, create the temporary file with automatic deletion by using "self.create_tmp_file(suffix=None, autodel=True)"', tmp_file
+                )
+
     @abc.abstractmethod
     def format(self):
         raise NotImplementedError('Subclasses must implement the "format()" method.')
 
+    def create_tmp_file(self, suffix=None, autodel=False):
+        tmp_file = TempFileHandler.create_tmp_file(view=self.view, uid=self.uid, region=self.region, auto_format_config=self.auto_format_config, suffix=suffix)
+        self._tmp_files_created[tmp_file] = autodel
+        return tmp_file
+
+    def remove_tmp_file(self, tmp_file=None):
+        if tmp_file in self._tmp_files_created:
+            del self._tmp_files_created[tmp_file]
+            return TempFileHandler.remove_tmp_file(tmp_file=tmp_file)
+        else:
+            raise ValueError('Attempting to remove a temporary file that was not created by this module instance.')
+
     def is_executable(self, file=None):
         return FileHandler.is_executable(file=file)
 
@@ -154,12 +182,6 @@ def is_view_formattable(self):
     def query(self, data_dict, default=None, *keys):
         return OptionHandler.query(data_dict, default, *keys)
 
-    def create_tmp_file(self, suffix=None):
-        return TempFileHandler.create_tmp_file(view=self.view, uid=self.uid, region=self.region, auto_format_config=self.auto_format_config, suffix=suffix)
-
-    def remove_tmp_file(self, tmp_file=None):
-        return TempFileHandler.remove_tmp_file(tmp_file=tmp_file)
-
     def get_executable(self, runtime_type=None):
         return ArgumentHandler.get_executable(view=self.view, uid=self.uid, executables=self.executables, runtime_type=runtime_type)
 
@@ -215,6 +237,24 @@ def popup_message(self, text, title=None, dialog=False):
 
 # === Module Supporting Classes === #
 
+class TempFileHandler:
+    @staticmethod
+    def create_tmp_file(view=None, uid=None, region=None, auto_format_config=None, suffix=None):
+        if not suffix:
+            uid, syntax = SyntaxHandler.get_assigned_syntax(view=view, uid=uid, region=region, auto_format_config=auto_format_config)
+            suffix = '.' + syntax if syntax else None
+
+        with tempfile.NamedTemporaryFile(mode='w+', delete=False, suffix=suffix, dir=None, encoding='utf-8') as file:
+            file.write(ViewHandler.get_text_from_region(view=view, region=region))
+            file.close()
+            return file.name
+
+    @staticmethod
+    def remove_tmp_file(tmp_file=None):
+        if tmp_file and os.path.isfile(tmp_file):
+            os.unlink(tmp_file)
+
+
 class FileHandler:
     @staticmethod
     def _is_valid_file(file=None):
@@ -530,26 +570,6 @@ def query(data_dict, default=None, *keys):
         return data_dict
 
 
-class TempFileHandler:
-    @staticmethod
-    def create_tmp_file(view=None, uid=None, region=None, auto_format_config=None, suffix=None):
-        if not suffix:
-            uid, syntax = SyntaxHandler.get_assigned_syntax(view=view, uid=uid, region=region, auto_format_config=auto_format_config)
-            suffix = '.' + syntax if syntax else None
-
-        with tempfile.NamedTemporaryFile(mode='w+', delete=False, suffix=suffix, dir=None, encoding='utf-8') as file:
-            file.write(ViewHandler.get_text_from_region(view=view, region=region))
-            file.close()
-            return file.name
-
-        return None
-
-    @staticmethod
-    def remove_tmp_file(tmp_file=None):
-        if tmp_file and os.path.isfile(tmp_file):
-            os.unlink(tmp_file)
-
-
 class ModeHandler:
     @staticmethod
     def is_generic_mode(uid=None):
@@ -1131,9 +1151,10 @@ class DataHandler:
     _categories = {
         '__sublime_preferences__': {'key': None, 'value': None},
         '__project_config__': {'key': None, 'value': None},
-        '__save_paste_action__': {'key': None, 'value': None},  # current action
+        '__save_paste_action__': {'key': None, 'value': None},  # current action state
         '__auto_format_chain_item__': {'key': None, 'value': None},  # current chaining item
-        '__auto_format_noop__': {'key': None, 'value': None}  # current no operation id
+        '__auto_format_noop__': {'key': None, 'value': None},  # current no operation id
+        '__dir_format_stop__': {'key': None, 'value': None}  # current dir format state
     }
 
     @classmethod

core/smanager.py

@@ -7,7 +7,7 @@
 import sublime
 import sublime_plugin
 
-from . import CONFIG, OptionHandler, bulk_operation_detector, log
+from . import CONFIG, DataHandler, OptionHandler, bulk_operation_detector, log
 
 SESSION_FILE = join(sublime.packages_path(), '..', 'Local', 'Session.formatter_session')
 MAX_AGE_DAYS = 180
@@ -171,10 +171,10 @@ def run_on_load(self, view):
 class SessionManagerListener(sublime_plugin.EventListener):
     @bulk_operation_detector.bulk_operation_guard(register=True)
     def on_load(self, view):
-        if OptionHandler.query(CONFIG, True, 'remember_session') and CONFIG.get('STOP', True):
+        if OptionHandler.query(CONFIG, True, 'remember_session') and (DataHandler.get('__dir_format_stop__')[1] or True):
             session_manager.run_on_load(view)
 
     @bulk_operation_detector.bulk_operation_guard(register=True)
     def on_pre_close(self, view):
-        if OptionHandler.query(CONFIG, True, 'remember_session') and CONFIG.get('STOP', True):
+        if OptionHandler.query(CONFIG, True, 'remember_session') and (DataHandler.get('__dir_format_stop__')[1] or True):
             session_manager.run_on_pre_close(view)

core/wcounter.py

@@ -1,8 +1,8 @@
 import sublime
 import sublime_plugin
 
-from . import (CONFIG, STATUS_KEY, OptionHandler, bulk_operation_detector,
-               debounce, skip_word_counter)
+from . import (CONFIG, STATUS_KEY, DataHandler, OptionHandler,
+               bulk_operation_detector, debounce, skip_word_counter)
 
 CHUNK_SIZE = 1024 * 1024  # ≈ 1048576 chars (1MB)
 
@@ -94,7 +94,7 @@ class WordCounterListener(sublime_plugin.EventListener):
     @debounce(delay_in_ms=300)
     def on_selection_modified_async(self, view):
         x = OptionHandler.query(CONFIG, {}, 'show_words_count')
-        if x.get('enable', True) and CONFIG.get('STOP', True):
+        if x.get('enable', True) and (DataHandler.get('__dir_format_stop__')[1] or True):
             ignore_whitespace_char = x.get('ignore_whitespace_char', True)
             use_short_label = x.get('use_short_label', False)
             view.settings().set('show_line_column', 'disabled')

plugin/dir_format.py

@@ -7,18 +7,20 @@
 
 from ..core import (CONFIG, PACKAGE_NAME, RECURSIVE_FAILURE_DIRECTORY,
                     RECURSIVE_SUCCESS_DIRECTORY, STATUS_KEY, ConfigHandler,
-                    InterfaceHandler, OptionHandler, PathHandler,
+                    DataHandler, InterfaceHandler, OptionHandler, PathHandler,
                     SyntaxHandler, TextHandler, TransformHandler, check_stop,
                     log)
 from ..core.formatter import Formatter
 from . import ActivityIndicator
 
-STOP = False
-START_TIME = None
+
+class DirFormatState:
+    STOP = False
+    START_TIME = None
 
 
 def get_stop_status():
-    return STOP
+    return DirFormatState.STOP
 
 
 class DirFormat:
@@ -51,9 +53,8 @@ def run(self):
         self.start_timer()
 
         try:
-            global STOP
-            STOP = False
-            CONFIG['STOP'] = False  # pause smanager and wcounter
+            DirFormatState.STOP = False
+            DataHandler.set('__dir_format_stop__', 'STOP', False)  # pause smanager and wcounter
 
             # Show progress indicator if formatting takes longer than 1s
             with ActivityIndicator(view=self.view, label='In Progress...', delay=1000):
@@ -69,9 +70,8 @@ def run(self):
 
     @staticmethod
     def stop():
-        global STOP
-        STOP = True
-        CONFIG['STOP'] = True
+        DirFormatState.STOP = True
+        DataHandler.set('__dir_format_stop__', 'STOP', True)
 
     @staticmethod
     def format_elapsed_time(seconds):
@@ -86,16 +86,14 @@ def format_elapsed_time(seconds):
 
     @staticmethod
     def start_timer():
-        global START_TIME
-        START_TIME = perf_counter()
+        DirFormatState.START_TIME = perf_counter()
 
     def end_timer(self):
-        global START_TIME
-        if START_TIME is None:
+        if DirFormatState.START_TIME is None:
             log.warning('Timer was not started.')
             return 'N/A'
-        elapsed_time = perf_counter() - START_TIME
-        START_TIME = None
+        elapsed_time = perf_counter() - DirFormatState.START_TIME
+        DirFormatState.START_TIME = None
         return self.format_elapsed_time(elapsed_time)
 
     def get_current_working_directory(self):
@@ -253,7 +251,7 @@ def show_completion_message(self):
             'Time:  {}\n\n'
             'Please check the result in:\n{}'
         ).format(
-            'COMPLETED' if STOP is False else 'ABORTED',
+            'COMPLETED' if DirFormatState.STOP is False else 'ABORTED',
             ok, ko, total, etime, cwd
         )
 
@@ -263,7 +261,7 @@ def reset_context(self):
         for key in self.CONTEXT:
             self.CONTEXT[key] = [] if isinstance(self.CONTEXT[key], list) else 0 if isinstance(self.CONTEXT[key], int) else None
         # Reset and end
-        CONFIG['STOP'] = True
+        DataHandler.set('__dir_format_stop__', 'STOP', True)
 
     @staticmethod
     def handle_error(error, cwd=None, file_path=None):

plugin/formatter_listener.py

@@ -25,31 +25,23 @@ def on_activated(self, view):
         if OptionHandler.query(CONFIG, False, 'layout', 'sync_scroll') and LayoutHandler.want_layout():
             sync_scroll_manager.stop_sync_scroll()
 
-            src_view = self._find_src_view_by_dst_view(view)
+            src_view = self._find_view_by_reference(view, lookup_src=False)
             if src_view:
                 sync_scroll_manager.start_sync_scroll('src', view, src_view)
             else:
-                dst_view = self._find_dst_view_by_src_view(view)
+                dst_view = self._find_view_by_reference(view, lookup_src=True)
                 if dst_view:
                     sync_scroll_manager.start_sync_scroll('dst', view, dst_view)
 
     @staticmethod
-    def _find_src_view_by_dst_view(dst_view):
-        src_view_id = dst_view.settings().get('txt_vref')
-        if src_view_id:
-            for window in sublime.windows():
-                for view in window.views():
-                    if view.id() == src_view_id:
-                        return view
-        return None
+    def _find_view_by_reference(view, lookup_src=True):
+        view_id = view.id() if lookup_src else view.settings().get('txt_vref')
 
-    @staticmethod
-    def _find_dst_view_by_src_view(src_view):
-        src_view_id = src_view.id()
-        for window in sublime.windows():
-            for view in window.views():
-                if view.settings().get('txt_vref') == src_view_id:
-                    return view
+        if view_id:
+            for window in sublime.windows():
+                for v in window.views():
+                    if (v.settings().get('txt_vref') == view_id) if lookup_src else (v.id() == view_id):
+                        return v
         return None
 
     def on_pre_close(self, view):