Site Tools


import-argparse

import argparse

import argparse is a Python import that parses command-line arguments with automatic help generation. Use it to accept options and positional arguments in CLI scripts.

Example

# Python
# description: parse command-line arguments
 
import argparse
 
parser = argparse.ArgumentParser(description="Process files")
 
# Positional argument
parser.add_argument("input", help="Input file")
 
# Optional arguments
parser.add_argument("-o", "--output", default="out.txt", help="Output file")
parser.add_argument("-v", "--verbose", action="store_true", help="Verbose mode")
parser.add_argument("-n", "--count", type=int, default=1, help="Repeat count")
 
args = parser.parse_args()
 
print(f"Input: {args.input}")
print(f"Output: {args.output}")
print(f"Verbose: {args.verbose}")
print(f"Count: {args.count}")
 
# Usage: Python script.py input.txt -o output.txt -v -n 5

Common methods

  • ArgumentParser(description): create parser
  • add_argument(name, help, type, default, action): add argument
  • parse_args(): parse command-line arguments
  • type=int: convert to integer
  • action="store_true": boolean flag
  • default=value: default value if not provided
  • required=True: make argument required
  • choices=[...]: restrict to specific values
import-argparse.md · Last modified: by 127.0.0.1