Add "MultiValueOption" to options.py

Author: domdfcoding

consolekit/_types.py

@@ -0,0 +1,40 @@
+#!/usr/bin/env python3
+#
+#  _types.py
+#
+#  Copyright © 2020 Dominic Davis-Foster <[email protected]>
+#
+#  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.
+#
+
+# stdlib
+from typing import Any, Callable, Optional, Tuple, Union
+
+# 3rd party
+from click import Context, Parameter, ParamType
+
+_ConvertibleType = Union[
+	type,
+	ParamType,
+	Tuple[Union[type, ParamType], ...],
+	Callable[[str], Any],
+	Callable[[Optional[str]], Any]
+	]
+
+Callback = Callable[[Context, Parameter, str], Any]

consolekit/input.py

@@ -83,6 +83,9 @@
 from click.termui import _build_prompt, hidden_prompt_func
 from click.types import ParamType, Path, convert_type
 
+# this package
+from consolekit._types import _ConvertibleType
+
 __all__ = ["prompt", "confirm", "stderr_input", "choice"]
 
 if not bool(getattr(sys, "ps1", sys.flags.interactive)):  # pragma: no cover
@@ -97,14 +100,6 @@
 		# Attribute error on PyPy, ImportError on Windows etc.
 		pass
 
-_ConvertibleType = Union[
-	type,
-	ParamType,
-	Tuple[Union[type, ParamType], ...],
-	Callable[[str], Any],
-	Callable[[Optional[str]], Any]
-	]
-
 
 def prompt(
 		text: str,

consolekit/options.py

@@ -27,15 +27,55 @@
 #  OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
 #  OR OTHER DEALINGS IN THE SOFTWARE.
 #
+#  MultiValueOption based on https://stackoverflow.com/a/48394004
+#  Copyright (c) 2018 Stephen Rauch <https://stackoverflow.com/users/7311767/stephen-rauch>
+#  CC BY-SA 3.0
+#
+#  MultiValueOption based on https://github.com/pallets/click
+#  Copyright 2014 Pallets
+#  |  Redistribution and use in source and binary forms, with or without modification,
+#  |  are permitted provided that the following conditions are met:
+#  |
+#  |      * Redistributions of source code must retain the above copyright notice,
+#  |        this list of conditions and the following disclaimer.
+#  |      * Redistributions in binary form must reproduce the above copyright notice,
+#  |        this list of conditions and the following disclaimer in the documentation
+#  |        and/or other materials provided with the distribution.
+#  |      * Neither the name of the copyright holder nor the names of its contributors
+#  |        may be used to endorse or promote products derived from this software without
+#  |        specific prior written permission.
+#  |
+#  |  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+#  |  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+#  |  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+#  |  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER
+#  |  OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+#  |  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+#  |  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+#  |  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+#  |  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+#  |  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+#  |  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
 
 # stdlib
-from typing import Any, Callable
+from typing import Any, Callable, List, Optional, cast
 
 # 3rd party
 import click
-from click import Context, Option
+from click import Context, Option, OptionParser
 
-__all__ = ["verbose_option", "version_option", "colour_option", "force_option", "no_pager_option"]
+# this package
+from consolekit._types import Callback, _ConvertibleType
+
+__all__ = [
+		"verbose_option",
+		"version_option",
+		"colour_option",
+		"force_option",
+		"no_pager_option",
+		"MultiValueOption",
+		]
 
 
 def verbose_option(help_text: str = "Show verbose output.") -> Callable:
@@ -78,7 +118,7 @@ def version_option(callback: Callable[[Context, Option, int], Any]) -> Callable:
 			expose_value=False,
 			is_eager=True,
 			help="Show the version and exit.",
-			callback=callback,  # type: ignore
+			callback=cast(Callback, callback),
 			)
 
 
@@ -138,3 +178,98 @@ def no_pager_option(help_text="Disable the output pager.") -> Callable:
 			default=False,
 			help=help_text,
 			)
+
+
+class MultiValueOption(click.Option):
+	"""
+	Subclass of :class:`click.Option` that behaves like argparse's ``nargs='+'``.
+
+	:param param_decls: The parameter declarations for this option or argument.
+		This is a list of flags or argument names.
+	:param show_default: Controls if the default value should be shown on the help page.
+		Normally, defaults are not shown.
+		If this value is a string, it shows the string instead of the value.
+		This is particularly useful for dynamic options.
+	:param help: The help string.
+	:param hidden: Hide this option from help outputs.
+	:param type: The type that should be used.  Either a :class:`click.ParamType` or a Python type.
+		The later is converted into the former automatically if supported.
+	:param required: Controls whether this is optional.
+	:param default: The default value if omitted.
+		This can also be a callable, in which case it's invoked when the default is needed without any arguments.
+	:param callback: A callback that should be executed after the parameter was matched.
+		This is called as ``fn(ctx, param, value)`` and needs to return the value.
+	:param metavar: How the value is represented in the help page.
+	:param expose_value: If :py:obj:`True` then the value is passed onwards to the command callback
+		and stored on the context, otherwise it's skipped.
+	:param is_eager: Eager values are processed before non eager ones.
+
+	.. versionadded:: 0.6.0
+	"""
+
+	def __init__(
+			self,
+			param_decls: Optional[List[str]] = None,
+			show_default: bool = False,
+			help: Optional[str] = None,
+			hidden: bool = False,
+			type: Optional[_ConvertibleType] = None,
+			required: bool = False,
+			default: Optional[Any] = None,
+			callback: Optional[Callback] = None,
+			metavar: Optional[str] = None,
+			expose_value: bool = True,
+			is_eager: bool = False,
+			):
+
+		super().__init__(
+				show_default=show_default,
+				help=help,
+				hidden=hidden,
+				param_decls=param_decls,
+				type=type,
+				required=required,
+				default=default,
+				callback=callback,
+				metavar=metavar,
+				expose_value=expose_value,
+				is_eager=is_eager,
+				)
+		self._previous_parser_process: Optional[Callable] = None
+		self._eat_all_parser: Optional[click.parser.Option] = None
+
+	def add_to_parser(self, parser: OptionParser, ctx: Context):
+		"""
+
+		:param parser:
+		:param ctx:
+		"""
+
+		def parser_process(value, state):
+			# method to hook to the parser.process
+			done = False
+			value = [value]
+			# grab everything up to the next option
+			while state.rargs and not done:
+				for prefix in self._eat_all_parser.prefixes:  # type: ignore
+					if state.rargs[0].startswith(prefix):
+						done = True
+				if not done:
+					value.append(state.rargs.pop(0))
+
+			value = tuple(value)
+
+			# call the actual process
+			self._previous_parser_process(value, state)  # type: ignore
+
+		retval = super().add_to_parser(parser, ctx)
+
+		for name in self.opts:
+			our_parser: Optional[click.parser.Option] = parser._long_opt.get(name) or parser._short_opt.get(name)
+			if our_parser:
+				self._eat_all_parser = our_parser
+				self._previous_parser_process = our_parser.process
+				our_parser.process = parser_process  # type: ignore
+				break
+
+		return retval

tox.ini

@@ -135,7 +135,7 @@ commands =
 [flake8]
 max-line-length = 120
 select = E301 E303 E304 E305 E306 E502 W291 W293 W391 E226 E225 E241 E231 W292 E265 E111 E112 E113 E121 E122 E125 E127 E128 E129 E131 E133 E201 E202 E203 E211 E222 E223 E224 E225 E227 E228 E242 E251 E261 E262 E271 E272 E402 E703 E711 E712 E713 E714 E721 W504 E302 YTT101 YTT102 YTT103 YTT201 YTT202 YTT203 YTT204 YTT301 YTT302 YTT303 STRFTIME001 STRFTIME002 SXL001  PT001 PT002 PT003 PT005 PT006 PT007 PT008 PT009 PT010 PT011 PT012 PT013 PT014 PT015 PT016 PT017 PT018 PT019 PT020 PT021 RST201 RST202 RST203 RST204 RST205 RST206 RST207 RST208 RST210 RST211 RST212 RST213 RST214 RST215 RST216 RST217 RST218 RST219 RST299 RST301 RST302 RST303 RST304 RST305 RST306 RST399 RST401 RST499 RST900 RST901 RST902 RST903 Q001 Q002 Q003 A001 A002 A003 TYP001 TYP002 TYP003 TYP004 TYP005 TYP006 Y001,Y002 Y003 Y004 Y005 Y006 Y007 Y008 Y009 Y010 Y011 Y012 Y013 Y014 Y015 Y090 Y091 D100 D101 D102 D103 D104 D106 D201 D204 D207 D208 D209 D210 D211 D212 D213 D214 D215 D300 D301 D400 D402 D403 D404 D415 D417 DALL000
-exclude = .git,__pycache__,doc-source,old,build,dist,make_conda_recipe.py,__pkginfo__.py,setup.py
+exclude = .git,__pycache__,doc-source,old,build,dist,make_conda_recipe.py,__pkginfo__.py,setup.py,.tox,venv
 rst-directives =
     TODO
     envvar