Linting.

Author: domdfcoding

domdf_python_tools/utils.py

@@ -53,10 +53,13 @@
 import itertools
 import sys
 from typing import Any, Callable, Dict, Generator, Iterable, List, Optional, Sequence, Tuple, Union
-from domdf_python_tools import __version__
+
+# 3rd party
 import deprecation  # type: ignore
-import domdf_python_tools.words
 
+# this package
+import domdf_python_tools.words
+from domdf_python_tools import __version__
 
 __all__ = [
 		"pyversion",
@@ -396,13 +399,19 @@ def convert_indents(text: str, tab_width: int = 4, from_: str = "\t", to: str =
 
 
 as_text = deprecation.deprecated(
-		deprecated_in="0.8.0", removed_in="1.0.0",
+		deprecated_in="0.8.0",
+		removed_in="1.0.0",
 		current_version=__version__,
 		details="Import from 'domdf_python_tools.words' instead.",
-		)(domdf_python_tools.words.as_text)
+		)(
+				domdf_python_tools.words.as_text
+				)
 
 word_join = deprecation.deprecated(
-		deprecated_in="0.8.0", removed_in="1.0.0",
+		deprecated_in="0.8.0",
+		removed_in="1.0.0",
 		current_version=__version__,
 		details="Import from 'domdf_python_tools.words' instead.",
-		)(domdf_python_tools.words.word_join)
+		)(
+				domdf_python_tools.words.word_join
+				)

domdf_python_tools/words.py

@@ -107,6 +107,7 @@ def get_words_list(min_length: int = 0, max_length: int = -1) -> List[str]:
 	.. versionadded:: 0.4.5
 	"""
 
+	# this package
 	from domdf_python_tools.paths import PathPlus
 
 	with importlib_resources.path(domdf_python_tools, "google-10000-english-no-swears.txt") as words_file_:

requirements.txt

@@ -1,5 +1,5 @@
 colorama>=0.4.3
+deprecation>=2.1.0
 importlib_resources>=3.0.0
 pydash>=4.7.4
 typing_extensions>=3.7.4.3
-deprecation>=2.1.0

tests/test_words.py

@@ -8,10 +8,10 @@
 import pytest
 
 # this package
+from domdf_python_tools import words
 from domdf_python_tools.paths import PathPlus
 from domdf_python_tools.stringlist import StringList
 from domdf_python_tools.words import DOUBLESTRUCK_LETTERS, alpha_sort, get_random_word, get_words_list
-from domdf_python_tools import words
 
 
 @pytest.mark.parametrize(
@@ -99,7 +99,7 @@ def test_alpha_sort():
 				(123.45, "123.45"),
 				([123.45], "[123.45]"),
 				({123.45}, "{123.45}"),
-				((123.45,), "(123.45,)"),
+				((123.45, ), "(123.45,)"),
 				(None, ''),
 				(pathlib.Path('.'), '.'),
 				(PathPlus('.'), '.'),
@@ -128,14 +128,14 @@ def test_word_join():
 
 	assert words.word_join(()) == ''
 
-	assert words.word_join(("bob",)) == "bob"
+	assert words.word_join(("bob", )) == "bob"
 	assert words.word_join(("bob", "alice")) == "bob and alice"
 	assert words.word_join(("bob", "alice", "fred")) == "bob, alice and fred"
 
-	assert words.word_join(("bob",), use_repr=True) == "'bob'"
+	assert words.word_join(("bob", ), use_repr=True) == "'bob'"
 	assert words.word_join(("bob", "alice"), use_repr=True) == "'bob' and 'alice'"
 	assert words.word_join(("bob", "alice", "fred"), use_repr=True) == "'bob', 'alice' and 'fred'"
 
-	assert words.word_join(("bob",), use_repr=True, oxford=True) == "'bob'"
+	assert words.word_join(("bob", ), use_repr=True, oxford=True) == "'bob'"
 	assert words.word_join(("bob", "alice"), use_repr=True, oxford=True) == "'bob' and 'alice'"
 	assert words.word_join(("bob", "alice", "fred"), use_repr=True, oxford=True) == "'bob', 'alice', and 'fred'"

tox.ini

@@ -113,6 +113,7 @@ ignore_errors = true
 changedir = {toxinidir}
 deps =
 	mypy==0.782
+	lxml
 	-r{toxinidir}/tests/requirements.txt
 commands = mypy domdf_python_tools tests {posargs}
 
@@ -166,13 +167,18 @@ rst-roles =
     meth
     exc
     attr
+    wikipedia
+    rst:role
+    rst:dir
 rst-directives =
     envvar
     exception
     seealso
     TODO
     versionadded
     versionchanged
+    rest-example
+    extras-require
 per-file-ignores =
     tests/*: D100 D101 D102 D103 D104 D106 D201 D204 D207 D208 D209 D210 D211 D212 D213 D214 D215 D300 D301 D400 D402 D403 D404 D415 D417 DALL000
 pytest-parametrize-names-type = csv