tools.conftest

 1"""Configure `doctest` tests for the `install` script."""
 2
 3from __future__ import annotations
 4
 5from collections.abc import Callable
 6from pathlib import Path
 7from typing import Any, TypeAlias
 8from unittest.mock import MagicMock
 9
10import pytest
11
12PathT: TypeAlias = Callable[..., Path]
13
14
15# pylint: disable=redefined-outer-name
16
17
18@pytest.fixture
19def mock_path(tmp_path: Path) -> PathT:
20    """Mock `pathlib.Path` to return a temporary directory."""
21    count = 0
22
23    def _mock_path(*args: str | Path) -> Path:
24        """Mock `pathlib.Path` to return a temporary directory instead of '.cn'."""
25        if len(args) == 1 and args[0] == '.cn':
26            nonlocal count, tmp_path
27            args = (tmp_path / str(count) / '.cn',)
28            count += 1
29        return Path(*args)
30
31    return _mock_path
32
33
34@pytest.fixture(autouse=True)
35def install_doctest_namespace(
36    _mock_install_io: None,  # pylint: disable=unused-argument
37    _mock_contextlib_closing: None,  # pylint: disable=unused-argument
38    _mock_urlopen_for_pypi: MagicMock,  # pylint: disable=unused-argument
39    mock_path: PathT,
40    doctest_namespace: dict[str, Any],
41) -> dict[str, Any]:
42    """Configure globals for `doctest` tests in the `install` script."""
43    doctest_namespace['Path'] = mock_path
44    doctest_namespace['pytest'] = pytest
45    return doctest_namespace