✨ Support common pydantic types #723

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

lachaib wants to merge 37 commits into fastapi:master from lachaib:lachaib/issue181

README.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -57,7 +57,7 @@ Create and activate a <a href="https://typer.tiangolo.com/virtual-environments/"
  
    ```console

    $ pip install typer

    ---> 100%

    Successfully installed typer rich shellingham

    Successfully installed typer rich shellingham pydantic

    ```

    </div>

    @@ -361,6 +361,7 @@ For a more complete example including more features, see the <a href="https://ty
  
    By default it also comes with extra standard dependencies:

    * <a href="https://rich.readthedocs.io/en/stable/index.html" class="external-link" target="_blank"><code>rich</code></a>: to show nicely formatted errors automatically.

    * <a href="https://docs.pydantic.dev/latest/" class="external-link" target="_blank"><code>pydantic</code></a>: to support the usage of Pydantic types.

    * <a href="https://github.com/sarugaku/shellingham" class="external-link" target="_blank"><code>shellingham</code></a>: to automatically detect the current shell when installing completion.

        * With `shellingham` you can just use `--install-completion`.

        * Without `shellingham`, you have to pass the name of the shell to install completion for, e.g. `--install-completion bash`.

    @@ -381,7 +382,7 @@ pip install typer
  
    pip install "typer-slim[standard]"

    ```

    The `standard` extra dependencies are `rich` and `shellingham`.

    The `standard` extra dependencies are `rich`, `shellingham` and `pydantic`.

    **Note**: The `typer` command is only included in the `typer` package.

docs/index.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -63,7 +63,7 @@ Create and activate a <a href="https://typer.tiangolo.com/virtual-environments/"
  
    ```console

    $ pip install typer

    ---> 100%

    Successfully installed typer rich shellingham

    Successfully installed typer rich shellingham pydantic

    ```

    </div>

    @@ -367,6 +367,7 @@ For a more complete example including more features, see the <a href="https://ty
  
    By default it also comes with extra standard dependencies:

    * <a href="https://rich.readthedocs.io/en/stable/index.html" class="external-link" target="_blank"><code>rich</code></a>: to show nicely formatted errors automatically.

    * <a href="https://docs.pydantic.dev/latest/" class="external-link" target="_blank"><code>pydantic</code></a>: to support the usage of Pydantic types.

    * <a href="https://github.com/sarugaku/shellingham" class="external-link" target="_blank"><code>shellingham</code></a>: to automatically detect the current shell when installing completion.

        * With `shellingham` you can just use `--install-completion`.

        * Without `shellingham`, you have to pass the name of the shell to install completion for, e.g. `--install-completion bash`.

    @@ -387,7 +388,7 @@ pip install typer
  
    pip install "typer-slim[standard]"

    ```

    The `standard` extra dependencies are `rich` and `shellingham`.

    The `standard` extra dependencies are `rich`, `shellingham` and `pydantic`.

    **Note**: The `typer` command is only included in the `typer` package.

docs/tutorial/parameter-types/pydantic-types.md

-Original file line number
+Diff line change
@@ -0,0 +1,37 @@
+    Pydantic types such as [AnyUrl](https://docs.pydantic.dev/latest/api/networks/#pydantic.networks.AnyUrl) or [EmailStr](https://docs.pydantic.dev/latest/api/networks/#pydantic.networks.EmailStr) can be very convenient to describe and validate some parameters.
+    Pydantic is installed automatically when installing Typer with its extra standard dependencies:
+    <div class="termy">
+    ```console
+    // Pydantic comes with typer
+    $ pip install typer
+    ---> 100%
+    Successfully installed typer rich shellingham pydantic
+    // Alternatively, you can install Pydantic independently
+    $ pip install pydantic
+    ---> 100%
+    Successfully installed pydantic
+    // Or if you want to use EmailStr
+    $ pip install "pydantic[email]"
+    ---> 100%
+    Successfully installed pydantic, email-validator
+    ```
+    </div>
+    You can then use them as parameter types.
+    {* docs_src/parameter_types/pydantic_types/tutorial001_an_py39.py hl[9] *}
+    {* docs_src/parameter_types/pydantic_types/tutorial002_an_py39.py hl[9] *}
+    These types are also supported in lists or tuples:
+    {* docs_src/parameter_types/pydantic_types/tutorial003_an_py39.py hl[9] *}
+    {* docs_src/parameter_types/pydantic_types/tutorial004_an_py39.py hl[9] *}

docs_src/parameter_types/pydantic_types/__init__.py

Empty file.

docs_src/parameter_types/pydantic_types/tutorial001_an_py39.py

-Original file line number
+Diff line change
@@ -0,0 +1,15 @@
+    from typing import Annotated
+    import typer
+    from pydantic import AnyHttpUrl
+    app = typer.Typer()
+    @app.command()
+    def main(url_arg: Annotated[AnyHttpUrl, typer.Argument()]):
+        typer.echo(f"url_arg: {url_arg}")
+    if __name__ == "__main__":
+        app()

docs_src/parameter_types/pydantic_types/tutorial001_py39.py

-Original file line number
+Diff line change
@@ -0,0 +1,13 @@
+    import typer
+    from pydantic import AnyHttpUrl
+    app = typer.Typer()
+    @app.command()
+    def main(url_arg: AnyHttpUrl):
+        typer.echo(f"url_arg: {url_arg}")
+    if __name__ == "__main__":
+        app()

docs_src/parameter_types/pydantic_types/tutorial002_an_py39.py

-Original file line number
+Diff line change
@@ -0,0 +1,15 @@
+    from typing import Annotated
+    import typer
+    from pydantic import AnyHttpUrl
+    app = typer.Typer()
+    @app.command()
+    def main(url_opt: Annotated[AnyHttpUrl, typer.Option()] = "https://typer.tiangolo.com"):
+        typer.echo(f"url_opt: {url_opt}")
+    if __name__ == "__main__":
+        app()

docs_src/parameter_types/pydantic_types/tutorial002_py39.py

-Original file line number
+Diff line change
@@ -0,0 +1,13 @@
+    import typer
+    from pydantic import AnyHttpUrl
+    app = typer.Typer()
+    @app.command()
+    def main(url_opt: AnyHttpUrl = typer.Option("https://typer.tiangolo.com")):
+        typer.echo(f"url_opt: {url_opt}")
+    if __name__ == "__main__":
+        app()

docs_src/parameter_types/pydantic_types/tutorial003_an_py39.py

-Original file line number
+Diff line change
@@ -0,0 +1,17 @@
+    from typing import Annotated
+    import typer
+    from pydantic import AnyHttpUrl
+    app = typer.Typer()
+    @app.command()
+    def main(
+        urls: Annotated[list[AnyHttpUrl], typer.Option("--url", default_factory=list)],
+    ):
+        typer.echo(f"urls: {urls}")
+    if __name__ == "__main__":
+        app()

docs_src/parameter_types/pydantic_types/tutorial003_py39.py

-Original file line number
+Diff line change
@@ -0,0 +1,13 @@
+    import typer
+    from pydantic import AnyHttpUrl
+    app = typer.Typer()
+    @app.command()
+    def main(urls: list[AnyHttpUrl] = typer.Option([], "--url")):
+        typer.echo(f"urls: {urls}")
+    if __name__ == "__main__":
+        app()

docs_src/parameter_types/pydantic_types/tutorial004_an_py39.py

-Original file line number
+Diff line change
@@ -0,0 +1,23 @@
+    from typing import Annotated
+    import typer
+    from pydantic import AnyHttpUrl, IPvAnyAddress
+    app = typer.Typer()
+    @app.command()
+    def main(
+        server: Annotated[
+            tuple[str, IPvAnyAddress, AnyHttpUrl],
+            typer.Option(help="User name, age, email and social media URL"),
+        ],
+    ):
+        name, address, url = server
+        typer.echo(f"name: {name}")
+        typer.echo(f"address: {address}")
+        typer.echo(f"url: {url}")
+    if __name__ == "__main__":
+        app()

docs_src/parameter_types/pydantic_types/tutorial004_py39.py

-Original file line number
+Diff line change
@@ -0,0 +1,20 @@
+    import typer
+    from pydantic import AnyHttpUrl, IPvAnyAddress
+    app = typer.Typer()
+    @app.command()
+    def main(
+        server: tuple[str, IPvAnyAddress, AnyHttpUrl] = typer.Option(
+            ..., help="Server name, IP address and public URL"
+        ),
+    ):
+        name, address, url = server
+        typer.echo(f"name: {name}")
+        typer.echo(f"address: {address}")
+        typer.echo(f"url: {url}")
+    if __name__ == "__main__":
+        app()

mkdocs.yml

-Original file line number
+Diff line change
@@ Expand Up / @@ -116,6 +116,7 @@ nav: @@
               - tutorial/parameter-types/path.md
               - tutorial/parameter-types/file.md
               - tutorial/parameter-types/custom-types.md
+              - tutorial/parameter-types/pydantic-types.md
           - SubCommands - Command Groups:
               - tutorial/subcommands/index.md
               - tutorial/subcommands/add-typer.md
@@ Expand Down @@

pyproject.toml

-Original file line number
+Diff line change
@@ Expand Up / @@ -50,6 +50,7 @@ Changelog = "https://typer.tiangolo.com/release-notes/" @@
     standard = [
         "shellingham >=1.3.0",
         "rich >=10.11.0",
+        "pydantic >=2.0.0",
     ]
     [dependency-groups]
@@ Expand Down Expand Up / @@ -81,6 +82,7 @@ github-actions = [ @@
     tests = [
         "coverage[toml]>=6.2,<8.0",
         "mypy==1.19.1",
+        "pydantic >=2.0.0",
         "pytest>=4.4.0,<9.0.0",
         "pytest-cov>=2.10.0,<8.0.0",
         "pytest-sugar>=0.9.4,<1.2.0",
@@ Expand Down @@

tests/test_tutorial/test_parameter_types/test_pydantic_types/__init__.py

Empty file.

tests/test_tutorial/test_parameter_types/test_pydantic_types/test_tutorial001.py

-Original file line number
+Diff line change
@@ -0,0 +1,48 @@
+    import importlib
+    import subprocess
+    import sys
+    from types import ModuleType
+    import pytest
+    from typer.testing import CliRunner
+    runner = CliRunner()
+    @pytest.fixture(
+        name="mod",
+        params=[
+            pytest.param("tutorial001_py39"),
+            pytest.param("tutorial001_an_py39"),
+        ],
+    )
+    def get_mod(request: pytest.FixtureRequest) -> ModuleType:
+        module_name = f"docs_src.parameter_types.pydantic_types.{request.param}"
+        mod = importlib.import_module(module_name)
+        return mod
+    def test_help(mod: ModuleType):
+        result = runner.invoke(mod.app, ["--help"])
+        assert result.exit_code == 0
+    def test_url_arg(mod: ModuleType):
+        result = runner.invoke(mod.app, ["https://typer.tiangolo.com"])
+        assert result.exit_code == 0
+        assert "url_arg: https://typer.tiangolo.com" in result.output
+    def test_url_arg_invalid(mod: ModuleType):
+        result = runner.invoke(mod.app, ["invalid"])
+        assert result.exit_code != 0
+        assert "Input should be a valid URL" in result.output
+    def test_script(mod: ModuleType):
+        result = subprocess.run(
+            [sys.executable, "-m", "coverage", "run", mod.__file__, "--help"],
+            capture_output=True,
+            encoding="utf-8",
+        )
+        assert "Usage" in result.stdout

tests/test_tutorial/test_parameter_types/test_pydantic_types/test_tutorial002.py

-Original file line number
+Diff line change
@@ -0,0 +1,48 @@
+    import importlib
+    import subprocess
+    import sys
+    from types import ModuleType
+    import pytest
+    from typer.testing import CliRunner
+    runner = CliRunner()
+    @pytest.fixture(
+        name="mod",
+        params=[
+            pytest.param("tutorial002_py39"),
+            pytest.param("tutorial002_an_py39"),
+        ],
+    )
+    def get_mod(request: pytest.FixtureRequest) -> ModuleType:
+        module_name = f"docs_src.parameter_types.pydantic_types.{request.param}"
+        mod = importlib.import_module(module_name)
+        return mod
+    def test_help(mod: ModuleType):
+        result = runner.invoke(mod.app, ["--help"])
+        assert result.exit_code == 0
+    def test_url_opt(mod: ModuleType):
+        result = runner.invoke(mod.app, ["--url-opt", "https://typer.tiangolo.com"])
+        assert result.exit_code == 0
+        assert "url_opt: https://typer.tiangolo.com" in result.output
+    def test_url_opt_invalid(mod: ModuleType):
+        result = runner.invoke(mod.app, ["--url-opt", "invalid"])
+        assert result.exit_code != 0
+        assert "Input should be a valid URL" in result.output
+    def test_script(mod: ModuleType):
+        result = subprocess.run(
+            [sys.executable, "-m", "coverage", "run", mod.__file__, "--help"],
+            capture_output=True,
+            encoding="utf-8",
+        )
+        assert "Usage" in result.stdout

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

✨ Support common pydantic types #723

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!

✨ Support common pydantic types #723

Are you sure you want to change the base?

Uh oh!

✨ Support common pydantic types #723

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!