| 1 |
# |
| 2 |
# This file is part of the PyMeasure package. |
| 3 |
# |
| 4 |
# Copyright (c) 2013-2024 PyMeasure Developers |
| 5 |
# |
| 6 |
# Permission is hereby granted, free of charge, to any person obtaining a copy |
| 7 |
# of this software and associated documentation files (the "Software"), to deal |
| 8 |
# in the Software without restriction, including without limitation the rights |
| 9 |
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 10 |
# copies of the Software, and to permit persons to whom the Software is |
| 11 |
# furnished to do so, subject to the following conditions: |
| 12 |
# |
| 13 |
# The above copyright notice and this permission notice shall be included in |
| 14 |
# all copies or substantial portions of the Software. |
| 15 |
# |
| 16 |
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 17 |
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 18 |
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 19 |
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 20 |
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 21 |
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| 22 |
# THE SOFTWARE. |
| 23 |
# |
| 24 |
|
| 25 |
import logging |
| 26 |
|
| 27 |
from threading import Event |
| 28 |
|
| 29 |
from .Qt import QtCore |
| 30 |
|
| 31 |
log = logging.getLogger(__name__) |
| 32 |
log.addHandler(logging.NullHandler()) |
| 33 |
|
| 34 |
|
| 35 |
class StoppableQThread(QtCore.QThread): |
| 36 |
""" Base class for QThreads which require the ability |
| 37 |
to be stopped by a thread-safe method call |
| 38 |
""" |
| 39 |
|
| 40 |
def __init__(self, parent=None): |
| 41 |
super().__init__(parent) |
| 42 |
self._should_stop = Event() |
| 43 |
self._should_stop.clear() |
| 44 |
|
| 45 |
def join(self, timeout=0): |
| 46 |
""" Joins the current thread and forces it to stop after |
| 47 |
the timeout if necessary |
| 48 |
|
| 49 |
:param timeout: Timeout duration in seconds |
| 50 |
""" |
| 51 |
self._should_stop.wait(timeout) |
| 52 |
if not self.should_stop(): |
| 53 |
self.stop() |
| 54 |
super().wait() |
| 55 |
|
| 56 |
def stop(self): |
| 57 |
self._should_stop.set() |
| 58 |
|
| 59 |
def should_stop(self): |
| 60 |
return self._should_stop.is_set() |
| 61 |
|
| 62 |
def __repr__(self): |
| 63 |
return "<{}(should_stop={})>".format( |
| 64 |
self.__class__.__name__, self.should_stop()) |