# config_inspector URL: /api/debug/config_inspector/ Section: debug -------------------------------------------------------------------------------- config_inspector - 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 Debug ᗢ 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 debug.config_inspector Configuration Inspector and Diff Tool. Advanced configuration comparison and analysis beyond the basic bengal config diff. Supports comparing arbitrary config sources, explaining effective values, and identifying potential configuration issues. Example usage: inspector = ConfigInspector(site) diff = inspector.compare(source1="local", source2="production") print(diff.format_detailed()) View source 4 Classes Classes ConfigDiff dataclass A single configuration difference. 1 Caret Right A single configuration difference. Attributes Name Type Description path str type Literal['added', 'removed', 'changed'] old_value Any new_value Any old_origin str | None new_origin str | None impact str | None Methods 1 format Format the diff for display. 0 str Caret Right def format(self) -> str Format the diff for display. Returns str ConfigComparisonResult dataclass Result of comparing two configurations. 6 Caret Right Result of comparing two configurations. Attributes Name Type Description source1 str source2 str diffs list[ConfigDiff] config1 dict[str, Any] config2 dict[str, Any] Methods 6 Tag has_changes property Check if there are any differences. bool Caret Right def has_changes(self) -> bool Check if there are any differences. Returns bool Tag added property Get added keys. list[ConfigDiff] Caret Right def added(self) -> list[ConfigDiff] Get added keys. Returns list[ConfigDiff] Tag removed property Get removed keys. list[ConfigDiff] Caret Right def removed(self) -> list[ConfigDiff] Get removed keys. Returns list[ConfigDiff] Tag changed property Get changed keys. list[ConfigDiff] Caret Right def changed(self) -> list[ConfigDiff] Get changed keys. Returns list[ConfigDiff] format_summary Format a summary of differences. 0 str Caret Right def format_summary(self) -> str Format a summary of differences. Returns str format_detailed Format detailed diff output. 0 str Caret Right def format_detailed(self) -> str Format detailed diff output. Returns str KeyExplanation dataclass Explanation of how a config key got its value. 1 Caret Right Explanation of how a config key got its value. Attributes Name Type Description key_path str effective_value Any origin str | None layer_values list[tuple[str, Any]] is_default bool deprecated bool deprecation_message str | None Methods 1 format Format the explanation. 0 str Caret Right def format(self) -> str Format the explanation. Returns str ConfigInspector Advanced configuration inspector and diff tool. Provides: - Deep comparison between any config sou… 12 Caret Right Advanced configuration inspector and diff tool. Provides: Deep comparison between any config sources Origin tracking for each value Impact analysis for differences Key-level explanation of value resolution Default value detection Deprecation warnings Inherits from DebugTool Attributes Name Type Description name str description str IMPACT_PATTERNS dict[str, str] Methods 5 run Run config inspection. 3 DebugReport Caret Right def run(self, compare_to: str | None = None, explain_key: str | None = None, list_sources: bool = False, **kwargs: Any) -> DebugReport Run config inspection. Parameters 3 compare_to str | None Source to compare against (environment or profile) explain_key str | None Specific key to explain list_sources bool List available config sources **kwargs: Additional arguments Returns DebugReport — DebugReport with findings analyze Perform analysis and return report. This is the abstract method required by De… 0 DebugReport Caret Right def analyze(self) -> DebugReport Perform analysis and return report. This is the abstract method required by DebugTool. For parameterized analysis, use run() instead. Returns DebugReport compare Compare two configuration sources. 3 ConfigComparisonResult Caret Right def compare(self, source1: str, source2: str, track_origins: bool = True) -> ConfigComparisonResult Compare two configuration sources. Parameters 3 source1 str First source (environment name, "profile:name", or file path) source2 str Second source track_origins bool Track origin of each value Returns ConfigComparisonResult — ConfigComparisonResult with all differences explain_key Explain how a config key got its effective value. Shows the resolution chain t… 1 KeyExplanation | None Caret Right def explain_key(self, key_path: str) -> KeyExplanation | None Explain how a config key got its effective value. Shows the resolution chain through defaults → environment → profile. Parameters 1 key_path str Dot-separated key path (e.g., "site.title") Returns KeyExplanation | None — KeyExplanation or None if key not found find_issues Find potential configuration issues. Checks for: - Deprecated keys - Missing r… 0 list[DebugFinding] Caret Right def find_issues(self) -> list[DebugFinding] Find potential configuration issues. Checks for: Deprecated keys Missing required keys Type mismatches Suspicious values Returns list[DebugFinding] — List of findings Internal Methods 7 Caret Right __init__ Initialize inspector. 1 None Caret Right def __init__(self, site: Any) -> None Initialize inspector. Parameters 1 site Any Site instance _list_available_sources List available configuration sources. 0 list[str] Caret Right def _list_available_sources(self) -> list[str] List available configuration sources. Returns list[str] _load_config_source Load configuration from a source. 2 tuple[dict[str, Any… Caret Right def _load_config_source(self, source: str, track_origins: bool = True) -> tuple[dict[str, Any], dict[str, str]] Load configuration from a source. Parameters 2 source str Source identifier track_origins bool Whether to track origins Returns tuple[dict[str, Any], dict[str, str]] — Tuple of (config_dict, origins_dict) _compute_diffs Recursively compute diffs between configs. 6 None Caret Right def _compute_diffs(self, config1: dict[str, Any], config2: dict[str, Any], origins1: dict[str, str], origins2: dict[str, str], path: list[str], diffs: list[ConfigDiff]) -> None Recursively compute diffs between configs. Parameters 6 config1 dict[str, Any] config2 dict[str, Any] origins1 dict[str, str] origins2 dict[str, str] path list[str] diffs list[ConfigDiff] _get_impact Get potential impact description for a config key. 1 str | None Caret Right def _get_impact(self, key: str) -> str | None Get potential impact description for a config key. Parameters 1 key str Returns str | None _load_defaults_only Load only the _default config files. 1 dict[str, Any] Caret Right def _load_defaults_only(self, defaults_dir: Path) -> dict[str, Any] Load only the _default config files. Parameters 1 defaults_dir Path Returns dict[str, Any] _get_nested_value Get a value from nested dict using dot-separated path. 2 Any Caret Right def _get_nested_value(self, config: dict[str, Any], key_path: str) -> Any Get a value from nested dict using dot-separated path. Parameters 2 config dict[str, Any] key_path str Returns Any ← Previous base Next → content_migrator 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: 1847 - Reading Time: 9 minutes