ikkVisualKit 0.0.0__py3-none-any.whl

ikkVisualKit/TkUiBase.py

@@ -0,0 +1,167 @@
+# TkUiBase.py
+import tkinter as tk
+import os
+from pathlib import Path
+from typing import Optional, Callable, Any
+
+
+class TkUiBase:
+    """
+    Tkは必ずメインスレッドで動かす。
+    サブクラスは _build(self, root) をオーバーライドする。
+    """
+    # ==========================================
+    def __init__(self
+        ,title: str = "Title"
+        ,size: tuple[int, int] = (600, 300)
+        ,icon_path: Optional[str] = None
+        ):
+        '''コンストラクタ
+        title: ウィンドウタイトル
+        size: ウィンドウサイズ (幅, 高さ)
+        icon_path: アイコン画像のパス（必要に応じて指定、Noneの場合はデフォルトアイコン）
+        '''
+        self._title = title
+        self._size = size
+        self._icon_path = icon_path
+        self._tkRoot: Optional[tk.Tk] = tk.Tk()
+
+        self._tkRoot.title(self._title)
+        self._tkRoot.geometry(f"{self._size[0]}x{self._size[1]}")
+        self._tkRoot.protocol("WM_DELETE_WINDOW", self._handle_close)
+        #画像をキーで管理する辞書
+        self._images: dict[str, tk.PhotoImage] = {}
+        base_dir = Path(__file__).resolve().parent
+        self._image_dir = base_dir / "image"
+
+        # 汎用画像を起動時に自動登録
+        self._register_common_images()
+
+        # UI構築
+        self._build(self._tkRoot)
+    # ==========================================
+    # サブクラス用
+    # ==========================================
+    def _build(self, root: tk.Tk):
+        """UI構築（サブクラスでオーバーライド）"""
+        # ウィンドウアイコン（.ico）
+        iconPath = self._icon_path
+        if iconPath and os.path.exists(iconPath):
+            root.iconbitmap(iconPath)
+    # ==========================================
+    # 他スレッドから安全にUI処理を投げる
+    # ==========================================
+    def invoke_ui(self, func: Callable, *args, **kwargs):
+        if not self._tkRoot:
+            return
+        self._tkRoot.after(0, lambda: func(*args, **kwargs))
+    # ==========================================
+    # 表示制御
+    # ==========================================
+    def show_window(self):
+        if not self._tkRoot:
+            return
+        self._tkRoot.deiconify()
+        self._tkRoot.lift()
+
+    def hide_window(self):
+        if not self._tkRoot:
+            return
+        self._tkRoot.withdraw()
+    # ==========================================
+    # 終了制御
+    # ==========================================
+    def close(self):
+        if self._tkRoot:
+            self._tkRoot.destroy()
+            self._tkRoot = None
+    #--------------------------------------------
+    def _handle_close(self):
+        self._on_close()
+    #--------------------------------------------
+    def _on_close(self):
+        """×ボタン動作（必要なら継承先で上書き）"""
+        self.close()
+    # ==========================================
+    # mainloop開始（必ずメインスレッドで呼ぶ）
+    # ==========================================
+    def run(self):
+        if self._tkRoot:
+            self._tkRoot.mainloop()
+            
+    #==========================================
+    # ボタン作成
+    def create_button(self,
+        text: str,      #表示する文字
+        x: int,y: int,  #位置
+        command: Optional[Callable[[], Any]] = None, #割り当てるメソッド
+        image_key: Optional[str] = None,
+        compound: str = "left",
+    ) -> Optional[tk.Button]:
+        """共通ボタン生成"""
+        if not self._tkRoot:
+            return None
+        #
+        button_kwargs: dict[str, Any] = {
+            "text": text,
+            "width": 32,
+            "height": 24,
+            "state": tk.NORMAL if command is not None else tk.DISABLED,
+        }
+
+        if command is not None:
+            button_kwargs["command"] = command
+
+        image = self.get_image(image_key) if image_key else None
+        if image is not None:
+            button_kwargs["image"] = image
+            button_kwargs["compound"] = compound
+
+        btn = tk.Button(self._tkRoot, **button_kwargs)
+        btn.place(x=x, y=y)
+        return btn
+    #UIに使う画像の登録
+    def register_image(self, key: str, filename: str) -> bool:
+        """imageフォルダ配下の画像をキーで登録する（主用途: png）"""
+        path = self._image_dir / filename
+        if not path.exists():
+            return False
+        try:
+            self._images[key] = tk.PhotoImage(file=str(path))
+            return True
+        except tk.TclError:
+            return False
+    #登録した画像を取得
+    def get_image(self, key: str) -> Optional[tk.PhotoImage]:
+        return self._images.get(key)
+    #
+    def _register_common_images(self):
+        """baseクラスで汎用利用するpngを事前登録する。"""
+        if not self._image_dir.exists():
+            return
+
+        for image_path in self._image_dir.glob("*.png"):
+            # 拡張子なしファイル名をキーとして登録（例: setting.dio.png -> setting.dio）
+            self.register_image(image_path.stem, image_path.name)
+    # アイコンリスト（icoファイルのアイコンはTkinterで直接扱えないため、ここではpngを想定）
+    @property
+    def icon_list(self) -> list[str]:
+        """imageフォルダ内のpngファイル名のリストを返す"""
+        if not self._image_dir.exists():
+            return []
+        return [p.stem for p in self._image_dir.glob("*.png")]
+#####################################################################
+#
+#####################################################################
+if __name__ == "__main__":
+    window = TkUiBase(title="テスト", size=(400, 200,), icon_path="../../icon.ico")
+    window.show_window()
+
+    # 2秒後に閉じる
+    def _close_later():
+        if window._tkRoot:
+            window._tkRoot.after(2000, window.close)
+    window.invoke_ui(_close_later)
+
+    window.run()
+    print("ウィンドウを閉じました")

ikkVisualKit/Tray/ResidentApp.py

@@ -0,0 +1,264 @@
+import sys
+import os
+import re
+import tempfile
+from pathlib import Path
+import logging
+import threading
+from typing import Protocol, Callable, Any, Optional, List, Tuple
+
+
+class SingleInstanceGuard:
+    """Keeps a single-instance lock alive for the process lifetime."""
+
+    def __init__(self, lock_handle: Any, releaser: Optional[Callable[[Any], None]] = None):
+        self._lock_handle = lock_handle
+        self._releaser = releaser
+
+    def release(self) -> None:
+        if self._lock_handle is None:
+            return
+
+        try:
+            if self._releaser:
+                self._releaser(self._lock_handle)
+        finally:
+            self._lock_handle = None
+            self._releaser = None
+
+
+def _build_lock_name(app_name: str) -> str:
+    normalized_name = re.sub(r"[^A-Za-z0-9_.-]+", "_", app_name).strip("._")
+    return normalized_name or "resident_app"
+
+
+def _release_windows_mutex(mutex_handle: Any) -> None:
+    import ctypes
+
+    ctypes.windll.kernel32.CloseHandle(mutex_handle)
+
+
+def _acquire_windows_guard(app_name: str) -> Optional[SingleInstanceGuard]:
+    import ctypes
+
+    mutex_name = f"Global\\{app_name}_Mutex"
+    mutex_handle = ctypes.windll.kernel32.CreateMutexW(None, False, mutex_name)
+    if not mutex_handle:
+        raise OSError("CreateMutexW failed")
+
+    last_error = ctypes.windll.kernel32.GetLastError()
+    ERROR_ALREADY_EXISTS = 183
+    if last_error == ERROR_ALREADY_EXISTS:
+        ctypes.windll.kernel32.CloseHandle(mutex_handle)
+        return None
+
+    return SingleInstanceGuard(mutex_handle, _release_windows_mutex)
+
+
+def _release_posix_lock(lock_data: tuple[Any, str]) -> None:
+    import fcntl
+
+    lock_file, lock_path = lock_data
+    try:
+        fcntl.flock(lock_file.fileno(), fcntl.LOCK_UN)
+    finally:
+        lock_file.close()
+        try:
+            os.unlink(lock_path)
+        except FileNotFoundError:
+            pass
+
+
+def _acquire_posix_guard(app_name: str) -> Optional[SingleInstanceGuard]:
+    import fcntl
+
+    lock_name = _build_lock_name(app_name)
+    lock_path = os.path.join(tempfile.gettempdir(), f"{lock_name}.lock")
+    lock_file = open(lock_path, "a+")
+
+    try:
+        fcntl.flock(lock_file.fileno(), fcntl.LOCK_EX | fcntl.LOCK_NB)
+    except BlockingIOError:
+        lock_file.close()
+        return None
+
+    lock_file.seek(0)
+    lock_file.truncate()
+    lock_file.write(str(os.getpid()))
+    lock_file.flush()
+
+    return SingleInstanceGuard((lock_file, lock_path), _release_posix_lock)
+
+
+def acquire_single_instance_guard(app_name: str) -> Optional[SingleInstanceGuard]:
+    """Create a process-wide single-instance guard.
+
+    Returns a guard object when this is the first instance, otherwise None.
+    """
+    if sys.platform == "win32":
+        return _acquire_windows_guard(app_name)
+    return _acquire_posix_guard(app_name)
+# ============================================================
+# アプリケーションのインターフェース定義
+# ============================================================
+class IAppLogic(Protocol):
+    def start(self) -> None: ...                            #アプリのロジック開始
+#    def show(self, icon=None, item=None) -> None: ...       #表示
+#    def hide(self, icon=None, item=None) -> None: ...       #非表示
+#    def settings(self, icon=None, item=None) -> None: ...   #設定の表示
+    def shutdown(self) -> None: ...     #アプリのシャットダウン処理
+# ============================================================
+# タスクトレイの インターフェース定義
+# ============================================================
+class ITray(Protocol):
+    def run(self) -> None: ...      #タスクトレイを開始（ブロッキング）
+    def run_detached(self) -> None: ... #タスクトレイを開始（非ブロッキング）
+    def stop(self) -> None: ...     #タスクトレイを停止
+# ============================================================
+# 常駐
+# ============================================================
+class ResidentApp:
+    """
+    常駐アプリのフレームワーク
+    """
+    # --------------------------------------------------------
+    def __init__(
+        self,
+        app_logic: IAppLogic,
+        tray_factory: Callable[..., ITray],
+        app_name: str = "常駐アプリ",
+        single_instance: bool = True,
+        icon_path: Optional[str] = None,
+        menu_items: Optional[List[Tuple[str, Callable]]] = None,
+    ):
+        '''コンストラクタ
+        :param app_logic: アプリのロジックを定義したクラスのインスタンス（IAppLogicを実装している必要がある）
+        :param tray_factory: タスクトレイ管理クラスのファクトリー関数（例：TrayApp）
+        :param app_name: アプリ名（トレイアイコンの右クリックメニューなどで使用）
+        :param single_instance: 多重起動を防止するかどうか
+        :param menu_items: 「表示名」と「コールバック関数」のタプルのリスト        
+        '''
+        self._app_logic = app_logic
+        self._tray_factory = tray_factory
+        self._app_name = app_name
+        self._single_instance = single_instance
+        self._icon_path = icon_path
+        self._tray: Optional[ITray] = None
+        self._single_instance_guard: Optional[SingleInstanceGuard] = None
+        self._menu_items: Optional[List[Tuple[str, Callable]]] = menu_items
+        self._setup_logging()
+    # --------------------------------------------------------
+    def _setup_logging(self) -> None:
+        logging.basicConfig(
+            level=logging.INFO,
+            format="%(asctime)s [%(levelname)s] %(message)s",
+        )
+        self._logger = logging.getLogger(self._app_name)
+    # --------------------------------------------------------
+    def run(self) -> None:
+        '''アプリを起動'''
+        try:
+            self._logger.info("Application starting...")
+            # 多重起動防止
+            if self._single_instance:
+                self._single_instance_guard = acquire_single_instance_guard(self._app_name)
+                if self._single_instance_guard is None:
+                    self._logger.warning("Another instance is already running.")
+                    return
+            # アプリのロジックを開始
+            self._app_logic.start()
+            # 呼び出し元から渡されたメニュー + 終了メニューを構成
+            menu_items: List[Tuple[str, Callable]] = []
+            if self._menu_items:
+                menu_items.extend(self._menu_items)
+            menu_items.append(("終了", self._exit)) # 終了は固定でメニューに追加
+            # タスクトレイを開始
+            self._tray = self._tray_factory(
+                icon_name=self._app_name,
+                on_exit=self._exit,
+                menu_items=menu_items,
+                icon_path=self._icon_path,  # アイコン画像のパス（必要に応じて指定）
+            )
+            self._tray.run()
+        except Exception as e:
+            self._logger.exception("Fatal error occurred: %s", e)
+            self._safe_shutdown()
+    # --------------------------------------------------------
+    def _exit(self, icon=None, item=None) -> None:
+        '''アプリを終了
+        :param icon: タスクトレイアイコン（pystray.Icon）※トレイの終了アクションから呼び出された場合に渡される
+        :param item: タスクトレイメニューアイテム（pystray.MenuItem）※トレイの終了アクションから呼び出された場合に渡される
+        '''
+        self._logger.info("Exit requested.")
+        self._safe_shutdown()
+        if icon:
+            icon.stop()
+
+    # --------------------------------------------------------
+    def _safe_shutdown(self) -> None:
+        '''安全にシャットダウン''' 
+        try:
+            self._app_logic.shutdown()
+            self._logger.info("Application shutdown complete.")
+        except Exception as e:
+            self._logger.exception("Error during shutdown: %s", e)
+        finally:
+            self._release_mutex()
+    # --------------------------------------------------------
+    # 多重起動防止
+    # --------------------------------------------------------
+    def _acquire_mutex(self) -> bool:
+        '''多重起動防止のためのミューテックスを取得'''
+        self._single_instance_guard = acquire_single_instance_guard(self._app_name)
+        return self._single_instance_guard is not None
+    # --------------------------------------------------------
+    def _release_mutex(self) -> None:
+        '''多重起動防止のためのミューテックスを解放'''
+        if self._single_instance_guard:
+            self._single_instance_guard.release()
+            self._single_instance_guard = None
+# ============================================================
+# 動作例
+# ============================================================
+try:
+    from .TrayMenu import TrayMenu # パッケージとして import される通常ケース
+except ImportError:
+    from TrayMenu import TrayMenu # ResidentApp.py を直接実行した場 合のフォールバック
+import time
+# アプリロジッククラスのダミー：インタフェースで基底されている関数は必須実装
+class DummyLogic(IAppLogic):
+    def start(self) -> None:
+        print("🚀アプリのロジックを開始します")
+    def show(self, icon=None, item=None):
+        print("🦊表示します")
+    def hide(self, icon=None, item=None):
+        print("🦉非表示にします")
+    def settings(self, icon=None, item=None):
+        print("設定ウインドウを表示します")
+    def shutdown(self):
+        print("🚦停止します")
+
+if __name__ == "__main__":
+    # 表示名とメソッドのペアをここで定義
+    tray_menu_items = [
+        ("表示", lambda: print("表示")),     # 例: 任意のメソッド名
+        ("一時停止", lambda: print("一時停止")), # 例
+    ]
+    
+    #常駐アプリクラスのインスタンスを作成
+    app = ResidentApp(
+        app_logic=DummyLogic(),
+        tray_factory=TrayMenu,       #タスクトレイモジュールを渡す(スレッドの中でインスタンスして起動される)
+        app_name="常駐アプリテスト",
+        single_instance=False,      #多重起動を許可
+        menu_items=tray_menu_items,
+        icon_path="../../icon.ico",             #アイコン画像のパス（必要に応じて指定、Noneの場合はデフォルトアイコン）
+    )
+    #スレッドで常駐アプリを起動
+    t = threading.Thread(target=app.run, daemon=True)
+    t.start()
+    
+    print("トレイ表示確認してください（15秒）")
+    time.sleep(15)
+    print("終了します")
+    app._exit()

ikkVisualKit/Tray/TrayMenu.py

@@ -0,0 +1,140 @@
+import threading
+from typing import Callable, List, Tuple, Optional
+
+import pystray #タスクトレイアイコン用ライブラリ
+from pystray import MenuItem as Item #トレイアイコンの右クリックメニューのアイテム用クラス
+from PIL import Image, ImageDraw
+from pathlib import Path
+from typing import Callable, Optional
+
+class TrayMenu:
+    """
+    汎用システムトレイ管理クラス
+    他アプリにそのまま流用可能
+    """
+    # ----------------------------------------------------------
+    def __init__(self,
+        icon_name: str,
+        on_exit: Callable,  
+        menu_items: List[Tuple[str, Callable]], 
+        icon_path: Optional[str] = None,
+    ):
+        '''コンストラクタ
+        :param icon_name: アイコンの名前（トレイアイコンの右クリックメニューなどで使用）
+        :param on_exit: 終了アクション関数（例：アプリの終了処理を呼び出す関数）
+        :param menu_items: 右クリックメニューのアイテム（表示名とアクション関数のタプルのリスト）
+        :param icon_path: アイコン画像のパス（省略可、見つからない場合はデフォルトアイコンを使用）
+        '''
+        self._icon_name = icon_name
+        self._on_exit: Callable = on_exit
+        self._menu_items: List[Tuple[str, Callable]] = menu_items
+        self._icon_path: Optional[str] = icon_path
+        self._tray_icon: Optional[pystray.Icon] = None
+        self._thread: Optional[threading.Thread] = None
+    # ----------------------------------------------------------
+    def run(self) -> None:
+        """タスクトレイを開始（ブロッキング）"""
+        self._create_icon()
+        self._tray_icon.run()
+    # ----------------------------------------------------------
+    def run_detached(self) -> None:
+        """タスクトレイ開始（別スレッド)"""
+        self._create_icon()
+        self._thread = threading.Thread(target=self._tray_icon.run, daemon=True)
+        self._thread.start() #タスクスタート
+    # ----------------------------------------------------------
+    def stop(self) -> None:
+        """トレイを停止"""
+        if self._tray_icon:
+            self._tray_icon.stop()
+    # ----------------------------------------------------------
+    def _create_icon(self) -> None:
+        #タスクトレイ用アイコン作成
+        image = self._load_icon_image()
+        #右クリックメニュー作成
+        menu = pystray.Menu(
+            *[  Item(name, action)
+                for name, action in self._menu_items
+            ]
+        )
+        #タスクトレイアイコン作成
+        self._tray_icon = pystray.Icon(
+            self._icon_name,    # アイコンの名前
+            image,              # アイコン画像
+            self._icon_name,    # ツールチップ
+            menu                # 右クリックメニュー
+        )
+    # ----------------------------------------------------------
+    def _load_icon_image(self) -> Image.Image:
+        default_size = (64, 64)
+
+        # 指定パスがあれば候補を順に探す（絶対/カレント/このモジュールと同じフォルダ）
+        if self._icon_path:
+            p = Path(self._icon_path)
+            candidates = [p] if p.is_absolute() else [
+                Path.cwd() / p,
+                Path(__file__).parent / p,
+                p,  # try raw as last resort (Pillow が扱える場合)
+            ]
+            for c in candidates:
+                try:
+                    if c.exists():
+                        img = Image.open(c)
+                        return self._prepare_image(img, default_size)
+                except Exception:
+                    continue
+            # 見つからなければデフォルトアイコンへフォールバック
+
+        # デフォルトアイコン（RGBA で返す）
+        image = Image.new("RGBA", default_size, (0, 0, 255, 255))
+        draw = ImageDraw.Draw(image)
+        draw.rectangle((16, 16, 48, 48), fill="white")
+        #draw.chord((32, 32, 48), 0, 180, fill="red")
+        return image
+
+    def _prepare_image(self, img: Image.Image, size: tuple) -> Image.Image:
+        """
+        Image を pystray 用サイズに変換して返す（透過パディングで中央配置）
+        """
+        img = img.convert("RGBA")
+        # サムネイル（アスペクト比維持）
+        img.thumbnail(size, Image.LANCZOS)
+        background = Image.new("RGBA", size, (0, 0, 0, 0))
+        x = (size[0] - img.width) // 2
+        y = (size[1] - img.height) // 2
+        background.paste(img, (x, y), img)
+        return background
+#####################################################################
+#テスト
+#####################################################################
+if __name__ == "__main__":
+    import time
+    loop = True
+    # 終処理の例
+    def on_exit_sample():
+        print("Exiting...")
+        global loop
+        loop = False
+        tray.stop()
+    # メニューアクションの例
+    def on_action_sample():
+        print("Hello from tray!")
+    # 右クリックメニューに登録する例（表示文字と関数のタプルのリスト）
+    menu_items = [
+        ("Say Hello", on_action_sample),
+        ("Exit", on_exit_sample)
+    ]
+    # トレイメニューの作成と起動
+    tray = TrayMenu(
+        icon_name="MyTrayApp",
+        on_exit=on_exit_sample,
+        menu_items=menu_items,
+        icon_path=None  # アイコンパスを指定（例: "icon.png"）
+    )
+    tray.run_detached()
+    #止めるまでループ
+    try:
+        while loop:
+            time.sleep(1)
+    except KeyboardInterrupt:
+        tray.stop()

ikkVisualKit/Tray/__init__.py

@@ -0,0 +1,4 @@
+from .TrayMenu import TrayMenu
+from .ResidentApp import acquire_single_instance_guard, SingleInstanceGuard
+
+__all__ = ["TrayMenu", "acquire_single_instance_guard", "SingleInstanceGuard"]