From c33cb3aa609216240b152c4744eda1e6f7bea3d2 Mon Sep 17 00:00:00 2001 From: enkore Date: Wed, 23 Oct 2013 21:35:50 +0200 Subject: [PATCH] CommandEndpoint docs --- i3pystatus/core/__init__.py | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/i3pystatus/core/__init__.py b/i3pystatus/core/__init__.py index 1aa493d..37d9b6a 100644 --- a/i3pystatus/core/__init__.py +++ b/i3pystatus/core/__init__.py @@ -2,13 +2,19 @@ import sys import os from threading import Thread -from i3pystatus.core.imputil import ClassFinder +from i3pystatus.core.imputil import ClassFinder from i3pystatus.core import io, util from i3pystatus.core.modules import Module class CommandEndpoint: + """ + Endpoint for i3bar click events: http://i3wm.org/docs/i3bar-protocol.html#_click_events + + :param modules: dict-like object with item access semantics via .get() + :param io_handler_factory: function creating a file-like object returning a JSON generator on .read() + """ def __init__(self, modules, io_handler_factory): self.modules = modules self.io_handler_factory = io_handler_factory @@ -16,11 +22,12 @@ class CommandEndpoint: self.thread.daemon = True def start(self): + """Starts the background thread""" self.thread.start() def _command_endpoint(self): for command in self.io_handler_factory().read(): - target_module = self.modules.get_module_by_id(command["instance"]) + target_module = self.modules.get(command["instance"]) if target_module: target_module.on_click(command["button"])