Skip to main content

A modern Python 3 test framework for finding and fixing flaws faster.

Project description

Ward

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"

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

💻 🤔

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.

Source Distribution

ward-0.38.0b0.tar.gz (655.1 kB view details)

Uploaded Source

Built Distribution

ward-0.38.0b0-py3-none-any.whl (26.6 kB view details)

Uploaded Python 3

File details

Details for the file ward-0.38.0b0.tar.gz.

File metadata

  • Download URL: ward-0.38.0b0.tar.gz
  • Upload date:
  • Size: 655.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.23.0

File hashes

Hashes for ward-0.38.0b0.tar.gz
Algorithm Hash digest
SHA256 781759f9223b474404d8731d56272de6d64205f6902036ed15854c196422e9e2
MD5 be1eec1c1a0e0e2a45f7f740b487d761
BLAKE2b-256 efb385027d42cb5d157a5fe47d7bf11a2ea3fad5f1bee0ad30ebee77399a38bf

See more details on using hashes here.

File details

Details for the file ward-0.38.0b0-py3-none-any.whl.

File metadata

  • Download URL: ward-0.38.0b0-py3-none-any.whl
  • Upload date:
  • Size: 26.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.23.0

File hashes

Hashes for ward-0.38.0b0-py3-none-any.whl
Algorithm Hash digest
SHA256 473844f63297d744feb603b1ccc473874a9dbc12f09499513445ff6dbed03ee6
MD5 bac8ee9640ce23c1bb2196e991200a2c
BLAKE2b-256 fd0173510d9ac44c5911979eaf90edd64c0e8993ccd822cc0260ebce0a1e12b1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page