[FEATURE] Handling Path / File arguments easily

[senpos]

click has an opportunity to handle Path and File arguments with ease.
Is there an option to do the same in typer?

I am not gonna lie, that was so fun to just put this into the click.argument parameters and let the library do all the magic and checking for me:

@click.command()
@click.argument(
    "filename",
    type=click.Path(exists=True, dir_okay=False, resolve_path=True, readable=True),
)
def path_command(filename):
    ...

The only inconvenience I had - it did not return a pathlib.Path object, so I had do manually create it, but that is not a big deal.

As I can see, click.Path type is not exposed in the typer module. And using pathlib.Path as a type for my parameter is not helping in any way.

Thanks for your time! I would like to know what you think about it.

[senpos]

Just wanted to point out, that importing click excplicitly and passing click.Path(...) as a type for my argument did not work, as it rise RuntimeError: Type not yet supported: <click.types.Path object at 0x00000000022EB848>

[senpos]

Hmm, that is interesting.
There is a built-in model, which allows to use most (if not all) click-specific attributes.
I am not sure how to use it though.

upd.

Ah, I see, it works similarly to route parameters it FastAPI!

@app.command()
def path_command(path: Path = typer.Argument(".", exists=True, dir_okay=False)):
    ...

That's cool!

[bandaangosta]

Hmm, that is interesting.
There is a built-in model, which allows to use most (if not all) click-specific attributes.
I am not sure how to use it though.

upd.

Ah, I see, it works similarly to route parameters it FastAPI!

@app.command()
def path_command(path: Path = typer.Argument(".", exists=True, dir_okay=False)):
    ...

That's cool!

Same principle applies, for example, to include additional attributes to options (still pending in documentation). In this case, an option help string:

@app.command()
def hello(name: str = typer.Option(help='First name of a person', default='Lucas', show_default=True)):
    typer.echo(f"Hello {name}")

$ python main.py hello --help
Usage: main.py hello [OPTIONS]

Options:
  --name TEXT  First name of a person  [default: Lucas]
  --help       Show this message and exit.

[tiangolo]

Thanks @senpos for updating the issue! Yep, you found it. Also thanks @bandaangosta !

Yep, there's a bunch of docs to add 😅

For paths and files at least there are docs now 🎉 📝 https://typer.tiangolo.com/tutorial/parameter-types/path/