PythonでTkinterを使ってDiscordのRichPresenceを使えるようにしたい

Question

前提・実現したいこと

Python初心者です。
PythonでTkinterを使用し、ボタンを押すとDiscordのRichPresenceを用いてステータスにPC情報等を表示するプログラムを作ろうと思い最初にthreadingを使わずにプログラムを書いたのですが、ボタンを押し、有効化するとフリーズして強制終了してしまします。そこでthreadingを使うとフリーズしなくなると聞いたのでthreadingを使用しプログラムを書いてみたのですが、エラーが発生してしまいます。

発生している問題・エラーメッセージ

C:\Users\ユーザー名\PycharmProjects\test\venv\Scripts\python.exe C:/Users/ユーザー名/PycharmProjects/test/python2.py
Exception in thread Thread-1:
Traceback (most recent call last):
  File "C:\Users\ユーザー名\AppData\Local\Programs\Python\Python36-32\lib\threading.py", line 916, in _bootstrap_inner
    self.run()
  File "C:\Users\ユーザー名\AppData\Local\Programs\Python\Python36-32\lib\threading.py", line 864, in run
    self._target(*self._args, **self._kwargs)
  File "C:/Users/ユーザー名/PycharmProjects/test/python2.py", line 17, in rp
    RPC = Presence(client_id, pipe=0)
  File "C:\Users\ユーザー名\PycharmProjects\test\venv\lib\site-packages\pypresence\presence.py", line 13, in __init__
    super().__init__(*args, **kwargs)
  File "C:\Users\ユーザー名\PycharmProjects\test\venv\lib\site-packages\pypresence\baseclient.py", line 37, in __init__
    self.update_event_loop(self.get_event_loop())
  File "C:\Users\ユーザー名\PycharmProjects\test\venv\lib\site-packages\pypresence\baseclient.py", line 80, in get_event_loop
    loop = asyncio.get_event_loop()
  File "C:\Users\ユーザー名\AppData\Local\Programs\Python\Python36-32\lib\asyncio\events.py", line 694, in get_event_loop
    return get_event_loop_policy().get_event_loop()
  File "C:\Users\ユーザー名\AppData\Local\Programs\Python\Python36-32\lib\asyncio\events.py", line 602, in get_event_loop% threading.current_thread().name)
RuntimeError: There is no current event loop in thread 'Thread-1'.

該当のソースコード

import psutil
from pypresence import Presence
import time
import platform
import tkinter as tk
from tkinter import messagebox as mbox
import threading

root = tk.Tk()
root.geometry("500x300")

client_id = 'クライアントID'

n = "\n"

starttime = time.time()

def rp():
    RPC = Presence(client_id, pipe=0)
    RPC.connect()
    mbox.showinfo("info", "ステータス表示を有効化しました")
    while True:
        cpu_per = round(psutil.cpu_percent(), 1)
        mem_per = round(psutil.virtual_memory().percent, 1)
        RPC.update(start=int(starttime), details="メモリ使用率: " + str(mem_per) + "%", state="CPU使用率:"+str(cpu_per))
        time.sleep(1)


def callback():
    th = threading.Thread(target=rp)
    th.start()



button1 = tk.Button(text="有効化", font=("", 30), width=15, height=5, command=callback)
button1.pack()

root.mainloop()

補足情報（FW/ツールのバージョンなど）

Windows10 64bit
Python3.6
RichPresenceの表示にはpypresenceを使用してます。

###追記
threadingからmultiprocessingに変えたところ、起動しボタンを押してrichpresenceを有効化するところまではできたのですが、そこで新しいウインドウが開きそれがフリーズしてしまいます。
最初に開いたウインドウはフリーズしていません。
https://stackoverflow.com/questions/46674498/tkinter-is-opening-multiple-gui-windows-upon-file-selection-with-multiprocessing
調べてみたところ上記のような情報が見つかり試してみたのですが、特に変わりはありませんでした。
以下変更後のソースコードです。

import psutil
from pypresence import Presence
import time
import tkinter as tk
from tkinter import messagebox as mbox
import multiprocessing


client_id = 'クライアントID'

n = "\n"

starttime = time.time()

def rp():
    RPC = Presence(client_id, pipe=0)
    RPC.connect()
    mbox.showinfo("info", "ステータス表示を有効化しました")
    while True:
        cpu_per = round(psutil.cpu_percent(), 1)
        mem_per = round(psutil.virtual_memory().percent, 1)
        RPC.update(start=int(starttime), details="メモリ使用率: " + str(mem_per) + "%", state="CPU使用率:"+str(cpu_per))
        time.sleep(1)


def callback():
    mp = multiprocessing.Process(target=rp)
    mp.start()


if __name__ == "__main__":
    root = tk.Tk()
    root.geometry("500x300")

    button1 = tk.Button(text="有効化", font=("", 30), width=15, height=5, command=callback)
    button1.pack()

    root.mainloop()

Answer 1

threadingを使わない方法になってしまいますが、
while Trueの中にウインドウを更新するroot.update()を挟めばフリーズしません。

import psutil
from pypresence import Presence
import time
import platform
import tkinter as tk
from tkinter import messagebox as mbox
import threading

root = tk.Tk()
root.geometry("500x300")

client_id = 'クライアントID'

n = "\n"

starttime = time.time()

def rp():
    RPC = Presence(client_id, pipe=0)
    RPC.connect()
    mbox.showinfo("info", "ステータス表示を有効化しました")
    while True:
        cpu_per = round(psutil.cpu_percent(), 1)
        mem_per = round(psutil.virtual_memory().percent, 1)
        RPC.update(start=int(starttime), details="メモリ使用率: " + str(mem_per) + "%", state="CPU使用率:"+str(cpu_per))
        time.sleep(1)
        root.update()

button1 = tk.Button(text="有効化", font=("", 30), width=15, height=5, command=rp)
button1.pack()

root.mainloop()

root.after()を使う方法もあります。個人的にはこっちのほうが好きです

import psutil
from pypresence import Presence
import time
import platform
import tkinter as tk
from tkinter import messagebox as mbox
import threading

root = tk.Tk()
root.geometry("500x300")

client_id = 'クライアントID'

n = "\n"

starttime = time.time()

def rp():
    cpu_per = round(psutil.cpu_percent(), 1)
    mem_per = round(psutil.virtual_memory().percent, 1)
    RPC.update(start=int(starttime), details="メモリ使用率: " + str(mem_per) + "%",state="CPU使用率:"+str(cpu_per))
    root.after(1000, rp) #1000ミリ秒後にrpを実行

def start():
    global RPC
    RPC = Presence(client_id, pipe=0)
    RPC.connect()
    mbox.showinfo("info", "ステータス表示を有効化しました")
    rp()

button1 = tk.Button(text="有効化", font=("", 30), width=15, height=5, command=start)
button1.pack()

root.mainloop()

Comments

[yuki0369]

回答ありがとうございます。
どちらを使用してもフリーズしなくなりました。
ただ後者の方は
def start():
global RPC
としないと関数rpのRPC.updateが動かなくなってしまうようです。

[dragoemon]

そうですね。失礼しました。修正しておきます。

[yuki0369]

ありがとうございます。

[teamikl]

上のコードは、while ループから抜けておらず、mainloopに処理が戻ってないので、
デバッグの際にエラーログが見にくくなるリスクがあります。(例えば、停止したい場合困ることに)
起動だけなら不要かもしれませんが、他のイベントも1秒毎にしか反応しなくなります。

after で済む場合はをそちらを使った方が良いです +1

[yuki0369]

なるほど。
参考になります。
ありがとうございます。

Answer 2

tkinterの利用をスレッドから分離したサンプルです。
有効化/無効化と、接続を保ったままの一時停止/再開を実装しました。

pypresence 利用の部分は試せなかった為、コメントに記述。
asyncio.new_event_loop()での修正を確認してから試してみてください。

拡張予定がなく、有効化のみのプログラムなら殆ど恩恵はないかもしれませんが、
スレッドを使う利点は、RPC.update の時にウィンドウが固まるリスクを下げられます。

後、訂正で「ネットワーク障害等により」と言っていた部分は、
「クライアントが応答をしない場合」が適切でした。(パイプであればネットワークは影響しない)

import tkinter as tk
from tkinter.messagebox import showinfo
import time
import itertools
from types import SimpleNamespace
from queue import Queue, Empty
from threading import Thread, Event

def rp_thread_run(queue, flag):
    # event は必須ではありませんが、ダイアログ表示中に処理を停止したい場合
    # この様にする必要があります。teek というライブラリを使うと、綺麗に書けます。
    event = Event()
    if not flag.wait_dialog.get():
        event.set() # <-- 待機しない場合、予め event.set を呼んでおく
    queue.put(("showinfo", event, "info", "start RP"))
    event.wait()  # <-- event.set が呼ばれる迄待機

    ## これは 厳密にはスレッドセーフではないが、これで充分事足りる事が多いが、
    ## スレッド内からtkinterへ頻繁に何か表示したいといった場合は、問題が顕在化することがあります。
    # showinfo("info", "start RP")
    # root.after_idle(showinfo, args=("info", "start RP"))

    print("RPC opened")
    queue.put(("status", None, "connected"))
    counter = itertools.count()
    while flag.running:
        flag.suspend.wait()
        print(next(counter))  # 動作確認用に、数値を出力
        time.sleep(1)
    print("RPC closed")
    queue.put(("status", None, "disconnected"))

    ## thread-safe でないケースの実演。以下のコードは
    ## スレッド稼働中にウィンドウを閉じるとエラーになります。
    # status.set("AAA") # RuntimeError 


def main():
    # 本来は不要なグローバル宣言しませんが、スレッド内でのテスト用。(不要になったら消してください)
    global status
    global root
    root = tk.Tk()
    queue = Queue()
    flag = SimpleNamespace(suspend=Event(), running=True, wait_dialog=tk.BooleanVar(value=True))

    def rp_thread_start(event=None):
        Thread(target=rp_thread_run, args=(queue, flag)).start()

    def rp_button_start():
        flag.running = True
        flag.suspend.set()
        button1.config(text="Stop", command=rp_button_stop)
        button2.config(state="normal")
        rp_thread_start()

    def rp_button_stop():
        flag.running = False
        flag.suspend.set()
        button1.config(text="Start", command=rp_button_start)
        button2.config(state="disable")

    def rp_button_pause():
        flag.suspend.clear()
        button2.config(text="Resume", command=rp_button_resume)

    def rp_button_resume():
        flag.suspend.set()
        button2.config(text="Pause", command=rp_button_pause)

    def on_delete_window():
        flag.running = False
        flag.suspend.set()
        root.destroy()

    # Thread-safe にする為、メインスレッド上でキューを処理
    def process_queue():
        # ※ time.sleep 等のメインループの実装を阻害するようなコードは避ける。
        try:
            item = queue.get(block=False) # <-- スレッドから送られたメッセージを受け取る
            name, event, *args = item
            if name == "showinfo":
                showinfo(*args)
                event.set()  # <-- ダイアログで待機中の状態を解除
            elif name == "status":
                status.set(args[0])
        except Empty:
            pass
        root.after(100, process_queue) # <-- 1個/100ms キューアイテムの処理速度(数値は要調整)
    process_queue()

    button1 = tk.Button(root, font=("", 30), width=15, height=5)
    button1.pack()
    button2 = tk.Button(root, font=("", 30), width=15, height=5)
    button2.pack()
    frame = tk.Frame(root)
    frame.pack(fill=tk.BOTH)
    tk.Checkbutton(frame, text="ダイアログが閉じられるのを待ってから開始", variable=flag.wait_dialog).pack(side=tk.LEFT)
    tk.Button(frame, text="Quit", command=on_delete_window).pack(fill=tk.BOTH, side=tk.RIGHT)
    status = tk.StringVar(root)
    tk.Label(root, textvar=status).pack(fill=tk.BOTH)

    rp_button_stop()
    rp_button_resume()

    root.protocol("WM_DELETE_WINDOW", on_delete_window)
    root.mainloop()


if __name__ == '__main__':
    main()

デモ内容:

• 「Start」 開始
• ダイアログが閉じてから、スレッド内のカウント開始
• 「Pause」「Resume」一時停止と再開
• 「Stop」停止時に
• 「Start」再スタート
• ダイアログが開いたまま、スレッド内のカウント開始
• 「Quit」ウィンドウを閉じた時にも RPC の close が呼ばれるのを保証。

Comments

[yuki0369]

書いて頂いたサンプルコードでpypresenceを使って書いてみたところ、正常に動作させることができました。
とても勉強になりました。
回答ありがとうございました。

Answer 3

Presenceを使ったことはありませんが、エラーログにasyncioとあったので、これでどうでしょう。

import asyncio

def rp():
    RPC = Presence(client_id, pipe=0, loop=asyncio.new_event_loop())

asynciomainスレッド以外で使う場合は、明示的にイベントループを指定する必要があり、
大抵は、loop引数を渡せる設計になっています。

• pypresence - Presence class

もしくは、スレッドではなくプロセスにすると期待通りに動作するかもしれません。

Comments

[yuki0369]

回答ありがとうございます。
asyncioでは同じエラーが出たのですが、プロセスにしたところ、GUIを開きボタンを押しrichpresenceを有効化させるところまではできました。
しかし、その後もう一つ何も書いていない別のウインドウが開き、それがフリーズしてしまいます。
最初に起動したウインドウはフリーズしていません。
調べてみたところ
https://stackoverflow.com/questions/46674498/tkinter-is-opening-multiple-gui-windows-upon-file-selection-with-multiprocessing
このような記事が見つかったため試してみたのですが、特に変わりはありませんでした。
変更後のソースコードを追記しておいたので、何か解決法をご教授いただければ幸いです。

[teamikl]

フリーズの原因は、while True と time.sleepですが、
rp()関数内でもダイアログ表示にtkinterを使ってたのですね。見落としてました。

回避する為には、showinfo をプロセス開始前に呼ぶか、
ウィンドウを消してイベントループ内でupdate() を呼ばなければいけないが
上述したデメリットがあります。(mainloopから呼ばれていないという違いはありますが)

# if __name__ == "__main__" の前に
root = tk.Tk()
root.withdraw() # ダイアログ表示時に表示されるウィンドウを消す

# while ループ内でウィンドウをフリーズさせない為に root.update()

別プロセス側でも２重にtkinterが使われてしまう為、
dragoemonさんのroot.after を使った方法の方が、
データのやり取り等が必要になった場合も、
同じスレッド内で行う方がやりやすいので、そちらをお勧めします。

懸念は、ネットワーク障害等によりRPC.update で時間が掛かった場合に、GUIが固まってしまう点
今の所は起動のみの様ですが、他に機能拡張の予定はありますか？
データやり取りが発生したりする場合は、一時的な回避策よりも、
プロセス側からtkinter を完全に分離する方が良いです。

----
discord bot のトークンみたいなのは取ってるのですけど、Presenceは使ったことなかったので
環境整備出来たら tkinter を完全に分離するサンプル書いてみます。

[yuki0369]

返信ありがとうございます。
ご教授頂いた方法を試したところ、正常に動作させることができました。
ですが当面はroot.afterを使って書こうと思います。
今のところは特に拡張する予定はないです。
サンプルの件、ありがとうございます。

[teamikl]

asyncio 対応のコード修正しました。
get_event_loop() ではなく、正しくは new_event_loop() でした。

問題のエラーは回避出来ましたが、実行環境が整ってなかったため他のエラーで断念。
クライアントとパイプで通信する仕組みだったんですね。botと勘違いしてました。

[yuki0369]

そうですね、自分が作ろうとしていたのはbotではなく自分のステータスにRichPresenceを表示するプログラムですね。
そして修正して頂いたasyncioですがスレッドを使用した状態で無事動作しました。
ありがとうございます。