Add new factory functions to testing.py

Author: domdfcoding

__pkginfo__.py

@@ -51,7 +51,7 @@
 web = github_url = "https://github.com/domdfcoding/domdf_python_tools"
 repo_root = pathlib.Path(__file__).parent
 install_requires = (repo_root / "requirements.txt").read_text(encoding="utf-8").split('\n')
-extras_require = {'dates': ['pytz>=2019.1'], 'all': ['pytz>=2019.1']}
+extras_require = {'dates': ['pytz>=2019.1'], 'testing': ['pytest>=6.0.0'], 'all': ['pytest>=6.0.0', 'pytz>=2019.1']}
 
 
 

domdf_python_tools/testing.py

@@ -31,15 +31,19 @@
 # stdlib
 import itertools
 import random
+import sys
 from functools import lru_cache
-from typing import Any, Iterator, List, Sequence
+from typing import Any, Iterator, List, Optional, Sequence, Tuple, Union
 
 # 3rd party
+import _pytest
 import pytest
 from _pytest.mark import MarkDecorator
 
 # this package
+from domdf_python_tools.doctools import PYPY
 from domdf_python_tools.utils import Len
+from domdf_python_tools.versions import Version
 
 __all__ = [
 		"generate_truthy_values",
@@ -49,6 +53,12 @@
 		"whitespace_perms_list",
 		"whitespace_perms",
 		"count",
+		"min_version",
+		"max_version",
+		"not_windows",
+		"only_windows",
+		"not_pypy",
+		"only_pypy",
 		]
 
 
@@ -199,3 +209,110 @@ def count(stop: int, start: int = 0, step: int = 1) -> MarkDecorator:
 	"""
 
 	return pytest.mark.parametrize("count", range(start, stop, step))
+
+
+def _make_version(version: Union[str, float, Tuple[int, ...]]) -> Version:
+	if isinstance(version, float):
+		return Version.from_float(version)
+	elif isinstance(version, str):
+		return Version.from_str(version)
+	else:
+		return Version.from_tuple(version)
+
+
+def min_version(
+		version: Union[str, float, Tuple[int]],
+		reason: Optional[str] = None,
+		) -> _pytest.mark.structures.MarkDecorator:
+	"""
+	Factory function to return a ``@pytest.mark.skipif`` decorator that will
+	skip a test if the current Python version is less than the required one.
+
+	:param version: The version number to compare to :py:data:`sys.version_info`.
+	:param reason: The reason to display when skipping.
+	:default reason: ``'Requires Python <version> or greater.'``
+
+	.. versionadded:: 0.9.0
+	"""
+
+	version_ = _make_version(version)
+
+	if reason is None:
+		reason = f"Requires Python {version_} or greater."
+
+	return pytest.mark.skipif(condition=sys.version_info[:3] < version_, reason=reason)
+
+
+def max_version(
+		version: Union[str, float, Tuple[int]],
+		reason: Optional[str] = None,
+		) -> _pytest.mark.structures.MarkDecorator:
+	"""
+	Factory function to return a ``@pytest.mark.skipif`` decorator that will
+	skip a test if the current Python version is greater than the required one.
+
+	:param version: The version number to compare to :py:data:`sys.version_info`.
+	:param reason: The reason to display when skipping.
+	:default reason: ``'Not needed after Python <version>.'``
+
+	.. versionadded:: 0.9.0
+	"""
+
+	version_ = _make_version(version)
+
+	if reason is None:
+		reason = f"Not needed after Python {version_}."
+
+	return pytest.mark.skipif(condition=sys.version_info[:3] > version_, reason=reason)
+
+
+def not_windows(reason: str = "Not required on Windows.", ) -> _pytest.mark.structures.MarkDecorator:
+	"""
+	Factory function to return a ``@pytest.mark.skipif`` decorator that will
+	skip a test if the current platform is Windows.
+
+	:param reason: The reason to display when skipping.
+
+	.. versionadded:: 0.9.0
+	"""
+
+	return pytest.mark.skipif(condition=sys.platform == "win32", reason=reason)
+
+
+def only_windows(reason: str = "Only required on Windows.", ) -> _pytest.mark.structures.MarkDecorator:
+	"""
+	Factory function to return a ``@pytest.mark.skipif`` decorator that will
+	skip a test if the current platform is **not** Windows.
+
+	:param reason: The reason to display when skipping.
+
+	.. versionadded:: 0.9.0
+	"""
+
+	return pytest.mark.skipif(condition=sys.platform != "win32", reason=reason)
+
+
+def not_pypy(reason: str = "Not required on PyPy.", ) -> _pytest.mark.structures.MarkDecorator:
+	"""
+	Factory function to return a ``@pytest.mark.skipif`` decorator that will
+	skip a test if the current Python implementation is PyPy.
+
+	:param reason: The reason to display when skipping.
+
+	.. versionadded:: 0.9.0
+	"""
+
+	return pytest.mark.skipif(condition=PYPY, reason=reason)
+
+
+def only_pypy(reason: str = "Only required on PyPy.", ) -> _pytest.mark.structures.MarkDecorator:
+	"""
+	Factory function to return a ``@pytest.mark.skipif`` decorator that will
+	skip a test if the current Python implementation is not PyPy.
+
+	:param reason: The reason to display when skipping.
+
+	.. versionadded:: 0.9.0
+	"""
+
+	return pytest.mark.skipif(condition=PYPY, reason=reason)

domdf_python_tools/versions.py

@@ -189,10 +189,15 @@ def from_tuple(cls, version_tuple: Tuple[Union[str, int], ...]) -> "Version":
 
 		:param version_tuple: The version number.
 
-		:return: The created Version
+		:return: The created :class:`~domdf_python_tools.versions.Version`.
+
+		.. versionchanged:: 0.9.0
+
+			Tuples with more than three elements are truncated.
+			Previously a :exc:`TypeError` was raised.
 		"""
 
-		return cls(*(int(x) for x in version_tuple))
+		return cls(*(int(x) for x in version_tuple[:3]))
 
 	@classmethod
 	def from_float(cls, version_float: float) -> "Version":
@@ -216,7 +221,7 @@ def _iter_string(version_string: str) -> Generator[int, None, None]:
 	:return: Iterable elements of the version.
 	"""
 
-	return (int(x) for x in version_string.split("."))
+	return (int(x) for x in re.split("[.,]", version_string))
 
 
 def _iter_float(version_float: float) -> Generator[int, None, None]:

tests/test_paths.py

@@ -22,6 +22,7 @@
 # this package
 from domdf_python_tools import paths
 from domdf_python_tools.paths import PathPlus, clean_writer, copytree
+from domdf_python_tools.testing import not_pypy, not_windows
 
 
 def test_maybe_make():
@@ -156,7 +157,7 @@ def test_parent_path():
 		assert str(paths.parent_path("spam/spam/spam")) == os.path.join("spam", "spam")
 
 
-@pytest.mark.skipif(sys.platform == "win32", reason="Needs special-casing for Windows")
+@not_windows("Needs special-casing for Windows")
 @pytest.mark.parametrize(
 		"relto, relpath",
 		[
@@ -288,7 +289,7 @@ def test_pathplus_write_clean(input_string, output_string):
 		assert tempfile.read_text() == "\n".join(output_string)
 
 
-@pytest.mark.xfail(reason="Unsupported on PyPy3 <7.2", condition=(platform.python_implementation() == "PyPy"))
+@not_pypy()
 def test_make_executable():
 	with TemporaryDirectory() as tmpdir:
 		tempfile = pathlib.Path(tmpdir) / "tmpfile.sh"

tests/test_paths_stdlib.py

@@ -26,6 +26,7 @@
 
 # this package
 from domdf_python_tools.paths import PathPlus, PosixPathPlus, WindowsPathPlus
+from domdf_python_tools.testing import min_version
 
 try:
 	# stdlib
@@ -236,7 +237,7 @@ def test_unlink(self):
 		self.assertFileNotFound(p.stat)
 		self.assertFileNotFound(p.unlink)
 
-	@pytest.mark.skipif(sys.version_info < (3, 9), reason="requires python3.9 or higher")
+	@min_version(3.9, "Requires Python 3.9 or higher")
 	def test_unlink_missing_ok(self):  # pragma: no cover (<py37)
 		p = PathPlus(BASE) / 'fileAAA'
 		self.assertFileNotFound(p.unlink)
@@ -250,7 +251,7 @@ def test_rmdir(self):
 		self.assertFileNotFound(p.stat)
 		self.assertFileNotFound(p.unlink)
 
-	@pytest.mark.skipif(sys.version_info < (3, 9), reason="requires python3.9 or higher")
+	@min_version(3.9, "Requires Python 3.9 or higher")
 	@unittest.skipUnless(hasattr(os, "link"), "os.link() is not present")
 	def test_link_to(self):  # pragma: no cover (<py37)
 		P = PathPlus(BASE)
@@ -340,7 +341,7 @@ def test_replace(self):
 		self.assertEqual(os.stat(r).st_size, size)
 		self.assertFileNotFound(q.stat)
 
-	@pytest.mark.skipif(sys.version_info < (3, 9), reason="requires python3.9 or higher")
+	@min_version(3.9, "Requires Python 3.9 or higher")
 	@with_symlinks
 	def test_readlink(self):  # pragma: no cover (<py39)
 		P = PathPlus(BASE)
@@ -544,7 +545,7 @@ def test_is_file(self):
 			self.assertFalse((P / 'linkB').is_file())
 			self.assertFalse((P / 'brokenLink').is_file())
 
-	@pytest.mark.skipif(sys.version_info < (3, 7), reason="requires python3.7 or higher")
+	@min_version(3.9, "Requires Python 3.9 or higher")
 	@only_posix
 	def test_is_mount(self):  # pragma: no cover (<py37)
 		P = PathPlus(BASE)

tests/test_terminal.py

@@ -12,6 +12,7 @@
 # this package
 from domdf_python_tools import terminal_colours
 from domdf_python_tools.terminal import Echo, br, clear, interrupt, overtype
+from domdf_python_tools.testing import not_windows, only_windows
 
 fake = Faker()
 fake.add_provider(internet)
@@ -44,7 +45,7 @@ def test_br(capsys):
 	assert stdout == ["foo", '', "bar", '']
 
 
-@pytest.mark.skipif(condition=os.name != "nt", reason="Different test used for POSIX")
+@only_windows(reason="Different test used for POSIX")
 def test_interrupt_windows(capsys):
 	interrupt()
 
@@ -53,7 +54,7 @@ def test_interrupt_windows(capsys):
 	assert stdout == ["(Press Ctrl-C to quit at any time.)", '']
 
 
-@pytest.mark.skipif(condition=os.name == "nt", reason="Different test used for Windows")
+@not_windows(reason="Different test used for Windows")
 def test_interrupt_posix(capsys):
 	interrupt()
 
@@ -62,7 +63,7 @@ def test_interrupt_posix(capsys):
 	assert stdout == ["(Press Ctrl-D to quit at any time.)", '']
 
 
-# @pytest.mark.skipif(condition=os.name != "nt", reason="Different test used for POSIX")
+# @only_windows(reason="Different test used for POSIX")
 # def test_clear_windows(capsys):
 # 	clear()
 #
@@ -72,7 +73,7 @@ def test_interrupt_posix(capsys):
 #
 
 
-@pytest.mark.skipif(condition=os.name == "nt", reason="Different test used for Windows")
+@not_windows(reason="Different test used for Windows")
 def test_clear_posix(capsys):
 	clear()