choices= limits accepted values, type= converts text, default= applies when an option is absent, and required=True can require an optional flag.
What It Does and Why It Matters
choices= limits accepted values, type= converts text, default= applies when an option is absent, and required=True can require an optional flag. Define validation requirements according to user experience, not merely available parser features.
Step-by-Step Example
Start with the complete example below. Read the inputs and predict what the final print statement will show before you run it.
import argparse
argument_parser = argparse.ArgumentParser()
argument_parser.add_argument('--action', choices=['list', 'archive'], required=True)
argument_parser.add_argument('--limit', type=int, default=5)
parsed_arguments = argument_parser.parse_args(['--action', 'list'])
print(parsed_arguments.action, parsed_arguments.limit)
How the Code Works
- The imports make these standard-library tools available: argparse.
- The name argument_parser receives the value of argparse.ArgumentParser(). Changing this input lets you explore a different case.
- The print calls display the results. Compare these results with the method’s documented return type and the input used.
- The parser configuration declares which options or positional arguments exist. parse_args() performs conversion and validation before the program reads attributes on the returned Namespace.
Expected output:
list 5
For the demonstrated inputs, Python displays 'list 5'. This result follows from the operation described above; change one input at a time to understand which rule matters.
What to Notice
Pay attention to the accepted input types, the returned value and the boundary behavior. Predict what changes if you replace the example input with an empty, zero, negative or missing value, where that value is meaningful for this operation.
If the task uses a library function, inspect its documented exceptions and return type before reusing it inside a larger function.
Where You Would Use This
This is useful for scripts, maintenance commands and automated workflows. Treat inputs as untrusted, keep normal results separate from errors, and choose exit codes consistently. Keep reusable logic outside the command-line parser so it can be tested independently.
Practice Exercise
Require an action from a predefined set and use an optional integer limit.
Before running your edited example, write down the result you expect. Then test at least one valid boundary or deliberately invalid value, using appropriate exception handling where necessary.
Reference: official Python documentation for the complete API contract and version notes.
Common Beginner Mistakes
- Setting default values outside allowed choices or assuming a custom type converter cannot fail.
- Overlooking the documented condition: define validation requirements according to user experience, not merely available parser features.
Key Takeaways
- choices= limits accepted values, type= converts text, default= applies when an option is absent, and required=True can require an optional flag.
- Require an action from a predefined set and use an optional integer limit.