Fixed several small issues.

Author: NameZero912

docs/signals.rst

@@ -211,7 +211,7 @@ Getting emitted signals and arguments
 
 To determine which of the expected signals were emitted during a ``wait()`` you can use
 ``blocker.all_signals_and_args`` which contains a list of
-:class:`wait_signal.SignalAndArgs <SignalAndArgs>` ``namedtuple`` objects, indicating the signals (and their arguments)
+:class:`wait_signal.SignalAndArgs <SignalAndArgs>` objects, indicating the signals (and their arguments)
 in the order they were received.
 
 

pytestqt/qtbot.py

@@ -219,7 +219,7 @@ def waitSignal(self, signal=None, timeout=1000, raising=None, check_params_cb=No
            The *check_params_cb* parameter.
 
         :param Signal signal:
-            A signal to wait for, or a tuple (signal, signal_name_as_str) to improve the error message that is part
+            A signal to wait for, or a tuple ``(signal, signal_name_as_str)`` to improve the error message that is part
             of ``SignalTimeoutError``. Set to ``None`` to just use timeout.
         :param int timeout:
             How many milliseconds to wait before resuming control flow.

pytestqt/wait_signal.py

@@ -48,7 +48,6 @@ def wait(self):
             self._timer.start()
         self._loop.exec_()
         if not self.signal_triggered and self.raising:
-            # raise SignalTimeoutError("Didn't get signal after %sms." % self.timeout)
             raise SignalTimeoutError(self._timeout_message)
 
     def _quit_loop_by_timeout(self):
@@ -70,22 +69,21 @@ def get_timeout_error_message(self):
 
     def _extract_pyqt_signal_name(self, potential_pyqt_signal):
         signal_name = potential_pyqt_signal.signal  # type: str
-        if type(signal_name) != str:
+        if not isinstance(signal_name, str):
             raise TypeError("Invalid 'signal' attribute in {}. "
                             "Expected str but got {}".format(signal_name, type(signal_name)))
         # strip magic number "2" that PyQt prepends to the signal names
-        if signal_name.startswith("2"):
-            signal_name = signal_name.lstrip('2')
+        signal_name = signal_name.lstrip('2')
         return signal_name
 
     def _extract_signal_from_signal_tuple(self, potential_signal_tuple):
-        if type(potential_signal_tuple) is tuple:
+        if isinstance(potential_signal_tuple, tuple):
             if len(potential_signal_tuple) != 2:
-                raise AssertionError("Signal tuple must have length of 2 (first element is the signal, "
-                                     "the second element is the signal's name).")
+                raise ValueError("Signal tuple must have length of 2 (first element is the signal, "
+                                 "the second element is the signal's name).")
             signal_tuple = potential_signal_tuple
             signal_name = signal_tuple[1]
-            if type(signal_name) != str or not signal_name:
+            if not isinstance(signal_name, str) or not signal_name:
                 raise TypeError("Invalid type for user-provided signal name, "
                                 "expected str but got {}".format(type(signal_name)))
             return signal_name
@@ -125,7 +123,7 @@ def get_callback_name(self, callback):
 
     @staticmethod
     def get_signal_from_potential_signal_tuple(signal_tuple):
-        if type(signal_tuple) is tuple:
+        if isinstance(signal_tuple, tuple):
             return signal_tuple[0]
         return signal_tuple
 
@@ -236,36 +234,36 @@ def get_timeout_error_message(self):
                                                    cb_name=self.get_callback_name(self.check_params_callback))
         else:
             return "Signal {signal_name} not emitted after {timeout} ms".format(signal_name=self.signal_name,
-                                                                               timeout=self.timeout)
+                                                                                timeout=self.timeout)
 
 
-SignalAndArgs = namedtuple("SignalAndArgs", ["signal_name", "args"])
+class SignalAndArgs:
+    def __init__(self, signal_name, args):
+        self.signal_name = signal_name
+        self.args = args
 
+    def _get_readable_signal_with_optional_args(self):
+        args = repr(self.args) if self.args else ""
 
-def _get_readable_signal_with_optional_args(self):
-    if self.args:
-        args_as_string = []
-        for arg in self.args:
-            if type(arg) is str:
-                args_as_string.append("'" + str(arg) + "'")
-            else:
-                args_as_string.append(str(arg))
-        args_as_list_string = ", ".join(args_as_string) if len(args_as_string) > 1 else args_as_string[0]
-        args = "({})".format(args_as_list_string)
-    else:
-        args = ""
+        # remove signal parameter signature, e.g. turn "some_signal(QString,int)" to "some_signal", because we're adding
+        # the actual parameters anyways
+        signal_name = self.signal_name
+        signal_name = signal_name.partition('(')[0]
 
-    # remove signal parameter signature, e.g. turn "some_signal(QString,int)" to "some_signal", because we're adding
-    # the actual parameters anyways
-    signal_name = self.signal_name
-    if '(' in signal_name:
-        signal_name = signal_name[:signal_name.index('(')]
+        return signal_name + args
 
-    return signal_name + args
+    def __str__(self):
+        return self._get_readable_signal_with_optional_args()
 
+    def __repr__(self):
+        return self._get_readable_signal_with_optional_args()
+
+    def __eq__(self, other):
+        if isinstance(other, self.__class__):
+            return self.__dict__ == other.__dict__
+        else:
+            return False
 
-SignalAndArgs.__str__ = _get_readable_signal_with_optional_args
-SignalAndArgs.__repr__ = _get_readable_signal_with_optional_args
 
 # Returns e.g. "3rd" for 3, or "21st" for 21
 get_ordinal_str = lambda n: "%d%s" % (n, {1: "st", 2: "nd", 3: "rd"}.get(n if n < 20 else n % 10, "th"))
@@ -400,8 +398,9 @@ def _check_signal_match(self, unique_signal, *args):
                     self._signal_expected_index += 1
                     self._strict_order_violated = False  # order has not been violated after all!
                 else:
-                    self._actual_signal_and_args_at_violation = SignalAndArgs(
-                        signal_name=self._signal_names[unique_signal], args=args)
+                    if self._are_signal_names_available():
+                        self._actual_signal_and_args_at_violation = SignalAndArgs(
+                            signal_name=self._signal_names[unique_signal], args=args)
 
     def _all_signals_emitted(self):
         return not self._strict_order_violated and all(self._signals_emitted)

tests/test_wait_signal.py

@@ -2,6 +2,7 @@
 import fnmatch
 
 import pytest
+import sys
 
 from pytestqt.qt_compat import qt_api
 from pytestqt.wait_signal import SignalEmittedError, SignalTimeoutError, SignalAndArgs
@@ -702,7 +703,7 @@ def get_mixed_signals_with_guaranteed_name(signaller):
 
 class TestAllSignalsAndArgs:
     """
-    Tests blocker.all_signals_and_args (waitSignals() blocker) is filled with the namedtuple SignalAndArgs for each
+    Tests blocker.all_signals_and_args (waitSignals() blocker) is a list of SignalAndArgs objects, one for each
     received expected signal (irrespective of the order parameter).
     """
 
@@ -738,7 +739,7 @@ def test_non_empty_on_timeout_no_cb(self, qtbot, signaller):
                                raising=False) as blocker:
             signaller.signal_args.emit('1', 1)
             signaller.signal.emit()
-        assert blocker.signal_triggered is False
+        assert not blocker.signal_triggered
         assert blocker.all_signals_and_args == [
             SignalAndArgs(signal_name='signal_args(QString,int)', args=('1', 1)),
             SignalAndArgs(signal_name='signal()', args=())
@@ -755,14 +756,17 @@ def test_non_empty_no_cb(self, qtbot, signaller):
             signaller.signal.emit()
             signaller.signal_args.emit('1', 1)
             signaller.signal_args.emit('2', 2)
-        assert blocker.signal_triggered is True
+        assert blocker.signal_triggered
         assert blocker.all_signals_and_args == [
             SignalAndArgs(signal_name='signal()', args=()),
             SignalAndArgs(signal_name='signal_args(QString,int)', args=('1', 1)),
             SignalAndArgs(signal_name='signal_args(QString,int)', args=('2', 2))
         ]
 
 
+PY_2 = sys.version_info[0] == 2
+
+
 class TestWaitSignalSignalTimeoutErrorMessage:
     """Tests that the messages of SignalTimeoutError are formatted correctly, for waitSignal() calls."""
 
@@ -801,8 +805,8 @@ def arg_validator(int_param):
                 signaller.signal_single_arg.emit(1)
                 signaller.signal_single_arg.emit(2)
         ex_msg = TestWaitSignalsSignalTimeoutErrorMessage.get_exception_message(excinfo)
-        assert ex_msg == "Signal signal_single_arg(int) emitted with parameters [1, 2] within 200 ms, " \
-                         "but did not satisfy the arg_validator callback"
+        assert ex_msg == ("Signal signal_single_arg(int) emitted with parameters [1, 2] within 200 ms, "
+                          "but did not satisfy the arg_validator callback")
 
     def test_with_multiple_args(self, qtbot, signaller):
         """
@@ -820,11 +824,14 @@ def arg_validator(str_param, int_param):
 
         with pytest.raises(SignalTimeoutError) as excinfo:
             with qtbot.waitSignal(signal=signal, timeout=200, check_params_cb=arg_validator, raising=True):
-                signaller.signal_args.emit('1', 1)
+                signaller.signal_args.emit("1", 1)
                 signaller.signal_args.emit('2', 2)
         ex_msg = TestWaitSignalsSignalTimeoutErrorMessage.get_exception_message(excinfo)
-        assert ex_msg == "Signal signal_args(QString,int) emitted with parameters [('1', 1), ('2', 2)] " \
-                         "within 200 ms, but did not satisfy the arg_validator callback"
+        parameters = "[('1', 1), ('2', 2)]"
+        if PY_2:
+            parameters = "[(u'1', 1), (u'2', 2)]"
+        assert ex_msg == ("Signal signal_args(QString,int) emitted with parameters {} "
+                          "within 200 ms, but did not satisfy the arg_validator callback").format(parameters)
 
 
 class TestWaitSignalsSignalTimeoutErrorMessage:
@@ -845,8 +852,8 @@ def my_callback(str_param, int_param):
                                    check_params_cbs=[None, None, my_callback], order=order, raising=True):
                 pass  # don't emit any signals
         ex_msg = TestWaitSignalsSignalTimeoutErrorMessage.get_exception_message(excinfo)
-        assert ex_msg == "Emitted signals: None. Missing: " \
-                         "[signal(), signal_args(QString,int), signal_args(QString,int) (callback: my_callback)]"
+        assert ex_msg == ("Emitted signals: None. Missing: "
+                          "[signal(), signal_args(QString,int), signal_args(QString,int) (callback: my_callback)]")
 
     @pytest.mark.parametrize("order", ["none", "simple", "strict"])
     def test_no_signal_emitted_no_callbacks(self, qtbot, signaller, order):
@@ -859,8 +866,8 @@ def test_no_signal_emitted_no_callbacks(self, qtbot, signaller, order):
                                    check_params_cbs=None, order=order, raising=True):
                 pass  # don't emit any signals
         ex_msg = TestWaitSignalsSignalTimeoutErrorMessage.get_exception_message(excinfo)
-        assert ex_msg == "Emitted signals: None. Missing: " \
-                         "[signal(), signal_args(QString,int), signal_args(QString,int)]"
+        assert ex_msg == ("Emitted signals: None. Missing: "
+                          "[signal(), signal_args(QString,int), signal_args(QString,int)]")
 
     def test_none_order_one_signal_emitted(self, qtbot, signaller):
         """
@@ -879,8 +886,11 @@ def my_callback_2(str_param, int_param):
                                    check_params_cbs=[None, my_callback_1, my_callback_2], order="none", raising=True):
                 signaller.signal_args.emit("1", 1)
         ex_msg = TestWaitSignalsSignalTimeoutErrorMessage.get_exception_message(excinfo)
-        assert ex_msg == "Emitted signals: [signal_args('1', 1)]. Missing: " \
-                         "[signal(), signal_args(QString,int) (callback: my_callback_2)]"
+        signal_args = "'1', 1"
+        if PY_2:
+            signal_args = "u'1', 1"
+        assert ex_msg == ("Emitted signals: [signal_args({})]. Missing: "
+                          "[signal(), signal_args(QString,int) (callback: my_callback_2)]").format(signal_args)
 
     def test_simple_order_first_signal_emitted(self, qtbot, signaller):
         """
@@ -892,8 +902,8 @@ def test_simple_order_first_signal_emitted(self, qtbot, signaller):
                                    check_params_cbs=None, order="simple", raising=True):
                 signaller.signal.emit()
         ex_msg = TestWaitSignalsSignalTimeoutErrorMessage.get_exception_message(excinfo)
-        assert ex_msg == "Emitted signals: [signal]. Missing: " \
-                         "[signal_args(QString,int), signal_args(QString,int)]"
+        assert ex_msg == ("Emitted signals: [signal]. Missing: "
+                          "[signal_args(QString,int), signal_args(QString,int)]")
 
     def test_simple_order_second_signal_emitted(self, qtbot, signaller):
         """
@@ -905,8 +915,11 @@ def test_simple_order_second_signal_emitted(self, qtbot, signaller):
                                    check_params_cbs=None, order="simple", raising=True):
                 signaller.signal_args.emit("1", 1)
         ex_msg = TestWaitSignalsSignalTimeoutErrorMessage.get_exception_message(excinfo)
-        assert ex_msg == "Emitted signals: [signal_args('1', 1)]. Missing: " \
-                         "[signal(), signal_args(QString,int), signal_args(QString,int)]"
+        signal_args = "'1', 1"
+        if PY_2:
+            signal_args = "u'1', 1"
+        assert ex_msg == ("Emitted signals: [signal_args({})]. Missing: "
+                          "[signal(), signal_args(QString,int), signal_args(QString,int)]").format(signal_args)
 
     def test_strict_order_violation(self, qtbot, signaller):
         """
@@ -920,9 +933,13 @@ def test_strict_order_violation(self, qtbot, signaller):
                 signaller.signal_args.emit("1", 1)
                 signaller.signal.emit()
         ex_msg = TestWaitSignalsSignalTimeoutErrorMessage.get_exception_message(excinfo)
-        assert ex_msg == "Signal order violated! Expected signal() as 1st signal, " \
-                         "but received signal_args('1', 1) instead. Emitted signals: [signal_args('1', 1), signal]. " \
-                         "Missing: [signal(), signal_args(QString,int), signal_args(QString,int)]"
+        signal_args = "'1', 1"
+        if PY_2:
+            signal_args = "u'1', 1"
+        assert ex_msg == ("Signal order violated! Expected signal() as 1st signal, "
+                          "but received signal_args({}) instead. Emitted signals: [signal_args({}), signal]. "
+                          "Missing: [signal(), signal_args(QString,int), signal_args(QString,int)]").format(signal_args,
+                                                                                                            signal_args)
 
     def test_degenerate_error_msg(self, qtbot, signaller):
         """
@@ -939,9 +956,9 @@ def test_degenerate_error_msg(self, qtbot, signaller):
                                    raising=True):
                 signaller.signal.emit()
         ex_msg = TestWaitSignalsSignalTimeoutErrorMessage.get_exception_message(excinfo)
-        assert ex_msg == "Received 1 of the 3 expected signals. " \
-                         "To improve this error message, provide the names of the signals " \
-                         "in the waitSignals() call."
+        assert ex_msg == ("Received 1 of the 3 expected signals. "
+                          "To improve this error message, provide the names of the signals "
+                          "in the waitSignals() call.")
 
     def test_self_defined_signal_name(self, qtbot, signaller):
         """
@@ -959,8 +976,8 @@ def my_cb(str_param, int_param):
                                    raising=True):
                 pass
         ex_msg = TestWaitSignalsSignalTimeoutErrorMessage.get_exception_message(excinfo)
-        assert ex_msg == "Emitted signals: None. " \
-                         "Missing: [signal_without_args, signal_with_args (callback: my_cb)]"
+        assert ex_msg == ("Emitted signals: None. "
+                          "Missing: [signal_without_args, signal_with_args (callback: my_cb)]")
 
     @staticmethod
     def get_exception_message(excinfo):