A simple but handy Python library to generate a `argparse.ArgumentParser` object from a type-annotated method
Project description
with-argparse
with-argparse
is a very simple and tiny package adding support to create
and apply argparse.ArgumentParser
objects automatically using the type
annotations from a given python method:
from pathlib import Path
from with_argparse import with_argparse
@with_argparse
def sample_method(
text_input: str, # required argument
another_text_input: str = None, # default argument
output_dir: Path = None,
flag: bool = False,
):
pass
sample_method()
will generate the argparse output:
usage: scratch_2.py [-h] --text_input TEXT_INPUT
[--another_text_input ANOTHER_TEXT_INPUT]
[--output_dir OUTPUT_DIR] [--flag]
Boolean values
- A
True
boolean default fieldflag
is converted to--no_flag
Configurability
with_opt_argparse
allows to override some of the default settings used
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
with_argparse-0.0.4.tar.gz
(7.1 kB
view details)
Built Distribution
File details
Details for the file with_argparse-0.0.4.tar.gz
.
File metadata
- Download URL: with_argparse-0.0.4.tar.gz
- Upload date:
- Size: 7.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f420c14b9fc78d5071efd47014daec431d4b7f7819d46ba8f4268d7ec660275b |
|
MD5 | bbd286c784b105ca8a8b901c9ddf8f5b |
|
BLAKE2b-256 | 5998c5b87afdc55451e3ce4c18b0a0ab6f139a8e83e71b74b1a82ae0b302ae1b |
File details
Details for the file with_argparse-0.0.4-py3-none-any.whl
.
File metadata
- Download URL: with_argparse-0.0.4-py3-none-any.whl
- Upload date:
- Size: 7.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd7225cb7c802e8f8c1d48effb8d5ef36aa6eb6929b0d41d599535233df03293 |
|
MD5 | e3286531a2d0e5398d2309370f079f71 |
|
BLAKE2b-256 | b6ef9cee9eb2fe3db9b1a5d5ed98811d18874d0f71dfaa5b225d0789b0be76e1 |