1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
#!/usr/bin/env python3
#
# __init__.py
"""
Additional utilities for `click <https://click.palletsprojects.com/en/7.x/>`_.
.. attention::
``consolekit`` disables Python's readline history to prevent unrelated histories appearing for prompts.
If the original behaviour is desired run:
.. code-block:: python
import readline
readline.set_history_length(-1)
readline.set_auto_history(True)
"""
#
# Copyright © 2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
# OR OTHER DEALINGS IN THE SOFTWARE.
#
# pylint: disable=redefined-builtin
# stdlib
from typing import Any, Callable, Dict, Optional, Type, TypeVar, cast
# 3rd party
import click
# this package
from consolekit import _readline, commands, input, terminal_colours, tracebacks, utils # noqa: F401
from consolekit.commands import SuggestionGroup
from consolekit.options import _Option
# pylint: enable=redefined-builtin
__author__: str = "Dominic Davis-Foster"
__copyright__: str = "2020 Dominic Davis-Foster"
__license__: str = "MIT License"
__version__: str = "1.7.2"
__email__: str = "dominic@davis-foster.co.uk"
__all__ = (
"CONTEXT_SETTINGS",
"click_command",
"click_group",
"option",
"SuggestionGroup",
)
_C = TypeVar("_C", bound=click.Command)
_G = TypeVar("_G", bound=click.Group)
CONTEXT_SETTINGS: Dict[str, Any] = dict(help_option_names=["-h", "--help"], max_content_width=120)
def click_command(
name: Optional[str] = None,
cls: Optional[Type[_C]] = None,
**attrs: Any,
) -> Callable[[Callable], _C]:
r"""
Shortcut to :func:`click.command`, with the ``-h``/``--help`` option enabled and a max width of ``120``.
:param name:
:param cls:
:type cls: :class:`~typing.Type`\[:class:`~click.Command`\]
:default type: :class:`click.Command`
:param \*\*attrs: Additional keyword arguments passed to the :class:`~click.Command`.
:rtype: :class:`~typing.Callable`\[[:class:`~typing.Callable`\], :class:`~click.Command`\]
"""
attrs.setdefault("context_settings", CONTEXT_SETTINGS)
return cast(Callable[[Callable], _C], click.command(name, cls=cls, **attrs))
def click_group(
name: Optional[str] = None,
cls: Optional[Type[_G]] = None,
**attrs: Any,
) -> Callable[[Callable], _G]:
r"""
Shortcut to :func:`click.group`, with the ``-h``/``--help`` option enabled and a max width of ``120``.
:param name:
:param cls:
:type cls: :class:`~typing.Type`\[:class:`~click.Group`\]
:default type: :class:`click.Group`
:param \*\*attrs: Additional keyword arguments passed to the :class:`~click.Group`.
:rtype:
.. latex:clearpage::
"""
if cls is None:
cls = SuggestionGroup
attrs.setdefault("context_settings", CONTEXT_SETTINGS)
return click_command(name, cls=cls, **attrs)
def option(
*param_decls: str,
**attrs: Any,
) -> Callable[[_C], _C]:
r"""
Shortcut to :func:`click.option`, but using :func:`consolekit.input.confirm` when prompting for a boolean flag.
:param \*param_decls:
:param \*\*attrs: Additional keyword arguments passed to :func:`click.command`.
"""
attrs.setdefault("cls", _Option)
return cast(Callable[[_C], _C], click.option(*param_decls, **attrs))
# 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"
|
