Возможно ли запустить функцию в одном потоке и заставить Tkinter Progressbar двигаться в другом потоке mainloop, пока эта функция выполняется?

Question

[ArtiomK]

У меня есть функция, которая читает файл, затем обрабатывает данные и пишет их в другой файл, я хочу, чтобы Tkinter.ttk progressbar "бегала" пока идет выполнение этой функции. Вместо ожидаемого результата я получаю, что пользовательский интерфейс зависает пока не выполнится функция в другой thread, после того, как функция завершается пользовательский интерфейс отвисает и progressbar начинает бежать. Возможно это сделать в Tkinter, наткнулся на информацию, что он не умеет работать с multithreading

Небольшой кусок кода:

# Ранее я нажал кнопку на запуск функции
self.prbar.start(10)  # progressbar должен начать работать
x = threading.Thread(target=do_work, args=(filename, text)) # запускаю в другом потоке функцию
x.start() # start thread
x.join() # функция завершена
# А вот теперь progressbar только начинает свой бег
messagebox.showinfo("Info", message="Work is done")

Answer 1

[Сергей Горностаев]

События графического интерфейса обрабатываются бесконечным циклом, который запускается, когда вы вызываете root.mainloop() Его нельзя останавливать, иначе приложение зависнет. А блокирующий вызов x.join() как раз это и делает.

Правильный способ - это обмен событиями между потоками и передача данных через очередь:

from functools import partial
import threading
import time
import tkinter as tk
from tkinter.ttk import Progressbar
import queue


def worker(q, r):
    for i in range(100):
        # Передаём в очередь текущее значение
        q.put(i + 1)
        # Генерируем событие
        r.event_generate('<<Updated>>', when='tail')
        # Спим для наглядности
        time.sleep(0.1)


def on_update(event, q=None, pb=None):
    # Получаем данные из очереди
    pb['value'] = q.get()


# Создаём очередь для обмена данными между поткоами
q = queue.Queue()

# Создаём окно
root = tk.Tk()
progressbar = Progressbar(root, orient=tk.HORIZONTAL, length=100, mode='determinate') 
progressbar.pack() 

# "Передаём" в обработчик ссылки на очередь и progressbar
handler = partial(on_update, q=q, pb=progressbar)

# Регистрируем обработчик для события обновления progressbar'а
root.bind('<<Updated>>', handler)

# Создаём поток и передаём в него ссылки на очередь и окно
t = threading.Thread(target=worker, args=(q, root))
t.start()

root.mainloop()

Comments

[tsarevfs]

UPD: Этот комент не верен. Синхронизация на основе эвентов позволит сделать все правильно.
Тут есть проблема, что on_update ждет пока воркер проснется и сделает порцию работы. Это можно решить проверкой на пустоту с return.
Теоритически, если воркер работает слишком быстро а on_update вызыватся не слишком часто прогрессбар будет отставать.

def on_update(event, q=None, pb=None):
    while not q.empty():
        pb['value'] = q.get()

[Сергей Горностаев]

tsarevfs, нет тут проблемы. Обработчики событий должны завершаться с максимально возможностью скоростью. Их нельзя блокировать.

[tsarevfs]

Сергей Горностаев, ну я о том и говорю.

Queue.get(block=True, timeout=None)
Remove and return an item from the queue. If optional args block is true and timeout is None (the default), block if necessary until an item is available.

без дополнительных проверок будет блокировка.

[Сергей Горностаев]

tsarevfs, on_update будет вызван только при получении события, а событие вызывается только после того, как в очередь что-то добавлено.

[tsarevfs]

Сергей Горностаев, Да увидел, вы правы.

[Сергей Горностаев]

tsarevfs, отдельный плюс событий в том, что они синхронизированы и обработчик всегда выполняется в том же потоке, в котором окно создано.

[ArtiomK]

Сергей Горностаев, tsarevfs прошу прощения за задержку (работаю в режиме прыгания между задачами), на стеке мне предложили загнать progressbar в одну thread вместе с функцией, получилось, что я хотел. Также использовал thread.Event, чтобы корректно завершить thread с чтением файла, если пользователь вдруг решил закрыть окно программы. Вот код на котором я отрабатывал идею:

# coding=cp866
import threading
import time
from tkinter import *
from tkinter import messagebox, filedialog, ttk


def do_work(_range, word, e, app):
    app.bt.config(state="disabled")
    separate_window = ProgressForm()
    separate_window.grid_all()
    app.protocol('WM_DELETE_WINDOW', app.stop_branch)
    try:
        for i in range(_range):
            print(word)
            time.sleep(1)
            if e.is_set():
                break
    except Exception as ex:
        separate_window.destroy()
        messagebox.showerror("Error", str(ex))
        app.protocol('WM_DELETE_WINDOW', app.destroy)
        app.bt.config(state="normal")
    else:
        if not e.is_set():
            separate_window.destroy()
            messagebox.showinfo("Info", message="Info message!!")
            app.protocol('WM_DELETE_WINDOW', app.destroy)
            app.bt.config(state="normal")


class ProgressForm(Toplevel):
    def __init__(self):
        super().__init__()
        self.resizable(False, False)
        self.protocol('WM_DELETE_WINDOW', self.do_nothing)
        self.geometry("260x100")
        self.title("Имя программы".upper())
        self.text = Label(self, text="Идет попытка обработки файла...")
        self.prbar = ttk.Progressbar(self, orient=HORIZONTAL, length=180, mode='indeterminate')

    def grid_all(self):
        self.text.grid(column=0, row=0, sticky=W, padx=20, pady=15)
        self.prbar.grid(column=0, row=1, sticky=W, padx=40)
        self.prbar.start()

    @staticmethod
    def do_nothing():
        pass

class MainForm(Tk):
    def __init__(self):
        super().__init__()
        self.geometry("300x300")
        self.resizable(False, False)
        self.bt = Button(self, command=self.start_all, text="Start All", bd=5)
        self.event1 = threading.Event()

    def grid_all(self):
        self.bt.grid(column=0, row=0, sticky=W, padx=120, pady=130)

    def start_all(self):
        try:
            branch = threading.Thread(target=do_work, args=(10, "hello", self.event1, self),)
            branch.start()
        except Exception as ex:
            print(str(ex))
            messagebox.showerror("Error", message="Error message")

    def stop_branch(self):
        self.event1.set()
        time.sleep(3)
        self.destroy()


def main():
    app = MainForm()
    app.grid_all()
    app.mainloop()


if __name__ == "__main__":
    debug = False
    if not debug:
        main()
    else:
        try:
            main()
        except Exception as ex:
            print(str(ex))
            time.sleep(5)

Answer 2

[tsarevfs]

Поскольку tk не потокобезопасный изменять показания прогрессбара придется из главного потока. Заведите переменную для хранения прогресса. Тред воркер будет писать в нее актуальное состояние а главный тред читать и применять новое значение к прогрессбару по таймеру. Не забудте про Lock при чтении и записи.
Как упомянул Сергей Горностаев, использовать join не вариант. Вероятно вам подойдет daemon тред.