Removed deprecated functions.

Author: domdfcoding

domdf_python_tools/paths.py

@@ -4,9 +4,9 @@
 """
 Functions for paths and files.
 
-.. versionchanged:: 0.8.0
+.. versionchanged:: 1.0.0
 
-	``relpath2`` is deprecated and will be removed in 1.0.0.
+	Removed ``relpath2``.
 	Use :func:`domdf_python_tools.paths.relpath` instead.
 """
 #
@@ -239,9 +239,6 @@ def relpath(path: PathLike, relative_to: Optional[PathLike] = None) -> pathlib.P
 		return abs_path
 
 
-relpath2 = relpath
-
-
 def write(var: str, filename: PathLike, **kwargs) -> None:
 	"""
 	Write a variable to file in the current directory.
@@ -526,8 +523,7 @@ def open(  # type: ignore  # noqa A003
 			else:
 				newline = "\n"
 
-		return super(
-		).open(  # type: ignore
+		return super().open(  # type: ignore
 				mode,
 				buffering=buffering,
 				encoding=encoding,

domdf_python_tools/stringlist.py

@@ -4,10 +4,9 @@
 """
 A list of strings that represent lines in a multiline string.
 
-.. versionchanged:: 0.8.0
+.. versionchanged:: 1.0.0
 
-	String moved to :mod:`domdf_python_tools.typing`.
-	It will be removed from this module in 1.0.0
+	``String`` should now be imported from :mod:`domdf_python_tools.typing`.
 """
 #
 #  Copyright © 2020 Dominic Davis-Foster <[email protected]>
@@ -36,8 +35,6 @@
 from domdf_python_tools.typing import String
 from domdf_python_tools.utils import convert_indents
 
-String = String
-
 __all__ = ["Indent", "StringList"]
 
 

domdf_python_tools/utils.py

@@ -5,10 +5,14 @@
 """
 General utility functions.
 
-.. versionchanged:: 0.8.0
-
-	``tuple2str`` and ``list2string`` are deprecated and will be removed in 1.0.0.
-	Use :func:`domdf_python_tools.utils.list2str` instead.
+.. versionchanged:: 1.0.0
+
+	* Removed ``tuple2str`` and ``list2string``.
+	  Use :func:`domdf_python_tools.utils.list2str` instead.
+	* Removed ``as_text`` and ``word_join``.
+	  Import from :mod:`domdf_python_tools.words` instead.
+	* Removed ``splitLen``.
+	  Use :func:`domdf_python_tools.utils.split_len` instead.
 """
 #
 #  Copyright © 2018-2020 Dominic Davis-Foster <[email protected]>
@@ -723,54 +727,3 @@ def _inner(*args, **kwargs):
 		return _inner
 
 	return _function_wrapper
-
-
-# Moved elsewhere
-as_text = deprecated(
-		deprecated_in="0.8.0",
-		removed_in="1.0.0",
-		current_version=__version__,
-		details="Import from 'domdf_python_tools.words' instead.",
-		)(
-				domdf_python_tools.words.as_text
-				)
-
-word_join = deprecated(
-		deprecated_in="0.8.0",
-		removed_in="1.0.0",
-		current_version=__version__,
-		details="Import from 'domdf_python_tools.words' instead.",
-		)(
-				domdf_python_tools.words.word_join
-				)
-
-# Deprecated aliases
-tuple2str = deprecated(
-		deprecated_in="0.8.0",
-		removed_in="1.0.0",
-		current_version=__version__,
-		details="Use 'domdf_python_tools.utils.list2str' instead.",
-		name="tuple2str",
-		)(
-				list2str
-				)
-
-list2string = deprecated(
-		deprecated_in="0.8.0",
-		removed_in="1.0.0",
-		current_version=__version__,
-		details="Use 'domdf_python_tools.utils.list2str' instead.",
-		name="list2string",
-		)(
-				list2str
-				)
-
-splitLen = deprecated(
-		deprecated_in="0.8.0",
-		removed_in="1.0.0",
-		current_version=__version__,
-		details="Use 'domdf_python_tools.utils.split_len' instead.",
-		name="splitLen",
-		)(
-				split_len
-				)

tests/test_utils.py

@@ -24,7 +24,7 @@
 from domdf_python_tools.paths import PathPlus
 from domdf_python_tools.testing import testing_boolean_values
 from domdf_python_tools.typing import HasHead
-from domdf_python_tools.utils import coloured_diff, head
+from domdf_python_tools.utils import coloured_diff, deprecated, head
 
 
 def test_pyversion():
@@ -485,30 +485,47 @@ def test_str(self):
 		assert head("Hello World", 5) == "Hello..."
 
 
-def test_deprecations():
-	# this package
-	from domdf_python_tools.utils import as_text, list2string, tuple2str, word_join
+def test_deprecation():
+
+	def func(*args, **kwargs):
+		"""
+		A normal function.
+		"""
+
+		return args, kwargs
+
+	@deprecated(deprecated_in="1", removed_in="3", current_version="2", details="use 'bar' instead.")
+	def deprecated_func(*args, **kwargs):
+		"""
+		A deprecated function.
+		"""
+
+		return args, kwargs
+
+	deprecated_alias = deprecated(
+			deprecated_in="1",
+			removed_in="3",
+			current_version="2",
+			details="use 'bar' instead.",
+			name="deprecated_alias",
+			)(func)
 
 	with pytest.warns(DeprecationWarning) as record:
-		as_text(1)
-		word_join(["a", "b"])
-		tuple2str(("a", "b"))
-		list2string(["a", "b"])
+		assert deprecated_func(1, a_list=["a", "b"]) == ((1, ), {"a_list": ["a", "b"]})
+		assert deprecated_alias(1, a_list=["a", "b"]) == ((1, ), {"a_list": ["a", "b"]})
 
-	assert len(record) == 4
+	assert len(record) == 2
 	assert record[0].message.args == (  # type: ignore
-		'as_text', '0.8.0', '1.0.0', "Import from 'domdf_python_tools.words' instead."
+		'deprecated_func', '1', '3', "use 'bar' instead."
 		)
 	assert record[1].message.args == (  # type: ignore
-		'word_join', '0.8.0', '1.0.0', "Import from 'domdf_python_tools.words' instead."
-		)
-	assert record[2].message.args == (  # type: ignore
-		'tuple2str', '0.8.0', '1.0.0', "Use 'domdf_python_tools.utils.list2str' instead."
-		)
-	assert record[3].message.args == (  # type: ignore
-		'list2string', '0.8.0', '1.0.0', "Use 'domdf_python_tools.utils.list2str' instead."
+		'deprecated_alias', '1', '3', "use 'bar' instead."
 		)
 
+	assert ".. deprecated::" in deprecated_func.__doc__
+	assert ".. deprecated::" in deprecated_alias.__doc__
+	assert ".. deprecated::" not in func.__doc__
+
 
 def test_diff(file_regression: FileRegressionFixture):
 	data_dir = PathPlus(__file__).parent / "test_diff"