Skip to main content

Strongly typed, zero-effort CLI interfaces

Project description


tyro logo

Documentation   •   pip install tyro

build mypy lint codecov codecov


tyro is a library for building CLI interfaces, configuration objects, and configuration systems with modern, type-annotated Python.

Our core interface consists of just one function, tyro.cli(), that translates Python callables and types into fully-featured argument parsers and configuration objects.

To get started, we recommend visiting the examples in our documentation.

Why tyro?

  1. Strong typing.

    Unlike tools dependent on dictionaries, YAML, or dynamic namespaces, arguments populated by tyro benefit from IDE and language server-supported operations — think tab completion, rename, jump-to-def, docstrings on hover — as well as static checking tools like pyright and mypy.

  2. Minimal overhead.

    Standard Python type annotations, docstrings, and default values are parsed to automatically generate command-line interfaces with informative helptext.

    If you're familiar with type annotations and docstrings in Python, you already know how to use tyro! If you're not, learning to use tyro reduces to learning to write modern Python.

    Hate tyro? Just remove one line of code, and you're left with beautiful, type-annotated, and documented vanilla Python that can be used with a range of other configuration libraries.

  3. Modularity.

    tyro supports hierarchical configuration structures, which make it easy to distribute definitions, defaults, and documentation of configurable fields across modules or source files.

  4. Tab completion.

    By extending shtab, tyro automatically generates tab completion scripts for bash, zsh, and tcsh.

A minimal example

As a replacement for argparse:

with argparse with tyro
"""Sum two numbers from argparse."""

import argparse
parser = argparse.ArgumentParser()
parser.add_argument(
    "--a",
    type=int,
    required=True,
)
parser.add_argument(
    "--b",
    type=int,
    default=3,
)
args = parser.parse_args()

print(args.a + args.b)
"""Sum two numbers by calling a
function with tyro."""

import tyro

def main(a: int, b: int = 3) -> None:
    print(a + b)

tyro.cli(main)

"""Sum two numbers by instantiating
a dataclass with tyro."""

from dataclasses import dataclass

import tyro

@dataclass
class Args:
    a: int
    b: int = 3

args = tyro.cli(Args)
print(args.a + args.b)

For more examples, see our documentation.

In the wild

tyro is still a new library, but being stress tested in several projects!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tyro-0.3.27.tar.gz (56.0 kB view details)

Uploaded Source

Built Distribution

tyro-0.3.27-py3-none-any.whl (63.4 kB view details)

Uploaded Python 3

File details

Details for the file tyro-0.3.27.tar.gz.

File metadata

  • Download URL: tyro-0.3.27.tar.gz
  • Upload date:
  • Size: 56.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.8.14 Linux/5.15.0-1020-azure

File hashes

Hashes for tyro-0.3.27.tar.gz
Algorithm Hash digest
SHA256 68dda5edb46d37434f00b52726e0b725ccb72971b104965473fc4dbb11a40bbb
MD5 256bc1b3cb9b99362fe55df29ba71a91
BLAKE2b-256 7b24c7ba257ed7121501b40fef42bfc0584a5156abfef2dc707883dc2acce81f

See more details on using hashes here.

File details

Details for the file tyro-0.3.27-py3-none-any.whl.

File metadata

  • Download URL: tyro-0.3.27-py3-none-any.whl
  • Upload date:
  • Size: 63.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.8.14 Linux/5.15.0-1020-azure

File hashes

Hashes for tyro-0.3.27-py3-none-any.whl
Algorithm Hash digest
SHA256 660d8731f6bdc4cec9e92f368780eaf419542ad460cb1114545991805acbb921
MD5 b5de6587a605f3a21bb65f9f4a971a7f
BLAKE2b-256 90544f9106732c068c9c45abb526225b3de432a33fefd50d2a9e588d5851bcbc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page