tmp_dir: add cat

Author: skshetry

pytest_test_utils/tmp_dir.py

@@ -33,3 +33,8 @@ def chdir(self) -> Iterator[None]:
             yield
         finally:
             os.chdir(old)
+
+    def cat(self):
+        if self.is_dir():
+            return {p.name: p.cat() for p in self.iterdir()}
+        return self.read_text(encoding="utf-8")

pytest_test_utils/tmp_dir.pyi

@@ -9,6 +9,8 @@ AnyStruct = Dict[AnyPath[T], Union[Text, Dict[AnyPath[T], Any]]]
 StrStruct = AnyStruct[str]
 BytesStruct = AnyStruct[bytes]
 
+CatStruct = Union[str, Dict[str, Union[str, Dict[str, Any]]]]
+
 class TmpDir(Path):
     @overload
     def gen(self, struct: AnyPath[T], text: Text = "") -> List[T]: ...
@@ -17,3 +19,4 @@ class TmpDir(Path):
     @overload
     def gen(self, struct: StrStruct, text: Text = "") -> List[str]: ...
     def chdir(self) -> ContextManager[None]: ...
+    def cat(self) -> CatStruct: ...

tests.py

@@ -51,3 +51,11 @@ def test_chdir(tmp_path: Path, tmp_dir: TmpDir) -> None:
         assert Path.cwd() == subdir
         assert Path.cwd() == tmp_path / "dir"
         assert Path.cwd() == tmp_dir / "dir"
+
+
+def test_cat(tmp_dir: TmpDir) -> None:
+    tmp_dir.gen({"dir": {"file": "lorem ipsum"}})
+
+    assert tmp_dir.cat() == {"dir": {"file": "lorem ipsum"}}
+    assert (tmp_dir / "dir").cat() == {"file": "lorem ipsum"}
+    assert (tmp_dir / "dir" / "file").cat() == "lorem ipsum"