argparse

Warnings

• gotcha The `argparse` module is part of the Python standard library for versions 2.7 and 3.2 and later. The PyPI package `argparse` (version 1.4.0) is a backport primarily intended for older Python versions (e.g., Python < 2.7 or < 3.2) or specific older Python 3.x releases. For most modern Python users, `pip install argparse` is unnecessary and potentially problematic as you already have a built-in, possibly newer, version.
  Fix: Do not `pip install argparse` on modern Python versions; simply `import argparse`. If targeting older Python versions, explicitly install the PyPI backport.
• gotcha By default, `argparse` treats all command-line inputs as strings. If you expect integer, float, or other types, you must explicitly specify the `type` argument in `add_argument()`. Failure to do so will result in string values, requiring manual conversion and validation in your code.
  Fix: Use `parser.add_argument('arg_name', type=int, help='...')` or `type=float` for automatic type conversion and basic validation.
• gotcha When `argparse` encounters invalid arguments or requests for help, its default behavior is to print messages to `sys.stderr` and then exit the program using `sys.exit()`. This can be undesirable in applications where you want to handle errors programmatically or integrate argument parsing into a larger system without exiting.
  Fix: To customize this behavior, you can subclass `ArgumentParser` and override the `exit()` or `_print_message()` methods. Alternatively, for simple cases, `parser.parse_args(args=['--help'])` will still exit, but `parser.parse_known_args()` can be used to process only recognized arguments and return the rest.
• deprecated The `nargs=REMAINDER` action was removed from the official documentation due to its fragility and potential for unexpected behavior when interspersed with other options. While still functional, it's not recommended for new code.
  Fix: Instead of `nargs=REMAINDER`, consider using `parser.parse_known_args()` to separate known arguments from unrecognized ones, and then process the 'unknown' arguments manually if needed.
• breaking The `optparse` module, a predecessor to `argparse`, was officially deprecated in Python 2.7+ and 3.2+ in favor of `argparse`. While `optparse` is still available, `argparse` offers more features and a different API, meaning direct replacements might require code changes.
  Fix: New projects should use `argparse`. For existing `optparse` code, review the 'Upgrading Optparse Code' section in the `argparse` documentation for migration guidance, as direct compatibility is not always maintained.
• gotcha If an argument value itself starts with a hyphen (e.g., a negative number or a filename like `-output.txt`), `argparse` might misinterpret it as an optional argument or flag, leading to 'unrecognized argument' errors.
  Fix: Users can typically resolve this by preceding such values with a special `--` argument, which tells `argparse` to stop processing options and treat everything that follows as positional arguments. For specific arguments, you can also adjust `parser.prefix_chars` if appropriate, or use `nargs` and a custom type if dealing with very specific formats.

Install

• pip install argparse For Python versions < 2.7 or < 3.2, or specific older 3.x releases (PyPI backport).
• # argparse is included in the Python standard library since 2.7 and 3.2. # No installation is typically required for modern Python versions. For modern Python (standard library)

Imports

• argparse

  import argparse

Quickstart

This quickstart defines a basic command-line tool that takes a required 'name' argument and an optional '--verbose' flag. It demonstrates creating an `ArgumentParser`, adding arguments, and parsing them.

import argparse

def main():
    parser = argparse.ArgumentParser(
        description='A simple command-line tool.'
    )
    parser.add_argument(
        'name', 
        type=str, 
        help='The name to greet.'
    )
    parser.add_argument(
        '-v', '--verbose', 
        action='store_true', 
        help='Enable verbose output.'
    )

    args = parser.parse_args()

    if args.verbose:
        print(f"Verbose mode enabled. Greeting {args.name}...")
    print(f"Hello, {args.name}!")

if __name__ == '__main__':
    main()