Use inspect.cleandoc rather than textwrap.dedent when appending docstrings.

Author: domdfcoding

domdf_python_tools/doctools.py

@@ -29,7 +29,7 @@
 # stdlib
 import builtins
 import platform
-from textwrap import dedent
+from inspect import cleandoc
 from types import MethodType
 from typing import Any, Callable, Dict, Optional, Sequence, Type, TypeVar, Union
 
@@ -102,13 +102,13 @@ def append_doctring_from_another(target: Union[Type, Callable], original: Union[
 	original_doc = original.__doc__
 
 	if isinstance(original_doc, str) and isinstance(target_doc, str):
-		deindented_target_doc = dedent(target_doc)
-		deindented_original_doc = dedent(original_doc)
+		deindented_target_doc = cleandoc(target_doc)
+		deindented_original_doc = cleandoc(original_doc)
 
 		target.__doc__ = deindented_target_doc + "\n" + deindented_original_doc
 
 	elif not isinstance(target_doc, str) and isinstance(original_doc, str):
-		target.__doc__ = dedent(original_doc)
+		target.__doc__ = cleandoc(original_doc)
 
 
 def make_sphinx_links(input_string: str, builtins_list: Optional[Sequence[str]] = None) -> str:

tests/test_doctools.py

@@ -124,8 +124,7 @@ def opening_hours(self):
 
 	@doctools.append_docstring_from(Cafe.set_opening_hours)
 	def set_opening_hours(self, opens_at, closes_at):
-		"""
-		I will not buy this record, it is scratched.
+		"""I will not buy this record, it is scratched.
 		"""
 
 		self._opens_at = opens_at
@@ -208,13 +207,13 @@ def test_decorators():
 	assert SpamCafe.opening_hours.__doc__ == Cafe.opening_hours.__doc__
 
 	# set_opening_hours and ceil should have extra text at the beginning
-	assert SpamCafe.set_opening_hours.__doc__.startswith("\nI will not buy this record, it is scratched.")
-	assert doctools.deindent_string(SpamCafe.set_opening_hours.__doc__, ).endswith(
+	assert SpamCafe.set_opening_hours.__doc__.startswith("I will not buy this record, it is scratched.")
+	assert (doctools.deindent_string(SpamCafe.set_opening_hours.__doc__) + "\n").endswith(
 			doctools.deindent_string(Cafe.set_opening_hours.__doc__)
 			)
 	# Dedented both strings to be sure of equivalence
 	assert SpamCafe.ceil.__doc__.startswith(
-			"\nI don't know why the cafe has a ceil function, but we'd better document it properly.",
+			"I don't know why the cafe has a ceil function, but we'd better document it properly.",
 			)
 	assert doctools.deindent_string(SpamCafe.ceil.__doc__).endswith(doctools.deindent_string(math.ceil.__doc__))
 	# Dedented both strings to be sure of equivalence
@@ -224,9 +223,9 @@ def test_decorators():
 	assert undocumented_function.__name__ == "undocumented_function"
 	assert undocumented_function.__annotations__ == {'a': float, 'b': float, 'c': float, 'd': int, "return": float}
 	assert partially_documented_function.__doc__.startswith(
-			"\nThis function works like ``documented_function`` except it returns the result telepathically.",
+			"This function works like ``documented_function`` except it returns the result telepathically.",
 			)
-	assert doctools.deindent_string(partially_documented_function.__doc__, ).endswith(
+	assert (doctools.deindent_string(partially_documented_function.__doc__) + "\n").endswith(
 			doctools.deindent_string(documented_function.__doc__)
 			)
 	# Dedented both strings to be sure of equivalence