jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/831187 )

Change subject: [doc] Documentation for tests.utils.skipping ......................................................................

[doc] Documentation for tests.utils.skipping

Change-Id: I8c80c4056d692147a46d61399211ce8a3d7c762b --- M tests/utils.py 1 file changed, 33 insertions(+), 2 deletions(-)

Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified

diff --git a/tests/utils.py b/tests/utils.py index 805ea62..9d1d86b 100644 --- a/tests/utils.py +++ b/tests/utils.py @@ -11,6 +11,7 @@ import warnings from contextlib import contextmanager from subprocess import PIPE, Popen, TimeoutExpired +from typing import Optional

import pywikibot from pywikibot import config @@ -517,8 +518,38 @@

@contextmanager -def skipping(*exceptions, msg=None): - """Context manager to skip test on specified exceptions.""" +def skipping(*exceptions: BaseException, msg: Optional[str] = None): + """Context manager to skip test on specified exceptions. + + For example Eventstreams raises ``NotImplementedError`` if no + ``streams`` parameter was given. Skip the following tests in that + case:: + + with skipping(NotImplementedError): + self.es = comms.eventstreams.EventStreams(streams=None) + self.assertIsInstance(self.es, tools.collections.GeneratorWrapper) + + The exception message is used for the ``SkipTest`` reason. To use a + custom message, add a ``msg`` parameter:: + + with skipping(AssertionError, msg='T304786'): + self.assertEqual(self.get_mainpage().oldest_revision.text, text) + + Multiple context expressions may also be used:: + + with ( + skipping(OtherPageSaveError), + self.assertRaisesRegex(SpamblacklistError, 'badsite.com'), + ): + page.save() + + .. note:: The last sample uses Python 3.10 syntax. + + .. versionadded:: 6.2 + + :param msg: Optional skipping reason + :param exceptions: Exceptions to let test skip + """ try: yield except exceptions as e: