Linting

Author: domdfcoding

domdf_python_tools/dates.py

@@ -179,7 +179,7 @@ def utc_timestamp_to_datetime(
 	return new_datetime.astimezone(output_tz)
 
 
-if sys.version_info <= (3, 7):
+if sys.version_info <= (3, 7, 2):
 	MonthsType = OrderedDict
 else:
 	MonthsType = typing.OrderedDict[str, str]

domdf_python_tools/delegators.py

@@ -121,7 +121,7 @@ def _f(f: _C) -> _C:
 			f.__signature__ = from_sig.replace(  # type: ignore
 				parameters=[
 				from_params["self"],
-				*to_sig.parameters.values()
+				*to_sig.parameters.values(),
 				]
 				)
 

domdf_python_tools/import_tools.py

@@ -96,7 +96,7 @@ def discover(
 	.. versionchanged:: 1.0.0
 
 		Added the ``exclude_side_effects`` parameter.
-	"""
+	"""  # noqa D400
 
 	matching_objects = []
 

domdf_python_tools/pagesizes/units.py

@@ -293,7 +293,7 @@ def __call__(self, value: Union[SupportsFloat, str, bytes, bytearray] = 0.0) ->
 
 class Unitpt(Unit):
 	"""
-	Point
+	Point.
 	"""
 
 	name = "pt"

domdf_python_tools/pretty_print.py

@@ -116,56 +116,57 @@ def _make_close(self, char: str, indent: int, obj):
 		else:
 			return char
 
-	def _pprint_dict(self, object, stream, indent, allowance, context, level):
+	def _pprint_dict(self, object, stream, indent, allowance, context, level):  # noqa: A002
+		obj = object
 		write = stream.write
-		write(self._make_open('{', indent, object))
+		write(self._make_open('{', indent, obj))
 
 		if self._indent_per_level > 1:
 			write((self._indent_per_level - 1) * ' ')
 
-		if len(object):
+		if len(obj):
 			self._format_dict_items(  # type: ignore
-				object.items(),
-				stream,
-				indent,
-				allowance + 1,
-				context,
-				level,
-				)
+					obj.items(),
+					stream,
+					indent,
+					allowance + 1,
+					context,
+					level,
+					)
 
-		write(self._make_close('}', indent, object))
+		write(self._make_close('}', indent, obj))
 
 	_dispatch[dict.__repr__] = _pprint_dict
 
-	def _pprint_list(self, object, stream, indent, allowance, context, level):
-		stream.write(self._make_open('[', indent, object))
-		self._format_items(object, stream, indent, allowance + 1, context, level)
-		stream.write(self._make_close(']', indent, object))
+	def _pprint_list(self, obj, stream, indent, allowance, context, level):
+		stream.write(self._make_open('[', indent, obj))
+		self._format_items(obj, stream, indent, allowance + 1, context, level)
+		stream.write(self._make_close(']', indent, obj))
 
 	_dispatch[list.__repr__] = _pprint_list
 
-	def _pprint_tuple(self, object, stream, indent, allowance, context, level):
-		stream.write(self._make_open('(', indent, object))
-		endchar = ",)" if len(object) == 1 else self._make_close(')', indent, object)
-		self._format_items(object, stream, indent, allowance + len(endchar), context, level)
+	def _pprint_tuple(self, obj, stream, indent, allowance, context, level):
+		stream.write(self._make_open('(', indent, obj))
+		endchar = ",)" if len(obj) == 1 else self._make_close(')', indent, obj)
+		self._format_items(obj, stream, indent, allowance + len(endchar), context, level)
 		stream.write(endchar)
 
 	_dispatch[tuple.__repr__] = _pprint_tuple
 
-	def _pprint_set(self, object, stream, indent, allowance, context, level):
-		if not len(object):
-			stream.write(repr(object))
+	def _pprint_set(self, obj, stream, indent, allowance, context, level):
+		if not len(obj):
+			stream.write(repr(obj))
 			return
-		typ = object.__class__
+		typ = obj.__class__
 		if typ is set:
-			stream.write(self._make_open('{', indent, object))
-			endchar = self._make_close('}', indent, object)
+			stream.write(self._make_open('{', indent, obj))
+			endchar = self._make_close('}', indent, obj)
 		else:
 			stream.write(typ.__name__ + f"({{\n{' ' * (indent + self._indent_per_level + len(typ.__name__) + 1)}")
 			endchar = f",\n{' ' * (indent + self._indent_per_level + len(typ.__name__) + 1)}}})"
 			indent += len(typ.__name__) + 1
-		object = sorted(object, key=_safe_key)
-		self._format_items(object, stream, indent, allowance + len(endchar), context, level)
+		obj = sorted(obj, key=_safe_key)
+		self._format_items(obj, stream, indent, allowance + len(endchar), context, level)
 		stream.write(endchar)
 
 	_dispatch[set.__repr__] = _pprint_set
@@ -215,7 +216,7 @@ def _format_attribute_items(self, items, stream, indent, allowance, context, lev
 
 		write = stream.write
 		indent += self._indent_per_level
-		delimnl = ',\n' + ' ' * indent
+		delimnl = ",\n" + ' ' * indent
 		last_index = len(items) - 1
 
 		for i, (key, ent) in enumerate(items):

domdf_python_tools/stringlist.py

@@ -72,15 +72,15 @@ def size(self) -> int:
 	def size(self, size: int) -> None:
 		self._size = int(size)
 
-	@property
-	def type(self) -> str:  # noqa A002,A003  # pylint: disable=redefined-builtin
+	@property  # noqa: A002,A003
+	def type(self) -> str:  # noqa: A002,A003  # pylint: disable=redefined-builtin
 		"""
 		The indent character.
 		"""
 
 		return self._type
 
-	@type.setter  # noqa A002  # pylint: disable=redefined-builtin
+	@type.setter  # noqa: A002,A003  # 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.")

domdf_python_tools/testing.py

@@ -343,10 +343,9 @@ def only_pypy(reason: str = "Only required on PyPy.") -> _pytest.mark.structures
 	return pytest.mark.skipif(condition=not PYPY, reason=reason)
 
 
-@pytest.fixture(scope="function")
+@pytest.fixture()
 def tmp_pathplus(tmp_path: Path) -> PathPlus:
 	"""
-
 	Pytest fixture that returns a temporary directory in the form of a
 	:class:`~domdf_python_tools.paths.PathPlus` object.
 
@@ -365,6 +364,6 @@ def my_test(tmp_pathplus: PathPlus):
 	:rtype:
 
 	.. versionadded:: 0.10.0
-	"""
+	"""  # noqa: D400
 
 	return PathPlus(tmp_path)

domdf_python_tools/typing.py

@@ -121,7 +121,7 @@ def dumps(
 			**kwds: Any,
 			) -> str:
 		"""
-		Serialize ``obj`` to a JSON formatted ``str``.
+		Serialize ``obj`` to a JSON formatted :class:`str`.
 
 		:param obj:
 		:param skipkeys:

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)):
@@ -569,10 +569,10 @@ def deprecated(
 		deprecated_in: Optional[str] = None,
 		removed_in: Optional[str] = None,
 		current_version: Optional[str] = None,
-		details: str = "",
+		details: str = '',
 		name: Optional[str] = None
 		):
-	r"""Decorate a function to signify its deprecation
+	r"""Decorate a function to signify its deprecation.
 
 	This function wraps a method that will soon be removed and does two things:
 
@@ -657,7 +657,7 @@ def deprecated(
 
 	def _function_wrapper(function):
 		# Everything *should* have a docstring, but just in case...
-		existing_docstring = function.__doc__ or ""
+		existing_docstring = function.__doc__ or ''
 
 		# split docstring at first occurrence of newline
 		string_list = existing_docstring.split("\n", 1)
@@ -726,7 +726,7 @@ def _inner(*args, **kwargs):
 
 			return function(*args, **kwargs)
 
-		_inner.__doc__ = "".join(string_list)
+		_inner.__doc__ = ''.join(string_list)
 
 		return _inner
 

tests/list_tests.py

@@ -102,7 +102,7 @@ def test_reversed(self):
 		assert list(reversed(self.type2test())) == self.type2test()
 		# Bug 3689: make sure list-reversed-iterator doesn't have __len__
 		with pytest.raises(TypeError):
-			len(reversed([1, 2, 3]))
+			len(reversed([1, 2, 3]))  # type: ignore
 
 	def test_setitem(self):
 		a = self.type2test([0, 1])