Add support for creating gzipped JSON files with PathPlus

Author: domdfcoding

domdf_python_tools/paths.py

@@ -41,6 +41,7 @@
 
 # stdlib
 import contextlib
+import gzip
 import json
 import os
 import pathlib
@@ -543,17 +544,20 @@ def dump_json(
 			encoding: Optional[str] = "UTF-8",
 			errors: Optional[str] = None,
 			json_library: JsonLibrary = json,  # type: ignore
+			*,
+			compress: bool = False,
 			**kwargs,
 			) -> None:
-		"""
+		r"""
 		Dump ``data`` to the file as JSON.
 
 		:param data: The object to serialise to JSON.
 		:param encoding: The encoding to write to the file in.
 		:param errors:
 		:param json_library: The JSON serialisation library to use.
 		:default json_library: :mod:`json`
-		:param kwargs: Keyword arguments to pass to the JSON serialisation function.
+		:param compress: Whether to compress the JSON file using gzip.
+		:param \*\*kwargs: Keyword arguments to pass to the JSON serialisation function.
 
 		.. versionadded:: 0.5.0
 
@@ -562,8 +566,16 @@ def dump_json(
 			Now uses :meth:`PathPlus.write_clean <domdf_python_tools.paths.PathPlus.write_clean>`
 			rather than :meth:`PathPlus.write_text <domdf_python_tools.paths.PathPlus.write_text>`,
 			and returns :py:obj:`None` rather than :class:`int`.
+
+		.. versionchanged:: 1.8.0
+
+			Added the ``compress`` keyword-only argument.
 		"""
 
+		if compress:
+			with gzip.open(self, mode="wt", encoding=encoding, errors=errors) as fp:
+				return fp.write(json_library.dumps(data, **kwargs))
+
 		return self.write_clean(
 				json_library.dumps(data, **kwargs),
 				encoding=encoding,
@@ -575,24 +587,38 @@ def load_json(
 			encoding: Optional[str] = "UTF-8",
 			errors: Optional[str] = None,
 			json_library: JsonLibrary = json,  # type: ignore
+			*,
+			decompress: bool = False,
 			**kwargs,
 			) -> Any:
-		"""
+		r"""
 		Load JSON data from the file.
 
 		:param encoding: The encoding to write to the file in.
 		:param errors:
 		:param json_library: The JSON serialisation library to use.
 		:default json_library: :mod:`json`
-		:param kwargs: Keyword arguments to pass to the JSON deserialisation function.
+		:param decompress: Whether to decompress the JSON file using gzip.
+			Will raise an exception if the file is not compressed.
+		:param \*\*kwargs: Keyword arguments to pass to the JSON deserialisation function.
 
 		:return: The deserialised JSON data.
 
 		.. versionadded:: 0.5.0
+
+		.. versionchanged:: 1.8.0
+
+			Added the ``compress`` keyword-only argument.
 		"""
 
+		if decompress:
+			with gzip.open(self, mode="rt", encoding=encoding, errors=errors) as fp:
+				content = fp.read()
+		else:
+			content = self.read_text(encoding=encoding, errors=errors)
+
 		return json_library.loads(
-				self.read_text(encoding=encoding, errors=errors),
+				content,
 				**kwargs,
 				)
 

tests/test_paths.py

@@ -580,6 +580,18 @@ def test_dump_json(tmpdir):
 """)
 
 
+def test_dump_json_gzip(tmpdir):
+	tmpdir_p = PathPlus(tmpdir)
+
+	tmp_file = tmpdir_p / "test.txt"
+
+	tmp_file.dump_json({"key": "value", "int": 1234, "float": 12.34}, compress=True)
+	assert tmp_file.load_json(decompress=True) == {"key": "value", "int": 1234, "float": 12.34}
+
+	tmp_file.dump_json({"key": "value", "int": 1234, "float": 12.34}, indent=2, compress=True)
+	assert tmp_file.load_json(decompress=True) == {"key": "value", "int": 1234, "float": 12.34}
+
+
 def test_load_json(tmpdir):
 	tmpdir_p = PathPlus(tmpdir)