je-editor 0.0.222__py3-none-any.whl → 0.0.224__py3-none-any.whl

je_editor/pyside_ui/code/plaintext_code_edit/code_edit_plaintext.py

@@ -5,17 +5,21 @@ from typing import TYPE_CHECKING
 
 from je_editor.utils.logging.loggin_instance import jeditor_logger
 
+# 僅在型別檢查時匯入，避免循環引用
+# Only imported for type checking, avoids circular imports
 if TYPE_CHECKING:
     from je_editor.pyside_ui.main_ui.editor.editor_widget import EditorWidget
     from je_editor.pyside_ui.main_ui.editor.editor_widget_dock import FullEditorWidget
 
 from typing import Union, List
 
-import jedi
+import jedi  # Python 自動補全與靜態分析工具
 from PySide6 import QtGui
 from PySide6.QtCore import Qt, QRect
-from PySide6.QtGui import QPainter, QTextCharFormat, QTextFormat, QKeyEvent, QAction, QTextDocument, QTextCursor, \
-    QTextOption
+from PySide6.QtGui import (
+    QPainter, QTextCharFormat, QTextFormat, QKeyEvent, QAction,
+    QTextDocument, QTextCursor, QTextOption
+)
 from PySide6.QtWidgets import QPlainTextEdit, QWidget, QTextEdit, QCompleter
 from jedi.api.classes import Completion
 
@@ -25,6 +29,7 @@ from je_editor.pyside_ui.main_ui.save_settings.user_color_setting_file import ac
 
 
 def venv_check():
+    """檢查當前工作目錄下是否有 venv 資料夾 / Check if venv exists in current working directory"""
     jeditor_logger.info("code_edit_plaintext.py venv check")
     venv_path = Path(str(Path.cwd()) + "/venv")
     return venv_path
@@ -32,24 +37,36 @@ def venv_check():
 
 class CodeEditor(QPlainTextEdit):
     """
-    Extend QPlainTextEdit,
-    Add line, edit tab distance, add highlighter, add search text
+    自訂的程式碼編輯器，繼承 QPlainTextEdit
+    Custom code editor extending QPlainTextEdit
+
+    功能：
+    - 行號顯示 (Line number area)
+    - Tab 縮排距離設定
+    - Python 語法高亮 (Syntax highlighting)
+    - 搜尋功能 (Search box)
+    - 自動補全 (Autocomplete with Jedi)
     """
 
     def __init__(self, main_window: Union[EditorWidget, FullEditorWidget]):
         jeditor_logger.info(f"Init CodeEditor main_window: {main_window}")
         super().__init__()
-        # Jedi
+
+        # Jedi 環境，用於 Python 自動補全
         self.env = None
         self.check_env()
-        # Self main window (parent)
+
+        # 主視窗 (父元件)
         self.main_window = main_window
         self.current_file = main_window.current_file
 
+        # 定義哪些按鍵不會觸發補全視窗
         self.skip_popup_behavior_list = [
             Qt.Key.Key_Enter, Qt.Key.Key_Return, Qt.Key.Key_Up, Qt.Key.Key_Down,
             Qt.Key.Key_Tab, Qt.Key.Key_Backtab, Qt.Key.Key_Space, Qt.Key.Key_Backspace
         ]
+
+        # 定義哪些按鍵會觸發補全 (A-Z)
         self.need_complete_list = [
             Qt.Key.Key_A, Qt.Key.Key_B, Qt.Key.Key_C, Qt.Key.Key_D, Qt.Key.Key_E, Qt.Key.Key_F,
             Qt.Key.Key_G, Qt.Key.Key_H, Qt.Key.Key_I, Qt.Key.Key_J, Qt.Key.Key_K, Qt.Key.Key_L,
@@ -57,37 +74,50 @@ class CodeEditor(QPlainTextEdit):
             Qt.Key.Key_S, Qt.Key.Key_T, Qt.Key.Key_U, Qt.Key.Key_V, Qt.Key.Key_W, Qt.Key.Key_X,
             Qt.Key.Key_Y, Qt.Key.Key_Z
         ]
+
+        # 搜尋框 (延遲建立)
         self.search_box = None
+
+        # 行號區域 (LineNumber 是另一個自訂類別)
         self.line_number: LineNumber = LineNumber(self)
         self.blockCountChanged.connect(self.update_line_number_area_width)
         self.updateRequest.connect(self.update_line_number_area)
         self.update_line_number_area_width(0)
+
+        # 當文字改變時，重新高亮當前行
         self.textChanged.connect(self.highlight_current_line)
+
+        # 設定 Tab 寬度 (以字元寬度計算)
         self.setTabStopDistance(
             QtGui.QFontMetricsF(self.font()).horizontalAdvance("        ")
         )
+
+        # Python 語法高亮
         self.highlighter = PythonHighlighter(self.document(), main_window=self)
         self.highlight_current_line()
+
+        # 關閉自動換行，改為單行顯示
         self.setLineWrapMode(self.LineWrapMode.NoWrap)
         self.setWordWrapMode(QTextOption.WrapMode.WrapAnywhere)
-        # Search Text
+
+        # 搜尋功能 (Ctrl+F)
         self.search_action = QAction("Search")
         self.search_action.setShortcut("Ctrl+f")
-        self.search_action.triggered.connect(
-            self.start_search_dialog
-        )
-        # Add actions
+        self.search_action.triggered.connect(self.start_search_dialog)
         self.addAction(self.search_action)
-        # Complete
+
+        # 自動補全初始化
         self.completer: Union[None, QCompleter] = None
         self.set_complete([])
 
     def reset_highlighter(self):
+        """重設語法高亮 / Reset syntax highlighter"""
         jeditor_logger.info("CodeEditor reset_highlighter")
         self.highlighter = PythonHighlighter(self.document(), main_window=self)
         self.highlight_current_line()
 
     def check_env(self):
+        """檢查虛擬環境並建立 Jedi 環境 / Check venv and create Jedi environment"""
         jeditor_logger.info("CodeEditor check_env")
         path = venv_check()
         if path.exists():
@@ -95,9 +125,8 @@ class CodeEditor(QPlainTextEdit):
 
     def set_complete(self, list_to_complete: list) -> None:
         """
-        Set complete and bind.
-        :param list_to_complete: keyword list to complete.
-        :return: None
+        設定自動補全清單
+        Set completion list
         """
         jeditor_logger.info(f"CodeEditor set_complete list_to_complete: {list_to_complete}")
         completer = QCompleter(list_to_complete)
@@ -110,9 +139,8 @@ class CodeEditor(QPlainTextEdit):
 
     def insert_completion(self, completion) -> None:
         """
-        insert complete keyword to editor.
-        :param completion: completion text
-        :return: None
+        插入補全文字
+        Insert completion text into editor
         """
         jeditor_logger.info(f"CodeEditor insert_completion completion: {completion}")
         if self.completer.widget() != self:
@@ -126,13 +154,14 @@ class CodeEditor(QPlainTextEdit):
 
     @property
     def text_under_cursor(self):
+        """取得游標下的文字 / Get text under cursor"""
         jeditor_logger.info("CodeEditor text_under_cursor")
-        # Find text under cursor
         text_cursor = self.textCursor()
         text_cursor.select(QTextCursor.SelectionType.WordUnderCursor)
         return text_cursor.selectedText()
 
     def focusInEvent(self, e) -> None:
+        """當編輯器獲得焦點時，確保 completer 綁定正確"""
         jeditor_logger.info(f"CodeEditor focusInEvent event: {e}")
         if self.completer:
             self.completer.setWidget(self)
@@ -140,8 +169,8 @@ class CodeEditor(QPlainTextEdit):
 
     def complete(self) -> None:
         """
-        Keyword autocomplete
-        :return:  None
+        使用 Jedi 進行自動補全
+        Keyword autocomplete with Jedi
         """
         jeditor_logger.info("CodeEditor complete")
         prefix = self.text_under_cursor
@@ -149,15 +178,18 @@ class CodeEditor(QPlainTextEdit):
             script = jedi.Script(code=self.toPlainText(), environment=self.env)
         else:
             script = jedi.Script(code=self.toPlainText())
+
+        # 取得補全清單
         jedi_complete_list: List[Completion] = script.complete(
             self.textCursor().blockNumber() + 1,
             len(self.textCursor().document().findBlockByLineNumber(self.textCursor().blockNumber()).text())
         )
+
         if len(jedi_complete_list) > 0:
-            new_complete_list = list()
-            for complete_text in jedi_complete_list:
-                new_complete_list.append(complete_text.name)
+            new_complete_list = [complete_text.name for complete_text in jedi_complete_list]
             self.set_complete(new_complete_list)
+
+        # 顯示補全視窗
         self.completer.setCompletionPrefix(prefix)
         popup = self.completer.popup()
         cursor_rect = self.cursorRect()
@@ -166,16 +198,10 @@ class CodeEditor(QPlainTextEdit):
         self.completer.complete(cursor_rect)
 
     def start_search_dialog(self) -> None:
-        """
-        Show search box ui and bind.
-        :return: None
-        """
+        """顯示搜尋框 / Show search box"""
         jeditor_logger.info("CodeEditor start_search_dialog")
-        # Search box connect to function
         self.search_box = SearchBox()
-        self.search_box.search_back_button.clicked.connect(
-            self.find_back_text
-        )
+        self.search_box.search_back_button.clicked.connect(self.find_back_text)
         self.search_box.search_next_button.clicked.connect(
             self.find_next_text
         )
@@ -183,8 +209,8 @@ class CodeEditor(QPlainTextEdit):
 
     def find_next_text(self) -> None:
         """
-        Find next match text.
-        :return: None
+        找到下一個符合的文字
+        Find next match text
         """
         jeditor_logger.info("CodeEditor find_next_text")
         if self.search_box.isVisible():
@@ -193,8 +219,8 @@ class CodeEditor(QPlainTextEdit):
 
     def find_back_text(self) -> None:
         """
-        Find back match text.
-        :return: None
+        找到上一個符合的文字
+        Find previous match text
         """
         jeditor_logger.info("CodeEditor find_back_text")
         if self.search_box.isVisible():
@@ -202,13 +228,22 @@ class CodeEditor(QPlainTextEdit):
             self.find(text, QTextDocument.FindFlag.FindBackward)
 
     def line_number_paint(self, event) -> None:
+        """
+        繪製行號區域
+        Paint line number area
+        """
         jeditor_logger.info(f"CodeEditor line_number_paint event: {event}")
         painter = QPainter(self.line_number)
+        # 填滿背景色
         painter.fillRect(event.rect(), actually_color_dict.get("line_number_background_color"))
+
+        # 從第一個可見區塊開始
         block = self.firstVisibleBlock()
         block_number = block.blockNumber()
         top = self.blockBoundingGeometry(block).translated(self.contentOffset()).top()
         bottom = top + self.blockBoundingRect(block).height()
+
+        # 逐行繪製行號
         while block.isValid() and top <= event.rect().bottom():
             if block.isVisible() and bottom >= event.rect().top():
                 number = str(block_number + 1)
@@ -227,20 +262,27 @@ class CodeEditor(QPlainTextEdit):
             block_number += 1
 
     def line_number_width(self) -> int:
+        """
+        計算行號區域寬度
+        Calculate line number area width
+        """
         jeditor_logger.info("CodeEditor line_number_width")
-        digits = len(str(self.blockCount()))
+        digits = len(str(self.blockCount()))  # 根據總行數決定位數
         space = 12 * digits
         return space
 
     def update_line_number_area_width(self, value) -> None:
+        """
+        更新行號區域寬度
+        Update line number area width
+        """
         jeditor_logger.info(f"CodeEditor update_line_number_area_width value: {value}")
         self.setViewportMargins(self.line_number_width(), 0, 0, 0)
 
     def resizeEvent(self, event) -> None:
         """
-        Resize line number paint.
-        :param event: QT event.
-        :return: None
+        視窗大小改變時，調整行號區域
+        Resize line number paint area
         """
         jeditor_logger.info(f"CodeEditor resizeEvent event:{event}")
         QPlainTextEdit.resizeEvent(self, event)
@@ -251,10 +293,8 @@ class CodeEditor(QPlainTextEdit):
 
     def update_line_number_area(self, rect, dy) -> None:
         """
-        Set line number.
-        :param rect: line number rect.
-        :param dy: update or not.
-        :return: None
+        更新行號顯示
+        Update line number area
         """
         jeditor_logger.info(f"CodeEditor update_line_number_area rect: {rect}, dy: {dy}")
         if dy:
@@ -271,8 +311,8 @@ class CodeEditor(QPlainTextEdit):
 
     def highlight_current_line(self) -> None:
         """
-        Change current line color.
-        :return: None
+        高亮目前所在行
+        Highlight current line
         """
         jeditor_logger.info("CodeEditor highlight_current_line")
         selections = []
@@ -290,13 +330,16 @@ class CodeEditor(QPlainTextEdit):
 
     def keyPressEvent(self, event: QKeyEvent) -> None:
         """
-        Catch Soft new line (key, shift + enter)
-        :param event: keypress event
-        :return: None
+        鍵盤事件處理
+        Handle key press events
+        - Ctrl+B: 使用 Jedi 跳轉定義
+        - Shift+Enter: 忽略軟換行
+        - 其他情況觸發自動補全
         """
-        # Catch soft wrap shift + return (line nuber not working on soft warp)
         key = event.key()
         jeditor_logger.info(f"CodeEditor keyPressEvent event: {event} key: {key}")
+
+        # Ctrl + B → 跳轉到定義
         if event.modifiers() and Qt.Modifier.CTRL:
             if key == Qt.Key.Key_B:
                 if self.env is not None:
@@ -313,31 +356,45 @@ class CodeEditor(QPlainTextEdit):
                     else:
                         self.textCursor().setPosition(goto_list[0].line - 1)
                 return
+
+        # 如果補全視窗開啟，且按下不該觸發的按鍵 → 關閉補全
         if self.completer.popup().isVisible() and key in self.skip_popup_behavior_list:
             self.completer.popup().close()
             event.ignore()
             return
+
+        # Shift+Enter → 忽略 (避免軟換行影響行號)
         if event.modifiers() and Qt.Modifier.SHIFT:
             if key == Qt.Key.Key_Enter or key == Qt.Key.Key_Return:
                 event.ignore()
                 return
+
+        # 呼叫父類別處理其他按鍵
         super().keyPressEvent(event)
+
+        # 更新目前行高亮
         self.highlight_current_line()
+
+        # 如果輸入英文字母，觸發自動補全
         if key in self.need_complete_list and self.completer is not None:
             if self.completer.popup().isVisible():
                 self.completer.popup().close()
             self.complete()
 
     def mousePressEvent(self, event) -> None:
+        """
+        滑鼠點擊事件
+        Mouse press event
+        - 點擊後高亮所在行
+        """
         jeditor_logger.info(f"CodeEditor mousePressEvent event: {event}")
-        # Highlight mouse click line
         super().mousePressEvent(event)
         self.highlight_current_line()
 
-
 class LineNumber(QWidget):
     """
-    Used to paint line number.
+    行號區域元件
+    Widget used to paint line numbers
     """
 
     def __init__(self, editor):
@@ -346,5 +403,9 @@ class LineNumber(QWidget):
         self.editor = editor
 
     def paintEvent(self, event) -> None:
+        """
+        呼叫編輯器的 line_number_paint 來繪製行號
+        Delegate painting to CodeEditor.line_number_paint
+        """
         jeditor_logger.info(f"LineNumber paintEvent event: {event}")
-        self.editor.line_number_paint(event)
+        self.editor.line_number_paint(event)

je_editor/pyside_ui/code/running_process_manager.py

@@ -5,6 +5,8 @@ from typing import TYPE_CHECKING
 from je_editor.utils.logging.loggin_instance import jeditor_logger
 
 if TYPE_CHECKING:
+    # 僅在型別檢查時匯入，避免循環依賴
+    # Only imported during type checking to avoid circular imports
     from je_editor.pyside_ui.code.code_process.code_exec import ExecManager
     from je_editor.pyside_ui.code.shell_process.shell_exec import ShellManager
 
@@ -12,19 +14,35 @@ from typing import List, Union
 
 
 class RunInstanceManager(object):
+    """
+    管理程式執行與 Shell 執行的實例
+    Manager for ExecManager and ShellManager instances
+    """
 
     def __init__(self):
+        # 初始化，建立一個空的實例清單
+        # Initialize with an empty instance list
         jeditor_logger.info("Init RunInstanceManager")
         self.instance_list: List[Union[ExecManager, ShellManager]] = list()
 
     def close_all_instance(self):
+        """
+        關閉所有執行中的實例，並清理 main_window 的執行狀態
+        Close all running instances and reset main_window execution states
+        """
         jeditor_logger.info("RunInstanceManager close_all_instance")
         for manager in self.instance_list:
+            # 若子程序仍存在，則終止
+            # Terminate process if still running
             if manager.process is not None:
                 manager.process.terminate()
+            # 清理 main_window 的執行狀態
+            # Reset execution states in main_window
             manager.main_window.exec_program = None
             manager.main_window.exec_shell = None
             manager.main_window.exec_python_debugger = None
 
 
-run_instance_manager = RunInstanceManager()
+# 建立全域唯一的 RunInstanceManager 實例
+# Create a global singleton instance of RunInstanceManager
+run_instance_manager = RunInstanceManager()