Skip to content

Commit 498b66d

Browse files
arxanasarxanas
committed
Add strokes meter
This adds a meter that tells you how many strokes, on average, you take to write words. If you write out many words, this number will be higher; likewise, if you write words in relatively few strokes, this number will be lower. This commit also adds a new method of counting words, which is to count the number of space-delimited substrings.
1 parent 4a12c6f commit 498b66d

6 files changed

+283
-51
lines changed

‎plover_wpm_meter/__init__.py

+108-40
Original file line numberDiff line numberDiff line change
@@ -1,103 +1,171 @@
11
import time
22

3-
from PyQt5.QtCore import Qt, QTimer, pyqtSlot
3+
from PyQt5.QtCore import Qt, QTimer
44

55
from plover.gui_qt.tool import Tool
6-
76
from textstat.textstat import textstat
7+
8+
from plover_wpm_meter.strokes_meter_ui import Ui_StrokesMeter
9+
from plover_wpm_meter.textstat.textstat import textstat
810
from plover_wpm_meter.wpm_meter_ui import Ui_WpmMeter
911

1012

11-
class PloverWpmMeter(Tool, Ui_WpmMeter):
12-
TITLE = "WPM Meter"
13-
ROLE = "wpm_meter"
14-
15-
_TIMEOUTS = {
16-
"wpm1": 10,
17-
"wpm2": 60,
18-
}
19-
13+
class BaseMeter(Tool):
2014
def __init__(self, engine):
2115
super().__init__(engine)
22-
self.setupUi(self)
2316

2417
self.setWindowFlags(self.windowFlags() | Qt.WindowStaysOnTopHint)
25-
self.wpm_method.addItem("NCRA", "ncra")
26-
self.wpm_method.addItem("Traditional", "traditional")
18+
self.setupUi(self)
2719

2820
self._timer = QTimer()
2921
self._timer.setInterval(1000)
3022
self._timer.setTimerType(Qt.PreciseTimer)
31-
self._timer.timeout.connect(self._update_wpms)
23+
self._timer.timeout.connect(self.on_timer)
3224
self._timer.start()
3325

34-
self._chars = []
35-
engine.signal_connect("translated", self._on_translation)
36-
3726
self.restore_state()
3827
self.finished.connect(self.save_state)
3928

40-
def _on_translation(self, old, new):
29+
self.chars = []
30+
engine.signal_connect("translated", self.on_translation)
31+
32+
def on_translation(self, old, new):
4133
for action in old:
4234
remove = len(action.text)
4335
if remove > 0:
44-
self._chars = self._chars[:-remove]
45-
self._chars += _timestamp_chars(action.replace)
36+
self.chars = self.chars[:-remove]
37+
self.chars += _timestamp_items(action.replace)
4638

4739
for action in new:
4840
remove = len(action.replace)
4941
if remove > 0:
50-
self._chars = self._chars[:-remove]
51-
self._chars += _timestamp_chars(action.text)
42+
self.chars = self.chars[:-remove]
43+
self.chars += _timestamp_items(action.text)
44+
45+
def on_timer(self):
46+
raise NotImplementedError()
47+
48+
49+
class PloverWpmMeter(BaseMeter, Ui_WpmMeter):
50+
TITLE = "WPM Meter"
51+
ROLE = "wpm_meter"
52+
53+
_TIMEOUTS = {
54+
"wpm1": 10,
55+
"wpm2": 60,
56+
}
57+
58+
def __init__(self, engine):
59+
super().__init__(engine)
60+
self.strokes = []
61+
self.wpm_method.addItem("NCRA (by syllables)", "ncra")
62+
self.wpm_method.addItem("Traditional (by characters)", "traditional")
63+
self.wpm_method.addItem("Spaces (by whitespace)", "spaces")
5264

53-
@pyqtSlot()
54-
def _update_wpms(self):
65+
def on_timer(self):
5566
max_timeout = max(self._TIMEOUTS.values())
56-
self._chars = _filter_old_chars(self._chars, max_timeout)
67+
self.chars = _filter_old_items(self.chars, max_timeout)
5768
for name, timeout in self._TIMEOUTS.items():
58-
chars = _filter_old_chars(self._chars, timeout)
69+
chars = _filter_old_items(self.chars, timeout)
5970
wpm = _wpm_of_chars(chars, method=self.wpm_method.currentData())
6071
getattr(self, name).display(str(wpm))
6172

6273

63-
def _timestamp_chars(chars):
74+
class PloverStrokesMeter(BaseMeter, Ui_StrokesMeter):
75+
TITLE = "Strokes Meter"
76+
ROLE = "strokes_meter"
77+
78+
_TIMEOUTS = {
79+
"strokes1": 10,
80+
"strokes2": 60,
81+
}
82+
83+
def __init__(self, engine):
84+
super().__init__(engine)
85+
self.strokes_method.addItem("NCRA (by syllables)", "ncra")
86+
self.strokes_method.addItem("Traditional (by characters)",
87+
"traditional")
88+
self.strokes_method.addItem("Spaces (by whitespace)", "spaces")
89+
self.actions = []
90+
91+
# By default, the QLCDNumbers will just display "0", without a decimal
92+
# point, on initial render. Render them ourselves so that we don't
93+
# switch from "0" to "0.00" after a second.
94+
self.on_timer()
95+
96+
def on_translation(self, old, new):
97+
super().on_translation(old, new)
98+
if len(old) > 0:
99+
self.actions = self.actions[:-len(old)]
100+
self.actions += _timestamp_items(new)
101+
102+
def on_timer(self):
103+
max_timeout = max(self._TIMEOUTS.values())
104+
self.chars = _filter_old_items(self.chars, max_timeout)
105+
self.actions = _filter_old_items(self.actions, max_timeout)
106+
for name, timeout in self._TIMEOUTS.items():
107+
chars = _filter_old_items(self.chars, timeout)
108+
num_strokes = len(_filter_old_items(self.actions, timeout))
109+
strokes_per_word = _spw_of_chars(
110+
num_strokes,
111+
chars,
112+
method=self.strokes_method.currentData()
113+
)
114+
getattr(self, name).display("{:0.2f}".format(strokes_per_word))
115+
116+
117+
def _timestamp_items(items):
64118
current_time = time.time()
65-
return [(c, current_time) for c in chars]
119+
return [(i, current_time) for i in items]
66120

67121

68-
def _filter_old_chars(chars, timeout):
122+
def _filter_old_items(items, timeout):
69123
current_time = time.time()
70-
return [(c, t) for c, t in chars
124+
return [(i, t) for i, t in items
71125
if (current_time - t) <= timeout]
72126

73127

74-
def _words_in_text(string, method):
128+
def _words_in_chars(chars, method):
129+
text = "".join(c for c, _ in chars)
75130
if method == "ncra":
76131
# The NCRA defines a "word" to be 1.4 syllables, which is the average
77132
# number of syllables per English word.
78133
syllables_per_word = 1.4
79134
# For some reason, textstat returns syllable counts such as a
80135
# one-syllable word like "the" being 0.9 syllables.
81-
syllables_in_text = textstat.syllable_count(string) / 0.9
136+
syllables_in_text = textstat.syllable_count(text) / 0.9
82137
return syllables_in_text * (1 / syllables_per_word)
83138
elif method == "traditional":
84139
# Formal definition; see https://en.wikipedia.org/wiki/Words_per_minute
85-
return len(string) / 5
140+
return len(text) / 5
141+
elif method == "spaces":
142+
return len([i for i in text.split() if i])
86143
else:
87144
assert False, "bad wpm method: " + method
88145

89146

90-
def _wpm_of_chars(chars, method):
91-
if not chars:
92-
return 0
93-
147+
def _time_interval_of_chars(chars):
94148
start_time = min(t for _, t in chars)
95149
current_time = time.time()
96150
time_interval = current_time - start_time
97151
time_interval = max(1, time_interval)
152+
return time_interval
98153

99-
text = "".join(c for c, _ in chars)
100-
num_words = _words_in_text(text, method)
154+
155+
def _wpm_of_chars(chars, method):
156+
num_words = _words_in_chars(chars, method)
157+
if not num_words:
158+
return 0
159+
160+
time_interval = _time_interval_of_chars(chars)
101161
num_minutes = time_interval / 60
102162
num_words_per_minute = num_words / num_minutes
103163
return int(round(num_words_per_minute))
164+
165+
166+
def _spw_of_chars(num_strokes, chars, method):
167+
num_words = _words_in_chars(chars, method)
168+
if not num_words:
169+
return 0
170+
171+
return num_strokes / num_words

‎plover_wpm_meter/strokes_meter.ui

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ui version="4.0">
3+
<class>StrokesMeter</class>
4+
<widget class="QDialog" name="StrokesMeter">
5+
<property name="geometry">
6+
<rect>
7+
<x>0</x>
8+
<y>0</y>
9+
<width>180</width>
10+
<height>151</height>
11+
</rect>
12+
</property>
13+
<property name="windowTitle">
14+
<string>Strokes Meter</string>
15+
</property>
16+
<widget class="QWidget" name="layoutWidget">
17+
<property name="geometry">
18+
<rect>
19+
<x>0</x>
20+
<y>30</y>
21+
<width>181</width>
22+
<height>121</height>
23+
</rect>
24+
</property>
25+
<layout class="QGridLayout" name="strokes_meter" columnstretch="2,1" columnminimumwidth="0,0">
26+
<item row="0" column="0">
27+
<widget class="QLCDNumber" name="strokes1">
28+
<property name="sizePolicy">
29+
<sizepolicy hsizetype="Minimum" vsizetype="Minimum">
30+
<horstretch>0</horstretch>
31+
<verstretch>0</verstretch>
32+
</sizepolicy>
33+
</property>
34+
<property name="segmentStyle">
35+
<enum>QLCDNumber::Flat</enum>
36+
</property>
37+
<property name="value" stdset="0">
38+
<double>0.000000000000000</double>
39+
</property>
40+
</widget>
41+
</item>
42+
<item row="0" column="1">
43+
<widget class="QLabel" name="strokes1_label">
44+
<property name="text">
45+
<string>last 10s</string>
46+
</property>
47+
<property name="alignment">
48+
<set>Qt::AlignCenter</set>
49+
</property>
50+
</widget>
51+
</item>
52+
<item row="1" column="0">
53+
<widget class="QLCDNumber" name="strokes2">
54+
<property name="segmentStyle">
55+
<enum>QLCDNumber::Flat</enum>
56+
</property>
57+
<property name="value" stdset="0">
58+
<double>0.000000000000000</double>
59+
</property>
60+
</widget>
61+
</item>
62+
<item row="1" column="1">
63+
<widget class="QLabel" name="strokes2_label">
64+
<property name="text">
65+
<string>last 1m</string>
66+
</property>
67+
<property name="alignment">
68+
<set>Qt::AlignCenter</set>
69+
</property>
70+
</widget>
71+
</item>
72+
</layout>
73+
</widget>
74+
<widget class="QWidget" name="layoutWidget">
75+
<property name="geometry">
76+
<rect>
77+
<x>0</x>
78+
<y>0</y>
79+
<width>181</width>
80+
<height>36</height>
81+
</rect>
82+
</property>
83+
<layout class="QGridLayout" name="strokes_controls" columnstretch="0">
84+
<item row="0" column="0">
85+
<widget class="QComboBox" name="strokes_method"/>
86+
</item>
87+
</layout>
88+
</widget>
89+
</widget>
90+
<layoutdefault spacing="0" margin="0"/>
91+
<resources/>
92+
<connections/>
93+
</ui>

‎plover_wpm_meter/strokes_meter_ui.py

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# -*- coding: utf-8 -*-
2+
3+
# Form implementation generated from reading ui file '/Users/waleedk/Workspace/plover_wpm_meter/plover_wpm_meter/strokes_meter.ui'
4+
#
5+
# Created by: PyQt5 UI code generator 5.8.1
6+
#
7+
# WARNING! All changes made in this file will be lost!
8+
9+
from PyQt5 import QtCore, QtGui, QtWidgets
10+
11+
class Ui_StrokesMeter(object):
12+
def setupUi(self, StrokesMeter):
13+
StrokesMeter.setObjectName("StrokesMeter")
14+
StrokesMeter.resize(180, 151)
15+
self.layoutWidget = QtWidgets.QWidget(StrokesMeter)
16+
self.layoutWidget.setGeometry(QtCore.QRect(0, 30, 181, 121))
17+
self.layoutWidget.setObjectName("layoutWidget")
18+
self.strokes_meter = QtWidgets.QGridLayout(self.layoutWidget)
19+
self.strokes_meter.setContentsMargins(0, 0, 0, 0)
20+
self.strokes_meter.setSpacing(0)
21+
self.strokes_meter.setObjectName("strokes_meter")
22+
self.strokes1 = QtWidgets.QLCDNumber(self.layoutWidget)
23+
sizePolicy = QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Minimum, QtWidgets.QSizePolicy.Minimum)
24+
sizePolicy.setHorizontalStretch(0)
25+
sizePolicy.setVerticalStretch(0)
26+
sizePolicy.setHeightForWidth(self.strokes1.sizePolicy().hasHeightForWidth())
27+
self.strokes1.setSizePolicy(sizePolicy)
28+
self.strokes1.setSegmentStyle(QtWidgets.QLCDNumber.Flat)
29+
self.strokes1.setProperty("value", 0.0)
30+
self.strokes1.setObjectName("strokes1")
31+
self.strokes_meter.addWidget(self.strokes1, 0, 0, 1, 1)
32+
self.strokes1_label = QtWidgets.QLabel(self.layoutWidget)
33+
self.strokes1_label.setAlignment(QtCore.Qt.AlignCenter)
34+
self.strokes1_label.setObjectName("strokes1_label")
35+
self.strokes_meter.addWidget(self.strokes1_label, 0, 1, 1, 1)
36+
self.strokes2 = QtWidgets.QLCDNumber(self.layoutWidget)
37+
self.strokes2.setSegmentStyle(QtWidgets.QLCDNumber.Flat)
38+
self.strokes2.setProperty("value", 0.0)
39+
self.strokes2.setObjectName("strokes2")
40+
self.strokes_meter.addWidget(self.strokes2, 1, 0, 1, 1)
41+
self.strokes2_label = QtWidgets.QLabel(self.layoutWidget)
42+
self.strokes2_label.setAlignment(QtCore.Qt.AlignCenter)
43+
self.strokes2_label.setObjectName("strokes2_label")
44+
self.strokes_meter.addWidget(self.strokes2_label, 1, 1, 1, 1)
45+
self.strokes_meter.setColumnStretch(0, 2)
46+
self.strokes_meter.setColumnStretch(1, 1)
47+
self.layoutWidget1 = QtWidgets.QWidget(StrokesMeter)
48+
self.layoutWidget1.setGeometry(QtCore.QRect(0, 0, 181, 36))
49+
self.layoutWidget1.setObjectName("layoutWidget1")
50+
self.strokes_controls = QtWidgets.QGridLayout(self.layoutWidget1)
51+
self.strokes_controls.setContentsMargins(0, 0, 0, 0)
52+
self.strokes_controls.setSpacing(0)
53+
self.strokes_controls.setObjectName("strokes_controls")
54+
self.strokes_method = QtWidgets.QComboBox(self.layoutWidget1)
55+
self.strokes_method.setObjectName("strokes_method")
56+
self.strokes_controls.addWidget(self.strokes_method, 0, 0, 1, 1)
57+
58+
self.retranslateUi(StrokesMeter)
59+
QtCore.QMetaObject.connectSlotsByName(StrokesMeter)
60+
61+
def retranslateUi(self, StrokesMeter):
62+
_translate = QtCore.QCoreApplication.translate
63+
StrokesMeter.setWindowTitle(_translate("StrokesMeter", "Strokes Meter"))
64+
self.strokes1_label.setText(_translate("StrokesMeter", "last 10s"))
65+
self.strokes2_label.setText(_translate("StrokesMeter", "last 1m"))
66+

‎requirements-dev.txt

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1-
pytest==3.0.6
2-
pytest-pythonpath==0.7.1
31
mock==2.0.0
2+
pyqt-distutils==0.7.2
3+
pytest-pythonpath==0.7.1
4+
pytest==3.0.6

‎setup.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
cmdclass = {}
88

99
setup(
10-
name="Plover: WPM meter",
10+
name="Plover: WPM and strokes meter",
1111
version="0.1",
1212
description="A meter to show your typing speed in Plover.",
1313
author="Waleed Khan",
@@ -21,6 +21,7 @@
2121
entry_points="""
2222
[plover.gui.qt.tool]
2323
wpm_meter = plover_wpm_meter:PloverWpmMeter
24+
strokes_meter = plover_wpm_meter:PloverStrokesMeter
2425
""",
2526
cmdclass=cmdclass,
2627
)

0 commit comments

Comments
 (0)