Session-scoped temporary directories in pytest

I habitually use the tmpdir fixture in pytest to get a temporary directory that will be cleaned up after each test, but that doesn't work with scope="session" - which can be used to ensure an expensive fixture is run only once per test session and the generated content is used for multiple tests.

To get a temporary directory that works with scope="session", use the tmp_path_factory built-in pytest fixture like this:

import pytest


@pytest.fixture(scope="session")
def template_dir(tmp_path_factory):
    template_dir = tmp_path_factory.mktemp("page-templates")
    pages_dir = template_dir / "pages"
    pages_dir.mkdir()
    (pages_dir / "about.html").write_text("ABOUT!", "utf-8")
    (pages_dir / "request.html").write_text("request", "utf-8")
    return template_dir


def test_about(template_dir):
    assert "ABOUT!" == (template_dir / "pages" / "about.html").read_text()


def test_request(template_dir):
    assert "request" == (template_dir / "pages" / "request.html").read_text()

Example: https://github.com/simonw/datasette/blob/1b7b66c465e44025ec73421bd69752e42f108321/tests/test_custom_pages.py#L16-L45

Related

• cookiecutter Testing cookiecutter templates with pytest - 2021-01-27
• pytest Start a server in a subprocess during a pytest session - 2020-08-31
• pytest Show files opened by pytest tests - 2022-12-11
• pytest Async fixtures with pytest-asyncio - 2022-03-19
• pytest Registering temporary pluggy plugins inside tests - 2020-07-21
• readthedocs Using custom Sphinx templates on Read the Docs - 2020-12-07
• pytest pytest coverage with context - 2022-03-04
• pytest Using pytest and Playwright to test a JavaScript web application - 2022-07-24
• django Writing tests for the Django admin with pytest-django - 2021-03-02
• pytest Mocking subprocess with pytest-subprocess - 2023-03-08

Created 2020-04-26T20:47:07-07:00 · Edit