# cache_store URL: /api/cache/cache_store/ Section: cache -------------------------------------------------------------------------------- cache_store - Bengal window.BENGAL_THEME_DEFAULTS = { appearance: 'dark', palette: 'snow-lynx' }; // Progressive Enhancement System Configuration window.Bengal = window.Bengal || {}; window.Bengal.enhanceBaseUrl = '/bengal/assets/js/enhancements'; window.Bengal.watchDom = true; window.Bengal.debug = false; (function () { try { var defaults = window.BENGAL_THEME_DEFAULTS || { appearance: 'system', palette: '' }; var defaultAppearance = defaults.appearance; if (defaultAppearance === 'system') { defaultAppearance = (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) ? 'dark' : 'light'; } var storedTheme = localStorage.getItem('bengal-theme'); var storedPalette = localStorage.getItem('bengal-palette'); var theme = storedTheme ? (storedTheme === 'system' ? defaultAppearance : storedTheme) : defaultAppearance; var palette = storedPalette ?? defaults.palette; document.documentElement.setAttribute('data-theme', theme); if (palette) { document.documentElement.setAttribute('data-palette', palette); } } catch (e) { document.documentElement.setAttribute('data-theme', 'light'); } })(); Skip to main content Magnifying Glass ESC Recent Clear Magnifying Glass No results for "" Try different keywords or check your spelling Start typing to search... ↑↓ Navigate ↵ Open ESC Close Powered by Lunr ᓚᘏᗢ Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Magnifying Glass Search ⌘K Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal List ᓚᘏᗢ Magnifying Glass Search X Close Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal API Reference __main__ bengal Caret Right Folder Analysis community_detection graph_analysis graph_reporting graph_visualizer knowledge_graph link_suggestions link_types page_rank path_analysis performance_advisor results Caret Right Folder Assets manifest pipeline Caret Right Folder Autodoc base config docstring_parser utils virtual_orchestrator Caret Right Folder Extractors cli openapi python Caret Right Folder Models cli common openapi python Caret Right Folder Cache asset_dependency_map cache_store cacheable compression dependency_tracker page_discovery_cache query_index query_index_registry taxonomy_index utils Caret Right Folder Build Cache autodoc_tracking core file_tracking fingerprint parsed_content_cache rendered_output_cache taxonomy_index_mixin validation_cache Caret Right Folder Indexes author_index category_index date_range_index section_index Caret Right Folder Cli __main__ base site_templates utils Caret Right Folder Commands assets build clean collections config debug explain fix health init perf project serve site skeleton sources theme utils validate Caret Right Folder Graph __main__ bridges communities orphans pagerank report suggest Caret Right Folder New config presets scaffolds site wizard Caret Right Folder Helpers cli_app_loader cli_output config_validation error_handling menu_config metadata progress site_loader traceback validation Caret Right Folder Skeleton hydrator schema Caret Right Folder Templates base registry Caret Right Folder Blog template Caret Right Folder Changelog template Caret Right Folder Default template Caret Right Folder Docs template Caret Right Folder Landing template Caret Right Folder Portfolio template Caret Right Folder Resume template Caret Right Folder Collections errors loader schemas validator Caret Right Folder Config defaults deprecation directory_loader env_overrides environment feature_mappings hash loader merge origin_tracker validators Caret Right Folder Content Layer entry loaders manager source Caret Right Folder Sources github local notion rest Caret Right Folder Content Types base registry strategies Caret Right Folder Core build_context cascade_engine menu section theme Caret Right Folder Asset asset_core css_transforms Caret Right Folder Page computed content metadata navigation operations page_core proxy relationships utils Caret Right Folder Site core data discovery factories page_caches properties section_registry theme Caret Right Folder Debug base config_inspector content_migrator delta_analyzer dependency_visualizer explainer incremental_debugger models reporter shortcode_sandbox Caret Right Folder Discovery asset_discovery content_discovery Caret Right Folder Fonts downloader generator Caret Right Folder Health autofix base health_check report Caret Right Folder Linkcheck async_checker ignore_policy internal_checker models orchestrator Caret Right Folder Validators anchors assets cache config connectivity cross_ref fonts links menu navigation output performance rendering rss sitemap taxonomy tracks Caret Right Folder Directives analysis checkers constants Caret Right Folder Orchestration asset content full_to_incremental incremental menu postprocess related_posts render section static streaming taxonomy Caret Right Folder Postprocess html_output redirects rss sitemap special_pages Caret Right Folder Output Formats index_generator json_generator llm_generator lunr_index_generator txt_generator utils Caret Right Folder Rendering api_doc_enhancer asset_extractor errors jinja_utils link_transformer link_validator pygments_cache renderer template_context template_profiler validator Caret Right Folder Parsers base factory mistune native_html pygments_patch python_markdown Caret Right Folder Pipeline core output thread_local toc transforms Caret Right Folder Plugins badges cross_references inline_icon term variable_substitution Caret Right Folder Directives _icons admonitions badge base button cache cards checklist code_tabs container contracts data_table dropdown embed errors example_label fenced figure glossary icon include list_table literalinclude marimo navigation options rubric steps tabs target term terminal tokens utils validator video Caret Right Folder Template Engine asset_url core environment manifest menu url_helpers Caret Right Folder Template Functions advanced_collections advanced_strings autodoc collections content crossref data dates debug files get_page i18n icons images math_functions navigation pagination_helpers seo strings tables taxonomies theme urls Caret Right Folder Server build_handler component_preview constants dev_server live_reload pid_manager reload_controller request_handler request_logger resource_manager utils Caret Right Folder Services validation Caret Right Folder Themes config Caret Right Folder Utils atomic_write autodoc build_context build_stats build_summary cli_output css_minifier dates dotdict error_handlers file_io file_lock hashing incremental_constants js_bundler live_progress logger metadata observability page_initializer pagination path_resolver paths performance_collector performance_report profile progress retry rich_console sections swizzle text theme_registry theme_resolution thread_local traceback_config traceback_renderer url_normalization url_strategy API Reference Cache ᗢ Caret Down Link Copy URL External Open LLM text Copy Copy LLM text Share with AI Ask Claude Ask ChatGPT Ask Gemini Ask Copilot Module cache.cache_store Generic cache storage for Cacheable types. This module provides a type-safe, generic cache storage mechanism that works with any type implementing the Cacheable protocol. It handles: JSON serialization/deserialization Zstandard compression (92-93% size reduction) Version management (tolerant loading) Directory creation Type-safe load/save operations Backward compatibility (reads both compressed and uncompressed) Design Philosophy: CacheStore provides a reusable cache storage layer that works with any Cacheable type. This eliminates the need for each cache (TaxonomyIndex, AssetDependencyMap, etc.) to implement its own save/load logic. Benefits: Consistent version handling across all caches Type-safe operations (mypy validates) Tolerant loading (returns empty on mismatch, doesn't crash) Automatic directory creation Single source of truth for cache file format 12-14x compression ratio with Zstandard (PEP 784) Usage Example: from bengal.cache.cache_store import CacheStore from bengal.cache.taxonomy_index import TagEntry # Create store (compression enabled by default) store = CacheStore(Path('.bengal/tags.json')) # Save entries (type-safe, compressed) tags = [ TagEntry(tag_slug='python', tag_name='Python', page_paths=[], updated_at='...'), TagEntry(tag_slug='web', tag_name='Web', page_paths=[], updated_at='...'), ] store.save(tags, version=1) # Load entries (auto-detects format: .json.zst or .json) loaded_tags = store.load(TagEntry, expected_version=1) # Returns [] if file missing or version mismatch See Also: bengal/cache/cacheable.py - Cacheable protocol definition bengal/cache/compression.py - Zstandard compression utilities bengal/cache/taxonomy_index.py - Example usage (TagEntry) bengal/cache/asset_dependency_map.py - Example usage (AssetDependencyEntry) plan/active/rfc-zstd-cache-compression.md - Compression RFC View source 1 Class Classes CacheStore Generic cache storage for types implementing the Cacheable protocol. Provides type-safe save/load … 6 Caret Right Generic cache storage for types implementing the Cacheable protocol. Provides type-safe save/load operations with version management, Zstandard compression, and tolerant loading (returns empty list on version mismatch or missing file). Attributes Name Type Description cache_path — Path to cache file (e.g., .bengal/taxonomy_index.json) compress — Whether to use Zstandard compression (default: True) Cache File Format: Compressed — Zstd-compressed JSON with same structure as below 92-93% smaller, 12-14x compression ratio Uncompressed — { "version": 1, "entries": [ {...}, // Serialized Cacheable objects {...} ] } Version Management: - Each cache file has a top-level "version" field - On version mismatch, load() returns empty list and logs warning - On missing file, load() returns empty list (no warning) - On malformed data, load() returns empty list and logs error This "tolerant loading" approach ensures that stale or incompatible caches don't crash the build - they just rebuild from scratch. Compression — Enabled by default (Python 3.14+ with compression.zstd) - 92-93% size reduction on typical cache files - <1ms compress time, <0.3ms decompress time - Auto-detects format on load (reads both .json.zst and .json) - Backward compatible: reads old uncompressed caches Type Safety: - save() accepts list of any Cacheable type - load() requires explicit type parameter for deserialization - mypy validates that type implements Cacheable protocol Methods 4 save Save entries to cache file. Serializes all entries to JSON and writes to cache… 3 None Caret Right def save(self, entries: list[Cacheable], version: int = 1, indent: int = 2) -> None Save entries to cache file. Serializes all entries to JSON and writes to cache file. Creates parent directory if missing. Uses Zstandard compression by default. Parameters 3 entries list[Cacheable] List of Cacheable objects to save version int Cache version number (default: 1). Increment when format changes (new fields, removed fields, etc.) indent int JSON indentation (default: 2). Only used when compression is disabled; compressed files always use compact JSON. load Load entries from cache file (tolerant). Deserializes entries and validates ve… 2 list[T] Caret Right def load(self, entry_type: type[T], expected_version: int = 1) -> list[T] Load entries from cache file (tolerant). Deserializes entries and validates version. Automatically detects format (compressed .json.zst or uncompressed .json). If version mismatch or file missing, returns empty list (doesn't crash). This "tolerant loading" approach ensures that builds never fail due to stale or incompatible caches - they just rebuild from scratch. Parameters 2 entry_type type[T] Type to deserialize (must implement Cacheable protocol). Used to call from_cache_dict() classmethod. expected_version int Expected cache version (default: 1). If file version doesn't match, returns empty list. Returns list[T] — List of deserialized entries, or [] if: File doesn't exist (no warning, normal for first build) Version mismatch (warning logged) Malformed data (error logged) Deserialization fails (error logged) exists Check if cache file exists (compressed or uncompressed). 0 bool Caret Right def exists(self) -> bool Check if cache file exists (compressed or uncompressed). Returns bool — True if cache file exists in either format, False otherwise clear Delete cache file if it exists (both compressed and uncompressed). Used to for… 0 None Caret Right def clear(self) -> None Delete cache file if it exists (both compressed and uncompressed). Used to force cache rebuild (e.g., after format changes). Internal Methods 2 Caret Right __init__ Initialize cache store. 2 None Caret Right def __init__(self, cache_path: Path, compress: bool = True) Initialize cache store. Parameters 2 cache_path Path Path to cache file (e.g., .bengal/taxonomy_index.json). Parent directory will be created if missing. With compression enabled, actual file will be .json.zst compress bool Whether to use Zstandard compression (default: True). Set to False for debugging or compatibility. _load_data Load raw data from cache file with auto-detection. Tries compressed format fir… 0 dict[Any, Any] | None Caret Right def _load_data(self) -> dict[Any, Any] | None Load raw data from cache file with auto-detection. Tries compressed format first (.json.zst), falls back to uncompressed (.json). This enables seamless migration from old uncompressed caches. Returns dict[Any, Any] | None — Parsed data dict, or None if file not found or load failed ← Previous cache Next → cacheable List © 2025 Bengal ᓚᘏᗢ window.BENGAL_LAZY_ASSETS = { tabulator: '/bengal/assets/js/tabulator.min.js', dataTable: '/bengal/assets/js/data-table.js', mermaidToolbar: '/bengal/assets/js/mermaid-toolbar.9de5abba.js', mermaidTheme: '/bengal/assets/js/mermaid-theme.344822c5.js', graphMinimap: '/bengal/assets/js/graph-minimap.cc7e42e3.js', graphContextual: '/bengal/assets/js/graph-contextual.440e59c6.js' }; window.BENGAL_ICONS = { close: '/bengal/assets/icons/close.911d4fe1.svg', enlarge: '/bengal/assets/icons/enlarge.652035e5.svg', copy: '/bengal/assets/icons/copy.3d56e945.svg', 'download-svg': '/bengal/assets/icons/download.04f07e1b.svg', 'download-png': '/bengal/assets/icons/image.c34dfd40.svg', 'zoom-in': '/bengal/assets/icons/zoom-in.237b4a83.svg', 'zoom-out': '/bengal/assets/icons/zoom-out.38857c77.svg', reset: '/bengal/assets/icons/reset.d26dba29.svg' }; Arrow Up X -------------------------------------------------------------------------------- Metadata: - Author: lbliii - Word Count: 1816 - Reading Time: 9 minutes