Add version_callback_option helper function.

Author: domdfcoding

consolekit/versions.py

@@ -32,7 +32,7 @@
 import platform
 import sys
 import textwrap
-from typing import Any, Callable, Iterable, Mapping, Union
+from typing import Any, Callable, Iterable, Mapping, TypeVar, Union
 
 # 3rd party
 import click
@@ -118,3 +118,28 @@ def version_callback(ctx: click.Context, param: click.Option, value: int) -> Non
 		ctx.exit()
 
 	return version_callback
+
+
+_C = TypeVar("_C", bound=click.Command)
+
+
+def version_callback_option(
+		tool_version: str,
+		tool_name: str,
+		dependencies: Union[Iterable[str], Mapping[str, str]] = (),
+		) -> Callable[[_C], _C]:
+	"""
+	Helper that calls :deco:`~.version_option` with :func:`~.get_version_callback` as the callback.
+
+	.. versionadded:: 1.10.0
+
+	:param tool_version: The version of the tool to show the version of.
+	:param tool_name: The name of the tool to show the version of.
+	:param dependencies: Either a list of dependency names,
+	    or a mapping of dependency name to a more human-readable form.
+	"""
+
+	# this package
+	from consolekit.options import version_option
+
+	return version_option(get_version_callback(tool_version, tool_name, dependencies))

tests/test_versions.py

@@ -5,7 +5,7 @@
 from consolekit import click_command
 from consolekit.options import version_option
 from consolekit.testing import CliRunner
-from consolekit.versions import get_formatted_versions, get_version_callback
+from consolekit.versions import get_formatted_versions, get_version_callback, version_callback_option
 
 
 def test_get_formatted_versions():
@@ -64,3 +64,28 @@ def main() -> None:
 	print(result.stdout)
 	assert result.stdout.startswith("my-tool\n  Version: 1.2.3\n  click: ")
 	assert result.exit_code == 0
+
+
+def test_version_callback_option(cli_runner: CliRunner):
+
+	@version_callback_option(
+			"1.2.3",
+			"my-tool",
+			["click", "deprecation-alias", "domdf-python-tools", "mistletoe", "typing-extensions"],
+			)
+	@click_command()
+	def main() -> None:
+		sys.exit(1)
+
+	result = cli_runner.invoke(main, args="--version")
+	assert result.stdout.rstrip() == "my-tool version 1.2.3"
+	assert result.exit_code == 0
+
+	result = cli_runner.invoke(main, args=["--version", "--version"])
+	assert result.stdout.startswith("my-tool version 1.2.3, Python 3.")
+	assert result.exit_code == 0
+
+	result = cli_runner.invoke(main, args=["--version", "--version", "--version"])
+	print(result.stdout)
+	assert result.stdout.startswith("my-tool\n  Version: 1.2.3\n  click: ")
+	assert result.exit_code == 0