gruns/icecream
Icecream
Icecream is a Python debugging utility designed for inspecting variable values and execution flow during development. It provides a variable inspector that automatically labels values and attaches file and line number metadata to each output.
The tool features a builtins injector that adds debugging functions to the global namespace, allowing for universal access across all project files without manual imports. It also includes an inline debugging tool that returns its arguments to the caller, enabling the insertion of inspection calls directly into active expressions without altering program logic.
The project covers a broader range of diagnostic capabilities, including execution flow tracing, customizable debug log formatting, and global output toggling to enable or disable messages without modifying source code.
Features
- Variable Inspection Tools - Provides a utility that automatically labels variables and values with file and line number metadata for immediate debugging context.
- Inline Expression Debugging - Enables debug statements to be inserted directly into expressions by returning arguments to the caller.
- Debugging Tools - Provides a function that returns its arguments, allowing debug statements to be inserted directly into expressions.
- Debugging Utilities - Provides an alternative to standard print statements for inspecting variable values and execution flow during development.
- Print-Based Debugging Workflows - Facilitates the identification of execution flow and variable values to find bugs without a full debugger.
- Non-Breaking Inline Inspection - Allows inspection calls to be inserted directly into logic flows without breaking the code's return values.
- Transparent - Allows debug calls to be inserted directly into active expressions by returning the passed arguments back to the caller.
- Frame Analyzers - Uses stack trace inspection to automatically extract filename, line number, and calling function for each log.
- Execution Tracing - Records the sequence of execution by printing the filename, line number, and parent function.
- Debug Output Configuration - Provides a configuration system to customize output prefixes, serialization methods, and destination sinks.
- Global Function Injection - Injects debugging functions into the global builtins module for use across all project files without imports.
- Global Debug Toggles - Includes a global toggle to enable or disable debug messages without modifying the source code.
- Pluggable Serialization - Allows users to swap the default string conversion method with custom serialization functions for different object formats.
- Builtins Namespace Injectors - Implements a utility that adds a global debugging function to the Python builtins module.
- Global Debugging Helpers - Adds debugging functions to the global environment to eliminate the need for repetitive imports across files.
- Custom Log Formatting - Defines specific prefixes and serialization methods to control how diagnostic information appears in the console.
- Global - Implements a builtins injector to make debugging functions globally available across all project files without imports.
- Global Debug Output Control - Offers a global control mechanism to enable or disable the printing of inspection messages.
- Code Quality Tools - Debugging tool for inspecting code without print statements.
- Debugging And Profiling - Simple function for inspecting variables and execution.
- Debugging Tools - Simplifies debugging with readable, formatted output.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
