Added module stopwatch #1216

onny · 2018-01-06T14:25:55Z

Hey,
I modified the timer module a bit, copied it and created a simple stopwatch module.
A left click starts or pauses the timer, right click resets it.

Regards,
Jonas

lasers · 2018-01-08T03:25:00Z

Hey @onny. Thanks for this module. If you looked at Travis (red X right there then one more red X in build jobs), you'll find few things you need to fix.

And I wonder if it's possible / better to implement this in timer instead? Perhaps with a button to toggle between timer and stopwatch? Anyhow, I'll be happy to review this next after Travis cleared you.

Remove unused variables

onny · 2018-01-08T17:44:23Z

All tests should pass now. The latest is not working because of a connection timeout of Travis ...
The idea is good but personally I prefer a seperate module so I don't have to change the behaviour of the timer/stopwatch every time. If someone is willing to change that in the future, I'll be happy to check it out 👍

lasers · 2018-01-08T17:42:06Z

py3status/modules/stopwatch.py

+
+    def stopwatch(self):
+
+        def make_2_didget(value):


Let's put this outside of def stopwatch(self) and maybe use def _add_zero and update the names. From make_2_didget(mins) to self._add_zero(minutes).

Or look at https://stackoverflow.com/a/539360 and use "%02d" formatting to add leading numbers.

lasers · 2018-01-08T17:54:44Z

py3status/modules/stopwatch.py

+        # Minutes
+        mins, t = divmod(t, 60)
+        # Seconds
+        seconds = t


(Nit). I'd like minutes here... and just kill the comments.

lasers · 2018-01-08T17:56:11Z

py3status/modules/stopwatch.py

+                'index': 'hours',
+            },
+            {
+                'color': '#CCCCCC',


We should kill all hardcoded #CCCCCC here. index: '???' is used to adjust numbers and we're not doing that here... so they all can go too.

lasers · 2018-01-08T18:01:20Z

py3status/modules/stopwatch.py

+        return {
+            'cached_until': cached_until,
+            'full_text':
+            self.py3.safe_format(self.format, {'stopwatch': stopwatch})


(Nit)

return { 'cached_until': cached_until, 'full_text': self.py3.safe_format( self.format, {'stopwatch': stopwatch}) }

lasers · 2018-01-08T18:05:19Z

py3status/modules/stopwatch.py

+                self.running = False
+                self.paused = True
+                self.time_state = int(time() - self.time_start)
+                self.color = '#FFFF00'


Remove this hardcoded colors by using this instead:

self.color = self.py3.COLOR_GOOD

self.color = self.py3.COLOR_BAD

This would allows users to change colors via...

# change good/bad for all modules config general { color_good = '#ccffcc' color_bad = '#ffccff' }

OR

# change good/bad for this per-module config stopwatch { color_good = '#ccffcc' color_bad = '#ffccff' }

lasers · 2018-01-08T18:06:22Z

py3status/modules/stopwatch.py

+                else:
+                    self.time_start = time()
+                    self.running = True
+                self.color = '#00FF00'


Let's put this self.color right before the # start/restart comment along with self.running = True too.

lasers · 2018-01-08T18:09:25Z

py3status/modules/stopwatch.py

+        if button == 2:
+            # reset and pause stopwatch
+            self.running = False
+            self.paused = False


We could make a def _reset_time(self) method for this one and the one in post_config_hook too.... And we should make configurable buttons too... button_toggle = 1 and button_reset = 3 instead of hardcoded buttons.

lasers · 2018-01-08T18:12:03Z

py3status/modules/stopwatch.py

+        else:
+            if self.time_state:
+                t = self.time_state
+            else:


I think we might be able to use elif here to make it a bit more cleaner.
EDIT: Or leave this alone and put cached_until stuffs in there instead.

lasers · 2018-01-20T19:00:16Z

py3status/modules/stopwatch.py

@@ -55,6 +55,8 @@ def post_config_hook(self):
        self.time_state = None
        self.color = None
        self.paused = False
+        self.button_reset = 3
+        self.button_toggle = 1


Move them up to line 50 # available configuration parameters

onny · 2018-01-20T19:23:06Z

Thanks for all the useful and educational code support. Is everything fine so far?

lasers

Almost there...

lasers · 2018-01-20T19:21:30Z

py3status/modules/stopwatch.py

+
+Configuration parameters:
+    format: display format for this module (default 'Stopwatch {stopwatch}')
+


Missing docs...

button_reset: mouse button to reset the stopwatch (default 3) button_toggle: mouse button to start/stop the stopwatch (default 1)

lasers · 2018-01-20T19:27:21Z

py3status/modules/stopwatch.py

+stopwatch.
+
+Button 1 starts/pauses the stopwatch.
+Button 2 resets stopwatch.


Kill the comments. The (missing) docs will take care of this.

lasers · 2018-01-20T19:34:01Z

py3status/modules/stopwatch.py

+A simple stopwatch.
+
+This is a very basic stopwatch. You can start, pause and reset the
+stopwatch.


Please write a bit more... A nice long description about your module. :-)

lasers · 2018-01-20T19:36:09Z

py3status/modules/stopwatch.py

+
+        if button == self.button_reset:
+            # reset and pause stopwatch
+            self._reset_time()


elif button == self.button_reset: self._reset_time() else: self.py3.prevent_refresh()

Prevent users from updating this module with clicks/scrolling if they feel like doing it. EDIT: And users have no reasons to play with this anyway.

lasers · 2018-01-20T19:47:42Z

py3status/modules/stopwatch.py

+@author Jonas Heinrich
+
+SAMPLE OUTPUT
+{'full_text': 'Stopwatch 0:01:00'}


No color 0:00:00. And change paused 54 to 58. Different number for screenshot.

lasers · 2018-01-20T19:50:04Z

py3status/modules/stopwatch.py

+        self._reset_time()
+
+    def stopwatch(self):
+


Kill this line... And keep def post_config_hook at top for consistency with other modules.

post_config_hook

_reset_time

stopwatch

on_click

lasers · 2018-01-20T20:24:12Z

py3status/modules/stopwatch.py

    def _reset_time(self):
        self.running = False
        self.paused = False
        self.time_state = None
        self.color = None

-    def post_config_hook(self):
-        self.time_start = None
-        self._reset_time()


Missing self._reset_time() in new location. Broke the module.

onny · 2018-01-20T23:47:48Z

Hope it's all right now :)

lasers · 2018-01-21T01:46:43Z

@onny I gave you another review in case you didn't notice. This module is cool and we still can make it more cool if we want to. 👍 EDIT: With only a little more work.

lasers

@tobes This is ready. However, I think it would be better if we default button_reset back to 2 and to set COLOR_DEGRADED instead of COLOR_BAD to stay in consistency with timer module...

I'm also thinking that it'd be good to reserve button_3 for maybe in the future, a button_lap = 3 to spawn new stopwatch (laps).

@onny Feel free to switch COLOR and button_reset if you agree and/or played with both stopwatch and timer. Nice job. Cheers. 👍

onny · 2018-01-21T14:39:33Z

I'm okay with that, we can change that 👍

lasers

(Nit) If we want to colorize everything same, then this patch would be better. Otherwise, the colons should not have colors if we want it to be identical to timer.

diff --git a/py3status/modules/stopwatch.py b/py3status/modules/stopwatch.py
index 7c433a9a..e10374af 100644
--- a/py3status/modules/stopwatch.py
+++ b/py3status/modules/stopwatch.py
@@ -62,7 +62,6 @@ class Py3status:
         self.color = None
 
     def stopwatch(self):
-
         if self.running:
             cached_until = self.py3.time_in(0, offset=1)
             t = int(time() - self.time_start)
@@ -77,35 +76,14 @@ class Py3status:
         minutes, t = divmod(t, 60)
         seconds = t
 
-        composites = [
-            {
-                'full_text': str(hours),
-                'color': self.color,
-            },
-            {
-                'color': self.color,
-                'full_text': ':',
-            },
-            {
-                'full_text': '%02d' % (minutes),
-                'color': self.color,
-            },
-            {
-                'color': self.color,
-                'full_text': ':',
-            },
-            {
-                'full_text': '%02d' % (seconds),
-                'color': self.color,
-            },
-        ]
-
-        stopwatch = self.py3.composite_create(composites)
+        stopwatch = self.py3.safe_format('\?color=%s %d:%02d:%02d' % (
+            self.color, hours, minutes, seconds))
 
         return {
             'cached_until': cached_until,
             'full_text': self.py3.safe_format(
-                self.format, {'stopwatch': stopwatch})
+                self.format, {'stopwatch': stopwatch}
+            )
         }
 
     def on_click(self, event):

onny · 2018-01-23T17:02:22Z

Okay this looks better now 👍

onny · 2018-03-23T14:17:22Z

Any updates on this?

lasers · 2018-03-28T15:50:05Z

@onny This module is up to standards. However, stopwatch contains roughly a half of timer code. If you can implement stopwatch functionality in timer instead, then that's where we can really shine here... and is likely to make more people happy by not worrying about switching between timer and stopwatch modules versus using built-in functionality.

tobes · 2018-08-26T10:40:12Z

I'm with @lasers here really we should combine the two - unless we are just going for how many modules can we have - but I'm for less is more

ultrabug · 2018-12-30T16:33:01Z

but I'm for less is more

Same, and after all this time I guess we should face the fact that we really want this in timer instead

Closing. Please @onny if you feel like it, move this logic to timer and open a new PR that we'll be glad to integrate

Thanks again for contributing !

added module stopwatch

9fae958

onny added 2 commits January 8, 2018 17:33

Update stopwatch.py

ecaaee7

Remove unused variables

Fix unused variable, break long lines

8b20c8c

lasers reviewed Jan 8, 2018

View reviewed changes

onny added 5 commits January 20, 2018 18:58

fix hardcoded colors

f14f755

remove duplicate variable assigning

a9504b9

better code formatting

2ac182e

remove useless comments

2827b82

fix random stuff

21dff90

lasers reviewed Jan 20, 2018

View reviewed changes

onny added 2 commits January 20, 2018 20:08

simpler code for two digit formatting

c763d29

add reset_time function

2e0a69a

variables in alphabetical order

44de92f

lasers reviewed Jan 20, 2018

View reviewed changes

add two new variables to documentation

6afd9d9

lasers reviewed Jan 20, 2018

View reviewed changes

reordner functions

80a7d09

lasers reviewed Jan 20, 2018

View reviewed changes

readd missing function call

e59d6af

fixed documentation inconsistencies

ca39388

lasers approved these changes Jan 21, 2018

View reviewed changes

changed pause color and use different mouse button for reset

cfba571

lasers reviewed Jan 21, 2018

View reviewed changes

rewrite watch composition

d319755

tobes added the new module ✨ I am proposing a new module label Jan 31, 2018

tobes self-assigned this Jan 31, 2018

ultrabug closed this Dec 30, 2018


		Configuration parameters:
		format: display format for this module (default 'Stopwatch {stopwatch}')

Added module stopwatch #1216

Added module stopwatch #1216

Conversation

onny commented Jan 6, 2018

lasers commented Jan 8, 2018

onny commented Jan 8, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lasers Jan 8, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lasers Jan 8, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

onny commented Jan 20, 2018

lasers left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lasers Jan 20, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

onny commented Jan 20, 2018

lasers commented Jan 21, 2018 • edited Loading

lasers left a comment

Choose a reason for hiding this comment

onny commented Jan 21, 2018

lasers left a comment • edited Loading

Choose a reason for hiding this comment

onny commented Jan 23, 2018

onny commented Mar 23, 2018

lasers commented Mar 28, 2018

tobes commented Aug 26, 2018

ultrabug commented Dec 30, 2018

lasers Jan 8, 2018 •

edited

Loading

lasers Jan 8, 2018 •

edited

Loading

lasers Jan 20, 2018 •

edited

Loading

lasers commented Jan 21, 2018 •

edited

Loading

lasers left a comment •

edited

Loading