Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

A modern Python testing framework

Project description

Ward

Build PyPI version Gitter All Contributors

See the full documentation and feature set here.

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

screenshot

Features

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 call it multiple times with different inputs

@test("truncate('{text}', num_chars={num_chars}) returns '{expected}'")
def _(
    text=s,
    num_chars=each(20, 11, 10, 5),
    expected=each(s, s, "hello w...", "he..."),
):
    result = truncate(text, num_chars)
    assert result == expected

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.

This project is currently in beta.

Planned features:

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

Let me know if you'd like to help out with any of these features!

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

Darren Burns
Darren Burns

💻 📖 🤔 👀 🐛 💡
khusrokarim
khusrokarim

🤔 💻 🐛
Alec Jordan
Alec Jordan

💻
Jason C. McDonald
Jason C. McDonald

💻 🤔
Andy Kluger
Andy Kluger

💻 🤔
thebigmunch
thebigmunch

💻
Tyler Couto
Tyler Couto

💻
Thibaut Le Page
Thibaut Le Page

💻
Dorian Czichotzki
Dorian Czichotzki

💻 🤔
jayesh hathila
jayesh hathila

💻
Mandar Vaze
Mandar Vaze

💻

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

Project details


Release history Release notifications | RSS feed

Download files

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

Files for ward, version 0.44.0b0
Filename, size File type Python version Upload date Hashes
Filename, size ward-0.44.0b0-py3-none-any.whl (28.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size ward-0.44.0b0.tar.gz (27.1 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