# dotdict URL: /api/utils/dotdict/ Section: utils -------------------------------------------------------------------------------- dotdict - 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 Utils ᗢ 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 utils.dotdict DotDict - Dictionary with dot notation access. Provides clean attribute-style access to dictionary data while avoiding Jinja2 template gotchas (like .items, .keys, .values accessing methods). View source 1 Class 1 Function Classes DotDict Dictionary wrapper that allows dot notation access without method name conflicts. This class solve… 17 Caret Right Dictionary wrapper that allows dot notation access without method name conflicts. This class solves a common Jinja2 gotcha: when using dot notation on a regular dict, Jinja2 will access dict methods (like .items()) instead of dictionary keys named "items". Example Problem: >>> data = {"skills": [{"category": "Programming", "items": ["Python"]}]} >>> # In Jinja2 template: >>> # {{ skill_group.items }} # Accesses .items() method! ❌ Solution with DotDict: >>> data = DotDict({"skills": [{"category": "Programming", "items": ["Python"]}]}) >>> # In Jinja2 template: >>> # {{ skill_group.items }} # Accesses "items" field! ✅ Features: Dot notation: obj.key Bracket notation: obj['key'] Recursive wrapping of nested dicts (with caching for performance) Dict-like interface (but not inheriting from dict) No method name collisions Usage: >>> # Create from dict >>> data = DotDict({"name": "Alice", "age": 30}) >>> data.name 'Alice' >>> # Nested dicts auto-wrapped >>> data = DotDict({"user": {"name": "Bob"}}) >>> data.user.name 'Bob' >>> # Lists preserved >>> data = DotDict({"items": ["a", "b", "c"]}) >>> data.items # Returns list, not a method! ['a', 'b', 'c'] Implementation Note: Unlike traditional dict subclasses, DotDict does NOT inherit from dict. This avoids method name collisions. We implement the dict interface manually to work with Jinja2 and other dict-expecting code. Performance: Nested dictionaries are wrapped lazily and cached on first access. This prevents repeatedly creating new DotDict objects for the same nested data, which is especially important for deeply nested structures or when accessed in template loops. Methods 6 get Get value with default. 2 Any Caret Right def get(self, key: str, default: Any = None) -> Any Get value with default. Parameters 2 key str default Any Returns Any keys Return dict keys. 0 KeysView[str] Caret Right def keys(self) -> KeysView[str] Return dict keys. Returns KeysView[str] values Return dict values. 0 ValuesView[Any] Caret Right def values(self) -> ValuesView[Any] Return dict values. Returns ValuesView[Any] items Return dict items - note this is the METHOD, not a field. 0 ItemsView[str, Any] Caret Right def items(self) -> ItemsView[str, Any] Return dict items - note this is the METHOD, not a field. Returns ItemsView[str, Any] from_dict classmethod Create DotDict from a regular dict, recursively wrapping nested dicts. 1 DotDict Caret Right def from_dict(cls, data: dict[str, Any]) -> DotDict Create DotDict from a regular dict, recursively wrapping nested dicts. Parameters 1 data dict[str, Any] Source dictionary Returns DotDict — DotDict with all nested dicts also wrapped to_dict Convert back to regular dict. 0 dict[str, Any] Caret Right def to_dict(self) -> dict[str, Any] Convert back to regular dict. Returns dict[str, Any] Internal Methods 11 Caret Right __init__ Initialize with a dictionary and a cache for wrapped nested objects. 1 None Caret Right def __init__(self, data: dict[str, Any] | None = None) Initialize with a dictionary and a cache for wrapped nested objects. Parameters 1 data dict[str, Any] | None __getattribute__ Intercept attribute access to prioritize data fields over methods. This ensure… 1 Any Caret Right def __getattribute__(self, key: str) -> Any Intercept attribute access to prioritize data fields over methods. This ensures that if a data field has the same name as a method (like 'items', 'keys', 'values'), the data field is returned. For Jinja2 compatibility, if a key doesn't exist in data and isn't a real attribute, we return None instead of raising AttributeError. This allows templates to safely check if obj.field without errors. Parameters 1 key str The attribute name Returns Any — The data value if it exists, the attribute, or None __setattr__ Allow dot notation assignment. Invalidates cache for the key. 2 None Caret Right def __setattr__(self, key: str, value: Any) -> None Allow dot notation assignment. Invalidates cache for the key. Parameters 2 key str value Any __delattr__ Allow dot notation deletion. Invalidates cache for the key. 1 None Caret Right def __delattr__(self, key: str) -> None Allow dot notation deletion. Invalidates cache for the key. Parameters 1 key str __getitem__ Bracket notation access with caching. 1 Any Caret Right def __getitem__(self, key: str) -> Any Bracket notation access with caching. Parameters 1 key str Returns Any __setitem__ Bracket notation assignment. Invalidates cache for the key. 2 None Caret Right def __setitem__(self, key: str, value: Any) -> None Bracket notation assignment. Invalidates cache for the key. Parameters 2 key str value Any __delitem__ Bracket notation deletion. Invalidates cache for the key. 1 None Caret Right def __delitem__(self, key: str) -> None Bracket notation deletion. Invalidates cache for the key. Parameters 1 key str __contains__ Check if key exists. 1 bool Caret Right def __contains__(self, key: str) -> bool Check if key exists. Parameters 1 key str Returns bool __len__ Return number of keys. 0 int Caret Right def __len__(self) -> int Return number of keys. Returns int __iter__ Iterate over keys. 0 Iterator[str] Caret Right def __iter__(self) -> Iterator[str] Iterate over keys. Returns Iterator[str] __repr__ Custom repr showing it's a DotDict. 0 str Caret Right def __repr__(self) -> str Custom repr showing it's a DotDict. Returns str Functions wrap_data Recursively wrap dictionaries in DotDict for clean access. This is the main helper function for wr… 1 Any Caret Right def wrap_data(data: Any) -> Any Recursively wrap dictionaries in DotDict for clean access. This is the main helper function for wrapping data loaded from YAML/JSON files before passing to templates. Parameters 1 Name Type Default Description data Any — Data to wrap (can be dict, list, or primitive) Returns Any — Wrapped data with DotDict for all dicts ← Previous dates Next → error_handlers 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: 1867 - Reading Time: 9 minutes