Function tortoise_test_context

tortoise/context.py:526–597

Async context manager for isolated test database setup. This is the recommended way to set up Tortoise ORM for testing with pytest. Each call creates a completely isolated context with its own: - ConnectionHandler (no global state pollution) - Apps registry - Database (crea

(
    modules: list[str],
    db_url: str = "sqlite://:memory:",
    app_label: str = "models",
    *,
    connection_label: str | None = None,
    use_tz: bool = True,
    timezone: str = "UTC",
    routers: list[str | type] | None = None,
)

@asynccontextmanager
async def tortoise_test_context(
    modules: list[str],
    db_url: str = "sqlite://:memory:",
    app_label: str = "models",
    *,
    connection_label: str | None = None,
    use_tz: bool = True,
    timezone: str = "UTC",
    routers: list[str | type] | None = None,
) -> AsyncIterator[TortoiseContext]:
    """
    Async context manager for isolated test database setup.

    This is the recommended way to set up Tortoise ORM for testing with pytest.
    Each call creates a completely isolated context with its own:
    - ConnectionHandler (no global state pollution)
    - Apps registry
    - Database (created fresh, cleaned up on exit)
    - Timezone and router configuration

    Example with pytest-asyncio:
        @pytest_asyncio.fixture
        async def db():
            async with tortoise_test_context(["myapp.models"]) as ctx:
                yield ctx

        @pytest.mark.asyncio
        async def test_create_user(db):
            user = await User.create(name="Alice")
            assert user.id is not None

    Features:
    - Creates isolated TortoiseContext (no global state pollution)
    - Creates fresh database and generates schemas
    - Cleans up connections on exit
    - xdist-safe (each worker gets own context)

    Args:
        modules: List of module paths to discover models from.
        db_url: Database URL, defaults to in-memory SQLite.
        app_label: The app label for the models, defaults to "models".
        connection_label: The connection alias name. If None, defaults to "default".
        use_tz: If True, datetime fields will be timezone-aware.
        timezone: Timezone to use, defaults to "UTC".
        routers: List of database router paths or classes.

    Yields:
        An initialized TortoiseContext ready for use.
    """
    import warnings

    from tortoise.warnings import TortoiseLoopSwitchWarning

    with warnings.catch_warnings():
        warnings.filterwarnings("ignore", category=TortoiseLoopSwitchWarning)
        ctx = TortoiseContext()
        async with ctx:
            config = generate_config(