added TerminableThread

CHANGELOG.md

 # v2.1.12
 
-* _TBA_
+* added [TerminableThread](satella/coding/concurrent/thread.py)
 
 # v2.1.11
 

docs/coding/concurrent.rst

@@ -12,3 +12,9 @@ LockedDataset
 
 .. autoclass:: satella.coding.concurrent.LockedDataset
     :members:
+
+TerminableThread
+----------------
+
+.. autoclass:: satella.coding.concurrent.TerminableThread
+    :members:

satella/__init__.py

 # coding=UTF-8
-__version__ = '2.1.12a1'
-
+__version__ = '2.1.12rc1'

satella/coding/concurrent/__init__.py

 from .callablegroup import *
 from .monitor import *
+from .thread import TerminableThread
 from .locked_dataset import LockedDataset
 
-__all__ = ['LockedDataset', 'Monitor', 'RMonitor', 'CallableGroup']
+__all__ = ['LockedDataset', 'Monitor', 'RMonitor', 'CallableGroup', 'TerminableThread']

satella/coding/concurrent/thread.py

+from threading import Thread
+
+
+class TerminableThread(Thread):
+    """
+    Class that will execute something in a loop unless terminated. Use like:
+
+    >>> class MeGrimlock(TerminableThread):
+    >>>     def loop(self):
+    >>>         ... do your operations ..
+    >>> a = MeGrimlock()
+    >>> a.start()
+    >>> a.terminate().join()
+
+    Flag whether to terminate is stored in self._terminating
+    """
+    def __init__(self):
+        super().__init__()
+        self._terminating = False
+
+    def loop(self) -> None:
+        pass
+
+    def run(self) -> None:
+        while not self._terminating:
+            self.loop()
+
+    def terminate(self) -> 'TerminableThread':
+        self._terminating = True
+        return self