All 15 Command-Line Interfaces (argparse) questions
More in Command-Line Interfaces (argparse)
How do you group related arguments visually in the generated --help output using argument groups? How do you implement mutually exclusive arguments, where the user must choose EXACTLY ONE of a set of flags? How do you write a custom 'type=' validation function for argparse that raises a properly-formatted error for invalid input? How would you build a CLI tool where some arguments can also be set via environment variables, falling back to a default if neither is provided? How would you write integration tests for an argparse-based CLI tool using pytest, verifying both successful parsing and expected error behavior? How do you build a plugin-style CLI where subcommands are dynamically discovered and registered from separate modules, rather than hardcoded?
Advertisement
Python › Command-Line Interfaces (argparse)

How do you customize argparse's automatically-generated usage and help text formatting, like preserving specific line breaks in the description?

Advanced

Answer

Pass a custom 'formatter_class' (like argparse.RawDescriptionHelpFormatter or RawTextHelpFormatter) to ArgumentParser() to disable argparse's default text-wrapping/reformatting behavior, letting you control exact formatting of multi-line descriptions or examples in the help output.
parser = argparse.ArgumentParser(
    description="""Deploy an application.

Examples:
  mytool deploy --env prod
  mytool deploy --env staging --dry-run""",
    formatter_class=argparse.RawDescriptionHelpFormatter
)
Real-world example Providing multi-line usage EXAMPLES in a CLI tool's --help output that preserve their intended formatting exactly.

Common follow-ups: What's the difference between RawDescriptionHelpFormatter and RawTextHelpFormatter?

Modules & Packaging
All 15 Command-Line Interfaces (argparse) questions