Improve test coverage.

Author: domdfcoding

domdf_python_tools/bases.py

@@ -53,10 +53,10 @@
 
 # 3rd party
 import pydash  # type: ignore
-from typing_extensions import Protocol
 
 # this package
 from domdf_python_tools.doctools import prettify_docstrings
+from domdf_python_tools.typing import SupportsIndex
 
 __all__ = [
 		"Dictable",
@@ -369,12 +369,6 @@ def extend(self, other: Iterable[_T]) -> None:
 			self.data.extend(other)
 
 
-class _SupportsIndex(Protocol):
-
-	def __index__(self) -> int:
-		...
-
-
 @prettify_docstrings
 class UserFloat(Real):
 	"""
@@ -385,7 +379,7 @@ class UserFloat(Real):
 	.. versionadded:: 1.6.0
 	"""
 
-	def __init__(self, value: Union[SupportsFloat, _SupportsIndex, str, bytes, bytearray] = 0.0):
+	def __init__(self, value: Union[SupportsFloat, SupportsIndex, str, bytes, bytearray] = 0.0):
 		self._value = (float(value), )
 
 	def as_integer_ratio(self) -> Tuple[int, int]:

domdf_python_tools/dates.py

@@ -294,8 +294,8 @@ def get_timezone(tz: str, date: Optional[datetime.datetime] = None) -> Optional[
 	:param date: The date to obtain the timezone for
 	"""
 
-	if date is None:
-		date = datetime.datetime.utcnow()  # pragma: no cover (hard to test)
+	if date is None:  # pragma: no cover (hard to test)
+		date = datetime.datetime.utcnow()
 
 	d = date.replace(tzinfo=None)
 

domdf_python_tools/paths.py

@@ -623,7 +623,7 @@ def load_json(
 				**kwargs,
 				)
 
-	if sys.version_info < (3, 7):
+	if sys.version_info < (3, 7):  # pragma: no cover (<py37)
 
 		def is_mount(self) -> bool:
 			"""
@@ -652,7 +652,7 @@ def is_mount(self) -> bool:
 			parent_ino = parent.stat().st_ino
 			return ino == parent_ino
 
-	if sys.version_info < (3, 8):
+	if sys.version_info < (3, 8):  # pragma: no cover (<py38)
 
 		def rename(self: _P, target: Union[str, pathlib.PurePath]) -> _P:  # type: ignore
 			"""
@@ -710,7 +710,7 @@ def unlink(self, missing_ok: bool = False) -> None:
 				if not missing_ok:
 					raise
 
-	if sys.version_info < (3, 9):
+	if sys.version_info < (3, 9):  # pragma: no cover (<py39)
 
 		def __enter__(self):
 			return self

domdf_python_tools/typing.py

@@ -72,6 +72,7 @@
 		"HasHead",
 		"String",
 		"FrameOrSeries",
+		"SupportsIndex",
 		]
 
 #: Type hint for objects that represent filesystem paths.
@@ -218,3 +219,14 @@ def to_string(self, *args, **kwargs) -> Optional[str]:
 #
 # 	def __lt__(self, other: Any) -> bool:
 # 		...  # pragma: no cover
+
+
+class SupportsIndex(Protocol):
+	"""
+	:class:`typing.Protocol` for classes that support ``__index__``.
+
+	.. versionadded:: 2.0.0
+	"""
+
+	def __index__(self) -> int:  # pragma: no cover
+		...

domdf_python_tools/utils.py

@@ -73,23 +73,19 @@
 #
 
 # stdlib
-import functools
 import inspect
 import sys
-import textwrap
 import typing
-import warnings
-from datetime import date
 from math import log10
 from pprint import pformat
 from typing import Any, Callable, Dict, Iterable, List, Optional, Tuple, Union
 
 # 3rd party
-import deprecation  # type: ignore
-from packaging import version
+from deprecation_alias import deprecated  # type: ignore  # TODO
 
 # this package
 import domdf_python_tools.words
+from domdf_python_tools import __version__
 from domdf_python_tools.typing import HasHead, String
 
 if typing.TYPE_CHECKING or domdf_python_tools.__docs:  # pragma: no cover
@@ -358,174 +354,12 @@ def head(obj: Union[Tuple, List, "DataFrame", "Series", String, HasHead], n: int
 		return str(obj[:n]) + etc  # type: ignore
 
 
-def deprecated(
-		deprecated_in: Optional[str] = None,
-		removed_in: Optional[str] = None,
-		current_version: Optional[str] = None,
-		details: str = '',
-		name: Optional[str] = None
-		):
-	r"""Decorate a function to signify its deprecation.
-
-	This function wraps a method that will soon be removed and does two things:
-
-	* The docstring of the method will be modified to include a notice
-	  about deprecation, e.g., "Deprecated since 0.9.11. Use foo instead."
-	* Raises a :class:`~deprecation.DeprecatedWarning`
-	  via the :mod:`warnings` module, which is a subclass of the built-in
-	  :class:`DeprecationWarning`. Note that built-in
-	  :class:`DeprecationWarning`\s are ignored by default, so for users
-	  to be informed of said warnings they will need to enable them -- see
-	  the :mod:`warnings` module documentation for more details.
-
-	:param deprecated_in: The version at which the decorated method is considered
-		deprecated. This will usually be the next version to be released when
-		the decorator is added. The default is :py:obj:`None`, which effectively
-		means immediate deprecation. If this is not specified, then the
-		``removed_in`` and ``current_version`` arguments are ignored.
-	:no-default deprecated_in:
-
-	:param removed_in: The version or :class:`datetime.date` when the decorated
-		method will be removed. The default is :py:obj:`None`, specifying that
-		the function is not currently planned to be removed.
-
-		.. note::
-
-			This parameter cannot be set to a value if ``deprecated_in=None``.
-
-	:no-default removed_in:
-
-	:param current_version: The source of version information for the currently
-		running code. This will usually be a ``__version__`` attribute in your
-		library. The default is :py:obj:`None`. When ``current_version=None``
-		the automation to determine if the wrapped function is actually in
-		a period of deprecation or time for removal does not work, causing a
-		:class:`~deprecation.DeprecatedWarning` to be raised in all cases.
-	:no-default current_version:
-
-	:param details: Extra details to be added to the method docstring and
-		warning. For example, the details may point users to a replacement
-		method, such as "Use the foo_bar method instead".
-
-	:param name: The name of the deprecated function, if an alias is being
-		deprecated. Default is to the name of the decorated function.
-	:no-default name:
-	"""
-
-	# You can't just jump to removal. It's weird, unfair, and also makes
-	# building up the docstring weird.
-	if deprecated_in is None and removed_in is not None:
-		raise TypeError("Cannot set removed_in to a value without also setting deprecated_in")
-
-	# Only warn when it's appropriate. There may be cases when it makes sense
-	# to add this decorator before a formal deprecation period begins.
-	# In CPython, PendingDeprecatedWarning gets used in that period,
-	# so perhaps mimick that at some point.
-	is_deprecated = False
-	is_unsupported = False
-
-	# StrictVersion won't take a None or a "", so make whatever goes to it
-	# is at least *something*. Compare versions only if removed_in is not
-	# of type datetime.date
-	if isinstance(removed_in, date):
-		if date.today() >= removed_in:
-			is_unsupported = True
-		else:
-			is_deprecated = True
-	elif current_version:
-		current_version = version.parse(current_version)  # type: ignore
-
-		if removed_in is not None and current_version >= version.parse(removed_in):  # type: ignore
-			is_unsupported = True
-		elif deprecated_in is not None and current_version >= version.parse(deprecated_in):  # type: ignore
-			is_deprecated = True
-	else:
-		# If we can't actually calculate that we're in a period of
-		# deprecation...well, they used the decorator, so it's deprecated.
-		# This will cover the case of someone just using
-		# @deprecated("1.0") without the other advantages.
-		is_deprecated = True
-
-	should_warn = any([is_deprecated, is_unsupported])
-
-	def _function_wrapper(function):
-		# Everything *should* have a docstring, but just in case...
-		existing_docstring = function.__doc__ or ''
-
-		# split docstring at first occurrence of newline
-		string_list = existing_docstring.split('\n', 1)
-
-		if should_warn:
-			# The various parts of this decorator being optional makes for
-			# a number of ways the deprecation notice could go. The following
-			# makes for a nicely constructed sentence with or without any
-			# of the parts.
-
-			parts = {"deprecated_in": '', "removed_in": '', "details": ''}
-
-			if deprecated_in:
-				parts["deprecated_in"] = f" {deprecated_in}"
-			if removed_in:
-				# If removed_in is a date, use "removed on"
-				# If removed_in is a version, use "removed in"
-				if isinstance(removed_in, date):
-					parts["removed_in"] = f"\n   This will be removed on {removed_in}."
-				else:
-					parts["removed_in"] = f"\n   This will be removed in {removed_in}."
-			if details:
-				parts["details"] = f" {details}"
-
-			deprecation_note = (".. deprecated::{deprecated_in}{removed_in}{details}".format_map(parts))
-
-			# default location for insertion of deprecation note
-			loc = 1
-
-			if len(string_list) > 1:
-				# With a multi-line docstring, when we modify
-				# existing_docstring to add our deprecation_note,
-				# if we're not careful we'll interfere with the
-				# indentation levels of the contents below the
-				# first line, or as PEP 257 calls it, the summary
-				# line. Since the summary line can start on the
-				# same line as the """, dedenting the whole thing
-				# won't help. Split the summary and contents up,
-				# dedent the contents independently, then join
-				# summary, dedent'ed contents, and our
-				# deprecation_note.
-
-				# in-place dedent docstring content
-				string_list[1] = textwrap.dedent(string_list[1])
-
-				# we need another newline
-				string_list.insert(loc, '\n')
-
-				# change the message_location if we add to end of docstring
-				# do this always if not "top"
-				if deprecation.message_location != "top":
-					loc = 3
-
-			# insert deprecation note and dual newline
-			string_list.insert(loc, deprecation_note)
-			string_list.insert(loc, "\n\n")
-
-		@functools.wraps(function)
-		def _inner(*args, **kwargs):
-			if should_warn:
-				if is_unsupported:
-					cls = deprecation.UnsupportedWarning
-				else:
-					cls = deprecation.DeprecatedWarning
-
-				the_warning = cls(name or function.__name__, deprecated_in, removed_in, details)
-				warnings.warn(the_warning, category=DeprecationWarning, stacklevel=2)
-
-			return function(*args, **kwargs)
-
-		_inner.__doc__ = ''.join(string_list)
-
-		return _inner
-
-	return _function_wrapper
+deprecated = deprecated(
+	deprecated_in="2.0.0",
+	removed_in="2.3.0",
+	current_version=__version__,
+	details="Use the new 'deprecation-alias' package instead."
+	)(deprecated)  # yapf: disable
 
 
 def magnitude(x: float) -> int:

requirements.txt

@@ -1,7 +1,6 @@
-deprecation>=2.1.0
+deprecation-alias>=0.1.0
 importlib-metadata>=1.5.0; python_version < "3.8"
 importlib-resources>=3.0.0; python_version < "3.7"
 natsort>=7.1.0
-packaging>=20.4
 pydash>=4.7.4
 typing-extensions>=3.7.4.3

tests/requirements.txt

@@ -1,6 +1,7 @@
 coverage>=5.1
 coverage-pyver-pragma>=0.0.6
 faker>=4.1.2
+flake8>=3.8.4
 iniconfig!=1.1.0,>=1.0.1
 pandas>=1.0.0; implementation_name == "cpython" and python_version < "3.10"
 pytest>=6.0.0

tests/test_import_tools.py

@@ -5,9 +5,10 @@
 
 # 3rd party
 import pytest
+from pytest_regressions.data_regression import DataRegressionFixture
 
 # this package
-from domdf_python_tools.import_tools import discover
+from domdf_python_tools.import_tools import discover, discover_entry_points
 
 sys.path.append('.')
 sys.path.append("tests")
@@ -94,3 +95,12 @@ def raises_attribute_error(obj, **kwargs):
 def test_discover_errors(obj, expects):
 	with expects:
 		discover(obj)
+
+
+def test_discover_entry_points(data_regression: DataRegressionFixture):
+
+	entry_points = [
+			f.__name__
+			for f in discover_entry_points("flake8.extension", lambda f: f.__name__.startswith("break"))
+			]
+	data_regression.check(entry_points)

tests/test_import_tools_/test_discover_entry_points.yml

@@ -0,0 +1,2 @@
+- break_after_binary_operator
+- break_before_binary_operator

tests/test_utils.py

@@ -380,48 +380,6 @@ def test_str(self):
 		assert head("Hello World", 5) == "Hello..."
 
 
-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)  # yapf: disable
-
-	with pytest.warns(DeprecationWarning) as record:
-		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) == 2
-	assert record[0].message.args == (  # type: ignore
-			"deprecated_func", '1', '3', "use 'bar' instead."
-			)
-	assert record[1].message.args == (  # type: ignore
-			"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__  # type: ignore
-
-
 def test_trim_precision():
 	assert 170.10000000000002 != 170.1
 	assert trim_precision(170.10000000000002, 1) == 170.1