【Python】タスクトレイにアプリを常駐させる：pystrayで定期的に実行

pystrayとは

pystrayとはPythonで作成したアプリケーションをタスクトレイに常駐させることができるモジュールです。

タスクトレイとは画面右下にあるバックグラウンドで動作しているソフトを表示する領域です。

各アプリのアイコンが表示され、アイコンをクリックして表示したメニューから動作を選択できます。

tkinterで作成するGUIアプリケーションとpystrayを組み合わせることで、様々なことに応用できる柔軟なGUIアプリが作成できます。tkinterについて詳しくは以下記事をご参照ください。

【Python】tkinterを使ったGUIアプリケーションの作成方法

インストール

pystrayは標準でインストールされていないため、pipコマンドでインストールしましょう。

pip install pystray

現在（2022年5月）ではpystray-0.19.3がインストールされます。最新情報は以下PyPIをご確認ください。

PyPI - pystray

タスクトレイに表示するアイコン作成

タスクトレイに常駐させるアプリの作成にはpystray.Icon()メソッドを使用します。

引数のiconにはPILで開いた画像やPILで作成した画像を指定します。以下にpystrayのサンプルコードを記します。

from pystray import Icon, Menu, MenuItem
from PIL import Image
image = Image.open('E.ico')
icon = Icon(name='test', icon=image, title='pystray App')
icon.run()

pystrayで作成したアプリはrun()メソッドで走らせます。上記コードを実行させると次図のようにアイコンがタスクトレイに表示されます。

メニューの作成

タスクトレイに常駐させたアイコンが右クリックされたときにポップアップ表示されるメニューはpystray.Menu()とpython.MenuItem()で設定します。

以下にメニューを追加したサンプルコードを記します。

from pystray import Icon, Menu, MenuItem
from PIL import Image
def quit_app():
    icon.stop()
def run_app():
    pass
image = Image.open('E.ico')
menu = Menu(MenuItem('Quit', quit_app), MenuItem('Run', run_app))
icon = Icon(name='test', icon=image, title='pystray App', menu=menu)
icon.run()

上記コードからわかるように、Menu()の引数に表示するメニューアイテムを指定します。そして各メニューアイテムはMenuItem()で作成します。MenuItem()の第一引数には表示するテキスト、第二引数にクリックされたときに実行する関数を指定します。

またアプリを停止させるにはstop()メソッドを使用します。