Ward

See the full documentation and feature set here.

A modern Python test framework designed to help you find and fix flaws faster.

Features

This project is a work in progress. Some of the features that are currently available in a basic form are listed below.

• Descriptive test names: describe what your tests do using strings, not function names.
• Modular test dependencies: manage test setup/teardown code using fixtures that rely on Python's import system, not name matching.
• 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.
• Colourful, human readable output: quickly pinpoint and fix issues with detailed output for failing tests.
• Expect API: A simple but powerful assertion API inspired by Jest.
• Cross platform: Tested on Mac OS, Linux, and Windows.
• Zero config: Sensible defaults mean running ward with no arguments is enough to get started.

Planned features:

• Smart test execution order designed to surface failures faster (using various heuristics)
• Multi-process mode to improve performance
• Highly configurable output modes
• Code coverage with --coverage flag
• Handling flaky tests with test-specific retries, timeouts
• Plugin system

Getting Started

Install Ward with pip install ward.

Write your first test in test_sum.py (module name must start with "test"):

from ward import expect, test

@test("1 plus 2 equals 3")
def _():
    expect(1 + 2).equals(3)

Now run your test with ward (no arguments needed). Ward will output the following:

 PASS  test_sum: 1 plus 2 equals 3

You've just wrote your first test with Ward, congrats!

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):

Darren Burns 💻 📖 🤔 👀 🐛 💡

khusrokarim 🤔

This project follows the all-contributors specification. Contributions of any kind welcome!