click-pathlib 2020.3.13.0

'A Python click type which is similar to click.Path but returns a pathlib Path'

Click Pathlib

A Python click type which is similar to click.Path but returns a Pathlib.Path.

Contents

• Click Pathlib

  • Installation

    • Usage

  • Credits

  • Contributing

Installation

$ pip install click-pathlib

This supports Python 3.8+.

Usage

Use the click_pathlib.Path just like a click.Path type and your function will receive a pathlib.Path.

import click
import click_pathlib

@click.command('delete')
@click.argument(
    'existing_file',
    type=click_pathlib.Path(exists=True),
)
def delete(existing_file):
    existing_file.unlink()

Credits

Thanks to @jeremyh for describing this solution on GitHub at https://github.com/pallets/click/issues/405#issuecomment-470812067.

Contributing

See CONTRIBUTING.rst.