Linting.

Author: domdfcoding

doc-source/conf.py

@@ -70,6 +70,7 @@
 		'python': ('https://docs.python.org/3/', None),
 		'sphinx': ('https://www.sphinx-doc.org/en/stable/', None),
 		'pandas': ('https://pandas.pydata.org/docs/', None),
+		'consolekit': ('https://consolekit.readthedocs.io/en/latest/', None),
 		}
 
 html_theme = 'domdf_sphinx_theme'

domdf_python_tools/iterative.py

@@ -151,7 +151,7 @@ def double_chain(iterable: Iterable[Iterable]):
 	yield from itertools.chain.from_iterable(itertools.chain.from_iterable(iterable))
 
 
-def flatten(iterable: Iterable, primitives: Tuple[Type] = (str, int, float)):
+def flatten(iterable: Iterable, primitives: Tuple[Type, ...] = (str, int, float)):
 	"""
 	Flattens a mixed list of primitive types and iterables of those types into a single list,
 	regardless of nesting.
@@ -171,7 +171,7 @@ def flatten(iterable: Iterable, primitives: Tuple[Type] = (str, int, float)):
 			raise NotImplementedError
 
 
-Branch = Union[List[str], List["Branch"]]
+Branch = Union[Sequence[str], Sequence[Union[Sequence[str], Sequence]]]
 
 
 def make_tree(tree: Branch) -> Iterator[str]:

domdf_python_tools/terminal_colours.py

@@ -6,6 +6,8 @@
 
 This module generates ANSI character codes to printing colors to terminals.
 See: http://en.wikipedia.org/wiki/ANSI_escape_code
+
+.. deprecated:: Use :mod:`consolekit.terminal_colours` instead.
 """
 #
 #  Copyright © 2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>

domdf_python_tools/utils.py

@@ -23,7 +23,7 @@
 	:func:`~domdf_python_tools.iterative.double_chain`
 	moved to :func:`domdf_python_tools.iterative`.
 
-	They can still be importrd from here until version 2.0.0, but that use is deprecated.
+	They can still be imported from here until version 2.0.0, but that use is deprecated.
 """
 #
 #  Copyright © 2018-2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>
@@ -132,38 +132,6 @@
 SPACE_PLACEHOLDER = '␣'
 
 
-def check_dependencies(dependencies: Iterable[str], prt: bool = True) -> List[str]:
-	"""
-	Check whether one or more dependencies are available to be imported.
-
-	:param dependencies: The list of dependencies to check the availability of.
-	:param prt: Whether the status should be printed to the terminal.
-
-	:return: A list of any missing modules.
-	"""
-
-	# stdlib
-	from pkgutil import iter_modules
-
-	modules = {x[1] for x in iter_modules()}
-	missing_modules = []
-
-	for requirement in dependencies:
-		if requirement not in modules:
-			missing_modules.append(requirement)
-
-	if prt:
-		if len(missing_modules) == 0:
-			print("All modules installed")
-		else:
-			print("The following modules are missing.")
-			print(missing_modules)
-			print("Please check the documentation.")
-		print('')
-
-	return missing_modules
-
-
 def cmp(x, y) -> int:
 	"""
 	Implementation of ``cmp`` for Python 3.
@@ -641,42 +609,80 @@ def _inner(*args, **kwargs):
 
 
 chunks = deprecated(
-		"1.4.0",
-		"2.0.0",
-		__version__,
-		"Import from :mod:`domdf_python_tools.iterative` instead.",
+		deprecated_in="1.4.0",
+		removed_in="2.0.0",
+		current_version=__version__,
+		details="Import from 'domdf_python_tools.iterative' instead.",
 		)(
 				iterative.chunks
 				)
 permutations = deprecated(
-		"1.4.0",
-		"2.0.0",
-		__version__,
-		"Import from :mod:`domdf_python_tools.iterative` instead.",
+		deprecated_in="1.4.0",
+		removed_in="2.0.0",
+		current_version=__version__,
+		details="Import from 'domdf_python_tools.iterative' instead.",
 		)(
 				iterative.permutations
 				)
 split_len = deprecated(
-		"1.4.0",
-		"2.0.0",
-		__version__,
-		"Import from :mod:`domdf_python_tools.iterative` instead.",
+		deprecated_in="1.4.0",
+		removed_in="2.0.0",
+		current_version=__version__,
+		details="Import from 'domdf_python_tools.iterative' instead.",
 		)(
 				iterative.split_len
 				)
 Len = deprecated(
-		"1.4.0",
-		"2.0.0",
-		__version__,
-		"Import from :mod:`domdf_python_tools.iterative` instead.",
+		deprecated_in="1.4.0",
+		removed_in="2.0.0",
+		current_version=__version__,
+		details="Import from 'domdf_python_tools.iterative' instead.",
 		)(
 				iterative.Len
 				)
 double_chain = deprecated(
-		"1.4.0",
-		"2.0.0",
-		__version__,
-		"Import from :mod:`domdf_python_tools.iterative` instead.",
+		deprecated_in="1.4.0",
+		removed_in="2.0.0",
+		current_version=__version__,
+		details="Import from 'domdf_python_tools.iterative' instead.",
 		)(
 				iterative.double_chain
 				)
+
+
+@deprecated(
+		deprecated_in="1.4.0",
+		removed_in="2.0.0",
+		current_version=__version__,
+		details="Import from :mod:`packing_tape.requirements` instead.",
+		)
+def check_dependencies(dependencies: Iterable[str], prt: bool = True) -> List[str]:
+	"""
+	Check whether one or more dependencies are available to be imported.
+
+	:param dependencies: The list of dependencies to check the availability of.
+	:param prt: Whether the status should be printed to the terminal.
+
+	:return: A list of any missing modules.
+	"""
+
+	# stdlib
+	from pkgutil import iter_modules
+
+	modules = {x[1] for x in iter_modules()}
+	missing_modules = []
+
+	for requirement in dependencies:
+		if requirement not in modules:
+			missing_modules.append(requirement)
+
+	if prt:
+		if len(missing_modules) == 0:
+			print("All modules installed")
+		else:
+			print("The following modules are missing:")
+			print(missing_modules)
+			print("Please check the documentation.")
+		print('')
+
+	return missing_modules

repo_helper.yml

@@ -59,6 +59,7 @@ tox_testenv_extras: all
 
 intersphinx_mapping:
  - "'pandas': ('https://pandas.pydata.org/docs/', None)"
+ - "'consolekit': ('https://consolekit.readthedocs.io/en/latest/', None)"
 
 mypy_deps:
  - pprint36

setup.cfg

@@ -4,6 +4,7 @@
 #     * options
 #     * options.packages.find
 #     * mypy
+#     * options.entry_points
 
 [metadata]
 name = domdf_python_tools

tests/conftest.py

@@ -1,6 +1,8 @@
+# stdlib
 import os
 from pathlib import Path
 
+# 3rd party
 import pytest
 
 pytest_plugins = ("domdf_python_tools.testing", )

tests/test_iterative_/test_make_tree.txt

@@ -6,4 +6,4 @@
         │   ├── idna<3,>=2.5
         │   ├── urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1
         │   └── certifi>=2017.4.17
-        └── msgpack>=0.5.2
+        └── msgpack>=0.5.2

tests/test_utils.py

@@ -42,7 +42,7 @@ def test_check_dependencies(capsys):
 	missing_deps = utils.check_dependencies(deps)
 	captured = capsys.readouterr()
 	stdout = captured.out.split("\n")
-	assert stdout[0] == "The following modules are missing."
+	assert stdout[0] == "The following modules are missing:"
 	assert stdout[1] == "['madeup_module']"
 	assert stdout[2] == "Please check the documentation."
 	assert stdout[3] == ''
@@ -333,28 +333,47 @@ def test_protocol_pandas(self):
 		assert isinstance(pandas.DataFrame, HasHead)
 		assert isinstance(pandas.Series, HasHead)
 
-	def test_namedtuple(self):
-		foo = namedtuple("foo", "a, b, c, d, e, f, g, h, i, j, k, l, m")
-		assert head(
-				foo(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13)
-				) == "foo(a=1, b=2, c=3, d=4, e=5, f=6, g=7, h=8, i=9, j=10, ...)"
-		assert head(
-				foo(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13), 13
-				) == "foo(a=1, b=2, c=3, d=4, e=5, f=6, g=7, h=8, i=9, j=10, k=11, l=12, m=13)"
+	foo = namedtuple("foo", "a, b, c, d, e, f, g, h, i, j, k, l, m")
 
-	def test_tuple(self):
-		assert head((1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13)) == "(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, ...)"
-		assert head(
-				(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13),
-				13,
-				) == "(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13)"
+	@pytest.mark.parametrize(
+			"args, expects",
+			[
+					((foo(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13), ),
+						"foo(a=1, b=2, c=3, d=4, e=5, f=6, g=7, h=8, i=9, j=10, ...)"),
+					((foo(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13), 13),
+						"foo(a=1, b=2, c=3, d=4, e=5, f=6, g=7, h=8, i=9, j=10, k=11, l=12, m=13)"),
+					]
+			)
+	def test_namedtuple(self, args, expects):
+		assert head(*args) == expects
 
-	def test_list(self):
-		assert head([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]) == "[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, ...]"
-		assert head(
-				[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13],
-				13,
-				) == "[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]"
+	@pytest.mark.parametrize(
+			"args, expects",
+			[
+					(((1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13), ), "(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, ...)"),
+					((
+							(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13),
+							13,
+							),
+						"(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13)"),
+					]
+			)
+	def test_tuple(self, args, expects):
+		assert head(*args) == expects
+
+	@pytest.mark.parametrize(
+			"args, expects",
+			[
+					(([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], ), "[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, ...]"),
+					((
+							[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13],
+							13,
+							),
+						"[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]"),
+					]
+			)
+	def test_list(self, args, expects):
+		assert head(*args) == expects
 
 	def test_data_frame(self):
 		pandas = pytest.importorskip("pandas")
@@ -436,7 +455,7 @@ def deprecated_func(*args, **kwargs):
 
 
 def test_diff(file_regression: FileRegressionFixture):
-	data_dir = PathPlus(__file__).parent / "test_diff"
+	data_dir = PathPlus(__file__).parent / "test_diff_"
 	original = data_dir / "original"
 	modified = data_dir / "modified"