Typer

Features

* ✨ Add support for custom types and parsers. Initial PR [583](https://github.com/tiangolo/typer/pull/583) by [jpurviance](https://github.com/jpurviance). Based on original PR [#443](https://github.com/tiangolo/typer/pull/443) by [paulo-raca](https://github.com/paulo-raca).
* New docs: [CLI Parameter Types: Custom Types](https://typer.tiangolo.com/tutorial/parameter-types/custom-types/).

Upgrades

* ⬆ Upgrade Rich, support 13.x. PR [524](https://github.com/tiangolo/typer/pull/524) by [musicinmybrain](https://github.com/musicinmybrain).

Docs

* 📝 Tweak docs, Custom Types path, main page and READAME colors, broken links. PR [588](https://github.com/tiangolo/typer/pull/588) by [tiangolo](https://github.com/tiangolo).
* ✏ Fix spelling (shinny -> shiny). PR [586](https://github.com/tiangolo/typer/pull/586) by [runofthemill](https://github.com/runofthemill).
* 📝 Update docs about helping Typer. PR [547](https://github.com/tiangolo/typer/pull/547) by [tiangolo](https://github.com/tiangolo).
* ✏️ Fix typo in datetime docs. PR [495](https://github.com/tiangolo/typer/pull/495) by [huxuan](https://github.com/huxuan).
* ✏️ Add quotes to package name that includes brackets in docs. PR [475](https://github.com/tiangolo/typer/pull/475) by [gjolga](https://github.com/gjolga).

Internal

* ⬆ Bump dawidd6/action-download-artifact from 2.24.2 to 2.26.0. PR [558](https://github.com/tiangolo/typer/pull/558) by [dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [549](https://github.com/tiangolo/typer/pull/549) by [pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).
* 🔧 Add `exclude_lines` to coverage configuration. PR [585](https://github.com/tiangolo/typer/pull/585) by [dmontagu](https://github.com/dmontagu).
* ⬆️ Upgrade analytics. PR [557](https://github.com/tiangolo/typer/pull/557) by [tiangolo](https://github.com/tiangolo).
* 🔧 Update new issue chooser to suggest GitHub Discussions. PR [544](https://github.com/tiangolo/typer/pull/544) by [tiangolo](https://github.com/tiangolo).
* 🔧 Add GitHub Discussion templates for questions. PR [541](https://github.com/tiangolo/typer/pull/541) by [tiangolo](https://github.com/tiangolo).
* 🔧 Update pre-commit, Python version, isort version. PR [542](https://github.com/tiangolo/typer/pull/542) by [tiangolo](https://github.com/tiangolo).
* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [512](https://github.com/tiangolo/typer/pull/512) by [pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).
* ⬆ Bump nwtgck/actions-netlify from 1.2.4 to 2.0.0. PR [513](https://github.com/tiangolo/typer/pull/513) by [dependabot[bot]](https://github.com/apps/dependabot).
* 👷 Refactor CI artifact upload/download for docs previews. PR [516](https://github.com/tiangolo/typer/pull/516) by [tiangolo](https://github.com/tiangolo).
* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [500](https://github.com/tiangolo/typer/pull/500) by [pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).
* ⬆ Bump actions/cache from 2 to 3. PR [496](https://github.com/tiangolo/typer/pull/496) by [dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Bump dawidd6/action-download-artifact from 2.24.1 to 2.24.2. PR [494](https://github.com/tiangolo/typer/pull/494) by [dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Bump dawidd6/action-download-artifact from 2.9.0 to 2.24.1. PR [491](https://github.com/tiangolo/typer/pull/491) by [dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Bump actions/setup-python from 2 to 4. PR [492](https://github.com/tiangolo/typer/pull/492) by [dependabot[bot]](https://github.com/apps/dependabot).
* 👷‍♂️ Consistently use `sys.executable` to run subprocesses, needed by OpenSUSE. PR [408](https://github.com/tiangolo/typer/pull/408) by [theMarix](https://github.com/theMarix).
* 👷‍♂️ Ensure the `PYTHONPATH` is set properly when testing the tutorial scripts. PR [407](https://github.com/tiangolo/typer/pull/407) by [theMarix](https://github.com/theMarix).

Features

* ✨ Make `typer.run()` not add completion scripts by default, it only makes sense in installed apps. Also update docs for handling [autocompletion in CLI options](https://typer.tiangolo.com/tutorial/options-autocompletion/). PR [#488](https://github.com/tiangolo/typer/pull/488) by [tiangolo](https://github.com/tiangolo).
* ✨ Add support for Python 3.11, tests in CI and official marker. PR [487](https://github.com/tiangolo/typer/pull/487) by [tiangolo](https://github.com/tiangolo).
* 👷 Add CI for Python 3.10. PR [384](https://github.com/tiangolo/typer/pull/384) by [tiangolo](https://github.com/tiangolo).

Fixes

* 🎨 Fix type annotation of `typer.run()`. PR [284](https://github.com/tiangolo/typer/pull/284) by [yassu](https://github.com/yassu).
* 🎨 Fix type annotations for `get_group`. PR [430](https://github.com/tiangolo/typer/pull/430) by [tiangolo](https://github.com/tiangolo).

Docs

* 📝 Add note about how subcommands with function names using underscores are converted to dashes. PR [403](https://github.com/tiangolo/typer/pull/403) by [targhs](https://github.com/targhs).
* 📝 Fix typo in docs at `docs/tutorial/commands/help.md`. PR [466](https://github.com/tiangolo/typer/pull/466) by [fepegar](https://github.com/fepegar).
* ✏ Fix link in docs to `datetime.strptime()`. PR [464](https://github.com/tiangolo/typer/pull/464) by [Kobu](https://github.com/Kobu).
* ✏ Update `first-steps.md`, clarify distinction between parameter and argument. PR [176](https://github.com/tiangolo/typer/pull/176) by [mccarthysean](https://github.com/mccarthysean).
* ✏ Fix broken plac link. PR [275](https://github.com/tiangolo/typer/pull/275) by [mgielda](https://github.com/mgielda).

Internal

* ✅ Add extra tests just for coverage because monkeypatching with strange imports confuses coverage. PR [490](https://github.com/tiangolo/typer/pull/490) by [tiangolo](https://github.com/tiangolo).
* 🔧 Tweak pytest coverage. PR [485](https://github.com/tiangolo/typer/pull/485) by [tiangolo](https://github.com/tiangolo).
* ➕ Bring back pytest-cov because coverage can't detect pytest-xdist. PR [484](https://github.com/tiangolo/typer/pull/484) by [tiangolo](https://github.com/tiangolo).
* ⬆ Bump actions/upload-artifact from 2 to 3. PR [477](https://github.com/tiangolo/typer/pull/477) by [dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Bump actions/checkout from 2 to 3. PR [478](https://github.com/tiangolo/typer/pull/478) by [dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [411](https://github.com/tiangolo/typer/pull/411) by [pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).
* ⬆ Bump nwtgck/actions-netlify from 1.1.5 to 1.2.4. PR [479](https://github.com/tiangolo/typer/pull/479) by [dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Bump tiangolo/issue-manager from 0.2.0 to 0.4.0. PR [481](https://github.com/tiangolo/typer/pull/481) by [dependabot[bot]](https://github.com/apps/dependabot).
* 👷 Move from pytest-cov to coverage and Codecov to Smokeshow. PR [483](https://github.com/tiangolo/typer/pull/483) by [tiangolo](https://github.com/tiangolo).
* ➕ Add extra Material for MkDocs deps for docs. PR [482](https://github.com/tiangolo/typer/pull/482) by [tiangolo](https://github.com/tiangolo).
* 🔧 Update Dependabot config. PR [476](https://github.com/tiangolo/typer/pull/476) by [tiangolo](https://github.com/tiangolo).

Fixes

* 🐛 Fix setting `FORCE_TERMINAL` with colors 2. PR [424](https://github.com/tiangolo/typer/pull/424) by [tiangolo](https://github.com/tiangolo).
* 🐛 Fix setting `FORCE_TERMINAL` with colors. PR [423](https://github.com/tiangolo/typer/pull/423) by [tiangolo](https://github.com/tiangolo).

This release adds deep integrations with [Rich](https://rich.readthedocs.io/en/stable/). ✨

`rich` is an optional dependency, you can install it directly or it will be included when you install with:

console
$ pip install "typer[all]"


If Rich is available, it will be used to show the content from `--help` options, validation errors, and even errors in your app (exception tracebacks).

There are new options to group commands, *CLI arguments*, and *CLI options*, support for [Rich Console Markup](https://rich.readthedocs.io/en/stable/markup.html), and more! 🎉

Features

* ✨ Richify, add integrations with Rich everywhere. PR [419](https://github.com/tiangolo/typer/pull/419) by [tiangolo](https://github.com/tiangolo).
* Recommend Rich as the main information displaying tool, new docs: [Printing and Colors](https://typer.tiangolo.com/tutorial/printing/).
* For most use cases not using Rich, use plain `print()` instead of `typer.echo()` in the docs, to simplify the concepts and avoid confusions. New docs: [Printing and Colors - typer Echo](https://typer.tiangolo.com/tutorial/printing/#typer-echo).
* Define help panels for *CLI arguments*, new docs: [CLI Arguments with Help - CLI Argument help panels](https://typer.tiangolo.com/tutorial/arguments/help/#cli-argument-help-panels).
* Define help panels for *CLI options*, new docs: [CLI Options with Help - CLI Options help panels](https://typer.tiangolo.com/tutorial/options/help/#cli-options-help-panels).
* New docs for deprecating commands: [Commands - Command Help - Deprecate a Command](https://typer.tiangolo.com/tutorial/commands/help/#deprecate-a-command).
* Support for Rich Markdown in docstrings, *CLI parameters* `help`, and `epilog` with the new parameter `typer.Typer(rich_markup_mode="markdown")`, new docs: [Commands - Command Help - Rich Markdown and Markup](https://typer.tiangolo.com/tutorial/commands/help/#rich-markdown-and-markup).
* Support for Rich Markup (different from Markdown) in docstrings, *CLI parameters* `help`, and `epilog` with the new parameter `typer.Typer(rich_markup_mode="rich")`, new docs: [Commands - Command Help - Rich Markdown and Markup](https://typer.tiangolo.com/tutorial/commands/help/#rich-markdown-and-markup).
* Define help panels for *commands*, new docs: [Commands - Command Help - Help Panels](https://typer.tiangolo.com/tutorial/commands/help/#help-panels).
* New docs for setting an `epilog`, with support for Rich Markdown and Console Markup, new docs: [Commands - Command Help - Epilog](https://typer.tiangolo.com/tutorial/commands/help/#epilog).
* ✨ Refactor and document handling pretty exceptions. PR [422](https://github.com/tiangolo/typer/pull/422) by [tiangolo](https://github.com/tiangolo).
* Add support for customizing pretty short errors, new docs: [Exceptions and Errors](https://typer.tiangolo.com/tutorial/exceptions/).
* ✨ Allow configuring pretty errors when creating the Typer instance. PR [416](https://github.com/tiangolo/typer/pull/416) by [tiangolo](https://github.com/tiangolo).

Docs

* 📝 Add docs for using Rich with Typer. PR [421](https://github.com/tiangolo/typer/pull/421) by [tiangolo](https://github.com/tiangolo).
* Add new docs: [Ask with Prompt - Prompt with Rich](https://typer.tiangolo.com/tutorial/prompt/#prompt-with-rich).
* Add new docs to handle progress bars and spinners with Rich: [Progress Par](https://typer.tiangolo.com/tutorial/progressbar/).

Internal

* ⬆️ Upgrade codecov GitHub Action. PR [420](https://github.com/tiangolo/typer/pull/420) by [tiangolo](https://github.com/tiangolo).

Features

* ✨ Add pretty error tracebacks for user errors and support for Rich. PR [412](https://github.com/tiangolo/typer/pull/412) by [tiangolo](https://github.com/tiangolo).

Docs

* ✏ Fix typo, "ASCII codes" to "ANSI escape sequences". PR [308](https://github.com/tiangolo/typer/pull/308) by [septatrix](https://github.com/septatrix).

Fixes

* 🐛 Fix type conversion for `List` and `Tuple` and their internal types. PR [143](https://github.com/tiangolo/typer/pull/143) by [hellowhistler](https://github.com/hellowhistler).
* 🐛 Fix `context_settings` for a Typer app with a single command. PR [210](https://github.com/tiangolo/typer/pull/210) by [daddycocoaman](https://github.com/daddycocoaman).

Docs

* 📝 Clarify testing documentation about checking `stderr`. PR [335](https://github.com/tiangolo/typer/pull/335) by [cgabard](https://github.com/cgabard).
* ✏ Fix typo in docs for CLI Option autocompletion. PR [288](https://github.com/tiangolo/typer/pull/288) by [graue70](https://github.com/graue70).
* 🎨 Fix header format for "Standard Input" in `docs/tutorial/printing.md`. PR [386](https://github.com/tiangolo/typer/pull/386) by [briancohan](https://github.com/briancohan).
* ✏ Fix typo in `docs/tutorial/terminating.md`. PR [382](https://github.com/tiangolo/typer/pull/382) by [kianmeng](https://github.com/kianmeng).
* ✏ Fix syntax typo in `docs/tutorial/package.md`. PR [333](https://github.com/tiangolo/typer/pull/333) by [ryanstreur](https://github.com/ryanstreur).
* ✏ Fix typo, duplicated word in `docs/tutorial/options/required.md`.. PR [316](https://github.com/tiangolo/typer/pull/316) by [michaelriri](https://github.com/michaelriri).
* ✏ Fix minor typo in `index.md`. PR [274](https://github.com/tiangolo/typer/pull/274) by [RmStorm](https://github.com/RmStorm).
* ✏ Fix double "and" typo in first-steps tutorial. PR [225](https://github.com/tiangolo/typer/pull/225) by [softwarebloat](https://github.com/softwarebloat).
* 🎨 Fix format in docs explaining `datetime` parameter type. PR [220](https://github.com/tiangolo/typer/pull/220) by [DiegoPiloni](https://github.com/DiegoPiloni).

Internal

* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [404](https://github.com/tiangolo/typer/pull/404) by [pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).
* 👷 Fix Material for MkDocs install in CI. PR [395](https://github.com/tiangolo/typer/pull/395) by [tiangolo](https://github.com/tiangolo).
* 👷 Add pre-commit CI config. PR [394](https://github.com/tiangolo/typer/pull/394) by [tiangolo](https://github.com/tiangolo).
* 👷 Clear MkDocs Insiders cache. PR [393](https://github.com/tiangolo/typer/pull/393) by [tiangolo](https://github.com/tiangolo).
* 🔧 Add pre-commit config and formatting. PR [392](https://github.com/tiangolo/typer/pull/392) by [tiangolo](https://github.com/tiangolo).
* 👷 Disable installing MkDocs Insiders in forks. PR [391](https://github.com/tiangolo/typer/pull/391) by [tiangolo](https://github.com/tiangolo).
* ⬆️ Upgrade Codecov GitHub Action. PR [383](https://github.com/tiangolo/typer/pull/383) by [tiangolo](https://github.com/tiangolo).