fastapi/typer

Features

• CLI Frameworks - Provides a library for building command-line interfaces by converting standard functions into executable programs using type hints.
• Command Line Interfaces - Converts standard Python functions into executable command-line programs by inferring arguments and help documentation from type hints.
• CLI Command Frameworks - Provides a decorator-driven system to register functions as hierarchical subcommands within a command-line interface.
• Help Text Generators - Automatically generates and displays help documentation for commands and subcommands based on function signatures.
• Command-Line Interface Development - Converts standard functions into robust terminal applications with automatic argument parsing and help documentation.
• CLI Command Registrars - Registers functions as executable commands or subcommands to automatically generate help and handle execution.
• Function-to-CLI Converters - Transforms standard functions into executable command-line applications that run directly from the terminal.
• Nested Command Structures - Organizes related functions into a single command-line application with nested subcommands and automatic help generation.
• Argument Parsers - Maps function parameters to command-line arguments and options, supporting complex types and environment variables.
• Command Argument Parsers - Enables the definition of positional parameters for commands to accept required inputs directly from the terminal.
• CLI Argument Definitions - Configures command-line arguments with default values to ensure applications function correctly when inputs are omitted.
• Command Hierarchies - Structures application logic into complex, nested command trees with multiple levels of subcommands.
• Command-Line Argument Parsers - Configures positional inputs to allow users to pass required or optional data to the program.
• Command Line Configuration - Configures optional parameters with default values, help text, and validation rules for command-line interfaces.
• Multi-Value Option Parsers - Collect multiple occurrences of a command-line option into a list and convert each value to the required data type.
• Help Generators - Automatically generates and displays formatted help documentation for commands and subcommands based on function signatures.
• Shell Completion - Installs shell-specific scripts to enable interactive command suggestions and parameter discovery.
• Shell Completion Generators - Generates shell-specific completion scripts to enable tab-based discovery of commands and options in the terminal.
• Program Entry Points - Registers functions as executable command-line programs for direct terminal invocation.
• CLI Input Collectors - Gather several values for a single command-line argument by allowing users to repeat flags or provide lists of inputs.
• CLI Development - CLI framework based on type hints.
• Web and API Tools - Library for building CLI applications.
• CLI Type Converters - Parses and validates command-line arguments into native types based on function hints.
• Type-Safe Request Validators - Automatically validates that command-line arguments match expected data types like UUIDs or integers.
• Command Line Documentation - Generates automated help documentation for programs and individual commands by parsing docstrings and configuration parameters.
• Modular Command Structures - Supports grouping related command-line operations into separate files and modules for improved project scalability.
• CLI Option Mappers - Maps function parameters to optional command-line flags or key-value pairs.
• Named Option Definitions - Accepts values or flags passed to a command-line application using single or double dash prefixes.
• Custom Completion Providers - Allows developers to define custom functions that provide dynamic tab-completion suggestions for command-line arguments.
• Execution Context Management - Manages and injects runtime state and configuration into commands to facilitate shared data across subcommands.
• Positional Argument Handlers - Accepts required or optional values passed directly as positional parameters to a command-line application.
• Progress Indicators - Renders visual progress bars or spinners in the terminal to provide feedback during long-running operations.
• CLI Entrypoints - Configures the primary application interface and global parameters using a function that executes before any subcommands.
• Dependency Injection - Injects runtime state and configuration objects into command functions to manage execution flow.
• Type-Hint-Based Schema Definitions - Uses Python type annotations to automatically infer and generate command-line argument parsers and validation logic.
• Sensitive Input Prompts - Collects sensitive user input interactively via the terminal while masking characters on screen.
• Custom Type Converters - Supports custom parsing functions to convert raw command-line input strings into complex objects or specific data types.
• Programmatic Command Invokers - Allows manual execution of command functions and subcommands within application logic, handling argument forwarding and defaults automatically.
• Command Callbacks - Executes setup logic or shared behavior automatically whenever a command or subcommand group is invoked.
• Modular Subcommand Integrators - Integrates separate command groups into a single application structure to maintain clean code separation.
• Environment Variable Configuration - Reads command-line argument values from environment variables when no explicit input is provided.
• Variable Argument Collectors - Allows users to pass a variable number of items for a single command argument.
• Command-Line Autocompletion - Generates shell scripts to provide command suggestions and improve developer efficiency.
• Mandatory Parameter Enforcement - Enforces mandatory command-line options by omitting default values, ensuring required inputs are provided.
• Boolean Flag Generators - Creates boolean command-line options that automatically generate both positive and negative flag variants.
• Interactive Prompts - Requests information from users during command execution by displaying prompts and capturing responses.
• Context-Aware Autocompletion Providers - Injects current execution state into autocompletion functions to provide dynamic, context-aware suggestions.
• Shell Completion Integrations - Generates and installs shell completion scripts to assist users with command and argument discovery.
• Validation Logic - Executes custom validation logic on input values during parsing to enforce constraints before application execution.
• Metadata Reflection Frameworks - Analyzes function signatures and docstrings at runtime to dynamically construct help documentation and parameter configurations.
• Input Validation Rules - Applies declarative validation rules to command-line arguments and options to ensure data integrity.
• Input Validation Utilities - Ensures data integrity in terminal tools by automatically parsing, validating, and converting user inputs into native programming types.
• Choice Fields - Validates command-line inputs against a predefined set of allowed choices, rejecting invalid values automatically.
• Confirmation Validators - Ensures input accuracy by requiring users to enter sensitive values twice to confirm they match.
• Numeric Comparison Validators - Enforces numeric constraints such as minimum and maximum ranges on command-line arguments.
• CLI File Input Handlers - Enables command-line arguments to be automatically parsed and opened as accessible file objects.
• Autocompletion Contexts - Provides access to the current execution state during shell autocompletion to enable dynamic, context-aware command suggestions.
• Empty Input Help Displays - Configures the command-line interface to automatically show usage instructions when the program is executed without any arguments.
• CLI Option Name Customizers - Allows customization of command-line flags by specifying explicit long or short names.
• Execution Context Injectors - Injects runtime metadata into functions to handle conditional logic and shell completion scenarios.
• Exit Status Signaling - Signals task success or failure to the calling environment using standard system exit codes.
• Modular Architecture - Organizes large-scale command-line applications into hierarchical subcommands and separate modules for better maintainability.
• Path Validation Services - Validates file system paths provided as arguments and converts them into standard path objects.
• CLI Scripts - Enables running scripts as command-line applications with automatic tab completion without formal installation.
• Command Suggestion Tools - Detects mistyped commands and suggests the closest valid matches to assist users with input errors.
• Shared Instance States - Provides dependency injection mechanisms to share state and configuration objects across command hierarchies.
• Terminal Output Formatters - Structures and formats multi-line terminal content to improve readability through spacing and layout adjustments.
• User Confirmation Dialogs - Provides interactive prompts to request user confirmation before proceeding with sensitive or destructive operations.

Star history