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 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
|
import inspect
import itertools
import os
import shlex
import sys
from collections.abc import Iterable
from contextlib import suppress
from functools import partial
from typing import TYPE_CHECKING, Callable, Sequence, Union
from cyclopts._convert import _bool
from cyclopts.argument import ArgumentCollection
from cyclopts.exceptions import (
ArgumentOrderError,
CoercionError,
CycloptsError,
MissingArgumentError,
UnknownOptionError,
ValidationError,
)
from cyclopts.field_info import POSITIONAL_ONLY, POSITIONAL_OR_KEYWORD
from cyclopts.token import Token
from cyclopts.utils import UNSET, is_option_like
if TYPE_CHECKING:
from cyclopts.group import Group
CliToken = partial(Token, source="cli")
def normalize_tokens(tokens: Union[None, str, Iterable[str]]) -> list[str]:
if tokens is None:
tokens = sys.argv[1:] # Remove the executable
elif isinstance(tokens, str):
tokens = shlex.split(tokens)
else:
tokens = list(tokens)
return tokens
def _common_root_keys(argument_collection) -> tuple[str, ...]:
if not argument_collection:
return ()
common = argument_collection[0].keys
for argument in argument_collection[1:]:
if not argument.keys:
return ()
for i, (common_key, argument_key) in enumerate(zip(common, argument.keys)):
if common_key != argument_key:
if i == 0:
return ()
common = argument.keys[:i]
break
common = common[: len(argument.keys)]
return common
def _parse_kw_and_flags(
argument_collection: ArgumentCollection,
tokens: Sequence[str],
*,
end_of_options_delimiter: str = "--",
):
unused_tokens, positional_only_tokens = [], []
skip_next_iterations = 0
if end_of_options_delimiter:
try:
delimiter_index = tokens.index(end_of_options_delimiter)
except ValueError:
pass # end_of_options_delimiter not in token stream
else:
positional_only_tokens = tokens[delimiter_index:]
tokens = tokens[:delimiter_index]
for i, token in enumerate(tokens):
# If the previous argument was a keyword, then this is its value
if skip_next_iterations > 0:
skip_next_iterations -= 1
continue
if not is_option_like(token):
unused_tokens.append(token)
continue
cli_values: list[str] = []
consume_count = 0
if "=" in token:
cli_option, cli_value = token.split("=", 1)
cli_values.append(cli_value)
consume_count -= 1
else:
cli_option = token
try:
argument, leftover_keys, implicit_value = argument_collection.match(cli_option)
except ValueError:
unused_tokens.append(token)
continue
if implicit_value is not None:
# A flag was parsed
if cli_values:
try:
coerced_value = _bool(cli_values[-1])
except CoercionError as e:
if e.token is None:
e.token = CliToken(keyword=cli_option)
if e.argument is None:
e.argument = argument
raise
if coerced_value: # --positive-flag=true or --negative-flag=true or --empty-flag=true
argument.append(CliToken(keyword=cli_option, implicit_value=implicit_value))
else: # --positive-flag=false or --negative-flag=false or --empty-flag=false
if isinstance(implicit_value, bool):
argument.append(CliToken(keyword=cli_option, implicit_value=not implicit_value))
else:
continue
else:
argument.append(CliToken(keyword=cli_option, implicit_value=implicit_value))
else:
tokens_per_element, consume_all = argument.token_count(leftover_keys)
# Consume the appropriate number of tokens
with suppress(IndexError):
if consume_all and argument.parameter.consume_multiple:
for j in itertools.count():
token = tokens[i + 1 + j]
if not argument.parameter.allow_leading_hyphen and is_option_like(token):
break
cli_values.append(token)
skip_next_iterations += 1
else:
consume_count += tokens_per_element
for j in range(consume_count):
if len(cli_values) == 1 and (
argument._should_attempt_json_dict(cli_values)
or argument._should_attempt_json_list(cli_values, leftover_keys)
):
tokens_per_element = 1
# Assume that the contents are json and that we shouldn't
# consume any additional tokens.
break
token = tokens[i + 1 + j]
if not argument.parameter.allow_leading_hyphen and is_option_like(token):
raise MissingArgumentError(
argument=argument,
tokens_so_far=cli_values,
)
cli_values.append(token)
skip_next_iterations += 1
if not cli_values or len(cli_values) % tokens_per_element:
raise MissingArgumentError(argument=argument, tokens_so_far=cli_values)
for index, cli_value in enumerate(cli_values):
argument.append(CliToken(keyword=cli_option, value=cli_value, index=index, keys=leftover_keys))
unused_tokens.extend(positional_only_tokens)
return unused_tokens
def _future_positional_only_token_count(argument_collection: ArgumentCollection, starting_index: int) -> int:
n_tokens_to_leave = 0
for i in itertools.count():
try:
argument, _, _ = argument_collection.match(starting_index + i)
except ValueError:
break
if argument.field_info.kind is not POSITIONAL_ONLY:
break
future_tokens_per_element, future_consume_all = argument.token_count()
if future_consume_all:
raise ValueError("Cannot have 2 all-consuming positional arguments.")
n_tokens_to_leave += future_tokens_per_element
return n_tokens_to_leave
def _preprocess_positional_tokens(tokens: Sequence[str], end_of_options_delimiter: str) -> list[tuple[str, bool]]:
try:
delimiter_index = tokens.index(end_of_options_delimiter)
return [(t, False) for t in tokens[:delimiter_index]] + [(t, True) for t in tokens[delimiter_index + 1 :]]
except ValueError: # delimiter not found
return [(t, False) for t in tokens]
def _parse_pos(
argument_collection: ArgumentCollection,
tokens: list[str],
*,
end_of_options_delimiter: str = "--",
) -> list[str]:
prior_positional_or_keyword_supplied_as_keyword_arguments = []
if not tokens:
return []
tokens_and_force_positional = _preprocess_positional_tokens(tokens, end_of_options_delimiter)
for i in itertools.count():
try:
argument, _, _ = argument_collection.match(i)
except ValueError:
break
if argument.field_info.kind is POSITIONAL_OR_KEYWORD:
if argument.tokens and argument.tokens[0].keyword is not None:
prior_positional_or_keyword_supplied_as_keyword_arguments.append(argument)
# Continue in case we hit a VAR_POSITIONAL argument.
continue
if prior_positional_or_keyword_supplied_as_keyword_arguments:
token = tokens[0]
if not argument.parameter.allow_leading_hyphen and is_option_like(token):
# It's more meaningful to interpret the token as an intended option,
# rather than an intended positional value for ``argument``.
raise UnknownOptionError(token=CliToken(value=token), argument_collection=argument_collection)
else:
raise ArgumentOrderError(
argument=argument,
prior_positional_or_keyword_supplied_as_keyword_arguments=prior_positional_or_keyword_supplied_as_keyword_arguments,
token=tokens_and_force_positional[0][0],
)
tokens_per_element, consume_all = argument.token_count()
tokens_per_element = max(1, tokens_per_element)
if consume_all and argument.field_info.kind is POSITIONAL_ONLY:
# POSITIONAL_ONLY parameters can come after a POSITIONAL_ONLY list/iterable.
# This makes it easier to create programs that do something like:
# $ python my-program.py input_folder/*.csv output.csv
# Need to see how many tokens we need to leave for subsequent POSITIONAL_ONLY parameters.
n_tokens_to_leave = _future_positional_only_token_count(argument_collection, i + 1)
else:
n_tokens_to_leave = 0
new_tokens = []
while (len(tokens_and_force_positional) - n_tokens_to_leave) > 0:
if (len(tokens_and_force_positional) - n_tokens_to_leave) < tokens_per_element:
raise MissingArgumentError(
argument=argument,
tokens_so_far=[x[0] for x in tokens_and_force_positional],
)
for index, (token, force_positional) in enumerate(tokens_and_force_positional[:tokens_per_element]):
if not force_positional and not argument.parameter.allow_leading_hyphen and is_option_like(token):
raise UnknownOptionError(token=CliToken(value=token), argument_collection=argument_collection)
new_tokens.append(CliToken(value=token, index=index))
tokens_and_force_positional = tokens_and_force_positional[tokens_per_element:]
if not consume_all:
break
argument.tokens[:0] = new_tokens # Prepend the new tokens to the argument.
if not tokens_and_force_positional:
break
return [x[0] for x in tokens_and_force_positional]
def _parse_env(argument_collection: ArgumentCollection):
for argument in argument_collection:
if argument.tokens:
# Don't check environment variables for parameters that already have values from CLI.
continue
assert argument.parameter.env_var is not None
for env_var_name in argument.parameter.env_var:
try:
env_var_value = os.environ[env_var_name]
except KeyError:
pass
else:
argument.tokens.append(Token(keyword=env_var_name, value=env_var_value, source="env"))
break
def _bind(
argument_collection: ArgumentCollection,
func: Callable,
):
"""Bind the mapping to the function signature."""
bound = inspect.signature(func).bind_partial()
for argument in argument_collection._root_arguments:
if argument.value is not UNSET:
bound.arguments[argument.field_info.name] = argument.value
return bound
def _parse_configs(argument_collection: ArgumentCollection, configs):
for config in configs:
# Each ``config`` is a partial that already has apps and commands provided.
config(argument_collection)
def _sort_group(argument_collection) -> list[tuple["Group", ArgumentCollection]]:
"""Sort groups into "deepest common-root-keys first" order.
This is imperfect, but probably works sufficiently well for practical use-cases.
"""
out = {}
# Sort alphabetically by group-name to enfroce some determinism.
for i, group in enumerate(sorted(argument_collection.groups, key=lambda x: x.name)):
if not (group_arguments := argument_collection.filter_by(group=group, has_tree_tokens=True)):
continue
common_root_keys = _common_root_keys(group_arguments)
# Add i to key so that we don't get collisions.
out[(common_root_keys, i)] = (group, group_arguments.filter_by(keys_prefix=common_root_keys))
return [ga for _, ga in sorted(out.items(), reverse=True)]
def create_bound_arguments(
func: Callable,
argument_collection: ArgumentCollection,
tokens: list[str],
configs: Iterable[Callable],
*,
end_of_options_delimiter: str = "--",
) -> tuple[inspect.BoundArguments, list[str]]:
"""Parse and coerce CLI tokens to match a function's signature.
Parameters
----------
func: Callable
Function.
argument_collection: ArgumentCollection
tokens: List[str]
CLI tokens to parse and coerce to match ``f``'s signature.
configs: Iterable[Callable]
end_of_options_delimiter: str
Everything after this special token is forced to be supplied as a positional argument.
Returns
-------
bound: inspect.BoundArguments
The converted and bound positional and keyword arguments for ``f``.
unused_tokens: List[str]
Remaining tokens that couldn't be matched to ``f``'s signature.
"""
unused_tokens = tokens
try:
unused_tokens = _parse_kw_and_flags(
argument_collection, unused_tokens, end_of_options_delimiter=end_of_options_delimiter
)
unused_tokens = _parse_pos(
argument_collection, unused_tokens, end_of_options_delimiter=end_of_options_delimiter
)
_parse_env(argument_collection)
_parse_configs(argument_collection, configs)
argument_collection._convert()
groups_with_arguments = _sort_group(argument_collection)
try:
for group, group_arguments in groups_with_arguments:
for validator in group.validator: # pyright: ignore
validator(group_arguments) # pyright: ignore[reportOptionalCall]
except (AssertionError, ValueError, TypeError) as e:
raise ValidationError(exception_message=e.args[0] if e.args else "", group=group) from e # pyright: ignore
for argument in argument_collection:
# if a dict-like argument is missing, raise a MissingArgumentError on the first
# required child (as opposed generically to the root dict-like object).
if not argument.parameter.parse or not argument.field_info.required or argument.keys:
continue
if not argument.has_tokens:
raise MissingArgumentError(argument=argument)
bound = _bind(argument_collection, func)
except CycloptsError as e:
e.root_input_tokens = tokens
e.unused_tokens = unused_tokens
raise
return bound, unused_tokens
|