Lint

Author: domdfcoding

domdf_python_tools/bases.py

@@ -80,7 +80,7 @@
 
 
 @prettify_docstrings
-class Dictable(Iterable[Tuple[str, _V]]):
+class Dictable(Iterable[Tuple[str, _V]]):  # noqa: PRM002
 	"""
 	The basic structure of a class that can be converted into a dictionary.
 	"""
@@ -119,7 +119,7 @@ def __deepcopy__(self, memodict={}):
 	def __dict__(self):  # type: ignore[override]
 		return dict()  # pragma: no cover (abc)
 
-	def __eq__(self, other) -> bool:
+	def __eq__(self, other) -> bool:  # noqa: MAN001
 		if isinstance(other, self.__class__):
 			return is_match_with(other.__dict__, self.__dict__)
 
@@ -266,13 +266,18 @@ def __copy__(self):
 	def append(self, item: _T) -> None:
 		"""
 		Append ``item`` to the end of the :class:`~.domdf_python_tools.bases.UserList`.
+
+		:param item:
 		"""
 
 		self.data.append(item)
 
 	def insert(self, i: int, item: _T) -> None:
 		"""
 		Insert ``item`` at position ``i`` in the :class:`~.domdf_python_tools.bases.UserList`.
+
+		:param i:
+		:param item:
 		"""
 
 		self.data.insert(i, item)
@@ -281,6 +286,8 @@ def pop(self, i: int = -1) -> _T:
 		"""
 		Removes and returns the item at index ``i``.
 
+		:param i:
+
 		:raises IndexError: if list is empty or index is out of range.
 		"""
 
@@ -315,19 +322,19 @@ def copy(self: _S) -> _S:
 
 		return self.__class__(self)
 
-	def count(self, item: _T) -> int:
+	def count(self, item: _T) -> int:  # noqa: PRM002
 		"""
 		Returns the number of occurrences of ``item`` in the :class:`~.domdf_python_tools.bases.UserList`.
 		"""
 
 		return self.data.count(item)
 
 	def index(self, item: _T, *args: Any) -> int:
-		"""
+		r"""
 		Returns the index of the fist element matching ``item``.
 
 		:param item:
-		:param args:
+		:param \*args:
 
 		:raises ValueError: if the item is not present.
 		"""
@@ -341,7 +348,7 @@ def reverse(self) -> None:
 
 		self.data.reverse()
 
-	def sort(self, *, key=None, reverse: bool = False) -> None:
+	def sort(self, *, key=None, reverse: bool = False) -> None:  # noqa: PRM002
 		"""
 		Sort the list in ascending order and return :py:obj:`None`.
 
@@ -628,7 +635,7 @@ def replace(self: _LU, what: _T, with_: _T) -> _LU:
 
 		return self
 
-	def sort(  # type: ignore[override]
+	def sort(  # type: ignore[override]  # noqa: PRM002
 			self: _LU,
 			*,
 			key=None,

domdf_python_tools/dates.py

@@ -383,7 +383,7 @@ def is_bst(the_date: Union[time.struct_time, datetime.date]) -> bool:
 		'{word_join(_pytz_functions)}' require pytz (https://pypi.org/project/pytz/), but it could not be imported.
 
 		The error was: {e}.
-		"""
+		""",
 				)
 
 	else:
@@ -394,7 +394,7 @@ class SelfWrapper(ModuleType):
 			def __getattr__(self, name):
 				if name in _pytz_functions:
 					raise ImportError(
-							f"{name!r} requires pytz (https://pypi.org/project/pytz/), but it could not be imported."
+							f"{name!r} requires pytz (https://pypi.org/project/pytz/), but it could not be imported.",
 							)
 				else:
 					return getattr(_actual_module, name)

domdf_python_tools/delegators.py

@@ -83,8 +83,8 @@ def _f(f: _C) -> _C:
 					del to_params[param]
 
 			f.__signature__ = from_sig.replace(  # type: ignore[attr-defined]
-				parameters=[*from_params.values(), *to_params.values()]
-				)
+				parameters=[*from_params.values(), *to_params.values()],
+			)
 			f.__annotations__ = {**to_annotations, **from_annotations}
 
 		return f
@@ -121,8 +121,8 @@ def _f(f: _C) -> _C:
 
 		elif tuple(from_params.keys()) == ("self", "args", "kwargs"):
 			f.__signature__ = from_sig.replace(  # type: ignore[attr-defined]
-				parameters=[from_params["self"], *to_sig.parameters.values()]
-				)
+				parameters=[from_params["self"], *to_sig.parameters.values()],
+			)
 
 			copy_annotations(f)
 

domdf_python_tools/import_tools.py

@@ -53,7 +53,7 @@
 		"discover_in_module",
 		"discover_entry_points",
 		"discover_entry_points_by_name",
-		"iter_submodules"
+		"iter_submodules",
 		]
 
 

domdf_python_tools/pagesizes/classes.py

@@ -110,6 +110,8 @@ def from_pt(cls, size: Tuple[float, float]):
 	def from_size(cls, size: Tuple[AnyNumber, AnyNumber]) -> "BaseSize":
 		"""
 		Create a :class:`~domdf_python_tools.pagesizes.classes.BaseSize` object from a tuple.
+
+		:param size:
 		"""
 
 		return cls(*size)

domdf_python_tools/pagesizes/units.py

@@ -39,7 +39,7 @@
 # stdlib
 import math
 from decimal import ROUND_HALF_UP, Decimal
-from typing import SupportsFloat, Union
+from typing import NoReturn, SupportsFloat, Union
 
 # this package
 from domdf_python_tools.doctools import prettify_docstrings
@@ -199,12 +199,12 @@ class Unit(float):
 	name: str = "pt"
 	_in_pt: float = 1
 
-	def __repr__(self):
+	def __repr__(self) -> str:
 		value = _rounders(float(self), "0.000")
 		as_pt = _rounders(self.as_pt(), "0.000")
 		return f"<Unit '{value} {self.name}': {as_pt}pt>"
 
-	def __str__(self):
+	def __str__(self) -> str:
 		value = _rounders(float(self), "0.000")
 		as_pt = _rounders(self.as_pt(), "0.000")
 		return f"<Unit '{value}\u205F{self.name}': {as_pt}pt>"
@@ -251,10 +251,10 @@ def __mod__(self, other: Union[float, "Unit"]) -> "Unit":
 
 		return self.__class__(super().__mod__(other))
 
-	def __pow__(self, power, modulo=None):
+	def __pow__(self, power, modulo=None) -> NoReturn:  # noqa: MAN001
 		raise NotImplementedError("Powers are not supported for units.")
 
-	def __rtruediv__(self, other):
+	def __rtruediv__(self, other) -> NoReturn:  # noqa: MAN001
 		raise NotImplementedError("Dividing by a unit is not allowed.")
 
 	__rdiv__ = __rtruediv__

domdf_python_tools/paths.py

@@ -143,7 +143,7 @@
 """
 
 
-def append(var: str, filename: PathLike, **kwargs) -> int:
+def append(var: str, filename: PathLike, **kwargs) -> int:  # noqa: PRM002
 	"""
 	Append ``var`` to the file ``filename`` in the current directory.
 
@@ -205,7 +205,7 @@ def copytree(
 	return dst
 
 
-def delete(filename: PathLike, **kwargs):
+def delete(filename: PathLike, **kwargs):  # noqa: PRM002
 	"""
 	Delete the file in the current directory.
 
@@ -261,7 +261,7 @@ def parent_path(path: PathLike) -> pathlib.Path:
 	return path.parent
 
 
-def read(filename: PathLike, **kwargs) -> str:
+def read(filename: PathLike, **kwargs) -> str:  # noqa: PRM002
 	"""
 	Read a file in the current directory (in text mode).
 
@@ -308,7 +308,7 @@ def relpath(path: PathLike, relative_to: Optional[PathLike] = None) -> pathlib.P
 		return abs_path
 
 
-def write(var: str, filename: PathLike, **kwargs) -> None:
+def write(var: str, filename: PathLike, **kwargs) -> None:  # noqa: PRM002
 	"""
 	Write a variable to file in the current directory.
 
@@ -518,7 +518,7 @@ def write_lines(
 			encoding: Optional[str] = "UTF-8",
 			errors: Optional[str] = None,
 			*,
-			trailing_whitespace: bool = False
+			trailing_whitespace: bool = False,
 			) -> None:
 		"""
 		Write the given list of lines to the file without trailing whitespace.
@@ -536,7 +536,7 @@ def write_lines(
 		if isinstance(data, str):
 			warnings.warn(
 					"Passing a string to PathPlus.write_lines writes each character to its own line.\n"
-					"That probably isn't what you intended."
+					"That probably isn't what you intended.",
 					)
 
 		if trailing_whitespace:
@@ -592,7 +592,7 @@ def open(  # type: ignore  # noqa: A003  # pylint: disable=redefined-builtin
 		encoding: Optional[str] = "UTF-8",
 		errors: Optional[str] = None,
 		newline: Optional[str] = NEWLINE_DEFAULT,
-		) -> IO[Any]:
+	) -> IO[Any]:
 		"""
 		Open the file pointed by this path and return a file object, as
 		the built-in :func:`open` function does.
@@ -790,6 +790,8 @@ def unlink(self, missing_ok: bool = False) -> None:
 
 			If the path is a directory, use :meth:`~domdf_python_tools.paths.PathPlus.rmdir()` instead.
 
+			:param missing_ok:
+
 			.. versionadded:: 0.3.8 for Python 3.8 and above
 			.. versionadded:: 0.11.0 for Python 3.6 and Python 3.7
 			"""
@@ -1125,6 +1127,10 @@ class TemporaryPathPlus(tempfile.TemporaryDirectory):
 
 	Unlike :func:`tempfile.TemporaryDirectory` this class is based around a :class:`~.PathPlus` object.
 
+	:param suffix: A str suffix for the directory name.
+	:param prefix: A str prefix for the directory name.
+	:param dir: A directory to create this temp dir in.
+
 	.. versionadded:: 2.4.0
 	.. autosummary-widths:: 6/16
 	"""
@@ -1170,12 +1176,12 @@ def __enter__(self) -> PathPlus:
 
 
 def sort_paths(*paths: PathLike) -> List[PathPlus]:
-	"""
+	r"""
 	Sort the ``paths`` by directory, then by file.
 
 	.. versionadded:: 2.6.0
 
-	:param paths:
+	:param \*paths:
 	"""
 
 	directories: Dict[str, List[PathPlus]] = defaultdict(list)
@@ -1259,7 +1265,7 @@ def phase4(self) -> None:  # noqa: D102
 			"left_only": filecmp.dircmp.phase1,
 			"right_only": filecmp.dircmp.phase1,
 			"left_list": filecmp.dircmp.phase0,
-			"right_list": filecmp.dircmp.phase0
+			"right_list": filecmp.dircmp.phase0,
 			}
 
 	methodmap = _methodmap  # type: ignore[assignment]

domdf_python_tools/pretty_print.py

@@ -150,7 +150,7 @@ def _pprint_dict(
 				allowance + 1,
 				context,
 				level,
-				)
+			)
 
 		write(self._make_close('}', indent, obj))
 
@@ -250,7 +250,7 @@ def _format_attribute_items(self, items, stream, indent, allowance, context, lev
 				allowance if last else 1,
 				context,
 				level,
-				)
+			)
 
 			if not last:
 				write(delimnl)
@@ -263,7 +263,7 @@ def simple_repr(*attributes: str, show_module: bool = False, **kwargs):
 	r"""
 	Adds a simple ``__repr__`` method to the decorated class.
 
-	:param attributes: The attributes to include in the ``__repr__``.
+	:param \*attributes: The attributes to include in the ``__repr__``.
 	:param show_module: Whether to show the name of the module in the ``__repr__``.
 	:param \*\*kwargs: Keyword arguments passed on to :class:`pprint.PrettyPrinter`.
 	"""

domdf_python_tools/stringlist.py

@@ -108,7 +108,7 @@ def __repr__(self) -> str:
 
 		return f"{type(self).__name__}(size={self.size}, type={self.type!r})"
 
-	def __eq__(self, other):
+	def __eq__(self, other) -> bool:  # noqa: MAN001
 		if isinstance(other, Indent):
 			return other.size == self.size and other.type == self.type
 		elif isinstance(other, str):
@@ -252,7 +252,7 @@ def __setitem__(self, index: Union[SupportsIndex, slice], line: Union[String, It
 			for lline, idx in zip(
 				reversed(line),
 				reversed(range(index.start or 0, index.stop + 1, index.step or 1)),
-				):
+			):
 				self[idx] = lline
 		else:
 			line = cast(String, line)
@@ -304,7 +304,7 @@ def blankline(self, ensure_single: bool = False):
 
 		self.append('')
 
-	def set_indent_size(self, size: int = 0):
+	def set_indent_size(self, size: int = 0) -> None:
 		"""
 		Sets the size of the indent to insert at the beginning of new lines.
 
@@ -313,7 +313,7 @@ def set_indent_size(self, size: int = 0):
 
 		self.indent.size = int(size)
 
-	def set_indent_type(self, indent_type: str = '\t'):
+	def set_indent_type(self, indent_type: str = '\t') -> None:
 		"""
 		Sets the type of the indent to insert at the beginning of new lines.
 
@@ -322,7 +322,7 @@ def set_indent_type(self, indent_type: str = '\t'):
 
 		self.indent.type = str(indent_type)
 
-	def set_indent(self, indent: Union[String, Indent], size: int = 0):
+	def set_indent(self, indent: Union[String, Indent], size: int = 0) -> None:
 		"""
 		Sets the indent to insert at the beginning of new lines.
 
@@ -386,7 +386,7 @@ def __bytes__(self) -> bytes:
 
 		return str(self).encode("UTF-8")
 
-	def __eq__(self, other) -> bool:
+	def __eq__(self, other) -> bool:  # noqa: PRM002
 		"""
 		Returns whether the other object is equal to this :class:`~domdf_python_tools.stringlist.StringList`.
 		"""
@@ -467,6 +467,8 @@ def splitlines(self, keepends: bool = False) -> List[str]:
 		"""
 		Analagous to :meth:`str.splitlines`.
 
+		:param keepends:
+
 		.. versionadded:: 3.8.0
 		"""
 

domdf_python_tools/terminal.py

@@ -179,7 +179,7 @@ def __enter__(self):
 
 		self.locals_on_entry = self.parent_frame.f_locals.copy()  # type: ignore[union-attr]
 
-	def __exit__(self, *args, **kwargs):
+	def __exit__(self, *args, **kwargs):  # noqa: PRM002
 		"""
 		Called when exiting the context manager.
 		"""