Test on click 8.0.0a1 and fix some compatibility issues.

domdfcoding · domdfcoding · commit 09b1cafe6185 · 2021-01-04T20:32:33.000Z
diff --git a/.github/workflows/python_ci.yml b/.github/workflows/python_ci.yml
@@ -19,11 +19,11 @@ jobs:
       fail-fast: False
       matrix:
         config:
-          - {python-version: "3.6", testenvs: "py36,build", experimental: False}
-          - {python-version: "3.7", testenvs: "py37,build", experimental: False}
-          - {python-version: "3.8", testenvs: "py38,build", experimental: False}
-          - {python-version: "3.9", testenvs: "py39,build", experimental: False}
-          - {python-version: "3.10.0-alpha.3", testenvs: "py310-dev,build", experimental: True}
+          - {python-version: "3.6", testenvs: "py36-click{7.1,8.0.0a1},build", experimental: False}
+          - {python-version: "3.7", testenvs: "py37-click{7.1,8.0.0a1},build", experimental: False}
+          - {python-version: "3.8", testenvs: "py38-click{7.1,8.0.0a1},build", experimental: False}
+          - {python-version: "3.9", testenvs: "py39-click{7.1,8.0.0a1},build", experimental: False}
+          - {python-version: "3.10.0-alpha.3", testenvs: "py310-dev-click{7.1,8.0.0a1},build", experimental: True}
 
     steps:
       - name: Checkout 🛎️
diff --git a/.github/workflows/python_ci_linux.yml b/.github/workflows/python_ci_linux.yml
@@ -19,12 +19,12 @@ jobs:
       fail-fast: False
       matrix:
         config:
-          - {python-version: "3.6", testenvs: "py36,build", experimental: False}
-          - {python-version: "3.7", testenvs: "py37,build", experimental: False}
-          - {python-version: "3.8", testenvs: "py38,build", experimental: False}
-          - {python-version: "3.9", testenvs: "py39,build", experimental: False}
-          - {python-version: "3.10.0-alpha.3", testenvs: "py310-dev,build", experimental: True}
-          - {python-version: "pypy-3.6", testenvs: "pypy3,build", experimental: False}
+          - {python-version: "3.6", testenvs: "py36-click{7.1,8.0.0a1},build", experimental: False}
+          - {python-version: "3.7", testenvs: "py37-click{7.1,8.0.0a1},build", experimental: False}
+          - {python-version: "3.8", testenvs: "py38-click{7.1,8.0.0a1},build", experimental: False}
+          - {python-version: "3.9", testenvs: "py39-click{7.1,8.0.0a1},build", experimental: False}
+          - {python-version: "3.10.0-alpha.3", testenvs: "py310-dev-click{7.1,8.0.0a1},build", experimental: True}
+          - {python-version: "pypy-3.6", testenvs: "pypy3-click{7.1,8.0.0a1},build", experimental: False}
 
     steps:
       - name: Checkout 🛎️
diff --git a/.github/workflows/python_ci_macos.yml b/.github/workflows/python_ci_macos.yml
@@ -19,12 +19,12 @@ jobs:
       fail-fast: False
       matrix:
         config:
-          - {python-version: "3.6", testenvs: "py36,build", experimental: False}
-          - {python-version: "3.7", testenvs: "py37,build", experimental: False}
-          - {python-version: "3.8", testenvs: "py38,build", experimental: False}
-          - {python-version: "3.9", testenvs: "py39,build", experimental: False}
-          - {python-version: "3.10.0-alpha.3", testenvs: "py310-dev,build", experimental: True}
-          - {python-version: "pypy-3.6", testenvs: "pypy3,build", experimental: False}
+          - {python-version: "3.6", testenvs: "py36-click{7.1,8.0.0a1},build", experimental: False}
+          - {python-version: "3.7", testenvs: "py37-click{7.1,8.0.0a1},build", experimental: False}
+          - {python-version: "3.8", testenvs: "py38-click{7.1,8.0.0a1},build", experimental: False}
+          - {python-version: "3.9", testenvs: "py39-click{7.1,8.0.0a1},build", experimental: False}
+          - {python-version: "3.10.0-alpha.3", testenvs: "py310-dev-click{7.1,8.0.0a1},build", experimental: True}
+          - {python-version: "pypy-3.6", testenvs: "pypy3-click{7.1,8.0.0a1},build", experimental: False}
 
     steps:
       - name: Checkout 🛎️
diff --git a/.isort.cfg b/.isort.cfg
@@ -19,6 +19,7 @@ known_third_party =
     coverage_pyver_pragma
     domdf_python_tools
     github
+    mistletoe
     pytest
     pytest_cov
     pytest_randomly
diff --git a/__pkginfo__.py b/__pkginfo__.py
@@ -30,4 +30,4 @@
 
 repo_root = pathlib.Path(__file__).parent
 install_requires = (repo_root / "requirements.txt").read_text(encoding="utf-8").split('\n')
-extras_require = {"all": []}
+extras_require = {"terminals": ["psutil>=5.8.0"], "all": ["psutil>=5.8.0"]}
diff --git a/consolekit/__init__.py b/consolekit/__init__.py
@@ -34,7 +34,7 @@
 import click
 
 # this package
-from consolekit import input, terminal_colours, utils, commands  # pylint: disable=redefined-builtin
+from consolekit import commands, input, terminal_colours, utils  # pylint: disable=redefined-builtin
 from consolekit.commands import SuggestionGroup
 from consolekit.options import _Option
 
diff --git a/consolekit/options.py b/consolekit/options.py
@@ -60,11 +60,11 @@
 
 # stdlib
 import inspect
-from typing import Any, Callable, List, Optional, TypeVar, cast
+from typing import Any, Callable, Iterable, List, Optional, Tuple, TypeVar, cast
 
 # 3rd party
 import click
-from click import Argument, Context, Option, OptionParser
+from click import Argument, Context, IntRange, Option, OptionParser
 from click.decorators import _param_memo  # type: ignore
 
 # this package
@@ -87,6 +87,24 @@
 _C = TypeVar("_C", bound=click.Command)
 
 
+class VerboseVersionCountType(click.IntRange):
+	"""
+	Subclass of :class:`click.IntRange` which doesn't show the range of valid values.
+
+	.. versionadded:: 0.8.1
+	"""
+
+	def __init__(self):
+		super().__init__(min=0)
+
+	def _describe_range(self):
+		"""
+		Describe the range for use in help text.
+		"""
+
+		return ''
+
+
 def verbose_option(help_text: str = "Show verbose output.") -> Callable[..., click.Command]:
 	"""
 	Adds an option (via the parameter ``verbose``: :class:`int`) to enable verbose output.
@@ -98,12 +116,7 @@ def verbose_option(help_text: str = "Show verbose output.") -> Callable[..., cli
 	:param help_text: The help text for the option.
 	"""
 
-	return click.option(
-			"-v",
-			"--verbose",
-			count=True,
-			help=help_text,
-			)
+	return click.option("-v", "--verbose", count=True, help=help_text, type=VerboseVersionCountType())
 
 
 def version_option(callback: Callable[[Context, Option, int], Any]) -> Callable[..., click.Command]:
@@ -140,6 +153,7 @@ def version_callback(ctx: click.Context, param: click.Option, value: int):
 			expose_value=False,
 			is_eager=True,
 			help="Show the version and exit.",
+			type=VerboseVersionCountType(),
 			callback=cast(Callback, callback),
 			)
 
@@ -386,6 +400,29 @@ def parser_process(value, state):
 
 		return retval
 
+	def process_value(self, ctx: click.Context, value: Any) -> Optional[Tuple]:
+		"""
+		Given a value and context, converts the value as necessary.
+
+		:param ctx:
+		:param value:
+		"""
+
+		# If the value we were given is None we do nothing.
+		# This way code that calls this can easily figure out if something was not provided.
+		# Otherwise, it would be converted into an empty tuple for multiple invocations,
+		# which is inconvenient.
+
+		# assert isinstance(value, tuple), type(value)
+
+		if value is not None:
+			if isinstance(value, Iterable) and not isinstance(value, str):
+				return tuple(self.type_cast_value(ctx, v) for v in value)
+			elif value in ("()", str(self.default)) or not value:
+				return self.default
+			else:
+				return self.type_cast_value(ctx, value)
+
 
 class _Option(click.Option):
 
diff --git a/repo_helper.yml b/repo_helper.yml
@@ -38,3 +38,8 @@ extras_require:
   - psutil>=5.8.0
 
 tox_testenv_extras: all
+
+third_party_version_matrix:
+ click:
+  - 7.1
+  - 8.0.0a1
diff --git a/tests/requirements.txt b/tests/requirements.txt
@@ -1,7 +1,7 @@
 colorama>=0.4.4; python_version == "3.10" and platform_system != "Windows"
 coverage>=5.1
 coverage-pyver-pragma>=0.0.6
-domdf-python-tools[testing]>=1.6.0
+domdf-python-tools[testing]>=2.0.1
 iniconfig!=1.1.0,>=1.0.1
 pytest>=6.0.0
 pytest-cov>=2.8.1
diff --git a/tests/test_input.py b/tests/test_input.py
@@ -1,5 +1,6 @@
 # 3rd party
 import click
+import pytest
 from click import echo
 from domdf_python_tools.stringlist import StringList
 from pytest_regressions.data_regression import DataRegressionFixture
@@ -34,7 +35,24 @@ def fake_input(prompt):
 	data_regression.check(list(StringList(capsys.readouterr().out.splitlines())))
 
 
-def test_choice_numbers(capsys, monkeypatch, data_regression: DataRegressionFixture):
+@pytest.mark.parametrize(
+		"click_version",
+		[
+				pytest.param(
+						'7',
+						marks=pytest.mark.skipif(
+								not click.__version__.startswith('7'), reason="Output differs on click 8"
+								)
+						),
+				pytest.param(
+						'8',
+						marks=pytest.mark.skipif(
+								not click.__version__.startswith('8'), reason="Output differs on click 8"
+								)
+						),
+				]
+		)
+def test_choice_numbers(capsys, monkeypatch, data_regression: DataRegressionFixture, click_version):
 
 	inputs = iter(["20", '0', '5'])
 
diff --git a/tests/test_input_/test_choice_numbers_7_.yml b/tests/test_input_/test_choice_numbers_7_.yml
diff --git a/tests/test_input_/test_choice_numbers_8_.yml b/tests/test_input_/test_choice_numbers_8_.yml
@@ -0,0 +1,13 @@
+- What is the Development Status of this project?
+- ' [1] Planning'
+- ' [2] Pre-Alpha'
+- ' [3] Alpha'
+- ' [4] Beta'
+- ' [5] Production/Stable'
+- ' [6] Mature'
+- ' [7] Inactive'
+- ': 20'
+- 'Error: 20 is not in the range 1<=x<=7.'
+- ': 0'
+- 'Error: 0 is not in the range 1<=x<=7.'
+- ': 5'
diff --git a/tests/test_options.py b/tests/test_options.py
@@ -115,7 +115,7 @@ def main(force: bool):
 
 def test_verbose_option(file_regression: FileRegressionFixture):
 
-	@verbose_option("Force the operation")
+	@verbose_option("Show verbose output.")
 	@click_command()
 	def main(verbose: int):
 		print(verbose)
diff --git a/tests/test_options_/test_verbose_option.txt b/tests/test_options_/test_verbose_option.txt
@@ -1,5 +1,5 @@
 Usage: main [OPTIONS]
 
 Options:
-  -v, --verbose  Force the operation
+  -v, --verbose  Show verbose output.
   -h, --help     Show this message and exit.
diff --git a/tox.ini b/tox.ini
@@ -16,21 +16,39 @@
 #     * pytest
 
 [tox]
-envlist = py36, py37, py38, py39, py310-dev, pypy3, mypy, build
+envlist =
+    py36-click{7.1,8.0.0a1}
+    py37-click{7.1,8.0.0a1}
+    py38-click{7.1,8.0.0a1}
+    py39-click{7.1,8.0.0a1}
+    py310-dev-click{7.1,8.0.0a1}
+    pypy3-click{7.1,8.0.0a1}
+    mypy
+    build
 skip_missing_interpreters = True
 requires =
     pip>=20.3.3
     tox-envlist>=0.1.0
 isolated_build = True
 
 [envlists]
-test = py36, py37, py38, py39, py310-dev, pypy3
+test =
+    py36-click{7.1,8.0.0a1}
+    py37-click{7.1,8.0.0a1}
+    py38-click{7.1,8.0.0a1}
+    py39-click{7.1,8.0.0a1}
+    py310-dev-click{7.1,8.0.0a1}
+    pypy3-click{7.1,8.0.0a1}
 qa = mypy, lint
 cov = py36, coverage
 
 [testenv]
 setenv = PYTHONDEVMODE = 1
-deps = -r{toxinidir}/tests/requirements.txt
+deps =
+    -r{toxinidir}/tests/requirements.txt
+    click7.1: click~=7.1.0
+    click8.0.0a1: click==8.0.0a1
+extras = all
 commands =
     python --version
     python -m pytest --cov=consolekit -r aR tests/ {posargs}
@@ -39,6 +57,7 @@ commands =
 setenv = SHOW_TODOS = 1
 basepython = python3.8
 changedir = {toxinidir}/doc-source
+extras = all
 deps =
     -r{toxinidir}/requirements.txt
     -r{toxinidir}/doc-source/requirements.txt
@@ -60,7 +79,7 @@ commands =
 basepython = python3.6
 changedir = {toxinidir}
 ignore_errors = True
-skip_install = True
+skip_install = False
 deps =
     flake8 >=3.8.2
     flake8-2020 >= 1.6.0
@@ -84,6 +103,7 @@ commands = python3 -m flake8_rst_docstrings_sphinx consolekit tests --allow-tool
 basepython = python3.6
 ignore_errors = True
 changedir = {toxinidir}
+extras = all
 deps =
     mypy==0.790
     lxml
@@ -97,6 +117,7 @@ skip_install = True
 ignore_errors = True
 changedir = {toxinidir}
 deps = pyupgrade-directories
+extras = all
 commands = pyup_dirs consolekit tests --py36-plus --recursive
 
 [testenv:coverage]
