"""Shared helper functions and constants for the argument package."""
import sys
from collections.abc import Callable, Iterator
from contextlib import suppress
from enum import Enum, Flag
from functools import partial
from typing import TYPE_CHECKING, Annotated, Any, Literal, TypeVar, get_args, get_origin
if TYPE_CHECKING:
from cyclopts.argument._argument import Argument
F = TypeVar("F", bound=Flag)
from cyclopts._convert import ITERABLE_TYPES, convert_enum_flag
from cyclopts.annotations import (
is_class_and_subclass,
is_union,
resolve_annotated,
)
from cyclopts.field_info import (
KEYWORD_ONLY,
POSITIONAL_ONLY,
POSITIONAL_OR_KEYWORD,
VAR_KEYWORD,
VAR_POSITIONAL,
FieldInfo,
)
from cyclopts.parameter import Parameter
if sys.version_info >= (3, 12): # pragma: no cover
from typing import TypeAliasType
else: # pragma: no cover
TypeAliasType = None
PARAMETER_SUBKEY_BLOCKER = Parameter(
name=None,
alias=None,
converter=None, # pyright: ignore
validator=None,
accepts_keys=None,
consume_multiple=None,
env_var=None,
)
KIND_PARENT_CHILD_REASSIGNMENT = {
(POSITIONAL_OR_KEYWORD, POSITIONAL_OR_KEYWORD): POSITIONAL_OR_KEYWORD,
(POSITIONAL_OR_KEYWORD, POSITIONAL_ONLY): POSITIONAL_ONLY,
(POSITIONAL_OR_KEYWORD, KEYWORD_ONLY): KEYWORD_ONLY,
(POSITIONAL_OR_KEYWORD, VAR_POSITIONAL): VAR_POSITIONAL,
(POSITIONAL_OR_KEYWORD, VAR_KEYWORD): VAR_KEYWORD,
(POSITIONAL_ONLY, POSITIONAL_OR_KEYWORD): POSITIONAL_ONLY,
(POSITIONAL_ONLY, POSITIONAL_ONLY): POSITIONAL_ONLY,
(POSITIONAL_ONLY, KEYWORD_ONLY): None,
(POSITIONAL_ONLY, VAR_POSITIONAL): VAR_POSITIONAL,
(POSITIONAL_ONLY, VAR_KEYWORD): None,
(KEYWORD_ONLY, POSITIONAL_OR_KEYWORD): KEYWORD_ONLY,
(KEYWORD_ONLY, POSITIONAL_ONLY): None,
(KEYWORD_ONLY, KEYWORD_ONLY): KEYWORD_ONLY,
(KEYWORD_ONLY, VAR_POSITIONAL): None,
(KEYWORD_ONLY, VAR_KEYWORD): VAR_KEYWORD,
(VAR_POSITIONAL, POSITIONAL_OR_KEYWORD): POSITIONAL_ONLY,
(VAR_POSITIONAL, POSITIONAL_ONLY): POSITIONAL_ONLY,
(VAR_POSITIONAL, KEYWORD_ONLY): None,
(VAR_POSITIONAL, VAR_POSITIONAL): VAR_POSITIONAL,
(VAR_POSITIONAL, VAR_KEYWORD): None,
(VAR_KEYWORD, POSITIONAL_OR_KEYWORD): KEYWORD_ONLY,
(VAR_KEYWORD, POSITIONAL_ONLY): None,
(VAR_KEYWORD, KEYWORD_ONLY): KEYWORD_ONLY,
(VAR_KEYWORD, VAR_POSITIONAL): None,
(VAR_KEYWORD, VAR_KEYWORD): VAR_KEYWORD,
}
def get_choices_from_hint(type_: type, name_transform: Callable[[str], str]) -> list[str]:
"""Extract completion choices from a type hint.
Recursively extracts choices from Literal types, Enum types, and Union types.
Parameters
----------
type_ : type
Type annotation to extract choices from.
name_transform : Callable[[str], str]
Function to transform choice names (e.g., for case conversion).
Returns
-------
list[str]
List of choice strings extracted from the type hint.
"""
get_choices = partial(get_choices_from_hint, name_transform=name_transform)
choices = []
_origin = get_origin(type_)
if isinstance(type_, type) and is_class_and_subclass(type_, Enum):
choices.extend(name_transform(x) for x in type_.__members__)
elif is_union(_origin):
inner_choices = [get_choices(inner) for inner in get_args(type_)]
for x in inner_choices:
if x:
choices.extend(x)
elif _origin is Literal:
choices.extend(str(x) for x in get_args(type_))
elif _origin in ITERABLE_TYPES:
args = get_args(type_)
if len(args) == 1 or (_origin is tuple and len(args) == 2 and args[1] is Ellipsis):
choices.extend(get_choices(args[0]))
elif _origin is Annotated:
choices.extend(get_choices(resolve_annotated(type_)))
elif TypeAliasType is not None and isinstance(type_, TypeAliasType):
choices.extend(get_choices(type_.__value__))
return choices
def startswith(string, prefix):
def normalize(s):
return s.replace("_", "-")
return normalize(string).startswith(normalize(prefix))
def missing_keys_factory(
get_field_info: Callable[[Any], dict[str, FieldInfo]],
) -> Callable[["Argument", dict[str, Any]], list[str]]:
def inner(argument: "Argument", data: dict[str, Any]) -> list[str]:
provided_keys = set(data)
field_info = get_field_info(argument.hint)
return [k for k, v in field_info.items() if (v.required and k not in provided_keys)]
return inner
def get_annotated_discriminator(annotation):
for meta in get_args(annotation)[1:]:
try:
return meta.discriminator
except AttributeError:
pass
return None
def enum_flag_from_dict(
enum_type: type[F],
data: dict[str, bool],
name_transform: Callable[[str], str],
) -> F:
"""Convert a dictionary of boolean flags to a Flag enum value.
Parameters
----------
enum_type : type[F]
The Flag enum type to convert to.
data : dict[str, bool]
Dictionary mapping flag names to boolean values.
Returns
-------
F
The combined flag value.
"""
return convert_enum_flag(enum_type, (k for k, v in data.items() if v), name_transform)
def extract_docstring_help(f: Callable) -> dict[tuple[str, ...], Parameter]:
from docstring_parser import parse_from_object
with suppress(AttributeError):
f = f.func # pyright: ignore[reportFunctionMemberAccess]
result = {}
# For classes, walk through MRO to include base class fields.
# parse_from_object only extracts docstrings from the **immediate** class's source code,
# not from inherited fields.
# From docstring_parser docs:
#
# When given a class, only the attribute docstrings of that class are parsed, not its
# inherited classes. This is a design decision. Separate calls to this function
# should be performed to get attribute docstrings of parent classes.
if mro := getattr(f, "__mro__", None):
# Process base classes first (reversed MRO order), so derived classes can override
# their parent's docstrings if they redefine the same field with a new docstring.
for base_class in reversed(mro[:-1]): # Exclude 'object'
try:
parsed = parse_from_object(base_class)
for dparam in parsed.params:
result[tuple(dparam.arg_name.split("."))] = Parameter(help=dparam.description)
except (TypeError, AttributeError):
# Some base classes may not have parseable docstrings (e.g., built-in classes)
continue
else:
# For functions/callables (original behavior)
try:
parsed = parse_from_object(f)
for dparam in parsed.params:
result[tuple(dparam.arg_name.split("."))] = Parameter(help=dparam.description)
except (TypeError, AttributeError):
# parse_from_object may fail for some callables
pass
return result
def resolve_parameter_name_helper(elem):
if elem.endswith("*"):
elem = elem[:-1].rstrip(".")
if elem and not elem.startswith("-"):
elem = "--" + elem
return elem
def resolve_parameter_name(*argss: tuple[str, ...]) -> tuple[str, ...]:
"""Resolve parameter names by combining and formatting multiple tuples of strings.
Parameters
----------
*argss
Each tuple represents a group of parameter name components.
Returns
-------
tuple[str, ...]
A tuple of resolved parameter names.
"""
argss = tuple(x for x in argss if x)
if len(argss) == 0:
return ()
elif len(argss) == 1:
return tuple("*" if x == "*" else resolve_parameter_name_helper(x) for x in argss[0])
out = []
for a1 in argss[0]:
a1 = resolve_parameter_name_helper(a1)
for a2 in argss[1]:
if a2.startswith("-") or not a1:
out.append(a2)
else:
out.append(a1 + "." + a2)
return resolve_parameter_name(tuple(out), *argss[2:])
def walk_leaves(
d,
parent_keys: tuple[str, ...] | None = None,
) -> Iterator[tuple[tuple[str, ...], Any]]:
if parent_keys is None:
parent_keys = ()
if isinstance(d, dict):
for key, value in d.items():
current_keys = parent_keys + (key,)
if isinstance(value, dict):
yield from walk_leaves(value, current_keys)
else:
yield current_keys, value
else:
yield (), d
def to_cli_option_name(*keys: str) -> str:
return "--" + ".".join(keys)
