Outcomes

Control test execution with skip, fail, and xfail.

graph LR
    subgraph "Outcome Functions"
        A[skip] --> B[Skip test]
        C[fail] --> D[Fail explicitly]
        E[xfail] --> F[Expected failure]
        G[importorskip] --> H[Skip if import fails]
    end

    classDef func fill:#6366F1,stroke:#7C90A0,color:#fff
    classDef desc fill:#F59E0B,stroke:#7C90A0,color:#fff

    class A,C,E,G func
    class B,D,F,H desc

skip()

Skip the current test:

from testagent import skip

def test_feature():
    if not feature_available():
        skip("Feature not available")
    # test code

fail()

Explicitly fail a test:

from testagent import fail

def test_something():
    if unexpected_condition():
        fail("Unexpected condition occurred")

xfail()

Mark test as expected to fail:

from testagent import xfail

def test_known_bug():
    xfail("Known bug #123")
    # This test is expected to fail

importorskip()

Skip if module is not available:

from testagent import importorskip

def test_numpy_feature():
    np = importorskip("numpy")
    # Use numpy

def test_pandas_version():
    pd = importorskip("pandas", minversion="1.0.0")
    # Use pandas >= 1.0.0

Parameters:

Parameter	Type	Description
modname	str	Module name to import
minversion	str	Minimum version required
reason	str	Custom skip reason

Exception Classes

Class	Description
Skipped	Raised when test is skipped
Failed	Raised when test fails explicitly
XFailed	Raised for expected failures

from testagent import Skipped, Failed, XFailed

try:
    skip("reason")
except Skipped as e:
    print(f"Skipped: {e}")