add tmp_dir_factory fixture

Author: skshetry

pytest_test_utils/__init__.py

@@ -1,4 +1,5 @@
 from ._any import ANY
 from .tmp_dir import TmpDir
+from .tmp_dir_factory import TempDirFactory
 
-__all__ = ["ANY", "TmpDir"]
+__all__ = ["ANY", "TmpDir", "TempDirFactory"]

pytest_test_utils/pytest_plugin.py

@@ -2,8 +2,14 @@
 from typing import Iterator
 
 import pytest
+from pytest import TempPathFactory
 
-from .tmp_dir import TmpDir
+from . import TempDirFactory, TmpDir
+
+
+@pytest.fixture(scope="session")
+def tmp_dir_factory(tmp_path_factory: TempPathFactory) -> TempDirFactory:
+    return TempDirFactory(tmp_path_factory)
 
 
 @pytest.fixture

pytest_test_utils/tmp_dir_factory.py

@@ -0,0 +1,19 @@
+from typing import TYPE_CHECKING
+
+from .tmp_dir import TmpDir
+
+if TYPE_CHECKING:
+    from pytest import TempPathFactory
+
+
+class TempDirFactory:
+    def __init__(self, tmp_path_factory: "TempPathFactory") -> None:
+        self.tmp_path_factory: "TempPathFactory" = tmp_path_factory
+
+    def mktemp(self, basename: str, numbered: bool = True) -> TmpDir:
+        return TmpDir(
+            self.tmp_path_factory.mktemp(basename, numbered=numbered)
+        )
+
+    def getbasetemp(self) -> TmpDir:
+        return TmpDir(self.tmp_path_factory.getbasetemp())

tests.py

@@ -4,6 +4,7 @@
 import pytest
 
 from pytest_test_utils import ANY, TmpDir
+from pytest_test_utils.tmp_dir_factory import TempDirFactory
 
 
 def test_any() -> None:
@@ -71,3 +72,16 @@ def test_cat(tmp_dir: TmpDir) -> None:
     assert tmp_dir.cat() == {"dir": {"file": "lorem ipsum"}}
     assert (tmp_dir / "dir").cat() == {"file": "lorem ipsum"}
     assert (tmp_dir / "dir" / "file").cat() == "lorem ipsum"
+
+
+def test_tmp_dir_factory(tmp_dir_factory: TempDirFactory) -> None:
+    tmp_dir = tmp_dir_factory.mktemp("test-dir")
+    assert isinstance(tmp_dir, TmpDir)
+    assert isinstance(tmp_dir, os.PathLike)
+    assert isinstance(tmp_dir, Path)
+    assert "test-dir0" in tmp_dir.name
+
+    tmp_dir.gen({"foo": "foo"})
+    assert tmp_dir.cat() == {"foo": "foo"}
+
+    assert "test-dir1" in tmp_dir_factory.mktemp("test-dir").name