Linting and configuring pre-commit

Author: domdfcoding

.pre-commit-config.yaml

@@ -30,17 +30,18 @@ repos:
     -   id: pyupgrade
         args: [--py36-plus]
 
--   repo: https://github.com/asottile/add-trailing-comma
-    rev: v2.0.1
-    hooks:
-    -   id: add-trailing-comma
+#-   repo: https://github.com/asottile/add-trailing-comma
+#    rev: v2.0.1
+#    hooks:
+#    -   id: add-trailing-comma
 
--   repo: https://gitlab.com/pycqa/flake8
-    rev: 3.8.2
-    hooks:
-    -   id: flake8
+#-   repo: https://gitlab.com/pycqa/flake8
+#    rev: 3.8.2
+#    hooks:
+#    -   id: flake8
 
--   repo: https://github.com/pycqa/bandit
-    rev: 1.6.2
+-   repo: https://github.com/pre-commit/mirrors-yapf
+    rev: v0.30.0
     hooks:
-    -   id: bandit
+    -   id: yapf
+        args: [exclude *.pyi]

domdf_python_tools/dates.py

@@ -255,5 +255,5 @@ def check_date(month: Union[str, int], day: int, leap_year: bool = True) -> bool
 	# stdlib
 	import warnings
 	warnings.warn(
-			"'domdf_python_tools.dates' requires pytz (https://pypi.org/project/pytz/), but it is not installed."
+			"'domdf_python_tools.dates' requires pytz (https://pypi.org/project/pytz/), but it is not installed.",
 			)

repo_helper.yml

@@ -73,3 +73,6 @@ extras_require:
 
 keywords:
   - utilities
+
+yapf_exclude:
+  - "*.pyi"

tests/test_bases.py

@@ -8,7 +8,7 @@
 
 # stdlib
 import copy
-import pickle
+import pickle  # nosec: B101
 from collections import UserList
 
 # 3rd party
@@ -84,7 +84,7 @@ def test_copy(self, alice):
 		assert copy.copy(alice) == copy.copy(alice)
 
 	def test_pickle(self, alice):
-		assert pickle.loads(pickle.dumps(alice)) == alice
+		assert pickle.loads(pickle.dumps(alice)) == alice  # nosec: B101
 
 	def test_vars(self, alice):
 		assert vars(alice) == dict(alice)

tests/test_dates.py

@@ -47,7 +47,7 @@ def test_utc_offset():
 def test_converting_timezone():
 	# No matter what timezone we convert to the timestamp should be the same
 	for tz in pytz.all_timezones:
-		assert test_date.astimezone(dates.get_timezone(tz, test_date)
+		assert test_date.astimezone(dates.get_timezone(tz, test_date),
 									).timestamp() == test_date.timestamp() == 845173200.0
 
 		if dates.get_utc_offset(tz, test_date):  # otherwise the timezone stayed as UTC

tests/test_doctools.py

@@ -184,11 +184,12 @@ def test_decorators():
 
 	# set_opening_hours and ceil should have extra text at the beginning
 	assert SpamCafe.set_opening_hours.__doc__.startswith("\nI will not buy this record, it is scratched.")
-	assert doctools.deindent_string(SpamCafe.set_opening_hours.__doc__
-									).endswith(doctools.deindent_string(Cafe.set_opening_hours.__doc__))
+	assert doctools.deindent_string(SpamCafe.set_opening_hours.__doc__, ).endswith(
+			doctools.deindent_string(Cafe.set_opening_hours.__doc__)
+			)
 	# Dedented both strings to be sure of equivalence
 	assert SpamCafe.ceil.__doc__.startswith(
-			"\nI don't know why the cafe has a ceil function, but we'd better document it properly."
+			"\nI don't know why the cafe has a ceil function, but we'd better document it properly.",
 			)
 	assert doctools.deindent_string(SpamCafe.ceil.__doc__).endswith(doctools.deindent_string(math.ceil.__doc__))
 	# Dedented both strings to be sure of equivalence
@@ -198,10 +199,11 @@ def test_decorators():
 	assert undocumented_function.__name__ == "undocumented_function"
 	assert undocumented_function.__annotations__ == {'a': float, 'b': float, 'c': float, 'd': int, 'return': float}
 	assert partially_documented_function.__doc__.startswith(
-			"\nThis function works like ``documented_function`` except it returns the result telepathically."
+			"\nThis function works like ``documented_function`` except it returns the result telepathically.",
+			)
+	assert doctools.deindent_string(partially_documented_function.__doc__, ).endswith(
+			doctools.deindent_string(documented_function.__doc__)
 			)
-	assert doctools.deindent_string(partially_documented_function.__doc__
-									).endswith(doctools.deindent_string(documented_function.__doc__))
 	# Dedented both strings to be sure of equivalence
 	assert DummyClass.function_in_class_with_same_args.__doc__ == documented_function.__doc__
 	assert DummyClass.function_in_class_with_same_args.__name__ == "function_in_class_with_same_args"
@@ -265,7 +267,7 @@ def test_still_callable():
 			"Lobster Thermidor au Crevette with a Mornay "
 			"sauce served in a Provencale manner with "
 			"shallots and aubergines garnished with truffle "
-			"pate, brandy and with a fried egg on top and spam."
+			"pate, brandy and with a fried egg on top and spam.",
 			]
 	assert spam_cafe.opening_hours == """Open Monday-Saturday 7am - 6pm
 Please note our opening hours may vary due to COVID-19"""

tests/test_paths.py

@@ -122,7 +122,7 @@ def test_parent_path():
 				(pathlib.Path("/home/username/Documents/games/chess.py"), "/home/username/Documents/letter.doc"),
 				(pathlib.Path("/home/username/Documents"), "letter.doc"),
 				(None, pathlib.Path("/home/username/Documents/letter.doc")),
-				]
+				],
 		)
 def test_relpath(relto, relpath):
 	path = "/home/username/Documents/letter.doc"
@@ -175,12 +175,12 @@ def test_clean_writer():
 		tempfile = pathlib.Path(tmpdir) / "tmpfile.txt"
 
 		test_string = "\n".join([
-					"Top line",
-					"    ",
-					"Line with whitespace   ",
-					"Line with tabs				   ",
-					"No newline at end of file",
-					])
+				"Top line",
+				"    ",
+				"Line with whitespace   ",
+				"Line with tabs				   ",
+				"No newline at end of file",
+				])
 
 		with tempfile.open("w") as fp:
 			clean_writer(test_string, fp)
@@ -193,12 +193,12 @@ def test_clean_writer():
 """
 		# Again with lots of newlines
 		test_string = "\n".join([
-					"Top line",
-					"    ",
-					"Line with whitespace   ",
-					"Line with tabs				   ",
-					"Too many newlines\n\n\n\n\n\n\n",
-					])
+				"Top line",
+				"    ",
+				"Line with whitespace   ",
+				"Line with tabs				   ",
+				"Too many newlines\n\n\n\n\n\n\n",
+				])
 
 		with tempfile.open("w") as fp:
 			clean_writer(test_string, fp)

tests/test_terminal_colours.py

@@ -91,7 +91,7 @@ def test_fore_attributes(obj, expects, capsys):
 				(Back.LIGHTMAGENTA_EX, "\033[105m"),
 				(Back.LIGHTCYAN_EX, "\033[106m"),
 				(Back.LIGHTWHITE_EX, "\033[107m"),
-				]
+				],
 		)
 def test_back_attributes(obj, expects, capsys):
 	assert obj == expects
@@ -114,11 +114,12 @@ def test_back_attributes(obj, expects, capsys):
 
 
 @pytest.mark.parametrize(
-		"obj, expects", [
+		"obj, expects",
+		[
 				(Style.DIM, "\033[2m"),
 				(Style.NORMAL, "\033[22m"),
 				(Style.BRIGHT, "\033[1m"),
-				]
+				],
 		)
 def test_style_attributes(obj, expects, capsys):
 	assert obj == expects

tests/test_utils.py

@@ -88,7 +88,7 @@ def test_chunks():
 				(['a', 'b', 'c'], "a,b,c"),
 				(['a', 'b', 1, 2], "a,b,1,2"),
 				(['a', 2, pathlib.Path("foo.txt")], "a,2,foo.txt"),
-				]
+				],
 		)
 def test_list2str(value, expects):
 	str_representation = list2str(value)
@@ -107,7 +107,7 @@ def test_list2str(value, expects):
 				(['a', 'b', 'c'], "a;b;c"),
 				(['a', 'b', 1, 2], "a;b;1;2"),
 				(['a', 2, pathlib.Path("foo.txt")], "a;2;foo.txt"),
-				]
+				],
 		)
 def test_list2str_semicolon(value, expects):
 	str_representation = list2str(value, sep=';')
@@ -207,7 +207,7 @@ def get_mem_addr(obj):
 				(12.34, "12.34"),
 				(CustomRepr(), "This is my custom __repr__!"),
 				(no_repr_instance, f"<tests.test_utils.NoRepr object at {get_mem_addr(no_repr_instance)}>"),
-				]
+				],
 		)
 def test_printr(obj, expects, capsys):
 	utils.printr(obj)
@@ -226,7 +226,7 @@ def test_printr(obj, expects, capsys):
 				(12.34, "<class 'float'>"),
 				(CustomRepr(), "<class 'tests.test_utils.CustomRepr'>"),
 				(no_repr_instance, "<class 'tests.test_utils.NoRepr'>"),
-				]
+				],
 		)
 def test_printt(obj, expects, capsys):
 	utils.printt(obj)
@@ -245,7 +245,7 @@ def test_printt(obj, expects, capsys):
 				(12.34, "12.34"),
 				(CustomRepr(), "This is my custom __repr__!"),
 				(no_repr_instance, f"<tests.test_utils.NoRepr object at {get_mem_addr(no_repr_instance)}>"),
-				]
+				],
 		)
 def test_stderr_writer(obj, expects, capsys):
 	utils.stderr_writer(obj)
@@ -264,7 +264,7 @@ def test_split_len():
 		[
 				("1,2,3", (1, 2, 3)),  # tests without spaces
 				("1, 2, 3", (1, 2, 3)),  # tests with spaces
-				]
+				],
 		)
 def test_str2tuple(value, expects):
 	assert isinstance(str2tuple(value), tuple)
@@ -276,7 +276,7 @@ def test_str2tuple(value, expects):
 		[
 				("1;2;3", (1, 2, 3)),  # tests without semicolon
 				("1; 2; 3", (1, 2, 3)),  # tests with semicolon
-				]
+				],
 		)
 def test_str2tuple_semicolon(value, expects):
 	assert isinstance(str2tuple(value, sep=';'), tuple)
@@ -316,7 +316,7 @@ def test_str2tuple_semicolon(value, expects):
 				("oFF", False),
 				('0', False),
 				(0, False),
-				]
+				],
 		)
 def test_strtobool(obj, expects):
 	assert utils.strtobool(obj) == expects
@@ -331,7 +331,7 @@ def test_strtobool(obj, expects):
 				(None, AttributeError),
 				(1.0, AttributeError),
 				(0.0, AttributeError),
-				]
+				],
 		)
 def test_strtobool_errors(obj, expects):
 	with pytest.raises(expects):
@@ -357,7 +357,7 @@ def test_strtobool_errors(obj, expects):
 				("False", "False"),
 				("false", "'false'"),
 				("Hello World", "'Hello World'"),
-				]
+				],
 		)
 def test_enquote_value(obj, expects):
 	assert utils.enquote_value(obj) == expects

tox.ini

@@ -95,7 +95,7 @@ changedir = {toxinidir}
 skip_install = true
 ignore_errors = true
 deps = yapf
-commands = yapf -i --recursive domdf_python_tools tests
+commands = yapf -i --recursive domdf_python_tools tests --exclude "*.pyi"
 
 
 [testenv:isort]
@@ -119,6 +119,22 @@ deps =
 commands = mypy domdf_python_tools tests
 
 
+
+[testenv:bandit]
+basepython = python3.6
+
+ignore_errors = true
+changedir = {toxinidir}
+deps =
+    bandit
+whitelist_externals = /usr/bin/printf
+commands =
+    printf "===== Running Bandit on domdf_python_tools ====="
+    bandit domdf_python_tools -r
+    printf "===== Running Bandit on tests ====="
+    bandit tests -r -s B101
+
+
 [testenv:pyup]
 basepython = python3.6