Skip to main content

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 field flag is converted to --no_flag

Configurability

  • with_opt_argparse allows to override some of the default settings used

Project details


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.6.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

with_argparse-0.0.6-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

Details for the file with_argparse-0.0.6.tar.gz.

File metadata

  • Download URL: with_argparse-0.0.6.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

Hashes for with_argparse-0.0.6.tar.gz
Algorithm Hash digest
SHA256 b6d29edb8a2fd8b1b874e19e3ec79aad4712f13a779857e6bde0bf201a848a7e
MD5 d0c567a30aa463737e25f313a6c83883
BLAKE2b-256 19def6d479bb1c6c635232030f5fb439f15cc049512064c2597961693ac906a6

See more details on using hashes here.

File details

Details for the file with_argparse-0.0.6-py3-none-any.whl.

File metadata

File hashes

Hashes for with_argparse-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 0dd1c39f3ab146d780a93af47a4764ce4c3efb89b7eb8f222379e12f92ad7482
MD5 036c187686d40a5f747337170b5bd0e8
BLAKE2b-256 e42d02d75ec9e82a2543375a5e343057b7949a213f34fc39492468568ef0dd0c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page