# live_progress URL: /api/utils/live_progress/ Section: utils -------------------------------------------------------------------------------- live_progress - 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.live_progress Live progress display system with profile-aware output. Provides in-place progress updates that minimize terminal scrolling while showing appropriate detail for each user profile. View source 3 Classes Classes PhaseStatus Status of a build phase. 0 Caret Right Status of a build phase. Inherits from Enum PhaseProgress dataclass Track progress for a single build phase. 2 Caret Right Track progress for a single build phase. Attributes Name Type Description name str status PhaseStatus current int total int | None current_item str elapsed_ms float start_time float | None metadata dict[str, Any] recent_items list[str] Methods 2 get_percentage Get completion percentage. 0 float | None Caret Right def get_percentage(self) -> float | None Get completion percentage. Returns float | None get_elapsed_str Get formatted elapsed time string. 0 str Caret Right def get_elapsed_str(self) -> str Get formatted elapsed time string. Returns str LiveProgressManager Manager for live progress updates across build phases. Features: - Profile-aware display (Writer/T… 15 Caret Right Manager for live progress updates across build phases. Features: Profile-aware display (Writer/Theme-Dev/Developer) In-place updates (no scrolling) Graceful fallback for CI/non-TTY Context manager for clean setup/teardown Methods 5 add_phase Register a new phase. 3 None Caret Right def add_phase(self, phase_id: str, name: str, total: int | None = None) -> None Register a new phase. Parameters 3 phase_id str Unique identifier for the phase name str Display name for the phase total int | None Total number of items to process (if known) start_phase Mark phase as running. 1 None Caret Right def start_phase(self, phase_id: str) -> None Mark phase as running. Parameters 1 phase_id str Phase identifier update_phase Update phase progress. 3 None Caret Right def update_phase(self, phase_id: str, current: int | None = None, current_item: str | None = None, **metadata: Any) -> None Update phase progress. Parameters 3 phase_id str Phase identifier current int | None Current progress count current_item str | None Current item being processed **metadata: Additional metadata to track complete_phase Mark phase as complete. 2 None Caret Right def complete_phase(self, phase_id: str, elapsed_ms: float | None = None) -> None Mark phase as complete. Parameters 2 phase_id str Phase identifier elapsed_ms float | None Total elapsed time in milliseconds (optional) fail_phase Mark phase as failed. 2 None Caret Right def fail_phase(self, phase_id: str, error: str) -> None Mark phase as failed. Parameters 2 phase_id str Phase identifier error str Error message Internal Methods 10 Caret Right __init__ Initialize live progress manager. 3 None Caret Right def __init__(self, profile: BuildProfile, console: Console | None = None, enabled: bool = True) Initialize live progress manager. Parameters 3 profile BuildProfile Build profile (Writer/Theme-Dev/Developer) console Console | None Rich console instance (creates one if not provided) enabled bool Whether live progress is enabled __enter__ Enter context manager. 0 LiveProgressManager Caret Right def __enter__(self) -> LiveProgressManager Enter context manager. Returns LiveProgressManager __exit__ Exit context manager. 3 None Caret Right def __exit__(self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: TracebackType | None) -> None Exit context manager. Parameters 3 exc_type type[BaseException] | None exc_val BaseException | None exc_tb TracebackType | None _update_display Update the live display or print fallback. 1 None Caret Right def _update_display(self, force: bool = False) -> None Update the live display or print fallback. Parameters 1 force bool _render Render the progress display based on profile. 0 RenderableType Caret Right def _render(self) -> RenderableType Render the progress display based on profile. Returns RenderableType _render_writer Compact display for writers. Shows: phase name, progress bar, current count, c… 0 RenderableType Caret Right def _render_writer(self) -> RenderableType Compact display for writers. Shows: phase name, progress bar, current count, current item Returns RenderableType _render_theme_dev Detailed display with recent items for theme developers. Shows: progress bar, … 0 RenderableType Caret Right def _render_theme_dev(self) -> RenderableType Detailed display with recent items for theme developers. Shows: progress bar, recent items, elapsed time Returns RenderableType _render_developer Full observability display for developers. Shows: all phases, metrics, perform… 0 RenderableType Caret Right def _render_developer(self) -> RenderableType Full observability display for developers. Shows: all phases, metrics, performance stats Returns RenderableType _get_status_icon Get icon for phase status. 1 str Caret Right def _get_status_icon(self, status: PhaseStatus) -> str Get icon for phase status. Parameters 1 status PhaseStatus Returns str _print_fallback Fallback for non-TTY environments (CI, redirected output). Prints traditional … 0 None Caret Right def _print_fallback(self) -> None Fallback for non-TTY environments (CI, redirected output). Prints traditional sequential output with minimal updates. ← Previous js_bundler Next → logger 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: 1648 - Reading Time: 8 minutes