Linting.

Author: domdfcoding

domdf_python_tools/bases.py

@@ -107,7 +107,7 @@ def __eq__(self, other) -> bool:
 
 
 _T = TypeVar("_T")
-_S = TypeVar('_S', bound="UserList")
+_S = TypeVar("_S", bound="UserList")
 
 
 @prettify_docstrings

domdf_python_tools/delegators.py

@@ -3,8 +3,7 @@
 #
 #  delegators.py
 """
-Decorators for functions that delegate parts of their functionality
-to other functions.
+Decorators for functions that delegate parts of their functionality to other functions.
 
 .. versionadded:: 0.10.0
 """
@@ -59,7 +58,7 @@ def delegate_kwargs(to: Callable, *except_):
 	:param \*except\_: Parameter names not to delegate.
 
 	:raises ValueError: if a non-default argument follows a default argument.
-	"""
+	"""  # noqa: D400
 
 	# TODO: return annotation
 
@@ -97,7 +96,7 @@ def delegates(to: Callable) -> Callable[[_C], _C]:
 	with the signature of the delegated function.
 
 	:param to: The function the arguments are passed on to.
-	"""
+	"""  # noqa: D400
 
 	def copy_annotations(f):
 		if hasattr(to, "__annotations__"):

domdf_python_tools/import_tools.py

@@ -107,7 +107,7 @@ def discover(
 		package.__path__,  # type: ignore
 		prefix=package.__name__ + '.',
 		):
-		module = __import__(module_name, fromlist=['__trash'], level=0)
+		module = __import__(module_name, fromlist=["__trash"], level=0)
 
 		# Check all the functions in that module
 		for _, imported_objects in inspect.getmembers(module, match_func):

domdf_python_tools/pagesizes/units.py

@@ -302,7 +302,7 @@ class Unitpt(Unit):
 
 class UnitInch(Unit):
 	"""
-	Inch
+	Inch.
 	"""
 
 	name = "inch"
@@ -311,7 +311,7 @@ class UnitInch(Unit):
 
 class Unitcm(Unit):
 	"""
-	Centimetres
+	Centimetres.
 	"""
 
 	name = "cm"
@@ -320,7 +320,7 @@ class Unitcm(Unit):
 
 class Unitmm(Unit):
 	"""
-	Millimetres
+	Millimetres.
 	"""
 
 	name = "mm"
@@ -329,7 +329,7 @@ class Unitmm(Unit):
 
 class Unitum(Unit):
 	"""
-	Micrometres
+	Micrometres.
 	"""
 
 	name = "µm"
@@ -338,7 +338,7 @@ class Unitum(Unit):
 
 class Unitpc(Unit):
 	"""
-	Pica
+	Pica.
 	"""
 
 	name = "pc"

domdf_python_tools/paths.py

@@ -71,7 +71,7 @@
 		]
 
 newline_default = object()
-_P = TypeVar('_P', bound=pathlib.PurePath)
+_P = TypeVar("_P", bound=pathlib.PurePath)
 """
 .. versionadded:: 0.11.0
 """
@@ -289,7 +289,7 @@ def in_directory(directory: PathLike):
 	duration of the ``with`` block.
 
 	:param directory:
-	"""
+	"""  # noqa: D400
 
 	oldwd = os.getcwd()
 	try:
@@ -316,9 +316,9 @@ class PathPlus(pathlib.Path):
 		Defaults to Unix line endings (``LF``) on all platforms.
 	"""
 
-	def __new__(cls, *args, **kwargs):
+	def __new__(cls, *args, **kwargs):  # noqa D102
 		if cls is PathPlus:
-			cls = WindowsPathPlus if os.name == 'nt' else PosixPathPlus
+			cls = WindowsPathPlus if os.name == "nt" else PosixPathPlus
 
 		self = cls._from_parts(args, init=False)  # type: ignore
 		if not self._flavour.is_supported:
@@ -720,21 +720,21 @@ class WindowsPathPlus(PathPlus, pathlib.PureWindowsPath):
 
 	def owner(self):  # pragma: no cover
 		"""
-		Unsupported on Windows
+		Unsupported on Windows.
 		"""
 
 		raise NotImplementedError("Path.owner() is unsupported on this system")
 
 	def group(self):  # pragma: no cover
 		"""
-		Unsupported on Windows
+		Unsupported on Windows.
 		"""
 
 		raise NotImplementedError("Path.group() is unsupported on this system")
 
 	def is_mount(self):  # pragma: no cover
 		"""
-		Unsupported on Windows
+		Unsupported on Windows.
 		"""
 
 		raise NotImplementedError("Path.is_mount() is unsupported on this system")

domdf_python_tools/secrets.py

@@ -53,7 +53,7 @@ class Secret(str):
 
 	value: str  #: The actual value of the secret.
 
-	def __new__(cls, value) -> "Secret":
+	def __new__(cls, value) -> "Secret":  # noqa D102
 		obj: Secret = super().__new__(cls, "<SECRET>")  # type: ignore
 		obj.value = str(value)
 		return obj

domdf_python_tools/stringlist.py

@@ -73,7 +73,7 @@ def size(self, size: int) -> None:
 		self._size = int(size)
 
 	@property
-	def type(self) -> str:  # noqa A002  # pylint: disable=redefined-builtin
+	def type(self) -> str:  # noqa A002,A003  # pylint: disable=redefined-builtin
 		"""
 		The indent character.
 		"""
@@ -143,7 +143,7 @@ def __init__(self, iterable: Iterable[String] = (), convert_indents: bool = Fals
 	def _make_line(self, line: str) -> str:
 		if not str(self.indent_type).strip(" \t") and self.convert_indents:
 			if self.indent_type == "\t":
-				line = convert_indents(line, tab_width=1, from_='    ', to="\t")
+				line = convert_indents(line, tab_width=1, from_="    ", to="\t")
 			else:  # pragma: no cover
 				line = convert_indents(line, tab_width=1, from_="\t", to=self.indent_type)
 

domdf_python_tools/terminal_colours.py

@@ -133,7 +133,7 @@ def strip_ansi(value: str) -> str:
 	.. versionadded:: 1.1.0
 	"""
 
-	return _ansi_re.sub("", value)
+	return _ansi_re.sub('', value)
 
 
 class Colour(str):
@@ -154,7 +154,7 @@ class Colour(str):
 	reset: str
 	stack: List[str]
 
-	def __new__(cls, style: str, stack: List[str], reset: str) -> "Colour":
+	def __new__(cls, style: str, stack: List[str], reset: str) -> "Colour":  # noqa D102
 		color = super().__new__(cls, style)  # type: ignore
 		color.style = style
 		color.stack = stack

domdf_python_tools/typing.py

@@ -197,7 +197,7 @@ class HasHead(Protocol):
 	:class:`typing.Protocol` for classes that have a ``head`` method.
 
 	This includes :class:`pandas.DataFrame` and :class:`pandas.Series`.
-	"""
+	"""  # noqa D400
 
 	def head(self: "FrameOrSeries", n: int = 5) -> "FrameOrSeries":
 		"""

domdf_python_tools/utils.py

@@ -465,7 +465,7 @@ def head(obj: Union[Tuple, List, "DataFrame", "Series", String, HasHead], n: int
 			return repr(obj)
 		else:
 			head_of_namedtuple = {k: v for k, v in zip(obj._fields[:n], obj[:n])}  # type: ignore
-			repr_fmt = '(' + ', '.join(f'{k}={v!r}' for k, v in head_of_namedtuple.items()) + f', {etc})'
+			repr_fmt = '(' + ', '.join(f"{k}={v!r}" for k, v in head_of_namedtuple.items()) + f", {etc})"
 			return obj.__class__.__name__ + repr_fmt
 
 	elif isinstance(obj, (list, tuple)):
@@ -672,12 +672,12 @@ def _function_wrapper(function):
 			# If removed_in is a version, use "removed in"
 			parts = {
 					"deprecated_in":
-							f" {deprecated_in}" if deprecated_in else "",
+							f" {deprecated_in}" if deprecated_in else '',
 					"removed_in":
 							f"\n   This will be removed {'on' if isinstance(removed_in, date) else 'in'} {removed_in}."
-							if removed_in else "",
+							if removed_in else '',
 					"details":
-							f" {details}" if details else ""
+							f" {details}" if details else ''
 					}
 
 			deprecation_note = (".. deprecated::{deprecated_in}{removed_in}{details}".format(**parts))