Add new functions to PathPlus to read and write lines of text and JSON data.

Author: domdfcoding

domdf_python_tools/paths.py

@@ -35,11 +35,13 @@
 #
 
 # stdlib
+import json
 import os
 import pathlib
 import shutil
 import stat
-from typing import IO, Any, Callable, Optional
+import types
+from typing import IO, Any, Callable, Iterable, List, Optional
 
 # this package
 from domdf_python_tools.typing import PathLike
@@ -403,6 +405,26 @@ def write_text(
 
 		return super().write_text(data, encoding=encoding, errors=errors)
 
+	def write_lines(
+			self,
+			data: Iterable[str],
+			encoding: Optional[str] = "UTF-8",
+			errors: Optional[str] = None,
+			) -> None:
+		"""
+		Open the file in text mode, write the given list of lines to it without trailing spaces,
+		and close the file.
+
+		:param data:
+		:type data: str
+		:param encoding: The encoding to write to the file using.
+		:param errors:
+
+		.. versionadded:: 0.5.0
+		"""
+
+		return self.write_clean("\n".join(data), encoding=encoding, errors=errors)
+
 	def read_text(
 			self,
 			encoding: Optional[str] = "UTF-8",
@@ -421,6 +443,25 @@ def read_text(
 
 		return super().read_text(encoding=encoding, errors=errors)
 
+	def read_lines(
+			self,
+			encoding: Optional[str] = "UTF-8",
+			errors: Optional[str] = None,
+			) -> List[str]:
+		"""
+		Open the file in text mode, return a list containing the lines in the file,
+		and close the file.
+
+		:param encoding: The encoding to write to the file using.
+		:param errors:
+
+		:return: The content of the file.
+
+		.. versionadded:: 0.5.0
+		"""
+
+		return self.read_text(encoding=encoding, errors=errors).split("\n")
+
 	def open(
 			self,
 			mode: str = "r",
@@ -452,6 +493,60 @@ def open(
 			encoding = None
 		return super().open(mode, buffering=buffering, encoding=encoding, errors=errors, newline=newline)
 
+	def dump_json(
+			self,
+			data: Any,
+			encoding: Optional[str] = "UTF-8",
+			errors: Optional[str] = None,
+			json_library: types.ModuleType = json,
+			**kwargs,
+			) -> int:
+		"""
+		Dump ``data`` to the file.
+
+		:param data: The object to serialise to JSON.
+		:param encoding: The encoding to write to the file using.
+		:param errors:
+		:param json_library: The JSON serialisation library to use.
+		:param kwargs: Keyword arguments to pass to the JSON serialisation function.
+
+		.. versionadded:: 0.5.0
+		"""
+
+		return self.write_text(
+				json_library.dumps(data, **kwargs),  # type: ignore
+				encoding=encoding,
+				errors=errors,
+				)
+
+	def load_json(
+			self,
+			encoding: Optional[str] = "UTF-8",
+			errors: Optional[str] = None,
+			json_library: types.ModuleType = json,
+			**kwargs,
+			) -> Any:
+		"""
+		Load JSON data from the file.
+
+		:param encoding: The encoding to write to the file using.
+		:param errors:
+		:param json_library: The JSON serialisation library to use.
+		:param kwargs: Keyword arguments to pass to the JSON deserialisation function.
+
+		:return: The deserialised JSON data.
+
+		.. versionadded:: 0.5.0
+		"""
+
+		return json_library.loads(  # type: ignore
+				self.read_text(
+						encoding=encoding,
+						errors=errors,
+						),
+				**kwargs,
+				)
+
 
 class PosixPathPlus(PathPlus, pathlib.PurePosixPath):
 	"""Path subclass for non-Windows systems.

tests/test_paths.py

@@ -14,6 +14,7 @@
 import shutil
 import sys
 from tempfile import TemporaryDirectory
+from textwrap import dedent
 
 # 3rd party
 import pytest
@@ -486,3 +487,116 @@ def test_copytree_exists_stdlib():
 
 		with pytest.raises(FileExistsError, match=r".*[\\/]dest"):
 			shutil.copytree(srcdir, destdir)
+
+
+def test_write_lines():
+	with TemporaryDirectory() as tmpdir:
+		tmpdir_p = PathPlus(tmpdir)
+
+		tmp_file = tmpdir_p / "test.txt"
+
+		contents = [
+				"this",
+				"is",
+				"a",
+				"list",
+				"of",
+				"words",
+				"to",
+				"write",
+				"to",
+				"the",
+				"file",
+				]
+
+		tmp_file.write_lines(contents)
+
+		assert tmp_file.read_text(
+		) == dedent("""\
+		this
+		is
+		a
+		list
+		of
+		words
+		to
+		write
+		to
+		the
+		file
+		""")
+
+
+def test_read_lines(tmpdir):
+	tmpdir_p = PathPlus(tmpdir)
+
+	tmp_file = tmpdir_p / "test.txt"
+
+	contents = dedent("""\
+	this
+	is
+	a
+	list
+	of
+	words
+	to
+	write
+	to
+	the
+	file
+	""")
+
+	tmp_file.write_text(contents)
+
+	assert tmp_file.read_lines() == [
+			"this",
+			"is",
+			"a",
+			"list",
+			"of",
+			"words",
+			"to",
+			"write",
+			"to",
+			"the",
+			"file",
+			'',
+			]
+
+
+def test_dump_json(tmpdir):
+	tmpdir_p = PathPlus(tmpdir)
+
+	tmp_file = tmpdir_p / "test.txt"
+
+	tmp_file.dump_json({"key": "value", "int": 1234, "float": 12.34})
+
+	assert tmp_file.read_text() == '{"key": "value", "int": 1234, "float": 12.34}'
+
+	tmp_file.dump_json({"key": "value", "int": 1234, "float": 12.34}, indent=2)
+
+	assert tmp_file.read_text() == dedent("""\
+	{
+	  "key": "value",
+	  "int": 1234,
+	  "float": 12.34
+	}""")
+
+
+def test_load_json(tmpdir):
+	tmpdir_p = PathPlus(tmpdir)
+
+	tmp_file = tmpdir_p / "test.txt"
+
+	tmp_file.write_text('{"key": "value", "int": 1234, "float": 12.34}')
+
+	assert tmp_file.load_json() == {"key": "value", "int": 1234, "float": 12.34}
+
+	tmp_file.write_text(dedent("""\
+	{
+	  "key": "value",
+	  "int": 1234,
+	  "float": 12.34
+	}"""))
+
+	assert tmp_file.load_json() == {"key": "value", "int": 1234, "float": 12.34}