# file_lock URL: /api/utils/file_lock/ Section: utils -------------------------------------------------------------------------------- file_lock - 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_lock File locking utilities for concurrent build safety. Provides cross-platform file locking to prevent cache corruption when multiple build processes run simultaneously. On Unix/macOS: Uses fcntl.flock() On Windows: Uses msvcrt.locking() Example: >>> from bengal.utils.file_lock import file_lock >>> with file_lock(cache_path, exclusive=True): ... # Safely read/write cache ... cache.save(cache_path) View source 1 Class 10 Functions Classes LockAcquisitionError Raised when a lock cannot be acquired within the timeout. 0 Caret Right Raised when a lock cannot be acquired within the timeout. Inherits from Exception Functions file_lock Context manager for file locking. Acquires a lock on a .lock file adjacent to the target path. Use… 3 Generator[None] Caret Right def file_lock(path: Path, exclusive: bool = True, timeout: float = DEFAULT_LOCK_TIMEOUT) -> Generator[None] Context manager for file locking. Acquires a lock on a .lock file adjacent to the target path. Uses non-blocking attempts with retry for better timeout control. Parameters 3 Name Type Default Description path Path — Path to the file to lock (lock file will be path.lock) exclusive bool True If True, acquire exclusive (write) lock; else shared (read) lock timeout float DEFAULT_LOCK_TIMEOUT Maximum seconds to wait for lock (default: 30) Returns Generator[None] _acquire_lock Acquire a lock with timeout using non-blocking retries. 4 None Caret Right def _acquire_lock(lock_file: IO[str], exclusive: bool, timeout: float, lock_path: Path) -> None Acquire a lock with timeout using non-blocking retries. Parameters 4 Name Type Default Description lock_file IO[str] — Open file handle for the lock file exclusive bool — If True, acquire exclusive lock; else shared lock timeout float — Maximum seconds to wait lock_path Path — Path to lock file (for logging) _try_lock_nonblocking Try to acquire lock without blocking. 2 None Caret Right def _try_lock_nonblocking(lock_file: IO[str], exclusive: bool) -> None Try to acquire lock without blocking. Parameters 2 Name Type Default Description lock_file IO[str] — Open file handle exclusive bool — If True, acquire exclusive lock _lock_unix Acquire lock on Unix/macOS using fcntl.flock(). 3 None Caret Right def _lock_unix(lock_file: IO[str], exclusive: bool, blocking: bool) -> None Acquire lock on Unix/macOS using fcntl.flock(). Parameters 3 Name Type Default Description lock_file IO[str] — Open file handle exclusive bool — If True, acquire exclusive (LOCK_EX); else shared (LOCK_SH) blocking bool — If False, raise BlockingIOError if lock unavailable _lock_windows Acquire lock on Windows using msvcrt.locking(). 3 None Caret Right def _lock_windows(lock_file: IO[str], exclusive: bool, blocking: bool) -> None Acquire lock on Windows using msvcrt.locking(). Parameters 3 Name Type Default Description lock_file IO[str] — Open file handle exclusive bool — If True, acquire exclusive lock (always exclusive on Windows) blocking bool — If False, raise BlockingIOError if lock unavailable _release_lock Release lock on the file. 1 None Caret Right def _release_lock(lock_file: IO[str]) -> None Release lock on the file. Parameters 1 Name Type Default Description lock_file IO[str] — Open file handle with lock _unlock_unix Release Unix/macOS lock. 1 None Caret Right def _unlock_unix(lock_file: IO[str]) -> None Release Unix/macOS lock. Parameters 1 Name Type Default Description lock_file IO[str] — _unlock_windows Release Windows lock. 1 None Caret Right def _unlock_windows(lock_file: IO[str]) -> None Release Windows lock. Parameters 1 Name Type Default Description lock_file IO[str] — is_locked Check if a file is currently locked. 1 bool Caret Right def is_locked(path: Path) -> bool Check if a file is currently locked. Parameters 1 Name Type Default Description path Path — Path to check Returns bool — True if file appears to be locked by another process remove_stale_lock Remove a stale lock file that may have been left by a crashed process. 2 bool Caret Right def remove_stale_lock(path: Path, max_age_seconds: float = 3600) -> bool Remove a stale lock file that may have been left by a crashed process. Parameters 2 Name Type Default Description path Path — Path to the file (not the lock file) max_age_seconds float 3600 Maximum age in seconds before considering stale Returns bool — True if stale lock was removed ← Previous file_io Next → hashing 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: 1558 - Reading Time: 8 minutes