Linting.

Author: domdfcoding

domdf_python_tools/doctools.py

@@ -324,17 +324,15 @@ def prettify_docstrings(obj: Type) -> Type:
 	"""
 	Prettify the default :class:`object` docstrings for use in Sphinx documentation.
 
-	:param obj: The object to prettify the docstrings for.
+	:param obj: The object to prettify the method docstrings for.
 
 	:return: The object
 
 	Default :func:`dir` implementation.
 	"""
 
-	new_docstrings = {
-			**base_new_docstrings,
-			"__repr__": f"Return a string representation of the :class:`~{obj.__module__}.{obj.__name__}`.",
-			}
+	repr_docstring = f"Return a string representation of the :class:`~{obj.__module__}.{obj.__name__}`."
+	new_docstrings = {**base_new_docstrings, "__repr__": repr_docstring}
 
 	_do_prettify(obj, object, new_docstrings)
 	_do_prettify(obj, dict, container_docstrings)

domdf_python_tools/import_tools.py

@@ -45,8 +45,10 @@
 #
 
 # stdlib
+# import importlib.util
 import inspect
 import pkgutil
+# import sys
 from types import ModuleType
 from typing import Any, Callable, List, Optional, Type
 
@@ -90,3 +92,18 @@ def discover(
 			matched_classes.append(imported_objects)
 
 	return matched_classes
+
+
+#
+# def import_module(filename: str):
+# 	"""
+# 	Import the module with the given filename.
+# 	:param filename:
+# 	:return:
+# 	"""
+#
+# 	spec = importlib.util.spec_from_file_location("typing", filename)
+# 	mod = importlib.util.module_from_spec(spec)
+# 	spec.loader.exec_module(mod)
+# 	sys.modules[mod.__name__] = mod
+# 	return mod

domdf_python_tools/words.py

@@ -143,11 +143,10 @@ 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:
-		...
-
+# 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)))
 

tests/test_doctools.py

@@ -8,20 +8,17 @@
 
 # stdlib
 import math
-
-# 3rd party
 from typing import get_type_hints
 
+# 3rd party
 import pytest
 
 # this package
 from domdf_python_tools import doctools
-
 # TODO: test sphinxification of docstrings
 from domdf_python_tools.doctools import (
-	base_int_docstrings, base_new_docstrings, container_docstrings, operator_docstrings,
-	prettify_docstrings,
-	)
+		base_int_docstrings, base_new_docstrings, container_docstrings, operator_docstrings, prettify_docstrings
+		)
 
 
 class Cafe:
@@ -347,160 +344,160 @@ def demo_function():
 		"""
 
 
-
 @prettify_docstrings
 class Klasse:
+
 	def __delattr__(self, **kwargs):
 		...  # pragma: no cover
-	
-	def __dir__(self): 
+
+	def __dir__(self):
 		...  # pragma: no cover
-	
+
 	def __eq__(self, **kwargs):
 		...  # pragma: no cover
-	
+
 	def __getattribute__(self, **kwargs):
 		...  # pragma: no cover
-	
-	def __ge__(self): 
+
+	def __ge__(self):
 		...  # pragma: no cover
-	
-	def __gt__(self): 
+
+	def __gt__(self):
 		...  # pragma: no cover
-	
-	def __hash__(self): 
+
+	def __hash__(self):
 		...  # pragma: no cover
-	
-	def __lt__(self): 
+
+	def __lt__(self):
 		...  # pragma: no cover
-	
-	def __le__(self): 
+
+	def __le__(self):
 		...  # pragma: no cover
-	
+
 	def __ne__(self, **kwargs):
 		...  # pragma: no cover
-	
+
 	def __setattr__(self, **kwargs):
 		...  # pragma: no cover
-	
-	def __sizeof__(self): 
+
+	def __sizeof__(self):
 		...  # pragma: no cover
-	
-	def __str__(self): 
+
+	def __str__(self):
 		...  # pragma: no cover
-	
-	def __contains__(self): 
+
+	def __contains__(self):
 		...  # pragma: no cover
-	
-	def __getitem__(self): 
+
+	def __getitem__(self):
 		...  # pragma: no cover
-	
-	def __setitem__(self): 
+
+	def __setitem__(self):
 		...  # pragma: no cover
-	
-	def __delitem__(self): 
+
+	def __delitem__(self):
 		...  # pragma: no cover
-	
-	def __and__(self): 
+
+	def __and__(self):
 		...  # pragma: no cover
-	
-	def __add__(self): 
+
+	def __add__(self):
 		...  # pragma: no cover
-	
-	def __abs__(self): 
+
+	def __abs__(self):
 		...  # pragma: no cover
-	
-	def __divmod__(self): 
+
+	def __divmod__(self):
 		...  # pragma: no cover
-	
-	def __floordiv__(self): 
+
+	def __floordiv__(self):
 		...  # pragma: no cover
-	
-	def __invert__(self): 
+
+	def __invert__(self):
 		...  # pragma: no cover
-	
-	def __lshift__(self): 
+
+	def __lshift__(self):
 		...  # pragma: no cover
-	
-	def __mod__(self): 
+
+	def __mod__(self):
 		...  # pragma: no cover
-	
-	def __mul__(self): 
+
+	def __mul__(self):
 		...  # pragma: no cover
-	
-	def __neg__(self): 
+
+	def __neg__(self):
 		...  # pragma: no cover
-	
-	def __or__(self): 
+
+	def __or__(self):
 		...  # pragma: no cover
-	
-	def __pos__(self): 
+
+	def __pos__(self):
 		...  # pragma: no cover
-	
-	def __pow__(self): 
+
+	def __pow__(self):
 		...  # pragma: no cover
-	
-	def __radd__(self): 
+
+	def __radd__(self):
 		...  # pragma: no cover
-	
-	def __rand__(self): 
+
+	def __rand__(self):
 		...  # pragma: no cover
-	
-	def __rdivmod__(self): 
+
+	def __rdivmod__(self):
 		...  # pragma: no cover
-	
-	def __rfloordiv__(self): 
+
+	def __rfloordiv__(self):
 		...  # pragma: no cover
-	
-	def __rlshift__(self): 
+
+	def __rlshift__(self):
 		...  # pragma: no cover
-	
-	def __rmod__(self): 
+
+	def __rmod__(self):
 		...  # pragma: no cover
-	
-	def __rmul__(self): 
+
+	def __rmul__(self):
 		...  # pragma: no cover
-	
-	def __ror__(self): 
+
+	def __ror__(self):
 		...  # pragma: no cover
-	
-	def __rpow__(self): 
+
+	def __rpow__(self):
 		...  # pragma: no cover
-	
-	def __rrshift__(self): 
+
+	def __rrshift__(self):
 		...  # pragma: no cover
-	
-	def __rshift__(self): 
+
+	def __rshift__(self):
 		...  # pragma: no cover
-	
-	def __rsub__(self): 
+
+	def __rsub__(self):
 		...  # pragma: no cover
-	
-	def __rtruediv__(self): 
+
+	def __rtruediv__(self):
 		...  # pragma: no cover
-	
-	def __rxor__(self): 
+
+	def __rxor__(self):
 		...  # pragma: no cover
-	
-	def __sub__(self): 
+
+	def __sub__(self):
 		...  # pragma: no cover
-	
-	def __truediv__(self): 
+
+	def __truediv__(self):
 		...  # pragma: no cover
-	
-	def __xor__(self): 
+
+	def __xor__(self):
 		...  # pragma: no cover
-	
-	def __float__(self): 
+
+	def __float__(self):
 		...  # pragma: no cover
-	
-	def __int__(self): 
+
+	def __int__(self):
 		...  # pragma: no cover
-	
+
 	def __repr__(self):
 		...  # pragma: no cover
 
-	def __bool__(self): 
+	def __bool__(self):
 		...  # pragma: no cover