Add PathType TypeVar to typing

Author: domdfcoding

doc-source/api/typing.rst

@@ -7,29 +7,29 @@
 
 .. data:: WrapperDescriptorType
 
-	The type of methods of some built-in data types and base classes such as
+	The type of methods of some built-in data types and base classes, such as
 	:meth:`object.__init__` or :meth:`object.__lt__`.
 
 	.. versionadded:: 0.8.0
 
 .. data:: MethodWrapperType
 
 	The type of *bound* methods of some built-in data types and base classes.
-	For example it is the type of :code:`object().__str__`.
+	For example, it is the type of :code:`object().__str__`.
 
 	.. versionadded:: 0.8.0
 
 
 .. data:: MethodDescriptorType
 
-	The type of methods of some built-in data types such as :meth:`str.join`.
+	The type of methods of some built-in data types, such as :meth:`str.join`.
 
 	.. versionadded:: 0.8.0
 
 
 .. data:: ClassMethodDescriptorType
 
-	The type of *unbound* class methods of some built-in data types such as
+	The type of *unbound* class methods of some built-in data types, such as
 	``dict.__dict__['fromkeys']``.
 
 	.. versionadded:: 0.8.0

domdf_python_tools/typing.py

@@ -62,6 +62,7 @@
 
 __all__ = [
 		"PathLike",
+		"PathType",
 		"AnyNumber",
 		"check_membership",
 		"JsonLibrary",
@@ -75,8 +76,21 @@
 		"SupportsIndex",
 		]
 
-#: Type hint for objects that represent filesystem paths.
 PathLike = Union[str, pathlib.Path, os.PathLike]
+"""
+Type hint for objects that represent filesystem paths.
+
+.. seealso:: :py:obj:`domdf_python_tools.typing.PathType`
+"""
+
+PathType = typing.TypeVar("PathType", str, pathlib.Path, os.PathLike)
+"""
+Type variable for objects that represent filesystem paths.
+
+.. versionadded:: 2.2.0
+
+.. seealso:: :py:obj:`domdf_python_tools.typing.PathLike`
+"""
 
 AnyNumber = Union[float, int, Decimal]
 """
@@ -93,7 +107,8 @@ def check_membership(obj: Any, type_: Union[Type, object]) -> bool:
 	Check if the type of ``obj`` is one of the types in a :py:data:`typing.Union`, :class:`typing.Sequence` etc.
 
 	:param obj: The object to check the type of
-	:param type\_: A :class:`~typing.Type` that has members, such as a List, Union or Sequence.
+	:param type\_: A :class:`~typing.Type` that has members,
+		such as a :class:`typing.List`, :py:data:`typing.Union` or :py:class:`typing.Sequence`.
 	"""
 
 	return isinstance(obj, type_.__args__)  # type: ignore