xnano.cli.parameters

xnano.cli.parameters ¶

Describe positional arguments and named options on typed commands.

Classes:

Argument –

Positional argument metadata.
Option –

Option metadata attached via default or Annotated.

Argument ¶

Argument(
    *,
    help: str | None = None,
    metavar: str | None = None,
    choices: Sequence[Any] | None = None
)

Positional argument metadata.

Attributes:

help –

Help text for this argument.
metavar –

Optional metavar override.
choices –

Optional allowed values.

Example

argument = Argument(help="Input file", metavar="PATH") argument.metavar 'PATH'

Source code in xnano/cli/parameters.py

def __init__(
    self,
    *,
    help: str | None = None,
    metavar: str | None = None,
    choices: Sequence[Any] | None = None,
) -> None:
    self.help = help
    self.metavar = metavar
    self.choices = choices

Option ¶

Option(
    *flags: str,
    help: str | None = None,
    metavar: str | None = None,
    choices: Sequence[Any] | None = None,
    hidden: bool = False
)

Option metadata attached via default or Annotated.

Attributes:

flags –

Short/long option flags (e.g. "-f", "--force").
help –

Help text for this option.
metavar –

Optional metavar override.
choices –

Optional allowed values.
hidden –

When True, omit from help.

Example

option = Option("-f", "--force", help="Overwrite output") option.flags ('-f', '--force')

Source code in xnano/cli/parameters.py

def __init__(
    self,
    *flags: str,
    help: str | None = None,
    metavar: str | None = None,
    choices: Sequence[Any] | None = None,
    hidden: bool = False,
) -> None:
    self.flags = tuple(flags)
    self.help = help
    self.metavar = metavar
    self.choices = choices
    self.hidden = hidden