# core URL: /api/cache/build_cache/core/ Section: build_cache -------------------------------------------------------------------------------- core - 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 Cache Build 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.build_cache.core Core BuildCache class for tracking file changes and dependencies. Main dataclass with fields, save/load, and coordination methods. Uses mixins for specialized functionality (file tracking, validation, taxonomy, caching). Key Concepts: File fingerprints: mtime + size for fast change detection, hash for verification Dependency tracking: Templates, partials, and data files used by pages Taxonomy indexes: Tag/category mappings for fast reconstruction Config hash: Auto-invalidation when configuration changes Version tolerance: Accepts missing/older cache versions gracefully Zstandard compression: 92-93% size reduction, <1ms overhead Related Modules: bengal.orchestration.incremental: Incremental build logic using cache bengal.cache.dependency_tracker: Dependency graph construction bengal.cache.taxonomy_index: Taxonomy reconstruction from cache bengal.cache.compression: Zstandard compression utilities See Also: plan/active/rfc-incremental-builds.md: Incremental build design plan/active/rfc-orchestrator-performance-improvements.md: Performance RFC plan/active/rfc-zstd-cache-compression.md: Compression RFC View source 1 Class Classes BuildCache dataclass Tracks file hashes and dependencies between builds. IMPORTANT PERSISTENCE CONTRACT: - This cache m… 14 Caret Right Tracks file hashes and dependencies between builds. IMPORTANT PERSISTENCE CONTRACT: This cache must NEVER contain object references (Page, Section, Asset objects) All data must be JSON-serializable (paths, strings, numbers, lists, dicts, sets) Object relationships are rebuilt each build from cached paths NOTE: BuildCache intentionally does NOT implement the Cacheable protocol. Rationale: Uses pickle for performance (faster than JSON for sets/complex structures) Has tolerant loader with custom version handling logic Contains many specialized fields (dependencies, hashes, etc.) Designed for internal build state, not type-safe caching contracts For type-safe caching, use types that implement the Cacheable protocol: PageCore (bengal/core/page/page_core.py) TagEntry (bengal/cache/taxonomy_index.py) AssetDependencyEntry (bengal/cache/asset_dependency_map.py) Inherits from FileTrackingMixin, ValidationCacheMixin, TaxonomyIndexMixin, ParsedContentCacheMixin, RenderedOutputCacheMixin, AutodocTrackingMixin Attributes Name Type Description VERSION int version int file_hashes dict[str, str] Mapping of file paths to their SHA256 hashes file_fingerprints dict[str, dict[str, Any]] Mapping of file paths to {mtime, size, hash} dicts dependencies dict[str, set[str]] Mapping of pages to their dependencies (templates, partials, etc.) output_sources dict[str, str] Mapping of output files to their source files taxonomy_deps dict[str, set[str]] Mapping of taxonomy terms to affected pages page_tags dict[str, set[str]] Mapping of page paths to their tags (for detecting tag changes) tag_to_pages dict[str, set[str]] Inverted index mapping tag slug to page paths (for O(1) reconstruction) known_tags set[str] Set of all tag slugs from previous build (for detecting deletions) parsed_content dict[str, dict[str, Any]] Cached parsed HTML/TOC (Optimization #2) rendered_output dict[str, dict[str, Any]] Cached rendered HTML (Optimization #3) synthetic_pages dict[str, dict[str, Any]] Cached synthetic page data (autodoc, etc.) validation_results dict[str, dict[str, list[dict[str, Any]]]] Cached validation results per file/validator autodoc_dependencies dict[str, set[str]] config_hash str | None Hash of resolved configuration (for auto-invalidation) last_build str | None Timestamp of last successful build Methods 9 load classmethod Load build cache from disk with optional file locking. Loader behavior: - Tole… 2 BuildCache Caret Right def load(cls, cache_path: Path, use_lock: bool = True) -> BuildCache Load build cache from disk with optional file locking. Loader behavior: Tolerant to malformed JSON: On parse errors or schema mismatches, returns a fresh BuildCache instance and logs a warning. Version mismatches: Logs a warning and best-effort loads known fields. File locking: Acquires shared lock to prevent reading during writes. Parameters 2 cache_path Path Path to cache file use_lock bool Whether to use file locking (default: True) Returns BuildCache — BuildCache instance (empty if file doesn't exist or is invalid) save Save build cache to disk with optional file locking. Persistence semantics: - … 2 None Caret Right def save(self, cache_path: Path, use_lock: bool = True) -> None Save build cache to disk with optional file locking. Persistence semantics: Atomic writes: Uses AtomicFile (temp-write → atomic rename) to prevent partial files on crash/interruption. File locking: Acquires exclusive lock to prevent concurrent writes. Combined safety: Lock + atomic write ensures complete consistency. Parameters 2 cache_path Path Path to cache file use_lock bool Whether to use file locking (default: True) clear Clear all cache data. 0 None Caret Right def clear(self) -> None Clear all cache data. validate_config Check if cache is valid for the current configuration. Compares the stored con… 1 bool Caret Right def validate_config(self, current_hash: str) -> bool Check if cache is valid for the current configuration. Compares the stored config_hash with the current configuration hash. If they differ, the cache is automatically cleared to ensure correctness. This enables automatic cache invalidation when: Configuration files change (bengal.toml, config/*.yaml) Environment variables change (BENGAL_*) Build profiles change (--profile writer) Parameters 1 current_hash str Hash of the current resolved configuration Returns bool — True if cache is valid (hashes match), False if cache was cleared invalidate_file Remove a file from all caches (useful when file is deleted). Extends FileTrack… 1 None Caret Right def invalidate_file(self, file_path: Path) -> None Remove a file from all caches (useful when file is deleted). Extends FileTrackingMixin.invalidate_file with additional cache cleanup. Parameters 1 file_path Path Path to file get_stats Get cache statistics with logging. 0 dict[str, int] Caret Right def get_stats(self) -> dict[str, int] Get cache statistics with logging. Returns dict[str, int] — Dictionary with cache stats get_page_cache Get cached data for a synthetic page. 1 dict[str, Any] | None Caret Right def get_page_cache(self, cache_key: str) -> dict[str, Any] | None Get cached data for a synthetic page. Parameters 1 cache_key str Unique cache key for the page Returns dict[str, Any] | None — Cached page data or None if not found set_page_cache Cache data for a synthetic page. 2 None Caret Right def set_page_cache(self, cache_key: str, page_data: dict[str, Any]) -> None Cache data for a synthetic page. Parameters 2 cache_key str Unique cache key for the page page_data dict[str, Any] Page data to cache invalidate_page_cache Remove cached data for a synthetic page. 1 None Caret Right def invalidate_page_cache(self, cache_key: str) -> None Remove cached data for a synthetic page. Parameters 1 cache_key str Cache key to invalidate Internal Methods 5 Caret Right __post_init__ Convert sets from lists after JSON deserialization. 0 None Caret Right def __post_init__(self) -> None Convert sets from lists after JSON deserialization. _load_from_file classmethod Internal method to load cache from file (assumes lock is held if needed). Auto… 1 BuildCache Caret Right def _load_from_file(cls, cache_path: Path) -> BuildCache Internal method to load cache from file (assumes lock is held if needed). Auto-detects format: tries compressed (.json.zst) first, falls back to uncompressed (.json). This enables seamless migration. Parameters 1 cache_path Path Path to cache file (base path, without .zst extension) Returns BuildCache — BuildCache instance _load_data_auto classmethod Load raw data with auto-detection of format. Tries compressed format first (.j… 1 dict[str, Any] | None Caret Right def _load_data_auto(cls, cache_path: Path) -> dict[str, Any] | None Load raw data with auto-detection of format. Tries compressed format first (.json.zst), falls back to uncompressed (.json). Parameters 1 cache_path Path Base path to cache file Returns dict[str, Any] | None — Parsed data dict, or None if load failed _save_to_file Internal method to save cache to file (assumes lock is held if needed). Uses Z… 2 None Caret Right def _save_to_file(self, cache_path: Path, compress: bool = True) -> None Internal method to save cache to file (assumes lock is held if needed). Uses Zstandard compression by default for 92-93% size reduction. Parameters 2 cache_path Path Path to cache file (base path, will save as .json.zst) compress bool Whether to use compression (default: True) __repr__ 0 str Caret Right def __repr__(self) -> str Returns str ← Previous build_cache Next → file_tracking 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: 2107 - Reading Time: 11 minutes