https://github.com/davidhozic/tkinter-async-execute

A small library, which provides a non-blocking way to run an asyncio event loop alongside Tkinter in a seperate thread, thread-safe functions for thread-safe interaction, and an execution progress widget.
https://github.com/davidhozic/tkinter-async-execute

async-execution-window asyncio asyncio-api-wrapper events pop-up thread-safe tkinter

Last synced: 2 months ago
JSON representation

A small library, which provides a non-blocking way to run an asyncio event loop alongside Tkinter in a seperate thread, thread-safe functions for thread-safe interaction, and an execution progress widget.

• Host: GitHub
• URL: https://github.com/davidhozic/tkinter-async-execute
• Owner: davidhozic
• License: mit
• Created: 2023-08-19T12:12:15.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-03-16T17:17:00.000Z (3 months ago)
• Last Synced: 2025-03-28T01:45:51.292Z (3 months ago)
• Topics: async-execution-window, asyncio, asyncio-api-wrapper, events, pop-up, thread-safe, tkinter
• Language: Python
• Homepage: https://tkinter-async-execute.readthedocs.io/
• Size: 61.5 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
======================

Tkinter-Async-Execute

======================

Tkinter-Async-Execute is a small library, that provides a way to run an ``asyncio`` event loop alongside Tkinter in

a separate thread.

It provides a way to execute methods of tkinter widgets from inside async functions and ability to call async functions

from functions (commands / events) running in tkinter's thread. The former can be called from any thread (or async function)

and the latter only from functions (commands / events) in tkinter's thread.

To show progress of an async function, submitted from tkinter, an async execution window widget is available,

which will display any text printed with the ``print()`` function (or any stdout write requests).

Installation

==============

.. code-block:: bash

    pip install tkinter-async-execute

Documentation

=============

All documentation is available on https://tkinter-async-execute.readthedocs.io/.

Example

=============

.. code-block:: python

    from tkinter import ttk

    import tkinter as tk

    import asyncio

    import tk_async_execute as tae

    async def async_function():

        # Call tkinter widget methods.

        print("Disabling button")

        tae.tk_execute(bnt.config, state="disabled")  # Thread safe exection

        await asyncio.sleep(5)

        print("Enabling button")

        tae.tk_execute(bnt.config, state="normal")

        await asyncio.sleep(2)

        # Change tkinter text

        print("Renaming button")

        tae.tk_execute(bnt.config, text="Example 2")

        await asyncio.sleep(2)

    def button_clicked():

        # Call async function

        tae.async_execute(async_function(), wait=True, visible=True, pop_up=True, callback=None, master=root)

        # Close application

        root.quit()

    if __name__ == "__main__":

        root = tk.Tk()

        bnt = ttk.Button(root, text="Click me", command=button_clicked, width=20)

        bnt.pack()

        tae.start()  # Starts the asyncio event loop in a different thread.

        root.mainloop()  # Main Tkinter loop

        tae.stop()  # Stops the event loop and closes it.