Skip to main content

argparse - Command-Line Argument Parser

The argparse module makes it easy to write user-friendly command-line interfaces. It parses arguments defined in sys.argv, generates help and usage messages, and issues errors when users give invalid arguments.

🔍 Key Components

🚀 Basic Usage

import argparse

# Create parser
parser = argparse.ArgumentParser(description='Process some files.')

# Add arguments
parser.add_argument('filename', help='Input filename')
parser.add_argument('--verbose', '-v', action='store_true',
help='Enable verbose output')
parser.add_argument('--count', type=int, default=1,
help='Number of times to process')

# Parse arguments
args = parser.parse_args()

# Use arguments
if args.verbose:
print(f"Processing {args.filename} {args.count} times")

📊 Argument Types

TypePurposeExample
PositionalRequired argumentsfilename
OptionalFlag arguments--verbose, -v
StoreStore values--output file.txt
Store True/FalseBoolean flags--verbose
CountCount occurrences-vvv
AppendList values--file a.txt --file b.txt