chore: Tidy code

Author: bitst0rm

plugin/dir_format.py

@@ -44,9 +44,8 @@ def __enter__(self):
 
     def __exit__(self, exc_type, exc_value, exc_traceback):
         if exc_type:
-            class_name = self.__class__.__name__
-            log.error('Error occurred in %s while exiting: %s\n%s', class_name, exc_value, ''.join(traceback.format_tb(exc_traceback)))
-        return False  # return True to suppress exceptions
+            log.error('Error in %s while exiting: %s\n%s', self.__class__.__name__, exc_value, ''.join(traceback.format_tb(exc_traceback)))
+        return False
 
     def run(self):
         self.start_timer()
@@ -61,13 +60,12 @@ def run(self):
                 try:
                     cwd = self.get_current_working_directory()
                     filelist = self.get_recursive_files(cwd)
-
                     self.prepare_context(cwd, filelist)
                     self.process_files()
                 except Exception as e:
                     self.handle_error(e)
         except Exception as e:
-            log.error('Error occurred during dir formatting: %s\n%s', e, ''.join(traceback.format_tb(e.__traceback__)))
+            log.error('Error during dir formatting: %s\n%s', e, ''.join(traceback.format_tb(e.__traceback__)))
 
     @staticmethod
     def stop():
@@ -96,12 +94,9 @@ def end_timer(self):
         if START_TIME is None:
             log.warning('Timer was not started.')
             return 'N/A'
-
-        end_time = perf_counter()
-        elapsed_time = end_time - START_TIME
-        formatted_time = self.format_elapsed_time(elapsed_time)
+        elapsed_time = perf_counter() - START_TIME
         START_TIME = None
-        return '{}'.format(formatted_time)
+        return self.format_elapsed_time(elapsed_time)
 
     def get_current_working_directory(self):
         return PathHandler.get_pathinfo(view=self.view, path=self.view.file_name())['cwd']
@@ -159,35 +154,32 @@ def format_next_file(self, new_view, is_ready=False):
 
     def _on_format_completed(self, new_view, is_ready, is_success):
         self.post_dir_format(new_view, is_success)
+
         if is_ready and is_success:
             new_view.run_command('undo')  # entry_view
         elif self.CONTEXT['entry_view'] != new_view:
             new_view.set_scratch(True)
             new_view.close()
 
         if self.CONTEXT['current_index'] == self.CONTEXT['filelist_length']:
-            # Handle the last file
-            self.handle_formatting_completion()
-
-        self.open_next_file()
+            self.handle_formatting_completion()  # handle the last file
+        else:
+            self.open_next_file()
 
     def post_dir_format(self, new_view, is_success):
         new_cwd = self.get_post_format_cwd(is_success)
-        self.show_result(is_success)
+        self.update_status(is_success)
         self.save_formatted_file(new_view, new_cwd, is_success)
 
     def get_post_format_cwd(self, is_success):
         base_directory = self.CONTEXT['cwd']
         sub_directory = RECURSIVE_SUCCESS_DIRECTORY if is_success else RECURSIVE_FAILURE_DIRECTORY
         return os.path.join(base_directory, sub_directory)
 
-    def show_result(self, is_success):
-        if is_success:
-            self.CONTEXT['success_count'] += 1
-            log.status('🎉 Formatting successful. 🥳✨\n')
-        else:
-            self.CONTEXT['failure_count'] += 1
-            log.status('❌ Formatting failed. 😢💔\n')
+    def update_status(self, is_success):
+        self.CONTEXT['success_count'] += is_success
+        self.CONTEXT['failure_count'] += not is_success
+        log.status('🎉 Formatting successful. 🥳✨\n' if is_success else '❌ Formatting failed. 😢💔\n')
 
     def save_formatted_file(self, new_view, new_cwd, is_success):
         file_path = new_view.file_name()
@@ -244,8 +236,7 @@ def generate_status_text(self):
 
     def open_console_on_failure(self):
         if OptionHandler.query(CONFIG, False, 'open_console_on_failure') and self.CONTEXT['failure_count'] > 0:
-            current_view = self.get_current_view()
-            current_view.window().run_command('show_panel', {'panel': 'console', 'toggle': True})
+            self.get_current_view().window().run_command('show_panel', {'panel': 'console', 'toggle': True})
 
     def show_completion_message(self):
         ok = self.CONTEXT['success_count']
@@ -269,36 +260,31 @@ def show_completion_message(self):
         InterfaceHandler.popup_message(message, 'INFO', dialog=True)
 
     def reset_context(self):
-        for key, value in self.CONTEXT.items():
-            if isinstance(value, list):
-                self.CONTEXT[key] = []
-            elif isinstance(value, int):
-                self.CONTEXT[key] = 0
-            else:
-                self.CONTEXT[key] = None
+        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
 
     @staticmethod
     def handle_error(error, cwd=None, file_path=None):
-        log.error('Error occurred: %s\n%s', error, ''.join(traceback.format_tb(error.__traceback__)))
+        log.error('Error: %s\n%s', error, ''.join(traceback.format_tb(error.__traceback__)))
         if cwd and (error.errno != os.errno.EEXIST):
-            log.error('Could not create directory: %s', cwd)
-            InterfaceHandler.popup_message('Could not create directory: %s\nError mainly appears due to a lack of necessary permissions.' % cwd, 'ERROR')
+            log.error('Directory creation failed: %s', cwd)
+            InterfaceHandler.popup_message('Error creating directory: %s\nPermissions issue likely.' % cwd, 'ERROR')
         if file_path:
             log.error('Could not save file: %s', file_path)
-            InterfaceHandler.popup_message('Could not save file: %s\nError mainly appears due to a lack of necessary permissions.' % file_path, 'ERROR')
+            InterfaceHandler.popup_message('Error saving file: %s\nPermissions issue likely.' % file_path, 'ERROR')
 
 
 class SerialFormat:
     @staticmethod
     def run(view=None, callback=None, **kwargs):
-        is_success = False
         try:
             region = sublime.Region(0, view.size())
             uid = kwargs.get('uid', None)
             uid, syntax = SyntaxHandler.get_assigned_syntax(view=view, uid=uid, region=region, auto_format_config=None)
             exclude_syntaxes = OptionHandler.query(CONFIG, [], 'formatters', uid, 'dir_format', 'exclude_syntaxes')
+
             if TextHandler.is_chars_limit_exceeded(view):
                 callback(False)
             elif not syntax or syntax in exclude_syntaxes:
@@ -307,11 +293,8 @@ def run(view=None, callback=None, **kwargs):
                     log.warning('Syntax out of the scope. Plugin scope: %s, UID: %s, File syntax: %s, File: %s', scope, uid, syntax, view.file_name())
                 callback(False)
             else:
-                kwargs.update({
-                    'view': view,
-                    'region': region
-                })
+                kwargs.update({'view': view, 'region': region})
                 is_success = Formatter(**kwargs).run()
                 callback(is_success)
         except Exception as e:
-            log.error('Error occurred: %s\n%s', e, ''.join(traceback.format_tb(e.__traceback__)))
+            log.error('Error in SerialFormat: %s\n%s', e, ''.join(traceback.format_tb(e.__traceback__)))

plugin/file_format.py

@@ -27,11 +27,9 @@ def __enter__(self):
 
     def __exit__(self, exc_type, exc_value, exc_traceback):
         self.cleanup_temp_dir()
-
         if exc_type:
-            class_name = self.__class__.__name__
-            log.error('Error occurred in %s while exiting: %s\n%s', class_name, exc_value, ''.join(traceback.format_tb(exc_traceback)))
-        return False  # return True to suppress exceptions
+            log.error('Error in %s while exiting: %s\n%s', self.__class__.__name__, exc_value, ''.join(traceback.format_tb(exc_traceback)))
+        return False
 
     def run(self):
         if TextHandler.is_chars_limit_exceeded(self.view):
@@ -46,18 +44,20 @@ def run(self):
                 for region in (self.view.sel() if self.has_selection() else [sublime.Region(0, self.view.size())]):
                     self.kwargs.update(region=region)
                     is_success = Formatter(**self.kwargs).run()
+
                     if self.is_no_operation(is_success):
                         continue
+
                     self.cycles.append(is_success)
-                    self.print_status(is_success)
+                    self.update_status(is_success)
 
                 if any(self.cycles):
                     self.close_console_on_success()
                     self.handle_successful_formatting()
                 else:
                     self.open_console_on_failure()
         except Exception as e:
-            log.error('Error occurred during file formatting: %s\n%s', e, ''.join(traceback.format_tb(e.__traceback__)))
+            log.error('Error during file formatting: %s\n%s', e, ''.join(traceback.format_tb(e.__traceback__)))
 
     def is_no_operation(self, is_success):
         if is_success is None:
@@ -75,13 +75,10 @@ def create_graphic_temp_dir(self):
     def has_selection(self):
         return any(not sel.empty() for sel in self.view.sel())
 
-    def print_status(self, is_success):
-        if is_success:
-            self.success += 1
-            log.status('🎉 Formatting successful. 🥳✨\n')
-        else:
-            self.failure += 1
-            log.status('❌ Formatting failed. 😢💔\n')
+    def update_status(self, is_success):
+        self.success += is_success
+        self.failure += not is_success
+        log.status('🎉 Formatting successful. 🥳✨\n' if is_success else '❌ Formatting failed. 😢💔\n')
 
         if OptionHandler.query(CONFIG, True, 'show_statusbar'):
             self.set_status_bar_text()
@@ -141,25 +138,23 @@ def create_or_reuse_view(self):
         if dst_view:
             dst_view.window().focus_view(dst_view)
             dst_view.set_read_only(False)
-            self.set_graphic_phantom(dst_view)
         else:
             src_window.focus_group(1)
             dst_view = src_window.new_file(flags=sublime.TRANSIENT, syntax=self.view.settings().get('syntax', None))
             dst_view.run_command('append', {'characters': ''})  # magic to assign a tab
             dst_view.settings().set('gfx_vref', gfx_vref)
-            self.set_graphic_phantom(dst_view)
             dst_view.set_scratch(True)
             if path:
                 dst_view.retarget(path)
 
+        self.set_graphic_phantom(dst_view)
         dst_view.set_read_only(True)
 
     def get_extended_data(self):
         uid = self.kwargs.get('uid', None)
 
-        if ConfigHandler.is_quick_options_mode():
-            if uid not in OptionHandler.query(CONFIG, [], 'quick_options', 'render_extended'):
-                return {}
+        if ConfigHandler.is_quick_options_mode() and uid not in OptionHandler.query(CONFIG, [], 'quick_options', 'render_extended'):
+            return {}
 
         try:
             extended_data = {}
@@ -171,7 +166,6 @@ def get_extended_data(self):
                 if os.path.exists(image_path):
                     with open(image_path, 'rb') as image_file:
                         extended_data[ext] = base64.b64encode(image_file.read()).decode('utf-8')
-
             return extended_data
         except Exception:
             return {}
@@ -181,9 +175,9 @@ def set_graphic_phantom(self, dst_view):
             image_path = os.path.join(self.temp_dir.name, GFX_OUT_NAME + '.png')
             with open(image_path, 'rb') as image_file:
                 data = image_file.read()
-                image_width, image_height = PhantomHandler.get_image_size(data)
-                image_data = base64.b64encode(data).decode('utf-8')
 
+            image_width, image_height = PhantomHandler.get_image_size(data)
+            image_data = base64.b64encode(data).decode('utf-8')
             fit_image_width, fit_image_height = PhantomHandler.image_scale_fit(dst_view, image_width, image_height)
             extended_data = self.get_extended_data()
 
@@ -215,23 +209,15 @@ def on_navigate(href, data, dst_view):
                 decoded_data = base64.b64decode(base64_data)
                 with open(save_path, 'wb') as f:
                     f.write(decoded_data)
-
-                InterfaceHandler.popup_message('Image successfully saved to:\n%s' % save_path, 'INFO', dialog=True)
+                InterfaceHandler.popup_message('Image saved to:\n%s' % save_path, 'INFO', dialog=True)
             except Exception as e:
                 InterfaceHandler.popup_message('Could not save file:\n%s\nError: %s' % (save_path, e), 'ERROR')
 
     @staticmethod
     def get_layout_and_suffix(uid, mode):
         if mode == 'qo':
-            return (
-                OptionHandler.query(CONFIG, False, 'quick_options', 'layout'),
-                OptionHandler.query(CONFIG, False, 'quick_options', 'new_file_on_format')
-            )
-        else:
-            return (
-                OptionHandler.query(CONFIG, False, 'layout', 'enable'),
-                OptionHandler.query(CONFIG, False, 'formatters', uid, 'new_file_on_format')
-            )
+            return OptionHandler.query(CONFIG, False, 'quick_options', 'layout'), OptionHandler.query(CONFIG, False, 'quick_options', 'new_file_on_format')
+        return OptionHandler.query(CONFIG, False, 'layout', 'enable'), OptionHandler.query(CONFIG, False, 'formatters', uid, 'new_file_on_format')
 
     def undo_history(self):
         for _ in range(min(500, self.cycles.count(True))):

plugin/formatter_listener.py

@@ -28,18 +28,15 @@ def start_sync_scroll(self, target_type, active_view, target_view):
         with self.lock:
             if not self.running:
                 self.running = True
-                self.thread = threading.Thread(
-                    target=self.sync_scroll, args=(target_type, active_view, target_view)
-                )
+                self.thread = threading.Thread(target=self.sync_scroll, args=(target_type, active_view, target_view))
                 self.thread.start()
 
     def stop_sync_scroll(self):
         with self.lock:
             self.running = False
             if self.thread and self.thread.is_alive():
                 self.thread.join(timeout=0.4)
-                if self.thread.is_alive():
-                    self.thread = None
+            self.thread = None
 
     def sync_scroll(self, target_type, active_view, target_view):
         try:
@@ -71,8 +68,7 @@ def apply_formatting(cls, view=None, action=None):
     @classmethod
     def _on_auto_format(cls, view=None, file_path=None, actkey=None):
         get_auto_format_args = DotFileHandler.get_auto_format_args(view=view, active_file_path=file_path)
-        x = get_auto_format_args['auto_format_config']
-        config = x.get('config', {})
+        config = get_auto_format_args['auto_format_config'].get('config', {})
         if config and not cls._should_skip(config.get(actkey, False)):
             config.update({AUTO_FORMAT_ACTION_KEY: actkey})
             CleanupHandler.clear_console()
@@ -83,7 +79,7 @@ def _on_auto_format(cls, view=None, file_path=None, actkey=None):
                     file_format.run()
                 return True
             except Exception as e:
-                log.error('Error occurred while auto formatting: %s', e)
+                log.error('Error during auto formatting: %s', e)
 
         return False
 
@@ -94,12 +90,12 @@ def _on_paste_or_save(cls, view=None, actkey=None):
 
         unique = OptionHandler.query(CONFIG, {}, 'format_on_priority') or OptionHandler.query(CONFIG, {}, 'format_on_unique')
         if unique and isinstance(unique, dict) and unique.get('enable', False):
-            cls._on_paste_or_save__unique(view=view, unique=unique, actkey=actkey)
+            cls._handle_unique_format(view=view, unique=unique, actkey=actkey)
         else:
-            cls._on_paste_or_save__regular(view=view, actkey=actkey)
+            cls._handle_regular_format(view=view, actkey=actkey)
 
     @classmethod
-    def _on_paste_or_save__unique(cls, view=None, unique=None, actkey=None):
+    def _handle_unique_format(cls, view=None, unique=None, actkey=None):
         def are_unique_values(unique=None):
             flat_values = [value for key, values_list in unique.items() if key != 'enable' for value in values_list]
             return (len(flat_values) == len(set(flat_values)))
@@ -124,14 +120,14 @@ def are_unique_values(unique=None):
                             with FileFormat(view=view, uid=uid, type=value.get('type', None)) as file_format:
                                 file_format.run()
                         except Exception as e:
-                            log.error('Error occurred while priority formatting: %s', e)
+                            log.error('Error during priority formatting: %s', e)
                         finally:
                             break
         else:
             InterfaceHandler.popup_message('There are duplicate syntaxes in your "format_on_priority" option. Please sort them out.', 'ERROR')
 
     @classmethod
-    def _on_paste_or_save__regular(cls, view=None, actkey=None):
+    def _handle_regular_format(cls, view=None, actkey=None):
         seen = set()
         formatters = OptionHandler.query(CONFIG, {}, 'formatters')
 
@@ -148,7 +144,7 @@ def _on_paste_or_save__regular(cls, view=None, actkey=None):
                         with FileFormat(view=view, uid=uid, type=value.get('type', None)) as file_format:
                             file_format.run()
                     except Exception as e:
-                        log.error('Error occurred while regular formatting: %s', e)
+                        log.error('Error during regular formatting: %s', e)
                     finally:
                         seen.add(syntax)
 
@@ -242,7 +238,7 @@ def on_load(self, view):
                 with DirFormat(view=view) as dir_format:
                     dir_format.format_next_file(view, is_ready=False)
             except Exception as e:
-                log.error('Error occurred while dir formatting: %s', e)
+                log.error('Error during dir formatting: %s', e)
 
         file_path = view.file_name()
         if file_path and file_path.endswith(PACKAGE_NAME + '.sublime-settings'):