argparse-utils

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


License
MIT
Install
pip install argparse-utils==1.2.0

Documentation

argparse_utils

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.

Example

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()

    print(repr(arguments.colour))
$ argparse_utils_example.py red
<Colours.red: 1>

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

Reference

  • datetime_action(fmt='%Y-%m-%dT%H:%M:%S')

    Maps command-line arguments in the given format to datetime objects. Only accepts valid date-times in that format.

    eg. An action of datetime_action() would map a command-line argument of 2000-01-01T00:00:00 to the Python object datetime.datetime(2000, 1, 1, 0, 0).

  • date_action(fmt='%Y-%m-%d')

    Maps command-line arguments in the given format to date objects. Only accepts valid dates in that format.

    eg. An action of date_action() would map a command-line argument of 2000-01-01 to the Python object datetime.date(2000, 1, 1).

  • time_action(fmt='%H:%M:%S')

    Maps command-line arguments in the given format to time objects. Only accepts valid times in that format.

    eg. An action of time_action() would map a command-line argument of 00:00:00 to the Python object datetime.time(0, 0).

  • timedelta_action(fmt='%H:%M:%S')

    Maps command-line arguments in the given format to timedelta objects. Only accepts valid time-deltas in that format.

    Note: As this uses a timedelta object, this may behave in unexpected ways when attempting to use months or years.

    eg. An action of timedelta_action() would map a command-line argument of 01:00:00 to the Python object datetime.timedelta(0, 3600)).

  • json_action(**kwargs)

    Maps command-line arguments to JSON objects. Only accepts valid JSON. Passes kwargs on to json.loads.

    eg. An action of json_action() would map a command-line argument of {"a": 1, "b": 2} to the Python object {"a": 1, "b": 2}.

  • 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

    mapping_action({
        '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

    enum_action(Colour)

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

  • python_literal_action()

    Maps command-line arguments to Python literals. Only accepts valid Python literal objects.

    Similar to json_action, but also allows tuples, and complex numbers.

    eg. An action of python_literal_action() would map a command-line argument of (1, 2) to the Python object (1, 2).

Installation

Install and update using the standard Python package manager pip:

pip install argparse-utils