Page MenuHomePhabricator
Create Task
Maniphest T154281

[recurring] Replace assertRaises with assertRaisesRegex
Open, LowPublic
Actions

Description

unittest.assertRaises is almost always lazy, and should be avoided.
The only desirable use of unittest.assertRaises is:

with self.assertRaises(ValueError) as cm:
    self.assertEqual(cm.exception, '.....')

unitest.assertRaisesRegex has an extra parameter to check the exception message, and should be used instead. By checking the exception message, the unit test verifies that the exception is precisely the one which was expected, rather than only of the same type as expected.
See: https://docs.python.org/3/library/unittest.html?highlight=assertraisesregex#unittest.TestCase.assertRaisesRegex

pywikibot hasunit test modules that use assertRaises and probably need upgrading:
https://codesearch.wmcloud.org/pywikibot/?q=assertRaises%5C(&i=nope&files=&excludeFiles=&repos=

Example: https://gerrit.wikimedia.org/r/#/c/330099/

Details

Related Changes in Gerrit:
SubjectRepoBranchLines +/-
Upgrade assertRaises to assertRaisesRegexpywikibot/coremaster+102 -52
Replace assertRaises with assertRaisesRegex in flow_tests.pypywikibot/coremaster+73 -33
[IMPR] Replace assertRaises with assertRaisesRegexpywikibot/coremaster+9 -4
[IMPR] move to assertRaisesRegexpywikibot/coremaster+6 -4
Replace assertRaises with assertRaisesRegex in api_tests.pypywikibot/coremaster+42 -21
Replace assertRaises with assertRaisesRegex in the several unittest filespywikibot/coremaster+184 -183
Replace assertRaises with assertRaisesRegex in isbn_tests.pypywikibot/coremaster+28 -8
Replace assertRaises with assertRaisesRegex in isbn_tests.pypywikibot/coremaster+53 -15
Replace assertRaises with assertRaisesRegex in isbn_tests.pypywikibot/coremaster+21 -8
Replace assertRaises with assertRaisesRegex in login_tests.pypywikibot/coremaster+3 -2
Replace assertRaises with assertRaisesRegex in namespace_tests.pypywikibot/coremaster+38 -20
Replace assertRaises with assertRaisesRegex in category_tests.pypywikibot/coremaster+11 -4
Change to use assertRaisesRegex in file_tests.pypywikibot/coremaster+36 -7
Change to use assertRaisesRegex in link_tests.pypywikibot/coremaster+99 -30
interwikidata_tests.py: Do not change config while performing testspywikibot/coremaster+9 -3
tests.page_tests: assertRaises => assertRaisesRegexpywikibot/coremaster+39 -17
Replace assertRaises with assertRaisesRegex in mediawikiversion_tests.pypywikibot/coremaster+9 -6
Replace assertRaises with assertRaisesRegex in http_tests.pypywikibot/coremaster+22 -18
Replace assertRaises with asserRaisesRegex in tools_tests.pypywikibot/coremaster+45 -16
Replace assertRaises with assertRaisesRegex in bot_tests.pypywikibot/coremaster+7 -5
Replace assertRaises with assertRaisesRegex in ui_options_tests.pypywikibot/coremaster+7 -5
Replace assertRaises with assertRaisesRegex in i18n_tests.pypywikibot/coremaster+2 -2
Replace assertRaises with asserRaisesRegex in family_tests.pypywikibot/coremaster+50 -12
Show related patches Customize query in gerrit

Related Objects

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes
gerritbot added a comment.Jan 31 2017, 7:58 AM

Change 331224 merged by jenkins-bot:
tests.page_tests: assertRaises => assertRaisesRegex

https://gerrit.wikimedia.org/r/331224

gerritbot added a comment.Mar 12 2017, 9:31 AM

Change 342325 had a related patch set uploaded (by Dalba):
[pywikibot/core] interwikidata_tests.py: Do not change config while performing tests

https://gerrit.wikimedia.org/r/342325

gerritbot added a comment.Mar 12 2017, 9:40 AM

Change 342325 merged by jenkins-bot:
[pywikibot/core] interwikidata_tests.py: Do not change config while performing tests

https://gerrit.wikimedia.org/r/342325

Dalba triaged this task as Low priority.May 5 2017, 3:34 AM
Xqt closed this task as Resolved.Jul 2 2017, 3:25 PM
Xqt claimed this task.
jayvdb reopened this task as Open.Oct 23 2017, 6:19 AM

This is not complete, and is suitable for GCI 2017

jayvdb claimed this task.Oct 23 2017, 6:19 AM
jayvdb updated the task description. (Show Details)
jayvdb added a subscriber: Xqt.
jayvdb added a project: Google-Code-in-2017.Oct 23 2017, 6:21 AM
MtDu subscribed.Oct 23 2017, 12:21 PM

@jayvdb I could help mentor this. Is the list above updated?

jayvdb renamed this task from Replace assertRaises with assertRaisesRegex to [recurring] Replace assertRaises with assertRaisesRegex.Oct 28 2017, 3:18 AM
jayvdb added a comment.EditedOct 28 2017, 3:20 AM

Yup you can mentor it, and I've updated the list.
Can just copy https://codein.withgoogle.com/dashboard/tasks/6553516124405760/
Archived at https://codein.withgoogle.com/archive/2016/organization/5709875686408192/task/4728573235560448/ (strange it is a different task ID)

Aklapper moved this task from Proposed tasks to Imported in GCI Site on the Google-Code-in-2017 board.Nov 25 2017, 8:41 PM

Imported for 2017 as https://codein.withgoogle.com/tasks/6278188768428032/

gerritbot added a comment.Nov 29 2017, 4:49 AM

Change 393990 had a related patch set uploaded (by Rafidaslam; owner: rafid):
[pywikibot/core@master] Change assertRaises to assertRaisesRegex in tests/file_tests.py

https://gerrit.wikimedia.org/r/393990

gerritbot added a comment.Dec 1 2017, 3:42 AM

Change 394520 had a related patch set uploaded (by Rafidaslam; owner: rafid):
[pywikibot/core@master] Change to use assertRaisesRegex in link_tests.py

https://gerrit.wikimedia.org/r/394520

gerritbot added a comment.Dec 1 2017, 12:23 PM

Change 394520 merged by jenkins-bot:
[pywikibot/core@master] Change to use assertRaisesRegex in link_tests.py

https://gerrit.wikimedia.org/r/394520

gerritbot added a comment.Dec 2 2017, 3:44 PM

Change 393990 merged by jenkins-bot:
[pywikibot/core@master] Change to use assertRaisesRegex in file_tests.py

https://gerrit.wikimedia.org/r/393990

gerritbot added a comment.Dec 9 2017, 12:33 PM

Change 396576 had a related patch set uploaded (by Divadsn; owner: Divadsn):
[pywikibot/core@master] Replace assertRaises with assertRaisesRegex in category_tests.py

https://gerrit.wikimedia.org/r/396576

gerritbot added a comment.Dec 9 2017, 2:31 PM

Change 396576 merged by jenkins-bot:
[pywikibot/core@master] Replace assertRaises with assertRaisesRegex in category_tests.py

https://gerrit.wikimedia.org/r/396576

gerritbot added a comment.Dec 9 2017, 6:01 PM

Change 396589 had a related patch set uploaded (by Divadsn; owner: Divadsn):
[pywikibot/core@master] Replace assertRaises with assertRaisesRegex in namespace_tests.py

https://gerrit.wikimedia.org/r/396589

gerritbot added a comment.Dec 10 2017, 11:27 AM

Change 396589 merged by jenkins-bot:
[pywikibot/core@master] Replace assertRaises with assertRaisesRegex in namespace_tests.py

https://gerrit.wikimedia.org/r/396589

Clockery subscribed.Dec 17 2017, 7:01 AM
gerritbot added a comment.Dec 19 2017, 3:48 AM

Change 399134 had a related patch set uploaded (by Ryan10145; owner: Ryan10145):
[pywikibot/core@master] Replace assertRaises with assertRaisesRegex in isbn_tests.py

https://gerrit.wikimedia.org/r/399134

gerritbot added a comment.Dec 19 2017, 3:49 PM

Change 399202 had a related patch set uploaded (by Clockery; owner: Clockery):
[pywikibot/core@master] Replace assertRaises with assertRaisesRegex in login_tests.py

https://gerrit.wikimedia.org/r/399202

gerritbot added a comment.Dec 19 2017, 4:44 PM

Change 399202 merged by jenkins-bot:
[pywikibot/core@master] Replace assertRaises with assertRaisesRegex in login_tests.py

https://gerrit.wikimedia.org/r/399202

gerritbot added a comment.Dec 20 2017, 5:04 AM

Change 399134 merged by jenkins-bot:
[pywikibot/core@master] Replace assertRaises with assertRaisesRegex in isbn_tests.py

https://gerrit.wikimedia.org/r/399134

gerritbot added a comment.Dec 20 2017, 7:20 AM

Change 399348 had a related patch set uploaded (by Xqt; owner: Ryan10145):
[pywikibot/core@master] Replace assertRaises with assertRaisesRegex in isbn_tests.py

https://gerrit.wikimedia.org/r/399348

gerritbot added a comment.Dec 20 2017, 2:17 PM

Change 399399 had a related patch set uploaded (by Clockery; owner: cf):
[pywikibot/core@master] Replace assertRaises with assertRaisesRegex in flow_tests.py

https://gerrit.wikimedia.org/r/399399

gerritbot added a comment.Jan 13 2018, 4:57 PM

Change 404085 had a related patch set uploaded (by Divadsn; owner: Divadsn):
[pywikibot/core@master] Replace assertRaises with assertRaisesRegex in isbn_tests.py

https://gerrit.wikimedia.org/r/404085

divadsn updated the task description. (Show Details)Jan 13 2018, 5:31 PM
divadsn updated the task description. (Show Details)
gerritbot added a comment.Jan 15 2018, 4:15 AM

Change 404085 merged by jenkins-bot:
[pywikibot/core@master] Replace assertRaises with assertRaisesRegex in isbn_tests.py

https://gerrit.wikimedia.org/r/404085

gerritbot added a comment.Jan 15 2018, 12:23 PM

Change 404285 had a related patch set uploaded (by Clockery; owner: cf):
[pywikibot/core@master] Replace assertRaises with assertRaisesRegex in api_tests.py

https://gerrit.wikimedia.org/r/404285

gerritbot added a comment.Jan 18 2018, 11:55 AM

Change 399348 abandoned by Dalba:
Replace assertRaises with assertRaisesRegex in isbn_tests.py

Reason:
9a13055ce9c130d832ebd273681e7bf4d5dd71a7

https://gerrit.wikimedia.org/r/399348

gerritbot added a comment.Jan 19 2018, 3:06 PM

Change 399348 restored by Dalba:
Replace assertRaises with assertRaisesRegex in isbn_tests.py

Reason:
T185317

https://gerrit.wikimedia.org/r/399348

• Phabricator_maintenance added a project: Pywikibot.Mar 23 2019, 10:17 PM
xSavitar moved this task from Backlog to Needs Review on the Pywikibot board.Apr 17 2019, 11:49 AM
Gopavasanth subscribed.Oct 12 2019, 3:14 AM

Any updates on this? If there is any work pending here we can move this to Google-Code-in-2019?

Xqt added a comment.Oct 12 2019, 9:12 AM
In T154281#5568101, @Gopavasanth wrote:

Any updates on this? If there is any work pending here we can move this to Google-Code-in-2019?

Sure.

Xqt removed jayvdb as the assignee of this task.Mar 26 2020, 7:20 PM
Dvorapa moved this task from Backlog to Framework on the Pywikibot-tests board.Apr 3 2020, 4:31 PM
gerritbot added a comment.Oct 7 2020, 10:44 AM

Change 399348 merged by Xqt:
[pywikibot/core@master] Replace assertRaises with assertRaisesRegex in isbn_tests.py

https://gerrit.wikimedia.org/r/399348

Xqt mentioned this in rPWBC0b288c6947fc: Replace assertRaises with assertRaisesRegex in isbn_tests.py.Oct 7 2020, 11:02 AM
Xqt removed a project: Patch-For-Review.Oct 7 2020, 8:28 PM
Xqt added a project: good first task.Jan 21 2021, 7:19 AM
gerritbot added a comment.May 3 2021, 3:22 PM

Change 684429 had a related patch set uploaded (by Ngwebecky96; author: Ngwebecky96):

[pywikibot/core@master] Replace assertRaises with assertRaisesRegex in the several unittest files

https://gerrit.wikimedia.org/r/684429

gerritbot added a project: Patch-For-Review.May 3 2021, 3:22 PM
Xqt updated the task description. (Show Details)May 4 2021, 7:48 AM
Xqt updated the task description. (Show Details)
Xqt added a subscriber: Ngwebecky96.Jun 1 2021, 2:13 PM

@Ngwebecky96: are you still working on this?

gerritbot added a comment.Jun 14 2021, 4:56 AM

Change 684429 abandoned by Xqt:

[pywikibot/core@master] Replace assertRaises with assertRaisesRegex in the several unittest files

Reason:

Not appropriate

https://gerrit.wikimedia.org/r/684429

Xqt removed a project: Patch-For-Review.Jun 14 2021, 4:57 AM
Gopavasanth unsubscribed.Jun 14 2021, 5:01 AM
gerritbot added a comment.May 23 2022, 6:09 AM

Change 404285 abandoned by Xqt:

[pywikibot/core@master] Replace assertRaises with assertRaisesRegex in api_tests.py

Reason:

too old, some tests were removed

https://gerrit.wikimedia.org/r/404285

gerritbot added a comment.Jul 1 2022, 4:32 PM

Change 810382 had a related patch set uploaded (by Vivian Rook; author: Vivian Rook):

[pywikibot/core@master] [IMPR] move to assertRaisesRegex

https://gerrit.wikimedia.org/r/810382

gerritbot added a project: Patch-For-Review.Jul 1 2022, 4:32 PM
gerritbot added a comment.Jul 1 2022, 7:40 PM

Change 810382 merged by jenkins-bot:

[pywikibot/core@master] [IMPR] move to assertRaisesRegex

https://gerrit.wikimedia.org/r/810382

Xqt removed a project: Patch-For-Review.Jul 1 2022, 10:23 PM
• rook subscribed.Jul 11 2022, 3:19 PM

I see one more of these in tests/utils.py though I'm unclear about how this is run. It does not appear to run through pytest (I would update tox.ini with a specific file to test, this one doesn't match the *tests.py pattern and ignoring that doesn't get it to run regardless). How would one run just the tests in utils.py?

Xqt added a comment.Jul 11 2022, 4:01 PM
In T154281#8069774, @rook wrote:

I see one more of these in tests/utils.py though I'm unclear about how this is run. It does not appear to run through pytest (I would update tox.ini with a specific file to test, this one doesn't match the *tests.py pattern and ignoring that doesn't get it to run regardless). How would one run just the tests in utils.py?

utils.py is not a test file itself but a library module for tests. All test files are ending with "tests" and are collected in tests.__init__.py, utils.py uses assertRaises inside the contextmanager AssertAPIErrorContextManager. The contextmanager is used in aspects to implement the assertAPIError method which is used for tests found here. For example you can test the flow_thanks_tests as follows:

  1. login your bot on testwiki: pwb login -site:wikipedia:test
  2. set the environment variable PYWIKIBOT_TEST_WRITE to 1 to enable write tests
  3. run the test script loacally: pwb -site:wikipedia:test flow_thanks_tests -v TestThankFlowPost.test_self_thank

The AssertAPIErrorContextManager contextmanager needs the exception message regex somehow e.g.:

def __init__(self, code, info, msg, test_case, regex=None):
    """Create instance expecting the code and info."""
    self.code = code
    self.info = info
    self.msg = msg
    self.test_case = test_case
    self.regex = regex

def __enter__(self):
    """Enter this context manager and the unittest's context manager."""
    if self.regex:
        self.cm = self.test_case.assertRaisesRegex(APIError, self.regex, msg=self.msg)
    else:
        self.cm = self.test_case.assertRaises(APIError, msg=self.msg)
    self.cm.__enter__()
    return self.cm
gerritbot added a comment.Jul 15 2022, 7:26 PM

Change 814235 had a related patch set uploaded (by Vivian Rook; author: Vivian Rook):

[pywikibot/core@master] [IMPR] Replace assertRaises with assertRaisesRegex

https://gerrit.wikimedia.org/r/814235

gerritbot added a project: Patch-For-Review.Jul 15 2022, 7:26 PM
gerritbot added a comment.Jul 17 2022, 5:15 PM

Change 814235 merged by jenkins-bot:

[pywikibot/core@master] [IMPR] Replace assertRaises with assertRaisesRegex

https://gerrit.wikimedia.org/r/814235

Xqt removed a project: Patch-For-Review.Jul 17 2022, 5:57 PM
Xqt moved this task from Needs Review to Backlog on the Pywikibot board.Sep 9 2022, 7:23 AM
gerritbot added a comment.Jul 28 2024, 10:25 AM

Change #399399 abandoned by Xqt:

[pywikibot/core@master] Replace assertRaises with assertRaisesRegex in flow_tests.py

Reason:

too old anf flow support will be dropped

https://gerrit.wikimedia.org/r/399399

Chickenleaf subscribed.Aug 28 2024, 5:59 PM

Hello! @jayvdb can i be assigned this? Im new to more organized large scale open-source projects and would like to begin my contribution to them with wikimedia.

Chickenleaf added a comment.Aug 28 2024, 6:27 PM

Hello! @jayvdb can i still work on this? are there more assertions to be changed/updated to regex?

Xqt added a comment.Oct 12 2024, 3:51 PM

Hi @Chickenleaf, you may work on this issue if you want to.
Here are the remaining parts to improve: https://codesearch.wmcloud.org/pywikibot/?q=assertRaises%5C(&i=nope&files=&excludeFiles=&repos=
but ignore tests/flow_tests.py because that module will be removed.

Tejashxv claimed this task.Sep 14 2025, 6:00 PM
gerritbot added a comment.Sep 14 2025, 6:19 PM

Change #1187987 had a related patch set uploaded (by Tejashxv; author: Tejashxv):

[pywikibot/core@master] upgrade assertRaises to assertRaisesRegex for better error validation

https://gerrit.wikimedia.org/r/1187987

gerritbot added a project: Patch-For-Review.Sep 14 2025, 6:19 PM
gerritbot added a comment.Oct 11 2025, 2:12 PM

Change #1187987 merged by jenkins-bot:

[pywikibot/core@master] Upgrade assertRaises to assertRaisesRegex

https://gerrit.wikimedia.org/r/1187987

Xqt removed a project: Patch-For-Review.Oct 11 2025, 4:58 PM
Tejashxv added a project: RoadToWiki.Oct 11 2025, 9:59 PM
Kavaljeet_Singh moved this task from Incoming to Completed on the RoadToWiki board.Oct 12 2025, 7:52 AM
Bharathvk1889 subscribed.Tue, Feb 3, 8:53 AM

Hi @Xqt, I noticed the previous patch was merged, but I ran the code search and found about 30 files that still use 'assertRaises' (like api_tests.py and datasite_tests.py). May I work on fixing these remaining instances?

Xqt removed Tejashxv as the assignee of this task.Tue, Feb 3, 3:04 PM
Xqt added a subscriber: Tejashxv.

Hi @Bharathvk1889, sure, there are still some remaining issues that you can work on. Please don’t try to fix them all in a single patch — split them, for example, by test file, as it’s easier to review smaller parts. I also recommend installing pre-commit and running the tool before submitting the patch. Please note that the repository is on Gerrit, not GitHub.

VishakhaSahu05 subscribed.Tue, Feb 3, 8:59 PM

Hi! I'm a beginner and would like to work on this task. Can someone guide me on how to start? I have set up my Gerrit account and SSH keys.

Xqt added a comment.Wed, Feb 4, 8:35 AM

Hi @Bharathvk1889 and @VishakhaSahu05, you can both work on this task. However, please make sure to coordinate and announce in advance which test files you intend to work on. Please also see the description in the introduction.

Important links

Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits