Linting

Author: domdfcoding

.pre-commit-config.yaml

@@ -50,8 +50,8 @@ repos:
  - repo: https://github.com/Lucas-C/pre-commit-hooks
    rev: v1.1.7
    hooks:
-    - id: forbid-crlf
     - id: remove-crlf
+    - id: forbid-crlf
 
 
  - repo: https://github.com/domdfcoding/yapf-isort

domdf_python_tools/doctools.py

@@ -329,7 +329,7 @@ def _do_prettify(obj: Type, base: Type, new_docstrings: Dict[str, str]):
 				):
 			continue
 		elif PYPY and isinstance(attribute, MethodType):
-			continue
+			continue  # pragma: no cover (!PyPy)
 
 		if attribute is None:
 			continue

domdf_python_tools/paths.py

@@ -66,6 +66,7 @@
 		"PathPlus",
 		"PosixPathPlus",
 		"WindowsPathPlus",
+		"in_directory",
 		]
 
 newline_default = object()
@@ -489,7 +490,7 @@ def read_lines(
 
 		return self.read_text(encoding=encoding, errors=errors).split("\n")
 
-	def open(  # noqa A003
+	def open(  # type: ignore  # noqa A003
 		self,
 		mode: str = "r",
 		buffering: int = -1,
@@ -526,7 +527,14 @@ def open(  # noqa A003
 			else:
 				newline = "\n"
 
-		return super().open(mode, buffering=buffering, encoding=encoding, errors=errors, newline=newline)
+		return super(
+		).open(  # type: ignore
+				mode,
+				buffering=buffering,
+				encoding=encoding,
+				errors=errors,
+				newline=newline,
+				)
 
 	def dump_json(
 			self,

domdf_python_tools/utils.py

@@ -72,19 +72,21 @@
 import textwrap
 import typing
 import warnings
+from datetime import date
 from pprint import pformat
 from typing import Any, Callable, Dict, Generator, Iterable, List, Optional, Sequence, Tuple, Union
 
 # 3rd party
 import deprecation  # type: ignore
+from packaging import version
 
 # this package
 import domdf_python_tools.words
 from domdf_python_tools import __version__
 from domdf_python_tools.terminal_colours import Colour, Fore
 from domdf_python_tools.typing import HasHead, String
 
-if typing.TYPE_CHECKING or domdf_python_tools.__docs:
+if typing.TYPE_CHECKING or domdf_python_tools.__docs:  # pragma: no cover
 	# 3rd party
 	from pandas import DataFrame, Series  # type: ignore
 
@@ -110,6 +112,7 @@
 		"convert_indents",
 		"etc",
 		"head",
+		"coloured_diff",
 		"deprecated",
 		]
 
@@ -270,7 +273,7 @@ def str2tuple(input_string: str, sep: str = ',') -> Tuple[int, ...]:
 	return tuple(int(x) for x in input_string.split(sep))
 
 
-def strtobool(val: Union[str, bool]) -> bool:
+def strtobool(val: Union[str, int]) -> bool:
 	"""
 	Convert a string representation of truth to :py:obj:`True` or :py:obj:`False`.
 
@@ -557,13 +560,6 @@ def coloured_diff(
 	return str(buf)
 
 
-# stdlib
-from datetime import date
-
-# 3rd party
-from packaging import version
-
-
 def deprecated(
 		deprecated_in: Optional[str] = None,
 		removed_in: Optional[str] = None,

setup.py

@@ -12,8 +12,6 @@
 # this package
 from __pkginfo__ import *  # pylint: disable=wildcard-import
 
-
-
 setup(
 		description='Helpful functions for Python\u2002🐍\u2002🛠️',
 		extras_require=extras_require,

stubs.txt

@@ -0,0 +1 @@
+git+https://github.com/domdfcoding/pytest-regressions-stubs

tests/conftest.py

@@ -0,0 +1 @@
+pytest_plugins = ("domdf_python_tools.testing", )

tests/list_tests.py

@@ -48,7 +48,7 @@ def test_init(self):
 	def test_getitem_error(self):
 		a = []
 		with pytest.raises(TypeError, match="list indices must be integers or slices"):
-			a['a']
+			a['a']  # pylint: disable=pointless-statement
 
 	@no_type_check
 	def test_setitem_error(self):

tests/seq_tests.py

@@ -19,6 +19,7 @@
 
 # this package
 from domdf_python_tools.testing import not_pypy
+from domdf_python_tools.utils import Len
 
 
 class _ALWAYS_EQ:
@@ -139,7 +140,7 @@ def __iter__(self):
 		return self
 
 	def __next__(self):
-		3 // 0
+		3 // 0  # pylint: disable=pointless-statement
 
 
 class IterFuncStop:
@@ -242,7 +243,7 @@ def test_truth(self):
 
 	def test_getitem(self):
 		u = self.type2test([0, 1, 2, 3, 4])
-		for i in range(len(u)):
+		for i in Len(u):
 			self.assertEqual(u[i], i)
 			self.assertEqual(u[int(i)], i)
 		for i in range(-len(u), -1):

tests/test_pretty_print.py

@@ -16,7 +16,7 @@
 
 # 3rd party
 import pytest
-from pytest_regressions.file_regression import FileRegressionFixture  # type: ignore
+from pytest_regressions.file_regression import FileRegressionFixture
 
 # this package
 from domdf_python_tools.pretty_print import FancyPrinter, simple_repr
@@ -578,8 +578,8 @@ def test_sort_orderable_and_unorderable_values(self):
 		# self-test
 		assert a < b
 		assert str(type(b)) < str(type(a))
-		assert sorted([b, a]) == [a, b]
-		assert sorted([a, b]) == [a, b]
+		assert sorted([b, a]) == [a, b]  # type: ignore
+		assert sorted([a, b]) == [a, b]  # type: ignore
 		# set
 		assert FancyPrinter(width=1).pformat({b, a}) == f'{{\n {a!r},\n {b!r},\n }}'
 		assert FancyPrinter(width=1).pformat({a, b}) == f'{{\n {a!r},\n {b!r},\n }}'
@@ -703,7 +703,7 @@ def test_compact_width(self):
 			lines = FancyPrinter(width=w, compact=True).pformat(o, ).splitlines()
 			maxwidth = max(map(len, lines))
 			assert maxwidth <= w
-			maxwidth > w - 3
+			maxwidth > w - 3  # pylint: disable=pointless-statement
 
 	def test_bytes_wrap(self):
 		assert FancyPrinter(width=1).pformat(b'') == "b''"