Add a "stream" method to PathPlus

Author: domdfcoding

domdf_python_tools/paths.py

@@ -938,6 +938,22 @@ def move(self: _PP, dst: PathLike) -> _PP:
 		new_path = shutil.move(os.fspath(self), dst)
 		return self.__class__(new_path)
 
+	def stream(self, chunk_size: int = 1024) -> Iterator[bytes]:
+		"""
+		Stream the file in ``chunk_size`` sized chunks.
+
+		:param chunk_size: The chunk size, in bytes
+
+		.. versionadded:: 3.2.0
+		"""
+
+		with self.open("rb") as fp:
+			while True:
+				chunk = fp.read(chunk_size)
+				if not chunk:
+					break
+				yield chunk
+
 
 class PosixPathPlus(PathPlus, pathlib.PurePosixPath):
 	"""

tests/test_paths.py

@@ -1031,3 +1031,9 @@ def test_dont_move_dir_in_itself(self, move_example_file: PathPlus):
 
 		with pytest.raises(shutil.Error):
 			move_example_file.parent.move(dst)
+
+
+def test_stream(tmp_pathplus: PathPlus, advanced_data_regression: AdvancedDataRegressionFixture):
+	the_file = tmp_pathplus / "file.dat"
+	the_file.write_text("The quick brown fox jumps over the lazy dog" * 100)
+	advanced_data_regression.check(list(map(bytes.decode, the_file.stream(chunk_size=10))))