google/python-fire
Python Fire
Python Fire is a library that automatically generates command line interfaces from any Python object, function, or class. It removes the need for manual argument parsing by mapping Python dictionaries, lists, and classes directly to terminal commands.
The tool converts Python docstrings into formatted terminal help screens and produces shell scripts to enable tab-completion for available commands. It can wrap existing libraries or external modules to expose their functionality via the terminal without requiring modifications to the original source code.
The library supports hierarchical command grouping and recursive object traversal to create structured, multi-level navigation trees. It includes the ability to parse complex data types from strings into Python literals and provides an integration to launch an interactive session immediately after executing a command.
Features
- Object-to-CLI Mappers - A tool that maps Python dictionaries, lists, and classes directly to terminal commands for rapid prototyping and debugging.
- Automatic CLI Generators - A library that automatically creates command line interfaces from any Python object, function, or class without manual argument parsing.
- Function-to-CLI Converters - Turn functions, modules, or classes into a fully functional command line interface using Fire without writing manual argument parsing.
- Source-to-CLI Generators - Generate a command line interface in Fire by mapping terminal arguments to functions, classes, dictionaries, lists, or object members.
- CLI Synthesis - Uses Python runtime introspection to map object members and functions directly to command line arguments.
- CLI Type Converters - Convert command line strings into Python literals such as integers, floats, booleans, lists, tuples, and dictionaries in Fire.
- Command Line Literal Parsing - Converting terminal input strings into complex Python data types like lists and dictionaries for use in functions.
- Nested Command Structures - Nest commands in Fire using classes or objects with member objects to create a structured, multi-level command hierarchy.
- External Module Wrappers - Wrapping existing Python libraries or modules in a terminal interface to test functionality without modifying the source code.
- Help Generators - Extracts function and class documentation strings to automatically build the user-facing command help interface.
- Command Line Argument Casting - Converts string-based command line input into Python literals by analyzing the target object's expected types.
- Object Hierarchy Navigation - Navigates nested classes and dictionaries to resolve hierarchical command paths during the execution phase.
- Coroutine Integration - Execute coroutine functions through the Fire CLI and block until the asynchronous operation completes.
- Interactive REPLs - Start a Python REPL session from the Fire command line to interact with objects directly after execution.
- Command Line Handoffs - Launching a REPL session directly from the command line to inspect objects and variables after executing a specific command.
- Stateful Handoffs - Transfers the current execution context and variable state into an interactive shell session after command completion.
- Module Wrapping Interfaces - Wrap existing libraries or external modules in a Fire CLI to execute their functionality without modifying the source code.
- Shell Completion Generators - Produce shell completion scripts in Fire to enable tab-completion for available commands and arguments in the terminal.
- Asynchronous Function Execution - Detects asynchronous functions at runtime and manages the event loop to block until the operation finishes.
- CLI Component Exposure - Limit CLI access to specific functions or classes in Fire to control which parts of a program are exposed.
- CLI Development - Automatically generates CLIs from any Python object.
- Python CLI Frameworks - Library for automatically generating CLIs from Python objects.
