# file_io URL: /api/utils/file_io/ Section: utils -------------------------------------------------------------------------------- file_io - 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.file_io File I/O utilities with robust error handling. Provides standardized file reading/writing operations with consistent error handling, logging, and encoding fallback. Consolidates duplicate file I/O patterns found throughout the codebase. Example: from bengal.utils.file_io import read_text_file, load_json, load_yaml, rmtree_robust # Read text file with encoding fallback content = read_text_file(path, fallback_encoding='latin-1') # Load JSON with error handling data = load_json(path, on_error='return_empty') # Auto-detect and load data file data = load_data_file(path) # Works for .json, .yaml, .toml # Robust directory removal (handles macOS quirks) rmtree_robust(Path('/path/to/dir')) View source 10 Functions Functions _strip_bom Strip UTF-8 BOM from content if present. 4 str Caret Right def _strip_bom(content: str, file_path: Path, encoding: str, caller: str | None = None) -> str Strip UTF-8 BOM from content if present. Parameters 4 Name Type Default Description content str — File content file_path Path — Path to file (for logging) encoding str — Encoding used (for logging) caller str | None None Caller identifier for logging Returns str — Content with BOM removed if present, otherwise unchanged read_text_file Read text file with robust error handling and encoding fallback. Consolidates patterns from: - ben… 5 str | None Caret Right def read_text_file(file_path: Path | str, encoding: str = 'utf-8', fallback_encoding: str | None = 'latin-1', on_error: str = 'raise', caller: str | None = None) -> str | None Read text file with robust error handling and encoding fallback. Consolidates patterns from: bengal/discovery/content_discovery.py:192 (UTF-8 with latin-1 fallback) bengal/rendering/template_functions/files.py:78 (file reading with logging) bengal/config/loader.py:137 (config file reading) Parameters 5 Name Type Default Description file_path Path | str — Path to file to read encoding str 'utf-8' Primary encoding to try (default: 'utf-8') fallback_encoding str | None 'latin-1' Fallback encoding if primary fails (default: 'latin-1') on_error str 'raise' Error handling strategy: - 'raise': Raise exception on error - 'return_empty': Return empty string on error - 'return_none': Return None on error caller str | None None Caller identifier for logging context Returns str | None — File contents as string, or None/empty string based on on_error. Encoding notes: Strips UTF-8 BOM when present. If primary decode fails, tries utf-8-sig before the configured fallback. load_json Load JSON file with error handling. Consolidates patterns from: - bengal/rendering/template_functi… 3 Any Caret Right def load_json(file_path: Path | str, on_error: str = 'return_empty', caller: str | None = None) -> Any Load JSON file with error handling. Consolidates patterns from: bengal/rendering/template_functions/data.py:80 (JSON loading) Parameters 3 Name Type Default Description file_path Path | str — Path to JSON file on_error str 'return_empty' Error handling strategy ('raise', 'return_empty', 'return_none') caller str | None None Caller identifier for logging Returns Any — Parsed JSON data, or {} / None based on on_error load_yaml Load YAML file with error handling. Consolidates patterns from: - bengal/config/loader.py:142 (YAM… 3 dict[str, Any] | None Caret Right def load_yaml(file_path: Path | str, on_error: str = 'return_empty', caller: str | None = None) -> dict[str, Any] | None Load YAML file with error handling. Consolidates patterns from: bengal/config/loader.py:142 (YAML config loading) bengal/rendering/template_functions/data.py:94 (YAML data loading) Parameters 3 Name Type Default Description file_path Path | str — Path to YAML file on_error str 'return_empty' Error handling strategy ('raise', 'return_empty', 'return_none') caller str | None None Caller identifier for logging Returns dict[str, Any] | None — Parsed YAML data, or {} / None based on on_error load_toml Load TOML file with error handling. Consolidates patterns from: - bengal/config/loader.py:137 (TOM… 3 dict[str, Any] | None Caret Right def load_toml(file_path: Path | str, on_error: str = 'return_empty', caller: str | None = None) -> dict[str, Any] | None Load TOML file with error handling. Consolidates patterns from: bengal/config/loader.py:137 (TOML config loading) Parameters 3 Name Type Default Description file_path Path | str — Path to TOML file on_error str 'return_empty' Error handling strategy ('raise', 'return_empty', 'return_none') caller str | None None Caller identifier for logging Returns dict[str, Any] | None — Parsed TOML data, or {} / None based on on_error load_data_file Auto-detect and load JSON/YAML/TOML file. Consolidates pattern from: - bengal/rendering/template_f… 3 dict[str, Any] | None Caret Right def load_data_file(file_path: Path | str, on_error: str = 'return_empty', caller: str | None = None) -> dict[str, Any] | None Auto-detect and load JSON/YAML/TOML file. Consolidates pattern from: bengal/rendering/template_functions/data.py:40 (get_data function) Parameters 3 Name Type Default Description file_path Path | str — Path to data file (.json, .yaml, .yml, .toml) on_error str 'return_empty' Error handling strategy ('raise', 'return_empty', 'return_none') caller str | None None Caller identifier for logging Returns dict[str, Any] | None — Parsed data, or {} / None based on on_error write_text_file Write text to file with parent directory creation. 5 None Caret Right def write_text_file(file_path: Path | str, content: str, encoding: str = 'utf-8', create_parents: bool = True, caller: str | None = None) -> None Write text to file with parent directory creation. Parameters 5 Name Type Default Description file_path Path | str — Path to file to write content str — Text content to write encoding str 'utf-8' Text encoding (default: 'utf-8') create_parents bool True Create parent directories if they don't exist caller str | None None Caller identifier for logging write_json Write data as JSON file. 5 None Caret Right def write_json(file_path: Path | str, data: Any, indent: int | None = 2, create_parents: bool = True, caller: str | None = None) -> None Write data as JSON file. Parameters 5 Name Type Default Description file_path Path | str — Path to JSON file data Any — Data to serialize as JSON indent int | None 2 JSON indentation (None for compact) create_parents bool True Create parent directories if needed caller str | None None Caller identifier for logging _remove_hidden_files Remove macOS hidden files that may prevent directory deletion. Targets .DS_Store, ._* files, and o… 1 int Caret Right def _remove_hidden_files(dir_path: Path) -> int Remove macOS hidden files that may prevent directory deletion. Targets .DS_Store, ._* files, and other dotfiles that macOS creates and can interfere with shutil.rmtree. Parameters 1 Name Type Default Description dir_path Path — Directory to clean hidden files from Returns int — Number of hidden files removed rmtree_robust Remove directory tree with robust error handling for filesystem quirks. On macOS, shutil.rmtree ca… 3 None Caret Right def rmtree_robust(path: Path, max_retries: int = 3, caller: str | None = None) -> None Remove directory tree with robust error handling for filesystem quirks. On macOS, shutil.rmtree can fail with Errno 66 (Directory not empty) due to race conditions with Spotlight indexing, Finder metadata files (.DS_Store, ._*), or other processes briefly accessing the directory. Strategy: 1. Try normal shutil.rmtree 2. On ENOTEMPTY, remove hidden files (.DS_Store, ._*) and retry 3. Fall back to subprocess `rm -rf` on macOS as last resort Parameters 3 Name Type Default Description path Path — Directory to remove max_retries int 3 Number of retry attempts (default 3) caller str | None None Caller identifier for logging ← Previous error_handlers Next → file_lock 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: 2054 - Reading Time: 10 minutes