Skip to main content
Help the Python Software Foundation raise $60,000 USD by December 31st!  Building the PSF Q4 Fundraiser

show where your regex match assertion failed!

Project description

Build Status Azure DevOps coverage


show where your regex match assertion failed!


pip install re-assert


re-assert provides a helper class to make assertions of regexes simpler.

re_assert.Matches(pattern: str, *args, **kwargs)

construct a Matches object.

note: under the hood, re-assert uses the regex library for matching, any *args / **kwargs that regex.compile supports will work. in general, the regex library is 100% compatible with the re library (and will even accept its flags, etc.)

re_assert.Matches.from_pattern(pattern: Pattern[str]) -> Matches

construct a Matches object from an already-compiled regex.

this is useful (for instance) if you're testing an existing compiled regex.

>>> import re
>>> reg = re.compile('foo')
>>> Matches.from_pattern(reg) == 'fork'
>>> Matches.from_pattern(reg) == 'food'

Matches.__eq__(other) (==)

the equality operator is overridden for use with assertion frameworks such as pytest

>>> pat = Matches('foo')
>>> pat == 'bar'
>>> pat == 'food'

Matches.__repr__() (repr(...))

a side-effect of an equality failure changes the repr(...) of a Matches object. this allows for useful pytest assertion messages:

>       assert Matches('foo') == 'fork'
E       AssertionError: assert Matches('foo'...ork\n    #    ^ == 'fork'
E         -Matches('foo')\n
E         -    # regex failed to match at:\n
E         -    #\n
E         -    #> fork\n
E         -    #    ^
E         +'fork'

Matches.assert_matches(s: str)

if you're using some other test framework, this method is useful for producing a readable traceback

>>> Matches('foo').assert_matches('food')
>>> Matches('foo').assert_matches('fork')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/asottile/workspace/re-assert/", line 63, in assert_matches
    assert self == s, self._fail
AssertionError:  regex failed to match at:

> fork

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for re-assert, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size re_assert-1.1.0-py2.py3-none-any.whl (4.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size re_assert-1.1.0.tar.gz (3.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page