Skip to content

Library API

async_handler(async_function, *args, **kwargs)

A helper function which allows to use async functions as command handlers (e.g. button click handlers) or event handlers.

async_function: async function
args: positional parameters which will be passed to the async function
kwargs: keyword parameters which will be passed to the async function

A sync function, which runs the original async function in an async event loop.

Usage examples: 

import tkinter as tk
from async_tkinter_loop import async_handler

async def some_async_function():
    print("Wait...")
    await asyncio.sleep(0.5)
    print("Done!")

button = tk.Button("Press me", command=async_handler(some_async_function))

# ----

async def some_async_function(event):
    print("Wait...")
    await asyncio.sleep(0.5)
    print("Done!")

root.bind("<1>", command=async_handler(some_async_function))

# ----

# Also, it can be used as a decorator
@async_handler
async def some_async_function():
    print("Wait...")
    await asyncio.sleep(0.5)
    print("Done!")

button = tk.Button("Press me", command=some_async_function)

Source code in async_tkinter_loop/async_tkinter_loop.py 
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
def async_handler(async_function: Callable[P, Coroutine[Any, Any, None]], *args, **kwargs) -> Callable[P, None]:
    """
    A helper function which allows to use async functions as command handlers (e.g. button click handlers) or event
    handlers.

    Args:
    ----
        async_function: async function
        args: positional parameters which will be passed to the async function
        kwargs: keyword parameters which will be passed to the async function

    Returns:
    -------
        A sync function, which runs the original async function in an async event loop.

    Usage examples:
    ```python
    import tkinter as tk
    from async_tkinter_loop import async_handler

    async def some_async_function():
        print("Wait...")
        await asyncio.sleep(0.5)
        print("Done!")

    button = tk.Button("Press me", command=async_handler(some_async_function))

    # ----

    async def some_async_function(event):
        print("Wait...")
        await asyncio.sleep(0.5)
        print("Done!")

    root.bind("<1>", command=async_handler(some_async_function))

    # ----

    # Also, it can be used as a decorator
    @async_handler
    async def some_async_function():
        print("Wait...")
        await asyncio.sleep(0.5)
        print("Done!")

    button = tk.Button("Press me", command=some_async_function)
    ```

    """

    @wraps(async_function)
    def wrapper(*handler_args) -> None:
        get_event_loop().create_task(async_function(*handler_args, *args, **kwargs))

    return wrapper

async_mainloop(root)

A function, which is a substitute to the standard root.mainloop().

root: tkinter root object
Source code in async_tkinter_loop/async_tkinter_loop.py 
45
46
47
48
49
50
51
52
53
54
def async_mainloop(root: tk.Tk) -> None:
    """
    A function, which is a substitute to the standard `root.mainloop()`.

    Args:
    ----
        root: tkinter root object

    """
    get_event_loop().run_until_complete(main_loop(root))

get_event_loop()

A helper function which returns an event loop using current event loop policy.

Returns

event loop
Source code in async_tkinter_loop/async_tkinter_loop.py 
33
34
35
36
37
38
39
40
41
42
def get_event_loop() -> asyncio.AbstractEventLoop:
    """
    A helper function which returns an event loop using current event loop policy.

    Returns
    -------
        event loop

    """
    return asyncio.get_event_loop_policy().get_event_loop()

main_loop(root) async

An asynchronous implementation of tkinter mainloop. The function is not intended to be called directly from your code.

root: tkinter root window object
Source code in async_tkinter_loop/async_tkinter_loop.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
async def main_loop(root: tk.Tk) -> None:
    """
    An asynchronous implementation of tkinter mainloop. The function is not intended to be called directly from your
    code.

    Args:
    ----
        root: tkinter root window object

    """
    while True:
        # Process all pending events
        while root.dooneevent(_tkinter.DONT_WAIT) > 0:
            pass

        try:
            root.winfo_exists()  # Will throw TclError if the main window is destroyed
        except tk.TclError:
            break

        await asyncio.sleep(0.01)