Skip to content

toaster

Base module for pushing toast messages on Win 10.

This module is a wrapper for a cli utility that provides toast message functionality. See https://github.com/go-toast/toast

Attributes

mlogger = get_logger(__name__) module-attribute

Functions

get_toaster()

Return full file path of the toast binary utility.

Source code in pyrevitlib/pyrevit/forms/toaster.py 
18
19
20
def get_toaster():
    """Return full file path of the toast binary utility."""
    return op.join(BIN_DIR, 'pyrevit-toast.exe')

send_toast(message, title=None, appid=None, icon=None, click=None, actions=None)

Send toast notificaton.

Parameters:

Name Type Description Default
message str

notification message

 required
title str

notification title

 None
appid str

application unique id (see --app-id cli option)

 None
icon str

notification icon (see --icon cli option)

 None
click str

click action (see --activation-arg cli option)

 None
actions dict[str

str]): list of actions (see --action and --action-arg cli options)

 None
Source code in pyrevitlib/pyrevit/forms/toaster.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
def send_toast(message,
               title=None, appid=None, icon=None, click=None, actions=None):
    """Send toast notificaton.

    Args:
        message (str): notification message
        title (str): notification title
        appid (str): application unique id (see `--app-id` cli option)
        icon (str): notification icon (see `--icon` cli option)
        click (str): click action (see `--activation-arg` cli option)
        actions (dict[str:str]):
            list of actions (see `--action` and `--action-arg` cli options)
    """
    # set defaults
    if not title:
        title = 'pyRevit'
    if not appid:
        appid = title
    if not icon:
        icon = op.join(BIN_DIR, 'pyRevit.ico')
    if not actions:
        actions = {}

    # build the toast
    toast_args = r'"{}"'.format(get_toaster())
    toast_args += r' --app-id "{}"'.format(appid)
    toast_args += r' --title "{}"'.format(title)
    toast_args += r' --message "{}"'.format(message)
    toast_args += r' --icon "{}"'.format(icon)
    toast_args += r' --audio "default"'
    # toast_args += r' --duration "long"'
    if click:
        toast_args += r' --activation-arg "{}"'.format(click)
    for action, args in actions.items():
        toast_args += r' --action "{}" --action-arg "{}"'.format(action, args)

    # send the toast now
    mlogger.debug('toasting: %s', toast_args)
    subprocess.Popen(toast_args, shell=True)