Ward
Ward is a modern test framework for Python with a focus on productivity and readability.
Features
See the full set of features in the documentation.
Descriptive test names: describe what your tests do using strings, not function names.
@test("1 + 2 == 3")
def _():
assert 1 + 2 == 3
Modular test dependencies: manage test setup/teardown code using fixtures that rely on Python's import system, not name matching.
@fixture
def user():
return User(name="darren")
@test("the user is called darren")
def _(u=user):
assert u.name == "darren"
Support for asyncio: define your tests and fixtures with async def and call asynchronous code within them.
@fixture
async def user():
u = await create_user()
return await u.login()
@test("the logged in user has a last session date")
async def _(user=user):
last_session = await get_last_session_date(user.id)
assert is_recent(last_session, get_last_session_date)
Powerful test selection: limit your test run not only by matching test names/descriptions, but also on the code contained in the body of the test.
ward --search "Database.get_all_users"
Or use tag expressions for more powerful filtering.
ward --tags "(unit or integration) and not slow"
Parameterised testing: write a test once, and run it multiple times with different inputs by writing it in a loop.
for lhs, rhs, res in [
(1, 1, 2),
(2, 3, 5),
]:
@test("simple addition")
def _(left=lhs, right=rhs, result=res):
assert left + right == result
Cross platform: Tested on Mac OS, Linux, and Windows.
Zero config: Sensible defaults mean running ward with no arguments is enough to get started. Can be configured using pyproject.toml or the command line if required.
Colourful, human readable output: quickly pinpoint and fix issues with detailed output for failing tests.
Getting Started
Take a look at the "Getting Started" tutorial.
How to Contribute
Contributions are very welcome and encouraged!
See the contributing guide for information on how you can take part in the development of Ward.
Contributors
✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
2 Aug 3, 2022
963 Dec 28, 2022
5 Nov 21, 2022
2.6k Dec 27, 2022
714 Dec 21, 2022
1 Dec 30, 2021
2 Mar 9, 2022
17 Nov 15, 2022
2 Jun 17, 2022
1.6k Dec 29, 2022
1.6k Jan 6, 2023
129 Nov 28, 2022
382 Dec 27, 2022
756 Dec 22, 2022
3k Jan 5, 2023