mahmoud/boltons
Boltons
Boltons is a comprehensive utility toolkit and extension of the Python standard library. It provides a collection of reusable recipes and specialized data structures, system utilities, and helper libraries designed to support common programming tasks across various domains.
The project is distinguished by a standard-library-only dependency model, ensuring maximum portability with zero external dependencies. It provides advanced implementations for data structures, such as immutable mappings and priority queues, alongside recursive data transformation tools for reshaping complex nested dictionaries and lists.
Its broader capability surface includes system and file management through atomic writes and path expansion, network reliability tools like exponential backoff, and command line interface development helpers. It also covers performance optimization via property memoization and cache invalidation, as well as observability tools for structured traceback parsing and callable object tracing.
Features
- Specialized Data Structures - Ships advanced implementations of priority queues, immutable mappings, and recursive data transformers.
- Immutable Maps - Implements frozen dictionaries that prevent the modification of keys and values after creation.
- Recursive Data Explorers - Provides utilities to traverse nested data structures and apply transformation functions based on custom entry rules.
- Recursive Data Transformers - Traverses and modifies nested dictionaries and lists to reshape complex data structures using custom mapping rules.
- CLI Development Helpers - Provides a suite of helpers for rendering progress bars, escaping shell arguments, and prompting users in the terminal.
- Network Reliability - Implements exponential backoff and socket buffering to ensure stable connections and complete message delivery.
- File System Operations - Provides utilities for atomic file writes, recursive directory searches, and shell path expansions.
- System Utility Helpers - Provides low-level system helpers for atomic file saving, path expansion, and network socket buffering.
- Python Tooling - Acts as a comprehensive utility toolkit providing reusable recipes for common Python programming tasks.
- Standard Library Extensions - Extends the Python standard library with reusable recipes and specialized utilities while maintaining zero external dependencies.
- Lazy Dataset Iterators - Implements memory-efficient processing of large datasets using sliding windows, chunking, and flattening.
- Nested Data Transformers - Provides recursive traversal tools to map and transform elements within nested data structures using custom rules.
- Recursive Data Remapping - Traverses nested data structures to transform or merge values recursively based on defined rules.
- Zero-Dependency Libraries - Ensures maximum portability by implementing all features using only the Python standard library with zero external dependencies.
- Command-Line Interface Development - Provides a toolkit for building terminal applications with progress bars, user prompts, and safe shell argument formatting.
- Dictionary Indexes - Provides a utility to create sub-dictionaries as indexes over a dataset to speed up lookups.
- Multi-Value Dictionaries - Provides a data structure that allows multiple values for a single key while preserving insertion order.
- Shell Argument Escapers - Provides a utility to escape and combine command line arguments into a single string safe for shell execution.
- Traceback Filters - Implements traceback folding to collapse repeated frames and reduce noise in recursive call stacks.
- Traceback Structurers - Transforms raw system stack traces into structured objects to facilitate error analysis and recursive call noise reduction.
- Sliding Window Algorithms - Implements a sliding-window iterator to produce overlapping groups of elements from a sequence.
- Iterable Flatteners - Provides a utility to collapse nested sequences or iterators into a single flat stream of elements.
- Key Filtering - Provides a utility to extract a new dictionary containing only a specified subset of keys from an original mapping.
- Non-Overwriting Updates - Ships a utility to merge key-value pairs into a dictionary only if the keys do not already exist.
- Atomic File Writes - Provides atomic file write operations that use temporary files to prevent data corruption during crashes.
- Traceback Parsing - Transforms raw traceback strings into structured objects for easier analysis and serialization.
- Disk-Memory Thresholds - Implements a system to store data in memory and spill to disk automatically when a size threshold is exceeded.
- LRU Cache Eviction - Implements a least-recently-used (LRU) eviction policy to maintain a fixed-size memory pool.
- Priority Queues - Provides a priority queue implementation where the highest priority item is processed first.
- Stack Trace Formatters - Represents traceback information as structured types to improve error reporting and debugging.
- Terminal Progress Indicators - Implements a visual progress bar for the terminal to track the completion status of long-running tasks.
- CLI Confirmation Prompts - Implements a terminal utility to ask yes/no questions and capture user responses to validate specific actions.
- State-Based Invalidation - Uses a dirty-bit mechanism to automatically invalidate cached property values when an object's state changes.
- General Utilities - Collection of over 250 useful constructs and utility snippets.
