test_memory_leaks.py

from __future__ import annotations

import gc
import sys

import pytest

from prompt_toolkit.shortcuts.prompt import PromptSession


def _count_prompt_session_instances() -> int:
    # Run full GC collection first.
    gc.collect()

    # Count number of remaining referenced `PromptSession` instances.
    objects = gc.get_objects()
    return len([obj for obj in objects if isinstance(obj, PromptSession)])


# This test used to fail in GitHub CI, probably due to GC differences.
# Still fails on Windows due to win32.NoConsoleScreenBufferError.
@pytest.mark.skipif(
    sys.platform.startswith("win"),
    reason="Fails in GitHug CI due to win32.NoConsoleScreenBufferError",
)
def test_prompt_session_memory_leak() -> None:
    before_count = _count_prompt_session_instances()

    # Somehow in CI/CD, the before_count is > 0
    assert before_count == 0

    p = PromptSession()

    after_count = _count_prompt_session_instances()
    assert after_count == before_count + 1

    del p

    after_delete_count = _count_prompt_session_instances()
    assert after_delete_count == before_count