typer/tests
John Purviance 3e37e01979
Add support for custom types and parsers (updates/builds upon PR #443) (#583)
* Support custom parameter types

While most CLI parameters are strings, ints, etc, we sometimes need custom
types.

Currently typer has no support for it (See #77), and while there are a few hacks, the
likely solution is to add a 'str' argument and parse it inside the main function.

This PR adds support for custom types in 3 different ways:
- Manually specifying a `click_type`
- Manually specifying a `parse` function
- Using a Callable type annotation (It is very common for types to have a string constructor, like `int("1")`)

* Document how to parse custom objects with Typer.

Typer supports parsing of cutom types with:
- A user provided parser class
- A click custom type parser

* 🎨 [pre-commit.ci] Auto format from pre-commit.com hooks

* 📝 Tweak and simplify docs

*  Tweak tests to run scripts and remove pragma: nocover in examples

* 📝 Tweak examples for docs, add types and remove # pragma: nocover

* ♻️ Tweak implementation checking for parser and Click type

---------

Co-authored-by: Paulo Costa <me@paulo.costa.nom.br>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2023-05-01 03:03:26 -07:00
..
assets Refactor and document handling pretty exceptions (#422) 2022-07-12 21:06:51 +02:00
test_compat 👷‍♂️ Consistently use sys.executable to run subprocesses, needed by OpenSUSE (#408) 2022-11-07 19:01:54 +01:00
test_completion 👷‍♂️ Consistently use sys.executable to run subprocesses, needed by OpenSUSE (#408) 2022-11-07 19:01:54 +01:00
test_tutorial Add support for custom types and parsers (updates/builds upon PR #443) (#583) 2023-05-01 03:03:26 -07:00
__init__.py Add first test, scaffold testing 2019-12-24 15:35:53 +01:00
test_exit_errors.py Richify, add integrations with Rich everywhere (#419) 2022-07-12 16:45:43 +00:00
test_others.py Add support for custom types and parsers (updates/builds upon PR #443) (#583) 2023-05-01 03:03:26 -07:00
test_prog_name.py 👷‍♂️ Consistently use sys.executable to run subprocesses, needed by OpenSUSE (#408) 2022-11-07 19:01:54 +01:00
test_rich_utils.py Richify, add integrations with Rich everywhere (#419) 2022-07-12 16:45:43 +00:00
test_tracebacks.py 👷‍♂️ Consistently use sys.executable to run subprocesses, needed by OpenSUSE (#408) 2022-11-07 19:01:54 +01:00
test_type_conversion.py Add support for custom types and parsers (updates/builds upon PR #443) (#583) 2023-05-01 03:03:26 -07:00