How to use argparse

The argparse module makes it really easy to read, parse and use the input arguments passed to a Python program.

Usage

Usage is in 3 simple steps:

• Create an object of ArgumentParser

• Add the arguments you want to parse one by one using add_argument

• Parse the inputs and extract the arguments using parse_args. The arguments are returned in an object with the values available using the object members.

Example

Here is a simple program that illustrates usage of argparse with different types of input arguments:

import argparse
import sys

def print_args(args):
    print args

    print "Radius:   ", args.rad
    print "Distance: ", args.d
    print "Name:     ", args.name
    print "Recompute:", args.recompute
    print "In files: ", args.in_files

def main():

    # Create parser
    arg_parser = argparse.ArgumentParser(
        description="This program achieves nothing!",
        formatter_class=argparse.ArgumentDefaultsHelpFormatter)

    # Add arguments you want to handle
    modes = ["release", "debug"]
    arg_parser.add_argument("--radius", type=float, default=1.2, required=True, help="Radius of the component")
    arg_parser.add_argument("-d", type=int, default=9, help="Distance to the component")
    arg_parser.add_argument("--name", type=str, help="Name of component")
    arg_parser.add_argument("--mode", type=str, choices=modes, help="Mode to use. Should be either release or debug")
    arg_parser.add_argument("--recompute", action="store_true", default=False, help="Indicate if recomputation is needed")
    arg_parser.add_argument("--in_files", type=str, nargs="+", help="One or more input file paths")

    if len(sys.argv) == 1:
        arg_parser.print_help()
        sys.exit(1)

    # Parse sys.argv using parser
    args = arg_parser.parse_args()

    # Pass arguments around
    foo(args)

if __name__ == "__main__":
    main()

ArgumentParser

This call has many useful options, the only one I actually use is:

• description: Specify what you want to be displayed about this program when it is invoked using --help.

add_argument

This call has many useful options. Many of them are needed in most scripts:

• The first input is the option name. If the option is named without a single or double dash, as say radius, then it becomes a positional argument. So, you cannot invoke its option name, but can directly pass its value. For example: ./main.py 3.14

• An option can be specified with a single -r or double dash --radius. You can access the value of this option later in the argument object using r or radius member respectively.

• An option can be specified with both single and double dashes, just separate both the quoted strings by a comma. Note that you can only access the value later using the name provided to the double dash option radius.

• Input argument to a named option can be separated by a space --radius 13 or using the equals symbol --radius=13.

• action parameter: There are many strings that can be passed to this parameter indicating what to do when the option is invoked. The most typical usage is to set a True or False value for a boolean using store_true or store_false respectively.

• default parameter: Specify the default value to be set if you do not provide a value for this option at the shell.

• type parameter: Specify what type the input value should be interpreted as. If you do not specify this, then it will be stored as a string. An error will be thrown if the input you provide cannot be converted to this type.

• required parameter: Set this to True if providing a value to this parameter is mandatory. An error is thrown at runtime if the value is not provided by user.

• help parameter: Set the string to shown as documentation when the program is invoked with --help.

• dest parameter: Specify the member name to be used to store the value passed to this option. By default it has the same name as the option name. If the option name had dashes, they are converted to underscores to create a valid member name.

• When the program is invoked with -h or --help, it will list the input options available and the documentation you have provided for each option.

Tried with: Python 3.10 and Ubuntu 22.04