Improve type hints.

Author: domdfcoding

domdf_python_tools/delegators.py

@@ -48,7 +48,7 @@
 _C = TypeVar("_C", bound="Callable")
 
 
-def delegate_kwargs(to: Callable, *except_):
+def delegate_kwargs(to: Callable, *except_: str) -> Callable[[_C], _C]:
 	r"""
 	Decorator to replace ``**kwargs`` in function signatures with the
 	parameter names from the delegated function.
@@ -61,7 +61,7 @@ def delegate_kwargs(to: Callable, *except_):
 
 	# TODO: return annotation
 
-	def _f(f: Callable):
+	def _f(f: _C) -> _C:
 		to_f, from_f = to, f
 
 		to_sig = inspect.signature(to_f)

domdf_python_tools/paths.py

@@ -318,7 +318,7 @@ def make_executable(filename: PathLike) -> None:
 	"""
 	Make the given file executable.
 
-	:param filename: Filename of the file to make executable
+	:param filename:
 	"""
 
 	if not isinstance(filename, pathlib.Path):
@@ -941,7 +941,7 @@ def traverse_to_file(base_directory: _P, *filename: PathLike, height: int = -1)
 	raise FileNotFoundError(f"'{filename[0]!s}' not found in {base_directory}")
 
 
-def matchglob(filename: PathLike, pattern: str, matchcase: bool = True):
+def matchglob(filename: PathLike, pattern: str, matchcase: bool = True) -> bool:
 	"""
 	Given a filename and a glob pattern, return whether the filename matches the glob.
 

domdf_python_tools/pretty_print.py

@@ -36,7 +36,7 @@
 # stdlib
 import sys
 from io import StringIO
-from typing import IO, Any, Callable, Iterator, MutableMapping, Optional, Tuple
+from typing import IO, Any, Callable, Iterator, MutableMapping, Optional, Tuple, Type, TypeVar
 
 try:  # pragma: no cover
 
@@ -55,6 +55,8 @@
 
 __all__ = ["FancyPrinter", "simple_repr"]
 
+_T = TypeVar("_T", bound=Type)
+
 
 class FancyPrinter(PrettyPrinter):
 	"""
@@ -201,7 +203,7 @@ def __iter__(self) -> Iterator[Tuple[str, Any]]:
 	def __len__(self) -> int:
 		return len(self.attributes)
 
-	def __repr__(self):
+	def __repr__(self) -> str:
 		return f"Attributes{self.attributes}"
 
 
@@ -263,7 +265,7 @@ def simple_repr(*attributes: str, show_module: bool = False, **kwargs):
 	:param \*\*kwargs: Keyword arguments passed on to :class:`pprint.PrettyPrinter`.
 	"""
 
-	def deco(obj):
+	def deco(obj: _T) -> _T:
 
 		def __repr__(self) -> str:
 			if kwargs:
@@ -279,7 +281,7 @@ def __repr__(self) -> str:
 		__repr__.__name__ = "__repr__"
 		__repr__.__module__ = obj.__module__
 		__repr__.__qualname__ = f"{obj.__module__}.__repr__"
-		obj.__repr__ = __repr__
+		obj.__repr__ = __repr__  # type: ignore
 
 		return obj
 

domdf_python_tools/testing/utils.py

@@ -74,7 +74,7 @@
 		]
 
 
-def is_docker():
+def is_docker() -> bool:
 	"""
 	Is this current environment running in docker?
 

domdf_python_tools/versions.py

@@ -25,13 +25,15 @@
 
 # stdlib
 import re
-from typing import Dict, Generator, Iterable, Sequence, Tuple, Union
+from typing import Dict, Generator, Iterable, Sequence, Tuple, Type, TypeVar, Union
 
 # 3rd party
 from typing_extensions import final
 
 __all__ = ["Version"]
 
+_V = TypeVar("_V", bound="Version")
+
 
 @final
 class Version(Tuple[int, int, int]):
@@ -84,8 +86,8 @@ def minor(self):  # noqa: D102
 	def patch(self):  # noqa: D102
 		return self[2]
 
-	def __new__(cls, major=0, minor=0, patch=0) -> "Version":  # noqa: D102
-		t: "Version" = super().__new__(cls, (int(major), int(minor), int(patch)))  # type: ignore
+	def __new__(cls: Type[_V], major=0, minor=0, patch=0) -> _V:  # noqa: D102
+		t: _V = super().__new__(cls, (int(major), int(minor), int(patch)))  # type: ignore
 
 		return t
 
@@ -129,7 +131,7 @@ def __eq__(self, other) -> bool:
 		"""
 		Returns whether this version is equal to the other version.
 
-		:type other: str, float, Version
+		:type other: :class:`str`, :class:`float`, :class:`~.Version`
 		"""
 
 		other = _prep_for_eq(other)
@@ -144,7 +146,7 @@ def __gt__(self, other) -> bool:
 		"""
 		Returns whether this version is greater than the other version.
 
-		:type other: str, float, Version
+		:type other: :class:`str`, :class:`float`, :class:`~.Version`
 		"""
 
 		other = _prep_for_eq(other)
@@ -158,7 +160,7 @@ def __lt__(self, other) -> bool:
 		"""
 		Returns whether this version is less than the other version.
 
-		:type other: str, float, Version
+		:type other: :class:`str`, :class:`float`, :class:`~.Version`
 		"""
 
 		other = _prep_for_eq(other)
@@ -172,7 +174,7 @@ def __ge__(self, other) -> bool:
 		"""
 		Returns whether this version is greater than or equal to the other version.
 
-		:type other: str, float, Version
+		:type other: :class:`str`, :class:`float`, :class:`~.Version`
 		"""
 
 		other = _prep_for_eq(other)
@@ -186,7 +188,7 @@ def __le__(self, other) -> bool:
 		"""
 		Returns whether this version is less than or equal to the other version.
 
-		:type other: str, float, Version
+		:type other: :class:`str`, :class:`float`, :class:`~.Version`
 		"""
 
 		other = _prep_for_eq(other)
@@ -197,7 +199,7 @@ def __le__(self, other) -> bool:
 			return tuple(self)[:len(other)] <= other
 
 	@classmethod
-	def from_str(cls, version_string: str) -> "Version":
+	def from_str(cls: Type[_V], version_string: str) -> _V:
 		"""
 		Create a :class:`~.Version` from a :class:`str`.
 
@@ -209,7 +211,7 @@ def from_str(cls, version_string: str) -> "Version":
 		return cls(*_iter_string(version_string))
 
 	@classmethod
-	def from_tuple(cls, version_tuple: Tuple[Union[str, int], ...]) -> "Version":
+	def from_tuple(cls: Type[_V], version_tuple: Tuple[Union[str, int], ...]) -> _V:
 		"""
 		Create a :class:`~.Version` from a :class:`tuple`.
 
@@ -226,7 +228,7 @@ def from_tuple(cls, version_tuple: Tuple[Union[str, int], ...]) -> "Version":
 		return cls(*(int(x) for x in version_tuple[:3]))
 
 	@classmethod
-	def from_float(cls, version_float: float) -> "Version":
+	def from_float(cls: Type[_V], version_float: float) -> _V:
 		"""
 		Create a :class:`~.Version` from a :class:`float`.
 
@@ -250,7 +252,7 @@ def _asdict(self) -> Dict[str, int]:
 				"patch": self.patch,
 				}
 
-	def _replace(self, **kwargs) -> "Version":
+	def _replace(self: _V, **kwargs) -> _V:
 		"""
 		Return a new instance of the named tuple replacing specified fields with new values.
 
@@ -262,7 +264,7 @@ def _replace(self, **kwargs) -> "Version":
 		return self.__class__(**{**self._asdict(), **kwargs})
 
 	@classmethod
-	def _make(cls, iterable: Iterable[Union[str, int]]) -> "Version":
+	def _make(cls: Type[_V], iterable: Iterable[Union[str, int]]) -> _V:
 		"""
 		Class method that makes a new instance from an existing sequence or iterable.