Function pytest_sessionfinish

src/_pytest/tmpdir.py:315–340

After each session, remove base directory if all the tests passed, the policy is "failed", and the basetemp is not specified by a user.

(session, exitstatus: int | ExitCode)

def pytest_sessionfinish(session, exitstatus: int | ExitCode):
    """After each session, remove base directory if all the tests passed,
    the policy is "failed", and the basetemp is not specified by a user.
    """
    tmp_path_factory: TempPathFactory = session.config._tmp_path_factory
    basetemp = tmp_path_factory._basetemp
    if basetemp is None:
        return

    policy = tmp_path_factory._retention_policy
    if (
        exitstatus == 0
        and policy == "failed"
        and tmp_path_factory._given_basetemp is None
    ):
        if basetemp.is_dir():
            # We do a "best effort" to remove files, but it might not be possible due to some leaked resource,
            # permissions, etc, in which case we ignore it.
            rmtree(basetemp, ignore_errors=True)

    # Remove dead symlinks.
    if basetemp.is_dir():
        cleanup_dead_symlinks(basetemp)

    # Run the numbered dirs and lock file cleanups registered on the ExitStack.
    tmp_path_factory._exit_stack.close()


@hookimpl(wrapper=True, tryfirst=True)