Update docs and fix type hints.

Author: domdfcoding

consolekit/__init__.py

@@ -79,3 +79,15 @@
 """
 Shortcut to :func:`click.option`, but using :func:`consolekit.input.confirm` when prompting for a boolean flag.
 """
+
+# Fixes intersphinx links
+click.Command.__module__ = "click"
+click.Argument.__module__ = "click"
+click.Abort.__module__ = "click"
+click.Option.__module__ = "click"
+click.ParamType.__module__ = "click"
+click.Parameter.__module__ = "click"
+click.Context.__module__ = "click"
+click.HelpFormatter.__module__ = "click"
+click.Group.__module__ = "click"
+click.OptionParser.__module__ = "click"

consolekit/input.py

@@ -125,8 +125,8 @@ def prompt(
 	"""
 	Prompts a user for input.
 
-	If the user aborts the input by sending an interrupt signal, this
-	function will catch it and raise a :exc:`click.exceptions.Abort` exception.
+	If the user aborts the input by sending an interrupt signal,
+	this function will catch it and raise a :exc:`click.Abort` exception.
 
 	:param text: The text to show for the prompt.
 	:param default: The default value to use if no input happens.
@@ -209,11 +209,11 @@ def confirm(
 	Prompts for confirmation (yes/no question).
 
 	If the user aborts the input by sending a interrupt signal this
-	function will catch it and raise a :exc:`Abort` exception.
+	function will catch it and raise a :exc:`click.Abort` exception.
 
 	:param text: The question to ask.
 	:param default: The default for the prompt.
-	:param abort: If :py:obj:`True` a negative answer aborts the exception by raising :exc:`Abort`.
+	:param abort: If :py:obj:`True` a negative answer aborts the exception by raising :exc:`click.Abort`.
 	:param prompt_suffix: A suffix that should be added to the prompt.
 	:param show_default: Shows or hides the default value in the prompt.
 	:param err: If :py:obj:`True` the file defaults to ``stderr`` instead of ``stdout``, the same as with echo.
@@ -342,7 +342,7 @@ def choice(
 	Prompts a user for input.
 
 	If the user aborts the input by sending an interrupt signal, this
-	function will catch it and raise a :exc:`click.exceptions.Abort` exception.
+	function will catch it and raise a :exc:`click.Abort` exception.
 
 	:param options:
 	:param text: The text to show for the prompt.
@@ -402,7 +402,7 @@ def hide_cursor() -> None:
 	Hide the cursor.
 
 	To show it again use :func:`~.show_cursor`,
-	or use the :func:`@.hidden_cursor` context manager.
+	or use the :func:`~.hidden_cursor` context manager.
 
 	.. versionadded:: 0.7.0
 	"""

consolekit/options.py

@@ -64,7 +64,7 @@
 
 # 3rd party
 import click
-from click import Argument, Context, IntRange, Option, OptionParser
+from click import Argument, Context, Option, OptionParser
 from click.decorators import _param_memo  # type: ignore
 
 # this package
@@ -81,6 +81,8 @@
 		"flag_option",
 		"auto_default_option",
 		"auto_default_argument",
+		"_A",
+		"_C",
 		]
 
 _A = TypeVar("_A", bound=click.Argument)
@@ -105,7 +107,7 @@ def _describe_range(self):
 		return ''
 
 
-def verbose_option(help_text: str = "Show verbose output.") -> Callable[..., click.Command]:
+def verbose_option(help_text: str = "Show verbose output.") -> Callable[[_C], _C]:
 	"""
 	Adds an option (via the parameter ``verbose``: :class:`int`) to enable verbose output.
 
@@ -119,7 +121,7 @@ def verbose_option(help_text: str = "Show verbose output.") -> Callable[..., cli
 	return click.option("-v", "--verbose", count=True, help=help_text, type=VerboseVersionCountType())
 
 
-def version_option(callback: Callable[[Context, Option, int], Any]) -> Callable[..., click.Command]:
+def version_option(callback: Callable[[Context, Option, int], Any]) -> Callable[[_C], _C]:
 	"""
 	Adds an option to show the version and exit.
 
@@ -158,7 +160,7 @@ def version_callback(ctx: click.Context, param: click.Option, value: int):
 			)
 
 
-def colour_option(help_text="Whether to use coloured output.") -> Callable[..., click.Command]:
+def colour_option(help_text="Whether to use coloured output.") -> Callable[[_C], _C]:
 	"""
 	Adds an option (via the parameter ``colour``: :class:`bool`) to enable verbose output.
 
@@ -174,7 +176,7 @@ def colour_option(help_text="Whether to use coloured output.") -> Callable[...,
 			)
 
 
-def force_option(help_text: str) -> Callable[..., click.Command]:
+def force_option(help_text: str) -> Callable[[_C], _C]:
 	"""
 	Decorator to add the ``-f / --force`` option to a click command.
 
@@ -188,7 +190,7 @@ def force_option(help_text: str) -> Callable[..., click.Command]:
 	return flag_option("-f", "--force", help=help_text)
 
 
-def no_pager_option(help_text="Disable the output pager.") -> Callable[..., click.Command]:
+def no_pager_option(help_text="Disable the output pager.") -> Callable[[_C], _C]:
 	"""
 	Decorator to add the ``--no-pager`` option to a click command.
 
@@ -202,7 +204,7 @@ def no_pager_option(help_text="Disable the output pager.") -> Callable[..., clic
 	return flag_option("--no-pager", help=help_text)
 
 
-def flag_option(*args, default: Optional[bool] = False, **kwargs) -> Callable[..., click.Command]:
+def flag_option(*args, default: Optional[bool] = False, **kwargs) -> Callable[[_C], _C]:
 	r"""
 	Decorator to a flag option to a click command.
 
@@ -221,7 +223,7 @@ def flag_option(*args, default: Optional[bool] = False, **kwargs) -> Callable[..
 			)
 
 
-def auto_default_option(*param_decls, **attrs) -> Callable[..., click.Command]:
+def auto_default_option(*param_decls, **attrs) -> Callable[[_C], _C]:
 	"""
 	Attaches an option to the command, with a default value determined from the decorated function's signature.
 
@@ -264,14 +266,14 @@ def _get_default_from_callback_and_set(command: click.Command, param: click.Para
 			param.default = param_default
 
 
-def auto_default_argument(*param_decls, **attrs) -> Callable[..., click.Argument]:
+def auto_default_argument(*param_decls, **attrs) -> Callable[[_C], _C]:
 	"""
 	Attaches an argument to the command, with a default value determined from the decorated function's signature.
 
 	All positional arguments are passed as parameter declarations to :class:`click.Argument`;
 	all keyword arguments are forwarded unchanged (except ``cls``).
 	This is equivalent to creating an :class:`click.Argument` instance manually
-	and attaching it to the :attr:`click.Argument.params` list.
+	and attaching it to the :attr:`click.Command.params` list.
 
 	.. versionadded:: 0.8.0
 

consolekit/utils.py

@@ -119,7 +119,7 @@ def overtype(*objects, sep: str = ' ', end: str = '', file: IO = None, flush: bo
 	All non-keyword arguments are converted to strings like :class:`str` does and written to the stream,
 	separated by `sep` and followed by `end`.
 
-	If no objects are given, :func:`~consolekit.terminal.overtype` will just write ``"\\r"``.
+	If no objects are given, :func:`~consolekit.utils.overtype` will just write ``"\\r"``.
 
 	.. TODO:: This does not currently work in the PyCharm console, at least on Windows
 
@@ -218,14 +218,14 @@ def coloured_diff(
 
 solidus_spinner = cycle("|/-\\")
 """
-:class:`itertools.cycle` of characters to use as a loading spinner.
+:func:`itertools.cycle` of characters to use as a loading spinner.
 
 .. versionadded:: 0.7.0
 """
 
 braille_spinner = cycle("⢿ ⣻ ⣽ ⣾ ⣷ ⣯ ⣟ ⡿ ".split(' '))
 """
-:class:`itertools.cycle` of braille characters to use as a loading spinner.
+:func:`itertools.cycle` of braille characters to use as a loading spinner.
 
 .. versionadded:: 0.7.0
 """
@@ -277,7 +277,7 @@ def traceback_handler():
 
 	* :exc:`EOFError`
 	* :exc:`KeyboardInterrupt`
-	* :exc:`click.exceptions.ClickException`
+	* :exc:`click.ClickException`
 
 	.. versionadded:: 0.8.0