Skip to content

Use explicit try/finally to ensure loops quit when receiving a signal #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 16, 2015
Merged

Use explicit try/finally to ensure loops quit when receiving a signal #116

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3241de5
Use explicit try/finally to ensure loops quit when receiving a signal
nicoddemus Dec 16, 2015
86e41e3
Implement proper clean up for MultiSignalBlocker
nicoddemus Dec 16, 2015
81b317c
Refactor signal disconnecting code
nicoddemus Dec 16, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 38 additions & 19 deletions pytestqt/wait_signal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,16 +48,14 @@ def wait(self):
self.timeout)

def _quit_loop_by_timeout(self):
self._loop.quit()
self._cleanup()
try:
self._cleanup()
finally:
self._loop.quit()

def _cleanup(self):
if self._timer is not None:
try:
self._timer.timeout.disconnect(self._quit_loop_by_timeout)
except (TypeError, RuntimeError):
# already disconnected by Qt?
pass
_silent_disconnect(self._timer.timeout, self._quit_loop_by_timeout)
self._timer.stop()
self._timer = None

Expand Down Expand Up @@ -119,19 +117,18 @@ def _quit_loop_by_signal(self, *args):
"""
quits the event loop and marks that we finished because of a signal.
"""
self.signal_triggered = True
self.args = list(args)
self._loop.quit()
self._cleanup()
try:
self.signal_triggered = True
self.args = list(args)
self._cleanup()
finally:
self._loop.quit()

def _cleanup(self):
super(SignalBlocker, self)._cleanup()
for signal in self._signals:
try:
signal.disconnect(self._quit_loop_by_signal)
except (TypeError, RuntimeError): # pragma: no cover
# already disconnected by Qt?
pass
_silent_disconnect(signal, self._quit_loop_by_signal)
self._signals = []


class MultiSignalBlocker(_AbstractSignalBlocker):
Expand All @@ -151,6 +148,7 @@ class MultiSignalBlocker(_AbstractSignalBlocker):
def __init__(self, timeout=1000, raising=False):
super(MultiSignalBlocker, self).__init__(timeout, raising=raising)
self._signals = {}
self._slots = {}

def _add_signal(self, signal):
"""
Expand All @@ -160,7 +158,9 @@ def _add_signal(self, signal):
:param signal: QtCore.Signal
"""
self._signals[signal] = False
signal.connect(functools.partial(self._signal_emitted, signal))
slot = functools.partial(self._signal_emitted, signal)
self._slots[signal] = slot
signal.connect(slot)

def _signal_emitted(self, signal):
"""
Expand All @@ -171,8 +171,18 @@ def _signal_emitted(self, signal):
"""
self._signals[signal] = True
if all(self._signals.values()):
self.signal_triggered = True
self._loop.quit()
try:
self.signal_triggered = True
self._cleanup()
finally:
self._loop.quit()

def _cleanup(self):
super(MultiSignalBlocker, self)._cleanup()
for signal, slot in self._slots.items():
_silent_disconnect(signal, slot)
self._signals.clear()
self._slots.clear()


class SignalTimeoutError(Exception):
Expand All @@ -184,3 +194,12 @@ class SignalTimeoutError(Exception):
"""
pass


def _silent_disconnect(signal, slot):
"""Disconnects a signal from a slot, ignoring errors. Sometimes
Qt might disconnect a signal automatically for unknown reasons.
"""
try:
signal.disconnect(slot)
except (TypeError, RuntimeError): # pragma: no cover
pass