How pallets/click works
Click is a Python library for building composable command-line interfaces. The principal workflow starts when a CLI user invokes a command: Click constructs command/context state, parses arguments and options, converts parameter values, invokes the command callback, and presents output or errors. Groups and decorators support nested command composition; help formatting, shell completion, and terminal interaction are related capabilities. The graph reflects documented behavior and source-index references; unsampled implementations are represented at subsystem level, and unverified links are omitted.
Main entry points: core.py Commands and Context · utils.py CLI Utilities · exceptions.py CLI Errors · termui.py Terminal UI
Components 17
CLI Runtime
- Commands and Context
src/click/core.py - Command Decorators
src/click/decorators.py - Argument Parser
src/click/parser.py - Shell Completion
src/click/shell_completion.py
Parameters and Errors
- Parameter Types
src/click/types.py - CLI Errors
src/click/exceptions.py
Terminal Experience
- Terminal UI
src/click/termui.py - Terminal UI Internals
src/click/_termui_impl.py - Help Formatting
src/click/formatting.py - Text Wrapping
src/click/_textwrap.py
Runtime Support
- CLI Utilities
src/click/utils.py - Context Globals
src/click/globals.py - Stream Compatibility
src/click/_compat.py - Windows Console
src/click/_winconsole.py - Internal Utilities
src/click/_utils.py - CLI Testing Tools
src/click/testing.py
Other components
- CLI User
Connections 27
- CLI User → Commands and Context: invokes CLI
README.md - Commands and Context → Argument Parser: parses arguments
src/click/core.py - Commands and Context → Parameter Types: converts values
src/click/core.py - Commands and Context → Command Decorators: invokes callbacks
src/click/core.py - Command Decorators → Commands and Context: builds commands
src/click/decorators.py - Commands and Context → Shell Completion: dispatches completion
src/click/core.py - Commands and Context → Help Formatting: formats help
src/click/core.py - Commands and Context → Context Globals: manages context
src/click/core.py - Commands and Context → CLI Errors: raises errors
src/click/core.py - Argument Parser → CLI Errors: reports parse errors
src/click/parser.py - Parameter Types → CLI Errors: reports conversion errors
src/click/types.py - Terminal UI → Terminal UI Internals: delegates UI
src/click/termui.py - Terminal UI → CLI Utilities: uses utilities
src/click/termui.py - Terminal UI Internals → CLI Utilities: uses utilities
src/click/_termui_impl.py - Terminal UI → CLI Errors: raises UI errors
src/click/termui.py - Help Formatting → Text Wrapping: wraps text
src/click/formatting.py - Help Formatting → Argument Parser: formats options
src/click/formatting.py - CLI Utilities → Parameter Types: uses types
src/click/utils.py - CLI Utilities → Context Globals: reads context
src/click/utils.py - CLI Errors → CLI Utilities: emits errors
src/click/exceptions.py - CLI Errors → Context Globals: reads context
src/click/exceptions.py - Stream Compatibility → Windows Console: uses console support
src/click/_compat.py - Parameter Types → Stream Compatibility: uses compatibility
src/click/types.py - CLI Utilities → Stream Compatibility: uses compatibility
src/click/utils.py - CLI Testing Tools → Commands and Context: exercises commands
src/click/testing.py - CLI Testing Tools → Terminal UI: captures terminal UI
src/click/testing.py - Commands and Context → Internal Utilities: uses internals
src/click/core.py