Counters

Repeatable ‘counter’ arguments can be specified via tyro.conf.UseCounterAction.

from typing_extensions import Annotated

import tyro
from tyro.conf import UseCounterAction


def main(
    verbosity: UseCounterAction[int],
    aliased_verbosity: Annotated[UseCounterAction[int], tyro.conf.arg(aliases=["-v"])],
) -> None:
    """Example showing how to use counter actions.

    Args:
        verbosity: Verbosity level.
        aliased_verbosity: Same as above, but can also be specified with -v, -vv, -vvv, etc.
    """
    print("Verbosity level:", verbosity)
    print("Verbosity level (aliased):", aliased_verbosity)


if __name__ == "__main__":
    tyro.cli(main)

---

python 04_additional/12_counters.py --help

usage: 12_counters.py [-h] [--verbosity] [--aliased-verbosity]

Example showing how to use counter actions.

╭─ options ──────────────────────────────────────────────────────────────────╮
│ -h, --help         show this help message and exit                         │
│ --verbosity        Verbosity level. (repeatable)                           │
│ --aliased-verbosity, -v                                                    │
│                    Same as above, but can also be specified with -v, -vv,  │
│                    -vvv, etc. (repeatable)                                 │
╰────────────────────────────────────────────────────────────────────────────╯

---

python 04_additional/12_counters.py --verbosity

Verbosity level: 1
Verbosity level (aliased): 0

---

python 04_additional/12_counters.py --verbosity --verbosity

Verbosity level: 2
Verbosity level (aliased): 0

---

python 04_additional/12_counters.py -vvv

Verbosity level: 0
Verbosity level (aliased): 3