tyro

What's Changed

Minor bug fixes, new features: tyro.conf.EnumChoicesFromValues (thanks @mcd!), tyro.extras.SubcommandApp (thanks @jedie!).

• Fix inconsistency between type[T] and typing.Type[T] annotations by @brentyi in https://github.com/brentyi/tyro/pull/165
• Feature: Markers: EnumChoicesFromValues by @emcd in https://github.com/brentyi/tyro/pull/168
• Fix --tyro-write-completion when use_underscores=True by @brentyi in https://github.com/brentyi/tyro/pull/173
• Decorator-based subcommand API (tyro.extras.SubcommandApp) by @brentyi in https://github.com/brentyi/tyro/pull/169

New Contributors

• @emcd made their first contribution in https://github.com/brentyi/tyro/pull/168

Full Changelog: https://github.com/brentyi/tyro/compare/v0.8.11...v0.8.12

What's Changed

• Support Enum aliases by @kevinddchen in https://github.com/brentyi/tyro/pull/162
• Support overriding behavior hint in argument helptext by @brentyi in https://github.com/brentyi/tyro/pull/161

Full Changelog: https://github.com/brentyi/tyro/compare/v0.8.10...v0.8.11

Better support for unions in completion script generation. (#158)

Full Changelog: https://github.com/brentyi/tyro/compare/v0.8.9...v0.8.10

What's Changed

• Add workaround for Python<=3.10 get_type_hints() bug in https://github.com/brentyi/tyro/pull/157
• Add support for datetime.{date,time,datetime} types in https://github.com/brentyi/tyro/pull/155
• Improve error messages for misplaced subcommand options.

Full Changelog: https://github.com/brentyi/tyro/compare/v0.8.8...v0.8.9

Added tyro.extras.overridable_config_cli().

Full Changelog: https://github.com/brentyi/tyro/compare/v0.8.7...v0.8.8

• Added config= argument to tyro.cli(), which takes a sequence of tyro.conf.* markers.
• Error message improvements for custom constructors and sequences over nested types.

Full Changelog: https://github.com/brentyi/tyro/compare/v0.8.6...v0.8.7

• Expanded type narrowing support for generics with type parameters bound to Any.
• Support collections.abc.Sequence.
• Error message improvements.
• tyro.conf.arg(prefix_name=False) now applies recursively when custom constructors are passed in.

Full Changelog: https://github.com/brentyi/tyro/compare/v0.8.5...v0.8.6

Performance and error message improvements.

• Refactoring to shorten tyro.cli() stack traces.
• Optimized string operations. tyro.cli() should run ~15% faster.
• Cleaner error messages for unsupported type annotations and subcommand helpers (#145).

Full Changelog: https://github.com/brentyi/tyro/compare/v0.8.4...v0.8.5

Main changes:

• Added console_outputs={True/False} argument to tyro.cli().
• Errors are now logged to stderr.

What's Changed

• More tests, quality-of-life improvements for scripts with multiple workers by @brentyi in https://github.com/brentyi/tyro/pull/142

Full Changelog: https://github.com/brentyi/tyro/compare/v0.8.3...v0.8.4

Switch to internal mirror of argparse. Fixes issue with Python 3.11.9.

Full Changelog: https://github.com/brentyi/tyro/compare/v0.8.2...v0.8.3

Require typing_extensions>=4.7.0.

Full Changelog: https://github.com/brentyi/tyro/compare/v0.8.1...v0.8.2

Fixed edge case in container narrowing logic. (#136)

Full Changelog: https://github.com/brentyi/tyro/compare/v0.8.0...v0.8.1

Primary update: official Python 3.12 support, including new type parameter + alias syntax.

What's Changed

• Support X | Y and list[T] for older versions of Python by @brentyi in https://github.com/brentyi/tyro/pull/134
• Make _fields.py assertion much more helpful by @pwais in https://github.com/brentyi/tyro/pull/131
• Implement counter actions by @brentyi in https://github.com/brentyi/tyro/pull/130
• Support Python 3.12 + PEP 695 (type statement, new type parameter syntax) by @brentyi in https://github.com/brentyi/tyro/pull/135

New Contributors

• @pwais made their first contribution in https://github.com/brentyi/tyro/pull/131

Full Changelog: https://github.com/brentyi/tyro/compare/v0.7.3...v0.8.0

What's Changed

• Fix init=False and forward references for attrs by @brentyi in https://github.com/brentyi/tyro/pull/126

Full Changelog: https://github.com/brentyi/tyro/compare/v0.7.2...v0.7.3

What's Changed

• Fix: tyro.cli description by @kevinddchen in https://github.com/brentyi/tyro/pull/124

Full Changelog: https://github.com/brentyi/tyro/compare/v0.7.1...v0.7.2

What's Changed

• Fix type narrowing edge case, bump to 0.7.1 in https://github.com/brentyi/tyro/pull/122

Full Changelog: https://github.com/brentyi/tyro/compare/v0.7.0...v0.7.1

What's Changed

• Consolidate field list generation in https://github.com/brentyi/tyro/pull/118
• typing.Self support + tests in https://github.com/brentyi/tyro/pull/120

Full Changelog: https://github.com/brentyi/tyro/compare/v0.6.6...v0.7.0

What's Changed

• Fix subcommand override edge case by @brentyi in https://github.com/brentyi/tyro/pull/117

Full Changelog: https://github.com/brentyi/tyro/compare/v0.6.5...v0.6.6

Helptext improvements!

Full Changelog: https://github.com/brentyi/tyro/compare/v0.6.4...v0.6.5

Fix tyro.conf.Suppress edge cases.

Full Changelog: https://github.com/brentyi/tyro/compare/v0.6.3...v0.6.4

What's Changed

• More succinct usage when a lot of options are present by @brentyi in https://github.com/brentyi/tyro/pull/114

Full Changelog: https://github.com/brentyi/tyro/compare/v0.6.2...v0.6.3

• Slightly improve helptext when tyro.conf.arg(constructor=...) is used.
• Fix an edge case where Annotated[] erases markers from tyro.conf.configure().
• More extensive helptext tests.

Full Changelog: https://github.com/brentyi/tyro/compare/v0.6.1...v0.6.2

What's Changed

• Improve PEP 585/604 annotation errors for older versions of Python by @brentyi in https://github.com/brentyi/tyro/pull/103
• Fix default values in Pydantic by @kevinddchen in https://github.com/brentyi/tyro/pull/109
• Support + test for typing.NewType by @brentyi in https://github.com/brentyi/tyro/pull/106
• Add default_instance support for attrs, fix docs by @brentyi in https://github.com/brentyi/tyro/pull/111

New Contributors

• @kevinddchen made their first contribution in https://github.com/brentyi/tyro/pull/109

Full Changelog: https://github.com/brentyi/tyro/compare/v0.6.0...v0.6.1

What's Changed

• Retain subcommand annotations by @brentyi in https://github.com/brentyi/tyro/pull/92
• Fix tuple + subcommand edge cases by @brentyi in https://github.com/brentyi/tyro/pull/93
• Account for indent in subcommand helptext wrapping by @brentyi in https://github.com/brentyi/tyro/pull/95
• Add support for mixed unions by @brentyi in https://github.com/brentyi/tyro/pull/96

Full Changelog: https://github.com/brentyi/tyro/compare/v0.5.18...v0.6.0

What's Changed

• Fix type narrowing edge case for unions by @brentyi in https://github.com/brentyi/tyro/pull/90
• Fix *args edge case.

Full Changelog: https://github.com/brentyi/tyro/compare/v0.5.17...v0.5.18

Eliminates some unnecessary warnings.

Fixed #84 (*args edge case), #88 (warning for incorrect default values).

Fixed TypedDict edge case. (#87)

Full Changelog: https://github.com/brentyi/tyro/compare/v0.5.14...v0.5.15

Fix tuple[] for structs in Python >= 3.9.

What's Changed

• Implement aliases by @brentyi in https://github.com/brentyi/tyro/pull/83

Full Changelog: https://github.com/brentyi/tyro/compare/v0.5.11...v0.5.12

What's Changed

• Improved dictionaries: TypedDict support, typing.[Required,NotRequired], defaults in https://github.com/brentyi/tyro/pull/81
• Implement custom constructor/proxy types in https://github.com/brentyi/tyro/pull/82

Full Changelog: https://github.com/brentyi/tyro/compare/v0.5.10...v0.5.11

What's Changed

• Patch underscore prefix edge case by @brentyi in https://github.com/brentyi/tyro/pull/78

Full Changelog: https://github.com/brentyi/tyro/compare/v0.5.9...v0.5.10

What's Changed

• Add use_underscores option by @brentyi in https://github.com/brentyi/tyro/pull/76
• Dependency and helptext cleanup

Full Changelog: https://github.com/brentyi/tyro/compare/v0.5.7...v0.5.8

What's Changed

• Add conf.PositionalRequiredArgs by @brentyi in https://github.com/brentyi/tyro/pull/66
• More error message tweaks by @brentyi in https://github.com/brentyi/tyro/pull/67
• Fix tyro.conf for pydantic>=2 by @brentyi in https://github.com/brentyi/tyro/pull/69

Full Changelog: https://github.com/brentyi/tyro/compare/v0.5.6...v0.5.7

What's Changed

• Fix typo in README.md by @eltociear in https://github.com/brentyi/tyro/pull/65
• Better error messages by @brentyi in https://github.com/brentyi/tyro/pull/63

New Contributors

• @eltociear made their first contribution in https://github.com/brentyi/tyro/pull/65

Full Changelog: https://github.com/brentyi/tyro/compare/v0.5.5...v0.5.6

Fix edge cases when generating subcommands from Optional[] types. (see #60)

What's Changed

• Support setting Tuple, Dict, and Union to empty in the command line by @ShenhanQian in https://github.com/brentyi/tyro/pull/57
• Support Pydantic 2.0
• Fixed tests for Python 3.11
• Cleaned up internals
• Replace poetry with setuptools

New Contributors

• @ShenhanQian made their first contribution in https://github.com/brentyi/tyro/pull/57

Full Changelog: https://github.com/brentyi/tyro/compare/v0.5.3...v0.5.4

Fix literals for latest typing_extensions release.

• Added tyro.conf.OmitArgPrefixes.

Full Changelog: https://github.com/brentyi/tyro/compare/v0.5.1...v0.5.2

What's Changed

• Remove debugging print statement by @vwxyzjn in https://github.com/brentyi/tyro/pull/51

New Contributors

• @vwxyzjn made their first contribution in https://github.com/brentyi/tyro/pull/51

Full Changelog: https://github.com/brentyi/tyro/compare/v0.5.0...v0.5.1

What's Changed

• Append action for variable-length containers in https://github.com/brentyi/tyro/pull/47
• More predictable boolean flag behavior in https://github.com/brentyi/tyro/pull/50
• Avoid unnecessary imports when Flax/JAX is installed

Full Changelog: https://github.com/brentyi/tyro/compare/v0.4.2...v0.5.0

Minor subcommand patch for Python 3.10.

Full Changelog: https://github.com/brentyi/tyro/compare/v0.4.1...v0.4.2

What's Changed

• Fix % character as default str argument in dataclass by @blurgyy in https://github.com/brentyi/tyro/pull/41
• Performance improvements
• Support containers as subcommands
• Warnings instead of errors for subcommand type mismatches (#20)

New Contributors

• @blurgyy made their first contribution in https://github.com/brentyi/tyro/pull/41

Full Changelog: https://github.com/brentyi/tyro/compare/v0.4.0...v0.4.1

• Add support for os.PathLike by @brentyi in https://github.com/brentyi/tyro/pull/37
• Add return_unknown_args to tyro.cli by @JesseFarebro in https://github.com/brentyi/tyro/pull/35
• Add support for PathLike classes & objects with new but no init by @JesseFarebro in https://github.com/brentyi/tyro/pull/38
• Smarter matching for default subcommands by @brentyi in https://github.com/brentyi/tyro/pull/33
• Add support for variadic arguments, as per #39
• --tyro-print-completion => --tyro-write-completion

Full Changelog: https://github.com/brentyi/tyro/compare/v0.3.38...v0.4.0

Minor improvements for helptext from pydantic dataclasses.

• Fix corner case with placing multiple subcommands below the root level (#29)
• Handle mixing of nested / non-nested types more gracefully
• Fix a broken f-string (#28)
• Minor internal improvements

• Support functools.partial and functools.wraps.
• Various minor bug fixes.

Add tyro.conf.ConsolidateSubcommandArgs, tyro.conf.configure().

(yanked) Add tyro.conf.ConsolidateSubcommandArgs, tyro.conf.configure().

Fix corner cases with non-leading positional arguments, helptext formatting.

• Add tyro.conf.arg().
• Add (currently undocumented) support for "help" metadata in dataclass fields. This should generally not be encouraged, but improves compatibility with HuggingFace-style configs.

Fixed flag conversion bug caused by runtime annotations:

flag1: bool = False # worked
flag2: Annotated[bool, "something"] = False # failed

PEP 604 support for Python 3.9. (fixes #19) Improve error message for subcommands with unmatched defaults. (eg x: A | B = C(), where issubclass(C, A) == issubclass(C, B) == False)

• Shift to upstream version of shtab for tab completion.
• Support classes defined using attrs and pydantic.
• Minor fixes for typing and docs.
• Support dataclasses.InitVar.

Yanked due to https://github.com/nerfstudio-project/nerfstudio/issues/882.

• Shift to upstream version of shtab for tab completion.
• Support classes defined using attrs and pydantic.
• Minor fixes for typing and docs.