Add "newline" argument to PathPlus.write_text to match Python 3.10

Author: domdfcoding

domdf_python_tools/paths.py

@@ -488,6 +488,7 @@ def write_text(
 			data: str,
 			encoding: Optional[str] = "UTF-8",
 			errors: Optional[str] = None,
+			newline: Optional[str] = NEWLINE_DEFAULT,
 			) -> int:
 		"""
 		Open the file in text mode, write to it, and close the file.
@@ -497,9 +498,20 @@ def write_text(
 		:param data:
 		:param encoding: The encoding to write to the file in.
 		:param errors:
+		:param newline:
+		:default newline: `universal newlines <https://docs.python.org/3/glossary.html#term-universal-newlines>`__ for reading, Unix line endings (``LF``) for writing.
+
+		.. versionchanged:: 3.1.0
+
+			Added the ``newline`` argument to match Python 3.10.
+			(see :github:pull:`22420 <python/cpython>`)
 		"""
 
-		return super().write_text(data, encoding=encoding, errors=errors)
+		if not isinstance(data, str):
+			raise TypeError(f'data must be str, not {data.__class__.__name__}')
+
+		with self.open(mode='w', encoding=encoding, errors=errors, newline=newline) as f:
+			return f.write(data)
 
 	def write_lines(
 			self,

tests/test_paths.py

@@ -927,3 +927,35 @@ def test_sort_paths():
 @pytest.mark.parametrize("left_type", [pathlib.PurePath, pathlib.Path, PathPlus])
 def test_pathplus_from_uri(path: str, left_type: Type):
 	assert PathPlus.from_uri(left_type(path).as_uri()).as_posix() == path
+
+
+def test_write_text_line_endings(tmp_pathplus: PathPlus):
+	the_file = (tmp_pathplus / "foo.md")
+	the_file.write_text("Hello\nWorld")
+	assert the_file.read_bytes() == b"Hello\nWorld"
+
+	with the_file.open('w') as fp:
+		fp.write("Hello\nWorld")
+
+	assert the_file.read_bytes() == b"Hello\nWorld"
+
+	with the_file.open('w', newline="\r\n") as fp:
+		fp.write("Hello\nWorld")
+
+	assert the_file.read_bytes() == b"Hello\r\nWorld"
+
+	# The following from https://github.com/python/cpython/pull/22420/files
+
+	# Check that `\n` character change nothing
+	the_file.write_text('abcde\r\nfghlk\n\rmnopq', newline='\n')
+	assert the_file.read_bytes() == b'abcde\r\nfghlk\n\rmnopq'
+	# Check that `\r` character replaces `\n`
+	the_file.write_text('abcde\r\nfghlk\n\rmnopq', newline='\r')
+	assert the_file.read_bytes() == b'abcde\r\rfghlk\r\rmnopq'
+	# Check that `\r\n` character replaces `\n`
+	the_file.write_text('abcde\r\nfghlk\n\rmnopq', newline='\r\n')
+	assert the_file.read_bytes() == b'abcde\r\r\nfghlk\r\n\rmnopq'
+	# Check that no argument passed will change `\n` to `os.linesep`
+	os_linesep_byte = bytes(os.linesep, encoding="ascii")
+	the_file.write_text('abcde\nfghlk\n\rmnopq')
+	assert the_file.read_bytes() == b'abcde' + os_linesep_byte + b'fghlk' + os_linesep_byte + b'\rmnopq'