krunnerdbusutils

Utilities for writing a KRunner plugin using python.

The DBus calls can be directly tested using qdbus:

qdbus --literal net.fancyplugin2 /fancyplugin Actions
qdbus --literal net.fancyplugin2 /fancyplugin Match hello
qdbus --literal net.fancyplugin2 /fancyplugin Run hello_match action_id

For KRunner to pick up the plugin, a desktop file with the name of the plugin needs to be added, a template can be found in https://invent.kde.org/frameworks/krunner/-/raw/master/templates/runner6python/%25%7BAPPNAMELC%7D.desktop?ref_type=heads
This file must be installed in ~/.local/share/krunner/dbusplugins

Usage example:

from krunnerdbusutils import krunner_actions, krunner_match, krunner_run, \
    AbstractRunner, Action, Match, run_event_loop


class Runner(AbstractRunner):
    def __init__(self):
        super().__init__("net.fancyplugin")

    @krunner_match
    def Match(self, query: str):
        matches = []
        if query == "hello":
            match = Match() # Or utilize keyword constructor, as shown for actions
            match.id = "hello_match"
            match.text = "Hello There!"
            match.subtext = "Example"
            match.icon = "planetkde"
            match.actions = ["dummy_action"] # show only the given actions, otherwise all are shown
            matches.append(match)
        return matches

    @krunner_actions
    def Actions(self):
        return [
            Action(id="dummy_action", text="Action Tooltip", icon="info"),
            Action(id="dummy_action_2", text="Second Action Tooltip", icon="info")
        ]

    @krunner_run
    def Run(self, match_id: str, action_id: str):
        print(data, action_id)


if __name__ == "__main__":
    run_event_loop(Runner)