Spaces:
Sleeping
Sleeping
File size: 16,666 Bytes
53dbcc1 | 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 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 | import inspect
import json
from collections.abc import Callable, Sequence
from enum import Enum
from itertools import chain
from typing import TYPE_CHECKING, Any, Literal, Optional, get_args, get_origin
from attrs import define, field
import cyclopts.utils
from cyclopts.annotations import get_hint_name
from cyclopts.command_spec import CommandSpec
from cyclopts.group import Group
from cyclopts.token import Token
from cyclopts.utils import is_option_like, json_decode_error_verbosifier
if TYPE_CHECKING:
from rich.console import Console
from cyclopts.argument import Argument, ArgumentCollection
from cyclopts.core import App
__all__ = [
"CoercionError",
"CommandCollisionError",
"CycloptsError",
"DocstringError",
"UnknownCommandError",
"MissingArgumentError",
"ConsumeMultipleError",
"MixedArgumentError",
"RepeatArgumentError",
"RequiresEqualsError",
"UnknownOptionError",
"UnusedCliTokensError",
"ValidationError",
"CombinedShortOptionError",
]
def _get_function_info(func):
return inspect.getsourcefile(func), inspect.getsourcelines(func)[1]
class CommandCollisionError(Exception):
"""A command with the same name has already been registered to the app."""
# This doesn't derive from CycloptsError since this is a developer error
# rather than a runtime error.
class DocstringError(Exception):
"""The docstring either has a syntax error, or inconsistency with the function signature."""
@define # (kw_only=True)
class CycloptsError(Exception):
"""Root exception for runtime errors.
As CycloptsErrors bubble up the Cyclopts call-stack, more information is added to it.
"""
msg: str | None = None
"""
If set, override automatic message generation.
"""
verbose: bool = True
"""
More verbose error messages; aimed towards developers debugging their Cyclopts app.
Defaults to ``False``.
"""
root_input_tokens: list[str] | None = None
"""
The parsed CLI tokens that were initially fed into the :class:`App`.
"""
unused_tokens: list[str] | None = None
"""
Leftover tokens after parsing is complete.
"""
target: Callable | None = None
"""
The python function associated with the command being parsed.
"""
argument: Optional["Argument"] = None
"""
:class:`Argument` that was matched.
"""
command_chain: Sequence[str] | None = None
"""
List of command that lead to ``target``.
"""
app: Optional["App"] = None
"""
The Cyclopts application itself.
"""
console: Optional["Console"] = field(default=None, kw_only=True)
""":class:`~rich.console.Console` to display runtime errors."""
def __str__(self):
if self.msg is not None:
return self.msg
strings = []
if self.verbose:
strings.append(type(self).__name__)
if self.target:
file, lineno = _get_function_info(self.target)
strings.append(f'Function defined in file "{file}", line {lineno}:')
strings.append(f" {self.target.__name__}{inspect.signature(self.target)}")
if self.root_input_tokens is not None:
strings.append(f"Root Input Tokens: {self.root_input_tokens}")
else:
pass
if strings:
return "\n".join(strings) + "\n"
else:
return ""
@define(kw_only=True)
class CombinedShortOptionError(CycloptsError):
"""Cannot combine short, token-consuming options with short flags."""
@define(kw_only=True)
class ValidationError(CycloptsError):
"""Validator function raised an exception."""
exception_message: str = ""
"""Parenting Assertion/Value/Type Error message."""
group: Group | None = None
"""If a group validator caused the exception."""
value: Any = cyclopts.utils.UNSET
"""Converted value that failed validation."""
def __str__(self):
message = ""
if self.argument:
value = self.argument.value if self.value is cyclopts.utils.UNSET else self.value
try:
token = self.argument.tokens[0]
except IndexError:
pass
else:
provided_by = "" if not token.source or token.source == "cli" else f' provided by "{token.source}"'
name = token.keyword if token.keyword else self.argument.name.lstrip("-").upper()
message = f'Invalid value "{value}" for "{name}"{provided_by}.'
elif self.group:
if self.group.name:
message = f'Invalid values for group "{self.group.name}".'
elif self.command_chain:
message = f"Invalid values for command {self.command_chain[-1]!r}."
else:
raise NotImplementedError
cyclopts_message = f"{super().__str__()}{message}"
if self.exception_message:
if cyclopts_message:
return f"{cyclopts_message} {self.exception_message}"
else:
return self.exception_message
else:
return cyclopts_message
@define(kw_only=True)
class UnknownOptionError(CycloptsError):
"""Unknown/unregistered option provided by the cli.
A nearest-neighbor parameter suggestion may be printed.
"""
token: Token
"""Token without a matching parameter."""
argument_collection: "ArgumentCollection"
"""Argument collection of plausible options."""
def __str__(self):
value = self.token.keyword or self.token.value
if self.token.source == "cli":
response = f'Unknown option: "{value}".'
else:
response = f'Unknown option: "{value}" from "{self.token.source}".'
if keyword := self.token.keyword or self.token.value:
import difflib
candidates = list(chain.from_iterable(x.names for x in self.argument_collection if x.parse))
close_matches = difflib.get_close_matches(keyword, candidates, n=1, cutoff=0.6)
if close_matches:
response += f' Did you mean "{close_matches[0]}"?'
return super().__str__() + response
@define(kw_only=True)
class CoercionError(CycloptsError):
"""There was an error performing automatic type coercion."""
token: Optional["Token"] = None
"""
Input token that couldn't be coerced.
"""
target_type: type | None = None
"""
Intended type to coerce into.
"""
def __str__(self):
if self.msg is not None:
if not self.token or self.token.keyword is None:
return self.msg
else:
return f"Invalid value for {self.token.keyword}: {self.msg}"
else:
# If a JsonDecodeError, try and verbosify it.
if isinstance(self.__cause__, json.JSONDecodeError):
msg = json_decode_error_verbosifier(self.__cause__) # pyright: ignore[reportArgumentType]
if not self.token or self.token.keyword is None:
return msg
else:
return f"Invalid value for {self.token.keyword}: {msg}"
assert self.argument is not None
assert self.target_type is not None
msg = super().__str__()
if get_origin(self.target_type) is Literal:
choices = "{" + ", ".join(repr(x) for x in get_args(self.target_type)) + "}"
target_type_name = f"one of {choices}"
elif isinstance(self.target_type, type) and issubclass(self.target_type, Enum):
nt = self.argument.parameter.name_transform
choices = "{" + ", ".join(repr(nt(x)) for x in self.target_type.__members__) + "}"
target_type_name = f"one of {choices}"
else:
target_type_name = get_hint_name(self.target_type)
if not self.token:
msg += f'Invalid value for "{self.argument.name}": unable to convert value to {target_type_name}.'
elif self.token.keyword is None:
positional_name = self.argument.name.lstrip("-").upper()
if self.token.source == "" or self.token.source == "cli":
msg += f'Invalid value for "{positional_name}": unable to convert "{self.token.value}" into {target_type_name}.'
else:
msg += f'Invalid value for "{positional_name}" from {self.token.source}: unable to convert "{self.token.value}" into {target_type_name}.'
else:
if self.token.source == "" or self.token.source == "cli":
msg += f'Invalid value for "{self.token.keyword}": unable to convert "{self.token.value}" into {target_type_name}.'
else:
msg += f'Invalid value for "{self.token.keyword}" from {self.token.source}: unable to convert "{self.token.value}" into {target_type_name}.'
return msg
class UnknownCommandError(CycloptsError):
"""CLI token combination did not yield a valid command."""
def __str__(self):
assert self.unused_tokens
token = self.unused_tokens[0]
response = f'Unknown command "{token}".'
if self.app and self.app._commands:
import difflib
# Resolve CommandSpec and filter visible commands
visible_commands = []
for name, app_or_spec in self.app._commands.items():
if name in self.app._help_flags or name in self.app._version_flags:
continue
# Resolve CommandSpec to App
subapp = app_or_spec.resolve(self.app) if isinstance(app_or_spec, CommandSpec) else app_or_spec
if not isinstance(subapp, type(self.app)):
continue
if subapp.show:
visible_commands.append(name)
close_matches = difflib.get_close_matches(
token,
visible_commands,
n=1,
cutoff=0.6,
)
if close_matches:
response += f' Did you mean "{close_matches[0]}"?'
# The following is a heuristic to be "maximally helpful" to someone who may have
# forgotten a command in their CLI call.
max_commands = 8
available_commands = [name for name in visible_commands if not name.startswith("-")]
if available_commands:
if len(available_commands) > max_commands:
response += f" Available commands: {', '.join(available_commands[:max_commands])}, ..."
else:
response += f" Available commands: {', '.join(available_commands)}."
return super().__str__() + response
@define(kw_only=True)
class UnusedCliTokensError(CycloptsError):
"""Not all CLI tokens were used as expected."""
def __str__(self):
assert self.unused_tokens is not None
return super().__str__() + f"Unused Tokens: {self.unused_tokens}."
@define(kw_only=True)
class MissingArgumentError(CycloptsError):
"""A required argument was not provided."""
tokens_so_far: list[str] = field(factory=list)
"""If the matched parameter requires multiple tokens, these are the ones we have parsed so far."""
keyword: str | None = None
"""The keyword that was used when the error was raised (e.g., '-o' instead of '--option')."""
def __str__(self):
assert self.argument is not None
strings = []
count, _ = self.argument.token_count()
if count == 0:
required_string = "flag required"
only_got_string = ""
elif count == 1:
required_string = "requires an argument"
only_got_string = ""
else:
required_string = f"requires {count} positional arguments"
received_count = len(self.tokens_so_far) % count
only_got_string = f" Only got {received_count}." if received_count else ""
close_match_string = ""
if self.unused_tokens and self.argument.field_info.is_keyword:
import difflib
candidates = [x for x in self.unused_tokens if is_option_like(x)]
close_matches = difflib.get_close_matches(self.argument.name, candidates, n=1, cutoff=0.6)
if close_matches and close_matches[0] not in self.argument.names:
close_match_string = f'Did you mean "{self.argument.name}" instead of "{close_matches[0]}"?'
param_name = self.argument.name
if self.keyword is not None:
param_name = self.keyword
elif self.argument.tokens:
for token in reversed(self.argument.tokens):
if token.keyword is not None:
param_name = token.keyword
break
if self.command_chain:
strings.append(
f'Command "{" ".join(self.command_chain)}" parameter "{param_name}" {required_string}.{only_got_string}'
)
else:
strings.append(f'Parameter "{param_name}" {required_string}.{only_got_string}')
if close_match_string:
strings.append(close_match_string)
if self.verbose:
strings.append(f" Parsed: {self.tokens_so_far}.")
return super().__str__() + " ".join(strings)
@define(kw_only=True)
class ConsumeMultipleError(MissingArgumentError):
"""The number of values provided doesn't meet consume_multiple constraints."""
min_required: int = 0
max_allowed: int | None = None
actual_count: int = 0
def __str__(self):
assert self.argument is not None
param_name = self.keyword or self.argument.name
if self.actual_count < self.min_required:
constraint = f"requires at least {self.min_required}"
else:
constraint = f"accepts at most {self.max_allowed}"
if self.command_chain:
base = f'Command "{" ".join(self.command_chain)}" parameter "{param_name}" {constraint} elements. Got {self.actual_count}.'
else:
base = f'Parameter "{param_name}" {constraint} elements. Got {self.actual_count}.'
return CycloptsError.__str__(self) + base
@define(kw_only=True)
class RequiresEqualsError(CycloptsError):
"""A long option requires ``=`` to assign a value (e.g., ``--option=value``)."""
keyword: str | None = None
"""The keyword that was used (e.g., '--name')."""
def __str__(self):
assert self.argument is not None
param_name = self.keyword or self.argument.name
return (
super().__str__()
+ f'Parameter "{param_name}" requires a value assigned with "=". Use "{param_name}=VALUE".'
)
@define(kw_only=True)
class RepeatArgumentError(CycloptsError):
"""The same parameter has erroneously been specified multiple times."""
token: "Token"
"""The repeated token."""
def __str__(self):
return super().__str__() + f"Parameter {self.token.keyword} specified multiple times."
@define(kw_only=True)
class ArgumentOrderError(CycloptsError):
"""Cannot supply a POSITIONAL_OR_KEYWORD argument with a keyword, and then a later POSITIONAL_OR_KEYWORD argument positionally."""
token: str
prior_positional_or_keyword_supplied_as_keyword_arguments: list["Argument"]
def __str__(self):
assert self.argument is not None
plural = len(self.prior_positional_or_keyword_supplied_as_keyword_arguments) > 1
display_name = next((x.keyword for x in self.argument.tokens if x.keyword), self.argument.name).lstrip("-")
prior_display_names = [
x.tokens[0].keyword for x in self.prior_positional_or_keyword_supplied_as_keyword_arguments
]
if len(prior_display_names) == 1:
prior_display_names = prior_display_names[0]
return (
super().__str__()
+ f"Cannot specify token {self.token!r} positionally for parameter {display_name!r} due to previously specified keyword{'s' if plural else ''} {prior_display_names!r}. {prior_display_names!r} must either be passed positionally, or {self.token!r} must be passed as a keyword to {self.argument.name!r}."
)
@define(kw_only=True)
class MixedArgumentError(CycloptsError):
"""Cannot supply keywords and non-keywords to the same argument."""
def __str__(self):
assert self.argument is not None
display_name = next((x.keyword for x in self.argument.tokens if x.keyword), self.argument.name)
return super().__str__() + f'Cannot supply keyword & non-keyword arguments to "{display_name}".'
|