Linting

Author: domdfcoding

domdf_python_tools/pagesizes/classes.py

@@ -40,6 +40,7 @@
 from typing import List, Tuple
 
 # this package
+from domdf_python_tools.doctools import prettify_docstrings
 from domdf_python_tools.typing import AnyNumber
 
 # this package
@@ -57,6 +58,7 @@
 		]
 
 
+@prettify_docstrings
 class BaseSize(namedtuple("__BaseSize", "width, height")):
 	"""
 	Base class namedtuple representing a page size, in point.

domdf_python_tools/stringlist.py

@@ -46,7 +46,7 @@ class Indent:
 	Represents an indent, having a symbol/type and a size.
 	"""
 
-	def __init__(self, size: int = 0, type: str = "\t"):
+	def __init__(self, size: int = 0, type: str = "\t"):  # noqa A002  # pylint: disable=redefined-builtin
 		self.size = int(size)
 		self.type = str(type)
 
@@ -71,15 +71,15 @@ def size(self, size: int) -> None:
 		self._size = int(size)
 
 	@property
-	def type(self) -> str:  # noqa A002
+	def type(self) -> str:  # noqa A002  # pylint: disable=redefined-builtin
 		"""
 		The indent character.
 		"""
 
 		return self._type
 
-	@type.setter  # noqa A002
-	def type(self, type: str) -> None:  # noqa A002
+	@type.setter  # noqa A002  # pylint: disable=redefined-builtin
+	def type(self, type: str) -> None:  # noqa A002  # pylint: disable=redefined-builtin
 		if not str(type):
 			raise ValueError("'type' cannot an empty string.")
 
@@ -324,7 +324,7 @@ def indent_type(self) -> str:
 		return str(self.indent.type)
 
 	@indent_type.setter
-	def indent_type(self, type: str) -> None:  # noqa: A002
+	def indent_type(self, type: str) -> None:  # noqa: A002  # pylint: disable=redefined-builtin
 		"""
 		Sets the indent type.
 		"""

domdf_python_tools/utils.py

@@ -437,14 +437,16 @@ def __repr__(self) -> str:
 """
 
 
-def head(obj: Union[Tuple, List, "DataFrame", "Series", "String"], n: int = 10) -> str:
+def head(obj: Union[Tuple, List, "DataFrame", "Series", String, HasHead], n: int = 10) -> str:
 	"""
 	Returns the head of the given object.
 
 	:param obj:
 	:param n: Show the first ``n`` items of ``obj``.
 
 	.. versionadded:: 0.8.0
+
+	.. seealso:: :func:`textwrap.shorten`, which truncates a string to fit within a given number of characters.
 	"""
 
 	if isinstance(obj, tuple) and hasattr(obj, "_fields"):

tests/test_stringlist.py

@@ -408,7 +408,7 @@ def test_str(self):
 	@pytest.mark.xfail()
 	def test_pickle(self):
 		sl = StringList(['', '', "hello", "world", '', '', '', "1234"])
-		assert sl == pickle.loads(pickle.dumps(sl))
+		assert sl == pickle.loads(pickle.dumps(sl))  # nosec: B301
 
 
 class TestIndent:
@@ -490,8 +490,8 @@ def test_eq(self):
 		assert Indent(2, "\t") == (2, "\t")
 		assert Indent(2, "\t") == "\t\t"
 
-		assert not Indent() == 1
+		assert Indent() != 1
 
 	def test_pickle(self):
 		indent = Indent(2, "    ")
-		assert indent == pickle.loads(pickle.dumps(indent))
+		assert indent == pickle.loads(pickle.dumps(indent))  # nosec: B301