gh-71339: Add additional assertion methods for unittest by serhiy-storchaka · Pull Request #128707 · python/cpython

serhiy-storchaka · 2025-01-10T13:10:15Z

Add the following methods:

assertHasAttr() and assertNotHasAttr()
assertIsSubclass() and assertNotIsSubclass()
assertStartsWith() and assertNotStartsWith()
assertEndsWith() and assertNotEndsWith()

Also improve error messages for assertIsInstance() and assertNotIsInstance().

Issue: Additional assert methods for unittest #71339

📚 Documentation preview 📚: https://cpython-previews--128707.org.readthedocs.build/

Add the following methods: * assertHasAttr() and assertNotHasAttr() * assertIsSubclass() and assertNotIsSubclass() * assertStartswith() and assertNotStartswith() * assertEndswith() and assertNotEndswith() Also improve error messages for assertIsInstance() and assertNotIsInstance().

hugovk · 2025-01-10T13:31:16Z

Great!

assertStartsWith() and assertEndsWith() has been renamed to assertStartswith() and assertEndswith().

I recommend assertStartsWith() and assertEndsWith(), both for readability, and for accessibility -- screen readers will have a better chance with the extra capitals.

It doesn't really matter that startswith is all lower case, because we're creating a new method name.

(And we already have assertIsInstance, which checks isinstance, and not assertIsinstance.)

serhiy-storchaka · 2025-01-10T13:53:57Z

I wrote them initially as assertStartsWith() and assertEndsWith(), but renamed to assertStartswith() and assertEndswith() as the result of the discussion on the issue.

serhiy-storchaka · 2025-01-10T14:06:39Z

I created a poll: https://discuss.python.org/t/assertstartwith-vs-assertstartwith/76701.

JelleZijlstra

Looks good but I agree with Hugo that the name should be assertStartsWith.

cjw296 · 2025-01-11T18:20:56Z

Looks like the poll is pretty unanimous :-)

The changes look great, but I'll admit I'm unlikely to use them as I tend to avoid the UnitTest base class where possible now.

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

vstinner

LGTM. Just a few minor coding style remarks.

vstinner · 2025-01-13T07:55:17Z

 if not isinstance(obj, cls):
- standardMsg = '%s is not an instance of %r' % (safe_repr(obj), cls)
+ if isinstance(cls, tuple):
+ standardMsg = '%s is not an instance of any of %r' % (safe_repr(obj), cls)


You may use f-strings :-)

Actually, '%s is not an instance of any of %r' % (safe_repr(obj), cls) and f'{safe_repr(obj)!s} is not an instance of any of {cls!r}' produce the same bytecode. So the difference is only in readability, which is at large part subjective. I was not sure that inlining expressions in f-strings would make the code more readable, but if you think so...

vstinner · 2025-01-13T07:55:41Z


+ def assertIsSubclass(self, cls, superclass, msg=None):
+ try:
+ r = issubclass(cls, superclass)


You may avoid variables of a single letter: use "res" or "result". Same remark for new functions below.

picnixz

Just some docs nits and LGTM. I'm very happy to have assertHasAttr because I needed it a lot in my personal projects.

vstinner · 2025-01-14T08:04:13Z

Nice additions, thanks @serhiy-storchaka.

…honGH-128707) Add a mix-in class ExtraAssertions containing the following methods: * assertHasAttr() and assertNotHasAttr() * assertIsSubclass() and assertNotIsSubclass() * assertStartsWith() and assertNotStartsWith() * assertEndsWith() and assertNotEndsWith() (cherry picked from commit 06cad77)

bedevere-app · 2025-01-14T08:53:32Z

GH-128815 is a backport of this pull request to the 3.13 branch.

…honGH-128707) Add a mix-in class ExtraAssertions containing the following methods: * assertHasAttr() and assertNotHasAttr() * assertIsSubclass() and assertNotIsSubclass() * assertStartsWith() and assertNotStartsWith() * assertEndsWith() and assertNotEndsWith() (cherry picked from commit 06cad77)

…-128707) (GH-128815) Add a mix-in class ExtraAssertions containing the following methods: * assertHasAttr() and assertNotHasAttr() * assertIsSubclass() and assertNotIsSubclass() * assertStartsWith() and assertNotStartsWith() * assertEndsWith() and assertNotEndsWith() (cherry picked from commit 06cad77)

…t.support (pythonGH-128707) (pythonGH-128815) Add a mix-in class ExtraAssertions containing the following methods: * assertHasAttr() and assertNotHasAttr() * assertIsSubclass() and assertNotIsSubclass() * assertStartsWith() and assertNotStartsWith() * assertEndsWith() and assertNotEndsWith() (cherry picked from commit c6a566e) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> (cherry picked from commit 06cad77)

…-128707) (GH-128815) (GH-129059) Add a mix-in class ExtraAssertions containing the following methods: * assertHasAttr() and assertNotHasAttr() * assertIsSubclass() and assertNotIsSubclass() * assertStartsWith() and assertNotStartsWith() * assertEndsWith() and assertNotEndsWith() (cherry picked from commit c6a566e) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> (cherry picked from commit 06cad77)

serhiy-storchaka requested review from AlexWaygood, FFY00, JelleZijlstra, cjw296, jaraco, vsajip and warsaw as code owners January 10, 2025 13:10

bedevere-appBot mentioned this pull request Jan 10, 2025
Additional assert methods for unittest #71339
Closed

bedevere-appBot added the awaiting core review label Jan 10, 2025

Fix references: "with" instead of "With".
b825e23

JelleZijlstra reviewed Jan 11, 2025
View reviewed changes

Spell "With" instead of "with".
a54e693

cjw296 removed their request for review January 11, 2025 18:21

hugovk reviewed Jan 11, 2025
View reviewed changes

Comment threadDoc/library/unittest.rst Outdated
Comment threadDoc/library/unittest.rst Outdated
Comment threadDoc/whatsnew/3.14.rst Outdated

jaraco approved these changes Jan 11, 2025
View reviewed changes

bedevere-appBot added awaiting merge and removed awaiting core review labels Jan 11, 2025

Apply suggestions from code review
85509f6
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

vstinner approved these changes Jan 13, 2025
View reviewed changes

Remove variable r.
bfe98aa

hugovk approved these changes Jan 13, 2025
View reviewed changes

Use f-strings.
89b1577

picnixz approved these changes Jan 13, 2025
View reviewed changes

Comment threadDoc/library/unittest.rst
Comment threadDoc/library/unittest.rst

Double empty lines.
c703dc9

serhiy-storchaka merged commit 06cad77 into python:mainJan 14, 2025

bedevere-appBot removed the awaiting merge label Jan 14, 2025

serhiy-storchaka deleted the extra-assertions branch January 14, 2025 08:02

Uh oh!

Uh oh!

Conversation

serhiy-storchaka commented Jan 10, 2025• edited by hugovk Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hugovk commented Jan 10, 2025

Uh oh!

serhiy-storchaka commented Jan 10, 2025

Uh oh!

serhiy-storchaka commented Jan 10, 2025

Uh oh!

JelleZijlstra left a comment

Choose a reason for hiding this comment

Uh oh!

cjw296 commented Jan 11, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vstinner left a comment

Choose a reason for hiding this comment

Uh oh!

vstinnerJan 13, 2025

Choose a reason for hiding this comment

Uh oh!

serhiy-storchakaJan 13, 2025

Choose a reason for hiding this comment

Uh oh!

vstinnerJan 13, 2025

Choose a reason for hiding this comment

Uh oh!

picnixz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

vstinner commented Jan 14, 2025

Uh oh!

bedevere-appBot commented Jan 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

serhiy-storchaka commented Jan 10, 2025•
edited by hugovk
Loading