Skip to main content

A collection of utilities for the Python standard-library argparse module

Project description


argparse_utils provides a collection of utilities for the Python standard-library argparse module. These utilities assist with parsing command-line arguments to Python objects.


Consider a simple command-line script which accepts a colour as it's only argument, and immediately prints the Python representation of that object.

from argparse import ArgumentParser
from enum import Enum

from argparse_utils import enum_action

class Colours(Enum):
    red = 1
    green = 2
    blue = 3

if __name__ == "__main__":
    parser = ArgumentParser()
    parser.add_argument('colour', action=enum_action(Colours))

    arguments = parser.parse_args()

$ red
< 1>

Without the enum_action action, arguments.colour would be the string 'red', rather than the enum value What's more, the action ensures that only the values given in the enum are allowed, instead of any string value.


  • mapping_action(possible_values)

    Takes a dictionary whose keys are the allowed values, and maps those values to the values found in the dictionary. Only the values found as keys in the dictionary are allowed as command-line arguments.

    eg. An action of

        'red': (255, 0, 0),
        'green': (0, 255, 0),
        'blue': (0, 0, 255)

    would map a command-line argument of red to the Python object (255, 0, 0).

  • enum_action(enum_class)

    Takes an Enum class, and maps the string representation of the keys to the appropriate enum value. Only the values found in the enum are allowed as command-line arguments.

    eg. Using the Colour enum, from the first example, an action of


    would map a command-line argument of red to the enum value.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for argparse-utils, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size argparse_utils-1.1.0-py3-none-any.whl (2.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size argparse_utils-1.1.0.tar.gz (2.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page