Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Fetching contributors…
Cannot retrieve contributors at this time
65 lines (35 sloc) 2.15 KB

Should-DSL: Improve readability for should-style expectations

The goal of Should-DSL is to write should expectations in Python as clear and readable as possible, using "almost" natural language (limited - sometimes - by the Python language constraints).

In order to use this DSL, you need to import should and should_not objects from should_dsl module.

For example:

>>> from should_dsl import should

>>> 1 |should| equal_to(1)
>>> 'should' |should| include('oul')
>>> 3 |should| be_into([0, 1, 2])
Traceback (most recent call last):
ShouldNotSatisfied: 3 is not into [0, 1, 2]

The equal_to matcher verifies object equality. If you want to ensure identity, you must use be as matcher:

>>> 2 |should| be(2)

A nice example of exceptions would be:

>>> def raise_zerodivisionerror():
...     return 1/0
>>> raise_zerodivisionerror |should| throw(ZeroDivisionError)

should has a negative version: should_not:

>>> from should_dsl import should_not

>>> 2 |should_not| be_into([1, 3, 5])
>>> 'should' |should_not| include('oul')
Traceback (most recent call last):
ShouldNotSatisfied: 'should' does include 'oul'

All Should-DSL releases before 2.0 uses a deprecated style, although we still support this old style, it will be dropped soon and we discourage you to use that style. Old style usage like:

>>> 3 |should_not.equal_to| 2.99

should be written as:

>>> 3 |should_not| equal_to(2.99)

should_dsl module offers should_be, should_have and their negative counterparts to be used with no matchers - but all old style:

>>> from should_dsl import should_be, should_have

>>> [1, 2] |should_have| 1

>>> 1 |should_be| 1

This new syntax for writing expectations has been changed because the requirement to have a single "right value" had been a limition to write new matchers and add other enhancements to Should-DSL and you should update the code that uses old style, because we plan to remove them soon.

Jump to Line
Something went wrong with that request. Please try again.