pytest

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Basic Test Structure

基础测试结构

python
import pytest

class TestUserService:
    def test_create_user_success(self):
        user = create_user(name="John", email="john@test.com")
        assert user.name == "John"
        assert user.email == "john@test.com"

    def test_create_user_invalid_email_fails(self):
        with pytest.raises(ValueError, match="Invalid email"):
            create_user(name="John", email="invalid")
python
import pytest

class TestUserService:
    def test_create_user_success(self):
        user = create_user(name="John", email="john@test.com")
        assert user.name == "John"
        assert user.email == "john@test.com"

    def test_create_user_invalid_email_fails(self):
        with pytest.raises(ValueError, match="Invalid email"):
            create_user(name="John", email="invalid")

Fixtures

Fixtures测试夹具

python
import pytest

@pytest.fixture
def user():
    """Create a test user."""
    return User(name="Test User", email="test@example.com")

@pytest.fixture
def authenticated_client(client, user):
    """Client with authenticated user."""
    client.force_login(user)
    return client
python
import pytest

@pytest.fixture
def user():
    """Create a test user."""
    return User(name="Test User", email="test@example.com")

@pytest.fixture
def authenticated_client(client, user):
    """Client with authenticated user."""
    client.force_login(user)
    return client

Fixture with teardown

Fixture with teardown

@pytest.fixture def temp_file(): path = Path("/tmp/test_file.txt") path.write_text("test content") yield path # Test runs here path.unlink() # Cleanup after test
@pytest.fixture def temp_file(): path = Path("/tmp/test_file.txt") path.write_text("test content") yield path # Test runs here path.unlink() # Cleanup after test

Fixture scopes

Fixture scopes

@pytest.fixture(scope="module") # Once per module @pytest.fixture(scope="class") # Once per class @pytest.fixture(scope="session") # Once per test session
undefined
@pytest.fixture(scope="module") # Once per module @pytest.fixture(scope="class") # Once per class @pytest.fixture(scope="session") # Once per test session
undefined

conftest.py

conftest.py共享配置文件

python
undefined
python
undefined

tests/conftest.py - Shared fixtures

tests/conftest.py - Shared fixtures

import pytest
@pytest.fixture def db_session(): session = create_session() yield session session.rollback()
@pytest.fixture def api_client(): return TestClient(app)
undefined
import pytest
@pytest.fixture def db_session(): session = create_session() yield session session.rollback()
@pytest.fixture def api_client(): return TestClient(app)
undefined

Mocking

Mocking模拟测试

python
from unittest.mock import patch, MagicMock

class TestPaymentService:
    def test_process_payment_success(self):
        with patch("services.payment.stripe_client") as mock_stripe:
            mock_stripe.charge.return_value = {"id": "ch_123", "status": "succeeded"}

            result = process_payment(amount=100)

            assert result["status"] == "succeeded"
            mock_stripe.charge.assert_called_once_with(amount=100)

    def test_process_payment_failure(self):
        with patch("services.payment.stripe_client") as mock_stripe:
            mock_stripe.charge.side_effect = PaymentError("Card declined")

            with pytest.raises(PaymentError):
                process_payment(amount=100)
python
from unittest.mock import patch, MagicMock

class TestPaymentService:
    def test_process_payment_success(self):
        with patch("services.payment.stripe_client") as mock_stripe:
            mock_stripe.charge.return_value = {"id": "ch_123", "status": "succeeded"}

            result = process_payment(amount=100)

            assert result["status"] == "succeeded"
            mock_stripe.charge.assert_called_once_with(amount=100)

    def test_process_payment_failure(self):
        with patch("services.payment.stripe_client") as mock_stripe:
            mock_stripe.charge.side_effect = PaymentError("Card declined")

            with pytest.raises(PaymentError):
                process_payment(amount=100)

MagicMock for complex objects

MagicMock for complex objects

def test_with_mock_object(): mock_user = MagicMock() mock_user.id = "user-123" mock_user.name = "Test User" mock_user.is_active = True
result = get_user_info(mock_user)
assert result["name"] == "Test User"
undefined
def test_with_mock_object(): mock_user = MagicMock() mock_user.id = "user-123" mock_user.name = "Test User" mock_user.is_active = True
result = get_user_info(mock_user)
assert result["name"] == "Test User"
undefined

Parametrize

Parametrize参数化测试

python
@pytest.mark.parametrize("input,expected", [
    ("hello", "HELLO"),
    ("world", "WORLD"),
    ("pytest", "PYTEST"),
])
def test_uppercase(input, expected):
    assert input.upper() == expected

@pytest.mark.parametrize("email,is_valid", [
    ("user@example.com", True),
    ("invalid-email", False),
    ("", False),
    ("user@.com", False),
])
def test_email_validation(email, is_valid):
    assert validate_email(email) == is_valid
python
@pytest.mark.parametrize("input,expected", [
    ("hello", "HELLO"),
    ("world", "WORLD"),
    ("pytest", "PYTEST"),
])
def test_uppercase(input, expected):
    assert input.upper() == expected

@pytest.mark.parametrize("email,is_valid", [
    ("user@example.com", True),
    ("invalid-email", False),
    ("", False),
    ("user@.com", False),
])
def test_email_validation(email, is_valid):
    assert validate_email(email) == is_valid

Markers

Markers测试标记

python
undefined
python
undefined

pytest.ini or pyproject.toml

pytest.ini or pyproject.toml

[tool.pytest.ini_options] markers = [ "slow: marks tests as slow", "integration: marks integration tests", ]
[tool.pytest.ini_options] markers = [ "slow: marks tests as slow", "integration: marks integration tests", ]

Usage

Usage

@pytest.mark.slow def test_large_data_processing(): ...
@pytest.mark.integration def test_database_connection(): ...
@pytest.mark.skip(reason="Not implemented yet") def test_future_feature(): ...
@pytest.mark.skipif(sys.platform == "win32", reason="Unix only") def test_unix_specific(): ...
@pytest.mark.slow def test_large_data_processing(): ...
@pytest.mark.integration def test_database_connection(): ...
@pytest.mark.skip(reason="Not implemented yet") def test_future_feature(): ...
@pytest.mark.skipif(sys.platform == "win32", reason="Unix only") def test_unix_specific(): ...

Run specific markers

Run specific markers

pytest -m "not slow"

pytest -m "not slow"

pytest -m "integration"

pytest -m "integration"

undefined
undefined

Async Tests

异步测试

python
import pytest

@pytest.mark.asyncio
async def test_async_function():
    result = await async_fetch_data()
    assert result is not None
python
import pytest

@pytest.mark.asyncio
async def test_async_function():
    result = await async_fetch_data()
    assert result is not None

Commands

常用命令

bash
pytest                          # Run all tests
pytest -v                       # Verbose output
pytest -x                       # Stop on first failure
pytest -k "test_user"           # Filter by name
pytest -m "not slow"            # Filter by marker
pytest --cov=src                # With coverage
pytest -n auto                  # Parallel (pytest-xdist)
pytest --tb=short               # Short traceback
bash
pytest                          # Run all tests
pytest -v                       # Verbose output
pytest -x                       # Stop on first failure
pytest -k "test_user"           # Filter by name
pytest -m "not slow"            # Filter by marker
pytest --cov=src                # With coverage
pytest -n auto                  # Parallel (pytest-xdist)
pytest --tb=short               # Short traceback

References

参考资料

For general pytest documentation, see:
For Prowler SDK testing with provider-specific patterns (moto, MagicMock), see:
  • Documentation: references/prowler-testing.md
关于pytest的通用文档,请查看:
针对使用特定提供商模式(moto、MagicMock)的Prowler SDK测试,请查看:
  • 文档: references/prowler-testing.md