mxi=9UdZddlmZddlZddlmZmZmZmZddl m Z er ddl m Z ddl mZe eZded <Gd d eZGd d Zy)aComponent file watching utilities. This module provides the `ComponentFileWatcher`, a utility that watches component asset directories for changes and notifies a caller-provided callback with the affected component names. It abstracts the underlying path-watcher implementation and ensures exception-safe startup and cleanup. Why this exists --------------- Streamlit supports advanced Custom Components that ship a package of static assets (for example, a Vite/Webpack build output). While a user develops their app, those frontend files may change. The component registry for Custom Components v2 must stay synchronized with the on-disk assets so that the server can resolve the up-to-date files. This watcher exists to keep the registry in sync by listening for changes in component asset roots and notifying a higher-level manager that can re-resolve the affected component definitions. Notes ----- - Watching is directory-based with a recursive glob ("**/*"). - Common noisy directories (e.g., ``node_modules``) are ignored in callbacks. - Startup is exception-safe and does not leak partially created watchers. See Also -------- - :class:`streamlit.watcher.local_sources_watcher.LocalSourcesWatcher` - watches app source files per session to trigger reruns. - :class:`streamlit.components.v2.component_registry.BidiComponentRegistry` - the server-side store of Custom Component v2 definitions that reacts to watcher notifications. ) annotationsN) TYPE_CHECKINGFinalProtocolcast) get_logger)CallablePathr_LOGGERceZdZddZy) _HasClosecyNselfs e/home/htdocs/ttos/venv/lib/python3.12/site-packages/streamlit/components/v2/component_file_watcher.pyclosez_HasClose.closeBsNreturnNone)__name__ __module__ __qualname__rrrrrrAs rrceZdZdZddZeddZddZddZddZ ddZ ddZ dd Z dd Z dd Zdd Zdd ZddZy)ComponentFileWatchera#Handle file watching for component asset directories. Parameters ---------- component_update_callback : Callable[[list[str]], None] Callback invoked when files change under any watched directory. It receives a list of component names affected by the change. c||_tj|_i|_g|_d|_i|_d|_y)aInitialize the file watcher. Parameters ---------- component_update_callback : Callable[[list[str]], None] Callback function to call when components under watched roots change. Signature: (affected_component_names) F) __pycache__z.cachez.gitz.hgz .mypy_cachez .pytest_cachez .ruff_cachez.svnz.swcz.yarncoverage node_modulesvenvN) _component_update_callback threadingLock_lock_watched_directories_path_watchers_watching_active_asset_watch_roots _ignored_dirs)rcomponent_update_callbacks r__init__zComponentFileWatcher.__init__OsN+D'^^%  !02 %46/ rc|jS)zCheck if file watching is currently active. Returns ------- bool True if file watching is active, False otherwise )r*rs ris_watching_activez'ComponentFileWatcher.is_watching_activevs$$$rcF|j|j|y)a{Start file watching for asset roots. Parameters ---------- asset_watch_roots : dict[str, Path] Mapping of component names to asset root directories to watch. Notes ----- The method is idempotent: it stops any active watchers first, then re-initializes watchers for the provided ``asset_watch_roots``. N)stop_file_watching_start_file_watching)rasset_watch_rootss rstart_file_watchingz(ComponentFileWatcher.start_file_watchings ! !!"34rc|j5|js dddy|jD]} |j|jj|jj|jjd|_t jddddy#t$rt j dYwxYw#1swYyxYw)zStop file watching and clean up watchers. Notes ----- This method is safe to call multiple times and will no-op if watching is not active. NzFailed to close path watcherFz,Stopped file watching for component registry) r'r*r)r Exceptionr exceptionclearr(r+debug)rwatchers rr2z'ComponentFileWatcher.stop_file_watchingsZZ J(( J J  .. FFMMO F    % % '  % % + + -  # # ) ) +$)D ! MMH I! J J!F%%&DEF J Js4CCB9A,C9CCCCC&c|j5|jr dddy|stjd dddy |j }| dddy|j |}|j ||\}}|r|j|||ntjddddy#t$rtjdY)wxYw#1swYyxYw)aInternal method to start file watching with the given roots. This method is exception-safe: in case of failures while creating watchers, any previously created watcher instances are closed and no internal state is committed. NzNo asset roots to watchz-No directories were watched; staying inactivezFailed to start file watching) r'r*r r:_get_default_path_watcher_class_prepare_directories_to_watch_build_watchers_for_directories_commit_watch_stater7r8)rr4path_watcher_classdirectories_to_watch new_watchersnew_watched_dirss rr3z)ComponentFileWatcher._start_file_watchingsZZ C$$ C C% 78  C C C%)%I%I%K"%- C C(,'I'I%($261U1U&(<2. .  ,,$&68IMM"QR9 C C: C!!"AB C; C Cs5C C B<"AB<<CC CC  C)cXddlm}m}|}||urtj dy|S)a Return the default path watcher class. Returns ------- type | None The concrete path watcher class to instantiate, or ``None`` if the NoOp watcher is configured and file watching should be skipped. r)NoOpPathWatcherget_default_path_watcher_classz8NoOpPathWatcher in use; skipping component file watchingN)streamlit.watcher.path_watcherrFrGr r:)rrFrGrAs rr=z4ComponentFileWatcher._get_default_path_watcher_classs0 <=  0 MMT U!!rci}|jD]C\}}t|j}||vrg||<|||vs0||j|E|S)aBuild a mapping of directory to component names. Parameters ---------- asset_watch_roots : dict[str, Path] Mapping of component names to their asset root directories. Returns ------- dict[str, list[str]] A map from absolute directory path to a deduplicated list of component names contained in that directory. )itemsstrresolveappend)rr4rB comp_nameroot directorys rr>z2ComponentFileWatcher._prepare_directories_to_watchsu 680668 BOItDLLN+I 4424$Y/ 4Y ??$Y/66yA  B $#rc<g}i}|jD]c\}} |jt|}|||dd}|jt d||||<t j d||e||fS#t$r|j|wxYw)aCreate watchers for directories with rollback on failure. Parameters ---------- path_watcher_class : type The path watcher class to instantiate for each directory. directories_to_watch : dict[str, list[str]] A map of directory to the associated component name list. Returns ------- tuple[list[_HasClose], dict[str, list[str]]] The list of created watcher instances and the watched directory mapping. Raises ------ Exception Propagates any exception during watcher creation after closing already-created watchers. z**/*F) glob_patternallow_nonexistentrz2Prepared watcher for directory %s (components: %s)) rJ_make_directory_callbacktuplerMrr r:r7_rollback_watchers) rrArBrCrDrPcomponent_namescbr;s rr?z4ComponentFileWatcher._build_watchers_for_directoriess0)+ 13*>*D*D*F  &I 2253IJ-!'&+  ##Dg$>?.= + H# .---  '' 5 s AA??Bc||_||_t||_d|_t j dt|jy)aCommit created watchers and mark watching active. Parameters ---------- new_watchers : list[_HasClose] Fully initialized watcher instances. new_watched_dirs : dict[str, list[str]] Mapping from directory to component names. asset_watch_roots : dict[str, Path] The asset roots used to initialize watchers; stored for reference. Tz(Started file watching for %d directoriesN)r)r(dictr+r*r r:len)rrCrDr4s rr@z(ComponentFileWatcher._commit_watch_state6sF"+$4!"&'8"9 $ 6D.callback`sL,,\: F U MMH   ) )$u+ 6r)rdrKrrr)rrerfs`` rrTz-ComponentFileWatcher._make_directory_callback]s 7rc|jsy |j|y#t$rtj dYywxYw)zHandle component changes for both directory and file events. Parameters ---------- affected_components : list[str] List of component names affected by the change Nz Component update callback raised)r*r$r7r r8)raffected_componentss rrbz-ComponentFileWatcher._handle_component_changemsE$$  B  + +,? @ B   @ A Bs!AAc ddlm}t||jjt fd|j DS#t$rYywxYw)aeReturn True if the changed path is inside an ignored directory. Parameters ---------- changed_path : str The filesystem path that triggered the change event. Returns ------- bool True if the path is located inside one of the ignored directories, False otherwise. rr c3&K|]}|v ywrr).0ignoredpartss r z@ComponentFileWatcher._is_in_ignored_directory..sJGw%'JsF)pathlibr setrLrmanyr,r7)rrd_Pathrms @rraz-ComponentFileWatcher._is_in_ignored_directorysR  -l+335;;r?r@rVrTrbrarrrrrEs% N%%5$J4%CN"*$!0$ $22."&2.>R2. 52.h % / +    2 R B$rr)rx __future__rr%typingrrrrstreamlit.loggerrcollections.abcr ror rr __annotations__rrrrrrsN D#77'(H%%!!NNr