refactor: renamed folder gui to context_menus

Author: Amir Ali

build/context_menus/context_menu_commands.py

@@ -0,0 +1,156 @@
+from tkinter import filedialog
+from tkinter.simpledialog import askstring
+
+from utils import *
+from tkinter import Event, TclError
+
+class PatternsMenuCommands:
+    def __init__(self, patterns_list, window):
+        self.patterns_list = patterns_list
+        self.window = window
+
+    @staticmethod
+    def get_pattern() -> str:
+        return askstring(title=APP_TITLE,prompt='Enter the pattern:')
+
+    def add_pattern(self, event : Event=None) -> None:
+        new_pattern = self.get_pattern()
+        self.patterns_list.insert('end',new_pattern)
+
+    def insert_pattern(self, event : Event=None) -> None:
+        selected = self.patterns_list.curselection()
+        if len(selected) == 1:
+            new_pattern = self.get_pattern()
+            self.patterns_list.insert(selected[0],new_pattern)
+
+    def swap_up(self, selected_index : int):
+        next_index = selected_index - 1
+
+        next_item = self.patterns_list.get(selected_index)
+        self.patterns_list.insert(next_index, next_item)
+        self.patterns_list.delete(selected_index + 1)
+
+    def move_selected(self, event : Event = None , up = True):
+        selected_index = self.patterns_list.curselection()[0]
+
+        if up:
+            self.swap_up(selected_index)
+            self.patterns_list.selection_set(selected_index - 1)
+
+        else:
+            self.swap_up(selected_index + 1)
+
+    def edit_selected(self, event : Event=None) -> None:
+        index = self.patterns_list.curselection()
+        if len(index) == 1:
+            value = self.patterns_list.get(index)
+            new_value = askstring(title=APP_TITLE, prompt='Enter the pattern: ', initialvalue=value)
+            if new_value:
+                self.patterns_list.delete(index)
+                self.patterns_list.insert(index, new_value)
+
+    def delete_selected(self, event : Event=None) -> None:
+        selected = self.patterns_list.curselection()
+        if selected:
+            self.patterns_list.delete(selected[0],selected[-1])
+
+    def delete_all(self, event : Event=None) -> None:
+        self.patterns_list.delete(0,'end')
+
+    def copy_pattern(self, event : Event=None, all : bool=False) -> None:
+        self.window.clipboard_clear()
+        if all:
+            self.window.clipboard_append('\n'.join(self.patterns_list.get(0,'end')))
+        else:
+            selected = self.patterns_list.curselection()
+            if selected:
+                self.window.clipboard_append('\n'.join(self.patterns_list.get(selected[0],selected[-1])))
+
+    def import_from_file(self, event : Event=None) -> None:
+        try:
+            file_path = filedialog.askopenfilename(title='Import')
+            if file_path:
+                with open(file_path, encoding=ENCODING) as f:
+                    for i in f.read().strip().splitlines():
+                        self.patterns_list.insert('end', i)
+        except UnicodeDecodeError:
+            show_error('The patterns file cannot be a binary file')
+
+    def export_to_file(self, event : Event=None) -> None:
+        try:
+            file_path = filedialog.asksaveasfilename(title='Export')
+            if file_path:
+                with open(file_path, 'w',encoding=ENCODING) as f:
+                    for i in self.patterns_list.get(0,'end'):
+                        f.write(i + '\n')
+        except Exception as err:
+            show_error(err)
+
+class LogMenuCommands:
+    def __init__(self, log_menu, window, log_text):
+        self.log_menu = log_menu
+        self.log_text = log_text
+        self.window = window
+
+    def toggle_log(self) -> None:
+        WithLogging.with_logging = not WithLogging.with_logging
+
+        mode = self.log_menu.entrycget(3,'label')
+
+        if mode == LOG_MODE[0]:
+            self.log_menu.entryconfig(3,label = LOG_MODE[1])
+        else:
+            self.log_menu.entryconfig(3,label = LOG_MODE[0])
+
+    def copy_log(self, event : Event=None) -> None:
+        self.window.clipboard_clear()
+        try:
+            data = self.log_text.selection_get()
+        except TclError:
+            data = self.log_text.get('1.0','end')
+        self.window.clipboard_append(data)
+
+    def clear_log(self, event : Event=None) -> None:
+        self.log_text.config(state='normal')
+        self.log_text.delete('1.0','end')
+        self.log_text.insert('end',LOG_DEFAULT)
+        self.log_text.config(state='disabled')
+
+class CSVExcelSwitchFunctions:
+
+    def __init__(self, exact_var, exact_cb, exact_cb_substitute_lbl, sheet_name_lbl, sheet_name_entry, col_var, excel_var):
+        self.exact_var = exact_var
+        self.exact_cb = exact_cb
+        self.exact_cb_substitute_lbl = exact_cb_substitute_lbl
+        self.sheet_name_lbl = sheet_name_lbl
+        self.sheet_name_entry = sheet_name_entry
+        self.col_var = col_var
+        self.excel_var = excel_var
+
+        self.exact_var_value = None
+
+    def hide_exact_order_cb(self) -> None:
+            self.exact_cb.grid_remove()
+            self.exact_var_value = self.exact_var.get()
+            self.exact_var.set(False)
+            self.exact_cb_substitute_lbl.grid(**EXACT_CB_GRID_ARGS)
+
+    def show_exact_order_cb(self) -> None:
+        if self.excel_var.get():
+            self.exact_cb_substitute_lbl.grid_remove()
+            self.exact_var.set(self.exact_var_value)
+            self.exact_cb.grid()
+
+    def hide_only_excel_required_widgets(self) -> None: # sheet_name_entry, sheet_name_lbl, exact_cb
+        if self.exact_cb.winfo_ismapped():
+            self.hide_exact_order_cb()
+
+        self.sheet_name_lbl.grid_remove()
+        self.sheet_name_entry.grid_remove()
+
+    def show_only_excel_required_widgets(self) -> None:
+        if self.col_var.get():
+            self.show_exact_order_cb()
+
+        self.sheet_name_lbl.grid()
+        self.sheet_name_entry.grid()

build/context_menus/context_menu_creators.py

@@ -0,0 +1,82 @@
+from tkinter.ttk import Entry
+from tkinter import Menu
+from utils import *
+from context_menus.context_menu_commands import *
+
+class CommandsObjects:
+    log_menu_commands = None
+    patterns_menu_commands = None
+    csv_excel_switch_functions = None
+
+def create_commands_objects(log_menu,log_text , window, patterns_list, exact_var,
+                            exact_cb, exact_cb_substitute_lbl, sheet_name_lbl,
+                            sheet_name_entry, col_var, excel_var):
+
+    CommandsObjects.csv_excel_switch_functions = CSVExcelSwitchFunctions(exact_var, exact_cb, exact_cb_substitute_lbl,
+                                                        sheet_name_lbl, sheet_name_entry, col_var, excel_var)
+    CommandsObjects.log_menu_commands = LogMenuCommands(log_menu, window, log_text)
+    CommandsObjects.patterns_menu_commands = PatternsMenuCommands(patterns_list, window)
+
+def browse_files(widget : Entry, is_input_file_entry : bool) -> None:
+    TITLE = 'Browse'
+
+    if is_input_file_entry:
+        file_path = filedialog.askopenfilename(title=TITLE)
+    else:
+        file_path = filedialog.askopenfilename(title=TITLE,filetypes=FILE_TYPES)
+
+    if file_path:
+        widget.delete(0,'end')
+        widget.insert('end',file_path)
+
+class MenuCreators:
+
+    @staticmethod
+    def create_patterns_menu() -> Menu:
+        menu = Menu(tearoff=False,**MENU_COLOR_ARGS)
+        # The numbers below the following lines are indices of context menu commands
+        # which are used in context_menu_displayers.py module given to entryconfig method
+        menu.add_command(label='Add Pattern', command=CommandsObjects.patterns_menu_commands.add_pattern,accelerator='Ctrl+Shift+A') # 0
+        menu.add_command(label='Insert Pattern',command=CommandsObjects.patterns_menu_commands.insert_pattern,accelerator='Ctrl+I') # 1
+        menu.add_separator() # 2
+        menu.add_command(label='Move Up', command = CommandsObjects.patterns_menu_commands.move_selected) # 3
+        menu.add_command(label='Move Down', command = lambda : CommandsObjects.patterns_menu_commands.move_selected(up = False)) # 4
+        menu.add_separator() # 5
+        menu.add_command(label='Edit selected', command=CommandsObjects.patterns_menu_commands.edit_selected,accelerator='F2') # 6
+        menu.add_command(label='Delete selected', command=CommandsObjects.patterns_menu_commands.delete_selected,accelerator='Delete') # 7
+        menu.add_command(label='Copy selected', command=CommandsObjects.patterns_menu_commands.copy_pattern,accelerator='Ctrl+C') # 8
+        menu.add_command(label='Delete All', command=CommandsObjects.patterns_menu_commands.delete_all,accelerator='Ctrl+Shift+D') # 9
+        menu.add_command(label='Copy All', command=lambda : CommandsObjects.patterns_menu_commands.copy_pattern(all=True),accelerator='Ctrl+Shift+C') # 10
+        menu.add_separator() # 11
+        menu.add_command(label='Import from file', command=CommandsObjects.patterns_menu_commands.import_from_file,accelerator='Ctrl+Shift+I') # 12
+        menu.add_command(label='Export to file', command=CommandsObjects.patterns_menu_commands.export_to_file,accelerator='Ctrl+E') # 13
+        return menu
+
+    @staticmethod
+    def create_log_menu() -> Menu:
+        menu = Menu(tearoff=False,**MENU_COLOR_ARGS)
+        menu.add_command(label='Copy log',command=CommandsObjects.log_menu_commands.copy_log,accelerator='Ctrl+C') # 0
+        menu.add_command(label='Clear log',command=CommandsObjects.log_menu_commands.clear_log,accelerator='Ctrl+D') # 1
+        menu.add_separator() # 2
+        menu.add_command(label=LOG_MODE[0],command=CommandsObjects.log_menu_commands.toggle_log) # 3
+        return menu
+
+    @staticmethod
+    def create_entry_menu(widget : Entry, excel_var, is_file_entry : bool=True,is_output_file_entry : bool=True) -> Menu:
+        menu = Menu(tearoff=False,**MENU_COLOR_ARGS)
+        menu.add_command(label='Select All', accelerator='Ctrl+A',command=lambda : widget.select_range(0,'end')) # 0
+        menu.add_command(label='Copy', accelerator='Ctrl+C',command=lambda : widget.event_generate('<<Copy>>')) # 1
+        menu.add_command(label='Paste', accelerator='Ctrl+V',command=lambda : widget.event_generate('<<Paste>>')) # 2
+        menu.add_command(label='Cut', accelerator='Ctrl+X',command=lambda : widget.event_generate('<<Cut>>')) # 3
+        menu.add_separator() # 4
+        menu.add_command(label='Clear',accelerator='Ctrl+Shift+C',command=lambda : widget.delete(0,'end')) # 5
+        if is_file_entry:
+            menu.add_command(label='Browse',command=lambda : browse_files(widget, not is_output_file_entry),accelerator='Ctrl+B') # 6
+            if is_output_file_entry:
+                menu.add_separator() # 7
+                menu.add_radiobutton(label='Excel',variable=excel_var,value=True,
+                                     command=CommandsObjects.csv_excel_switch_functions.show_only_excel_required_widgets) # 8
+
+                menu.add_radiobutton(label='CSV',variable=excel_var,value=False,
+                                     command=CommandsObjects.csv_excel_switch_functions.hide_only_excel_required_widgets) # 9
+        return menu

build/context_menus/context_menu_displayers.py

@@ -0,0 +1,106 @@
+from tkinter import Menu, Event
+from os import name
+
+def nt_get_label(self):
+    if self.log_text.tag_ranges('sel'):
+        return 'Copy selected'
+    else:
+        return 'Copy log'
+
+def posix_get_label(self):
+    return 'Copy log'
+
+
+class ContextMenuDisplayers:
+
+    def __init__(self,log_text, log_menu, patterns_menu, patterns_list, window,
+                 sheet_name_entry,input_file_entry, output_file_entry,
+                 sheet_name_menu, input_file_menu, output_file_menu):
+
+        self.log_text = log_text
+        self.log_menu = log_menu
+        self.patterns_menu = patterns_menu
+        self.patterns_list = patterns_list
+        self.window = window
+
+        self.sheet_name_entry = sheet_name_entry
+        self.input_file_entry = input_file_entry
+        self.output_file_entry = output_file_entry
+
+        self.sheet_name_menu = sheet_name_menu
+        self.input_file_menu = input_file_menu
+        self.output_file_menu = output_file_menu
+
+        if name == 'posix':
+            self.get_label = posix_get_label
+        else:
+            self.get_label = nt_get_label
+
+    def show_log_menu(self ,event : Event, app : bool = False) -> None:
+        text = self.get_label(self)
+
+        self.log_menu.entryconfig(0,label=text)
+
+        if app:
+            self.log_menu.tk_popup(self.log_text.winfo_rootx()+100, self.log_text.winfo_rooty()+100)
+        else:
+            self.log_menu.tk_popup(event.x_root,event.y_root)
+
+    def disable_moveup_movedown(self):
+        for i in (3,4):
+            self.patterns_menu.entryconfig(i, state='disabled')
+
+    def show_patterns_menu(self ,event : Event, app : bool=False) -> None:
+        selected = self.patterns_list.curselection()
+        if selected:
+            if len(selected) > 1:
+                for i in (1,6):
+                    self.patterns_menu.entryconfig(i,state='disabled')
+
+                for i in (7,8):
+                    self.patterns_menu.entryconfig(i,state='active')
+
+                self.disable_moveup_movedown()
+
+            else:
+                self.patterns_menu.entryconfig(1,state='active')
+
+                for i in (6,7,8):
+                    self.patterns_menu.entryconfig(i,state='active')
+
+                for i in (3,4):
+                    self.patterns_menu.entryconfig(i, state='active')
+        else:
+            self.patterns_menu.entryconfig(1,state='disabled')
+
+            for i in (6,7,8):
+                self.patterns_menu.entryconfig(i,state='disabled')
+
+            self.disable_moveup_movedown()
+
+        if app:
+            self.patterns_menu.tk_popup(self.patterns_list.winfo_rootx()+100, self.patterns_list.winfo_rooty()+100)
+        else:
+            self.patterns_menu.tk_popup(event.x_root, event.y_root)
+
+    def show_entry_menu(self, menu : Menu, event : Event, app : bool=False) -> None:
+        if self.window.focus_get() == event.widget:
+            for i in range(4):
+                menu.entryconfig(i,state='active')
+        else:
+            for i in range(4):
+                menu.entryconfig(i,state='disabled')
+        if app:
+            if event.widget == self.sheet_name_entry:
+                menu.tk_popup(event.widget.winfo_rootx()+50,event.widget.winfo_rooty()+25)
+            else:
+                menu.tk_popup(event.widget.winfo_rootx()+100,event.widget.winfo_rooty()+25)
+        else:
+            menu.tk_popup(event.x_root,event.y_root)
+
+    def set_keysym(self, menu_keysym):
+        self.input_file_entry.bind(menu_keysym,lambda event : self.show_entry_menu(self.input_file_menu,event,True))
+        self.output_file_entry.bind(menu_keysym,lambda event : self.show_entry_menu(self.output_file_menu,event,True))
+        self.sheet_name_entry.bind(menu_keysym,lambda event : self.show_entry_menu(self.sheet_name_menu,event,True))
+        self.log_text.bind(menu_keysym,lambda event : self.show_log_menu(event,True))
+        self.patterns_list.bind(menu_keysym, lambda event : self.show_patterns_menu(event, True))