diff --git a/bumblebee/modules/pomodoro.py b/bumblebee/modules/pomodoro.py index 68909d9..64f1514 100644 --- a/bumblebee/modules/pomodoro.py +++ b/bumblebee/modules/pomodoro.py @@ -3,6 +3,14 @@ """Display and run a Pomodoro timer. Left click to start timer, left click again to pause. Right click will cancel the timer. + +Parameters: + * pomodoro.work: The work duration of timer in minutes (defaults to 25) + * pomodoro.break: The break duration of timer in minutes (defaults to 5) + * pomodoro.format: Timer display format with "%m" and "%s" for minutes and seconds (defaults to "%m:%s") + Examples: "%m min %s sec", "%mm", "", "timer" + * pomodoro.notify: Notification command to run when timer ends/starts (defaults to nothing) + Example: 'notify-send "Time up!"' """ from __future__ import absolute_import @@ -16,21 +24,49 @@ import bumblebee.engine class Module(bumblebee.engine.Module): def __init__(self, engine, config): widgets = bumblebee.output.Widget(full_text=self.text) - self.work_period = 25 - self.break_period = 5 - self.remaining_time = datetime.timedelta(minutes=self.work_period) - self.remaining_time_str = "{}m ".format(ceil((self.remaining_time.seconds / 60))) - # self.remaining_time_str = "{}min{}s ".format(int((self.remaining_time.seconds / 60)), - # round((self.remaining_time.seconds/60) % 1*60)) + + super(Module, self).__init__(engine, config, widgets) + + # Parameters + self._work_period = int(self.parameter("work", 25)) + self._break_period = int(self.parameter("break", 5)) + self._time_format = self.parameter("format", "%m:%s") + self._notify_cmd = self.parameter("notify", "") + + # TODO: Handle time formats more gracefully. This is kludge. + self.display_seconds_p = False + self.display_minutes_p = False + if "%s" in self._time_format: + self.display_seconds_p = True + if "%m" in self._time_format: + self.display_minutes_p = True + + self.remaining_time = datetime.timedelta(minutes=self._work_period) + self.time = None self.pomodoro = { "state":"OFF", "type": ""} - self._text = self.remaining_time_str + self.pomodoro["type"] - super(Module, self).__init__(engine, config, widgets) + self._text = self.remaining_time_str() + self.pomodoro["type"] + engine.input.register_callback(self, button=bumblebee.input.LEFT_MOUSE, cmd=self.timer_play_pause) engine.input.register_callback(self, button=bumblebee.input.RIGHT_MOUSE, cmd=self.timer_reset) + def remaining_time_str(self): + + if self.display_seconds_p and self.display_minutes_p: + minutes, seconds = divmod(self.remaining_time.seconds, 60) + if not self.display_seconds_p: + minutes = ceil(self.remaining_time.seconds / 60) + seconds = 0 + if not self.display_minutes_p: + minutes = 0 + seconds = self.remaining_time.seconds + + minutes = "{:2d}".format(minutes) + seconds = "{:02d}".format(seconds) + return self._time_format.replace("%m",minutes).replace("%s",seconds)+" " + def text(self, widget): return "{}".format(self._text) @@ -42,22 +78,24 @@ class Module(bumblebee.engine.Module): self.time = datetime.datetime.now() if self.remaining_time.seconds <= 0: + self.notify() if self.pomodoro["type"] == "Work": self.pomodoro["type"] = "Break" - self.remaining_time = datetime.timedelta(minutes=self.break_period) + self.remaining_time = datetime.timedelta(minutes=self._break_period) elif self.pomodoro["type"] == "Break": self.pomodoro["type"] = "Work" - self.remaining_time = datetime.timedelta(minutes=self.work_period) + self.remaining_time = datetime.timedelta(minutes=self._work_period) - self.remaining_time_str = "{}m ".format(ceil((self.remaining_time.seconds / 60))) - # self.remaining_time_str = "{}min{}s ".format(int((self.remaining_time.seconds / 60)), - # round((self.remaining_time.seconds / 60) % 1 * 60)) - self._text = self.remaining_time_str + self.pomodoro["type"] + self._text = self.remaining_time_str() + self.pomodoro["type"] + def notify(self): + if self._notify_cmd: + bumblebee.util.execute(self._notify_cmd) + def timer_play_pause(self, widget): if self.pomodoro["state"] == "OFF": self.pomodoro = {"state": "ON", "type": "Work"} - self.remaining_time = datetime.timedelta(minutes=self.work_period) + self.remaining_time = datetime.timedelta(minutes=self._work_period) self.time = datetime.datetime.now() elif self.pomodoro["state"] == "ON": self.pomodoro["state"] = "PAUSED" @@ -70,7 +108,7 @@ class Module(bumblebee.engine.Module): def timer_reset(self, widget): if self.pomodoro["state"] == "ON" or self.pomodoro["state"] == "PAUSED": self.pomodoro = {"state":"OFF", "type": "" } - self.remaining_time = datetime.timedelta(minutes=self.work_period) + self.remaining_time = datetime.timedelta(minutes=self._work_period) def state(self, widget): state = [];