hJ JSSKJr \"SSS9"SS55rS\S\4S jrg ) ) dataclassTF)frozeneqc$\rSrSr%Sr\\S'Srg)_MutexGroupConfigFrequiredN)__name__ __module__ __qualname____firstlineno__r bool__annotations____static_attributes__r P/home/james-whalen/.local/lib/python3.13/site-packages/tyro/conf/_mutex_group.pyrrs Hdrrr returnc[US9$)aCreate a mutually exclusive group for command-line arguments. When multiple arguments are annotated with the same mutex group, they become mutually exclusive: only one can be specified at a time via the CLI. .. warning:: Mutex groups are currently only supported for individual arguments (primitive types, enums, etc.), not for composite types like dataclasses or structs. To make fields within a dataclass mutually exclusive, annotate each field individually rather than the dataclass itself. For example, the annotation on ``Config`` will have no effect:: @dataclass class Config: foo: int bar: str MutexGroup = tyro.conf.create_mutex_group(required=True) def main( config: Annotated[Config, MutexGroup], # Has no effect! other: Annotated[int, MutexGroup], ): ... Instead, annotate individual fields within the dataclass. Args: required: If True, exactly one argument from the group must be specified. If False, at most one argument from the group can be specified. Returns: A configuration object to be used with :py:data:`typing.Annotated`. Example:: import tyro from typing import Annotated # Create mutex groups. RequiredGroup = tyro.conf.create_mutex_group(required=True) OptionalGroup = tyro.conf.create_mutex_group(required=False) def main( # Exactly one of these must be specified. option_a: Annotated[str | None, RequiredGroup] = None, option_b: Annotated[int | None, RequiredGroup] = None, # At most one of these can be specified. verbose: Annotated[bool, OptionalGroup] = False, quiet: Annotated[bool, OptionalGroup] = False, ) -> None: print(f"{option_a=}, {option_b=}, {verbose=}, {quiet=}") # DisallowNone prevents None from being a valid CLI choice. tyro.cli(main, config=(tyro.conf.DisallowNone,)) In this example: - The user must specify either ``--option-a`` or ``--option-b``, but not both. - The user can optionally specify either ``--verbose`` or ``--quiet``, but not both. - Using :data:`DisallowNone` ensures that ``--option-a None`` is not accepted. r )rrs rcreate_mutex_groupr s| h //rN) dataclassesrrrobjectrr rrrs;! $5!">0D>0V>0r