Skip to main content

Simple library that allows interaction between Tkinter and asyncio event loop running in a seperate thread.

Project description

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

pip install tkinter-async-execute

Documentation

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

Example

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tkinter_async_execute-1.3.0.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

tkinter_async_execute-1.3.0-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file tkinter_async_execute-1.3.0.tar.gz.

File metadata

  • Download URL: tkinter_async_execute-1.3.0.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.9

File hashes

Hashes for tkinter_async_execute-1.3.0.tar.gz
Algorithm Hash digest
SHA256 f61e2a7c7de03f41320a7e61bc4ddf6450d17ca2cf60f05397f114f659856d0b
MD5 6cf0c126c32ef0d5eadc8159ed7e74be
BLAKE2b-256 3636a4be2f6cd316bea458750c84f51c08d738a39a605b87c27a61233f666791

See more details on using hashes here.

File details

Details for the file tkinter_async_execute-1.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for tkinter_async_execute-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8fce50194c26330ff99893aedfed6edd28915d8dbbf30705a74f0e40e138fca5
MD5 fc226096a5d6883c858f00fa0e760b9a
BLAKE2b-256 e28ea49356b41c19772edac9589995586341012bfa3b3111076edc6fb90d57bf

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page