Consolidate Protocols in typing module.

Author: domdfcoding

domdf_python_tools/stringlist.py

@@ -28,7 +28,8 @@
 from typing import Any, Iterable, Iterator, List, Tuple, Union, cast, overload
 
 # this package
-from domdf_python_tools.utils import String, convert_indents
+from domdf_python_tools.typing import String
+from domdf_python_tools.utils import convert_indents
 
 # Will be removed in 1.0
 String = String

domdf_python_tools/typing.py

@@ -15,6 +15,8 @@
 	:data:`~.MethodWrapperType`, The type of *bound* methods of some built-in data types and base classes.
 	:data:`~.MethodDescriptorType`, The type of methods of some built-in data types.
 	:data:`~.ClassMethodDescriptorType`, The type of *unbound* class methods of some built-in data types.
+	:data:`~.String`, :class:`~typing.Protocol` for classes that implement ``__str__``.
+	:data:`~.HasHead`, :class:`typing.Protocol` for classes that have a ``head``.
 
 """
 #
@@ -41,7 +43,7 @@
 import pathlib
 from decimal import Decimal
 from json import JSONDecoder, JSONEncoder
-from typing import Any, Callable, Dict, List, Optional, Tuple, Type, Union
+from typing import Any, Callable, Dict, List, Optional, Tuple, Type, Union, runtime_checkable
 
 # 3rd party
 from typing_extensions import Protocol
@@ -55,6 +57,8 @@
 		"MethodWrapperType",
 		"MethodDescriptorType",
 		"ClassMethodDescriptorType",
+		"HasHead",
+		"String",
 		]
 
 #: Type hint for objects that represent filesystem paths.
@@ -172,3 +176,34 @@ def loads(
 MethodWrapperType = type(object().__str__)
 MethodDescriptorType = type(str.join)
 ClassMethodDescriptorType = type(dict.__dict__['fromkeys'])
+
+
+@runtime_checkable
+class String(Protocol):
+	"""
+	:class:`~typing.Protocol` for classes that implement ``__str__``.
+	"""
+
+	def __str__(self) -> str:
+		...  # pragma: no cover
+
+
+@runtime_checkable
+class HasHead(Protocol):
+	"""
+	:class:`typing.Protocol` for classes that have a ``head``.
+
+	This includes :class:`pandas.DataFrame` and :class:`pandas.Series`.
+	"""
+
+	def head(self: "FrameOrSeries", n: int = 5) -> "FrameOrSeries":
+		...  # pragma: no cover
+
+	def to_string(self, *args, **kwargs) -> Optional[str]:
+		...  # pragma: no cover
+
+
+# class SupportsLessThan(Protocol):
+#
+# 	def __lt__(self, other: Any) -> bool:
+# 		...  # pragma: no cover

domdf_python_tools/utils.py

@@ -62,6 +62,7 @@
 # this package
 import domdf_python_tools.words
 from domdf_python_tools import __version__
+from domdf_python_tools.typing import HasHead, String
 
 if TYPE_CHECKING:
 	# 3rd party
@@ -91,8 +92,6 @@
 		"convert_indents",
 		"etc",
 		"head",
-		"HasHead",
-		"String",
 		]
 
 #: The current major python version.
@@ -102,16 +101,6 @@
 SPACE_PLACEHOLDER = '␣'
 
 
-@runtime_checkable
-class String(Protocol):
-	"""
-	Protocol for classes that implement ``__str__``.
-	"""
-
-	def __str__(self) -> str:
-		...  # pragma: no cover
-
-
 def check_dependencies(dependencies: Iterable[str], prt: bool = True) -> List[str]:
 	"""
 	Check whether one or more dependencies are available to be imported.
@@ -438,21 +427,6 @@ def convert_indents(text: str, tab_width: int = 4, from_: str = "\t", to: str =
 				)
 
 
-@runtime_checkable
-class HasHead(Protocol):
-	"""
-	:class:`typing.Protocol` for classes that have a ``head``.
-
-	This includes :class:`pandas.DataFrame` and :class:`pandas.Series`.
-	"""
-
-	def head(self: "FrameOrSeries", n: int = 5) -> "FrameOrSeries":
-		...  # pragma: no cover
-
-	def to_string(self, *args, **kwargs) -> Optional[str]:
-		...  # pragma: no cover
-
-
 class _Etcetera(str):
 
 	def __new__(cls):

domdf_python_tools/words.py

@@ -143,11 +143,6 @@ def get_random_word(min_length: int = 0, max_length: int = -1) -> str:
 	return random.choice(words_list)
 
 
-# class SupportsLessThan(Protocol):
-#
-# 	def __lt__(self, other: Any) -> bool:
-# 		...  # pragma: no cover
-
 # _default_unicode_sort_order: str = "".join(sorted(chr(i) for i in range(sys.maxunicode + 1)))