Merge branch 'master' into qt-api-ini

Author: nicoddemus

CHANGELOG.rst

@@ -40,15 +40,20 @@ New Features
   is met or a timeout is reached. Useful for testing asynchronous features 
   (like in X window environments for example).
 
-* Now which Qt binding ``pytest-qt`` should use can be configured by the ``qt_api`` config option.
+* ``waitSignal`` and ``waitSignals`` can receive an optional callback that can
+  evaluate if the arguments of emitted signals should resume execution or not.
+  Thanks `@MShekow`_ for the PR (`#141`_).
+
+* Now which Qt binding ``pytest-qt`` will use can be configured by the ``qt_api`` config option.
   Thanks `@The-Compiler`_ for the request (`#129`_).
 
-- While ``pytestqt.qt_compat`` is an internal module and shouldn't be imported directly,
+* While ``pytestqt.qt_compat`` is an internal module and shouldn't be imported directly,
   it is known that some test suites did import it. This module now uses a lazy-load mechanism
   to load Qt classes and objects, so the old symbols (``QtCore``, ``QApplication``, etc.) are
   no longer available from it.
 
 .. _#134: https://github.com/pytest-dev/pytest-qt/issues/134
+.. _#141: https://github.com/pytest-dev/pytest-qt/pull/141
 .. _#63: https://github.com/pytest-dev/pytest-qt/pull/63
 .. _#129: https://github.com/pytest-dev/pytest-qt/issues/129
 
@@ -369,13 +374,14 @@ Small bug fix release.
 First working version.
 
 
-.. _@The-Compiler: https://github.com/The-Compiler
-.. _@montefra: https://github.com/montefra
-.. _@gqmelo: https://github.com/gqmelo
-.. _@jdreaver: https://github.com/jdreaver
+.. _@baudren: https://github.com/baudren
+.. _@billyshambrook: https://github.com/billyshambrook
 .. _@datalyze-solutions: https://github.com/datalyze-solutions
 .. _@fabioz: https://github.com/fabioz
-.. _@baudren: https://github.com/baudren
+.. _@gqmelo: https://github.com/gqmelo
 .. _@itghisi: https://github.com/itghisi
+.. _@jdreaver: https://github.com/jdreaver
+.. _@montefra: https://github.com/montefra
+.. _@MShekow: https://github.com/MShekow
 .. _@Sheeo: https://github.com/Sheeo
-.. _@billyshambrook: https://github.com/billyshambrook
+.. _@The-Compiler: https://github.com/The-Compiler

pytestqt/qtbot.py

@@ -225,17 +225,18 @@ def waitSignal(self, signal=None, timeout=1000, raising=None, check_params_cb=No
             This defaults to ``True`` unless ``qt_wait_signal_raising = false``
             is set in the config.
         :param Callable check_params_cb:
-            Optional callable(*parameters) that compares the provided signal parameters to some expected parameters.
+            Optional ``callable(*parameters)`` that compares the provided signal parameters to some expected parameters.
             It has to match the signature of ``signal`` (just like a slot function would) and return ``True`` if
             parameters match, ``False`` otherwise.
         :returns:
             ``SignalBlocker`` object. Call ``SignalBlocker.wait()`` to wait.
 
         .. note::
-           Cannot have both ``signals`` and ``timeout`` equal ``None``, or
-           else you will block indefinitely. We throw an error if this occurs.
+            Cannot have both ``signals`` and ``timeout`` equal ``None``, or
+            else you will block indefinitely. We throw an error if this occurs.
 
-        .. note:: This method is also available as ``wait_signal`` (pep-8 alias)
+        .. note::
+            This method is also available as ``wait_signal`` (pep-8 alias)
         """
         if raising is None:
             raising_val = self._request.config.getini('qt_wait_signal_raising')
@@ -289,12 +290,16 @@ def waitSignals(self, signals=None, timeout=1000, raising=None, check_params_cbs
             Instead of a specific callable, ``None`` can be provided, to disable parameter checking for the
             corresponding signal.
             If the number of callbacks doesn't match the number of signals ``ValueError`` will be raised.
-        :param str order: determines the order in which to expect signals
-            * ``"none"``: no order is enforced
-            * ``"strict"``: signals have to be emitted strictly in the provided order
-                (e.g. fails when expecting signals [a, b] and [a, a, b] is emitted)
-            * ``"simple"``: like "strict", but signals may be emitted in-between the provided ones, e.g. expected
-                ``signals`` == [a, b, c] and actually emitted signals = [a, a, b, a, c] works (would fail with "strict")
+        :param str order:
+            Determines the order in which to expect signals:
+
+            - ``"none"``: no order is enforced
+            - ``"strict"``: signals have to be emitted strictly in the provided order
+              (e.g. fails when expecting signals [a, b] and [a, a, b] is emitted)
+            - ``"simple"``: like "strict", but signals may be emitted in-between the provided ones, e.g. expected
+              ``signals == [a, b, c]`` and actually emitted ``signals = [a, a, b, a, c]`` works
+              (would fail with ``"strict"``).
+
         :returns:
             ``MultiSignalBlocker`` object. Call ``MultiSignalBlocker.wait()``
             to wait.