Make file watcher more error-resistant #11841
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
🎉 Snyk checks have passed. No issues have been found so far.✅ security/snyk check is complete. No issues have been found. (View Details) ✅ license/snyk check is complete. No issues have been found. (View Details) |
Contributor
✅ PR preview is ready!
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the file-watching logic by normalizing paths with os.path.realpath, improving error handling in watcher registration and path-change events, and updating tests to accommodate full path comparisons.
- Switched from
os.path.abspathtoos.path.realpathacross watcher implementations for consistent path normalization. - Wrapped watcher scheduling and MD5 computation in broader exception handling with logged warnings.
- Adjusted tests to match substrings in full paths rather than exact filenames.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| lib/tests/streamlit/watcher/local_sources_watcher_test.py | Updated assertions to use substring checks for full paths. |
| lib/streamlit/watcher/util.py | Added a blank line before retry loop in _do_with_retries. |
| lib/streamlit/watcher/local_sources_watcher.py | Replaced abspath with realpath and improved exception logging. |
| lib/streamlit/watcher/event_based_path_watcher.py | Switched to realpath, ignored editor backup files, and added exception handling in scheduling and MD5 calc. |
Comments suppressed due to low confidence (1)
Contributor
📉 Python coverage change detectedThe Python unit test coverage has decreased by 0.0508%
💡 Consider adding more unit tests to maintain or improve coverage. Coverage by files
|
lukasmasuch
added a commit
that referenced
this pull request
Jul 9, 2025
## Describe your changes Follow-up to #11841 to improve the exception handling. The changes in #11841 can create some confusing logs and catch unrelated exceptions (e.g. runtime errors when the runtime shuts down). ## Testing Plan - This is mainly about logging and doesn't have any functional impact. --- **Contribution License Agreement** By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your changes
Applies a couple of improvements to the file watcher to make it more error-resistant.
GitHub Issue Link (if applicable)
File changed in watched directorylog while the file has not changed #11809Testing Plan
Contribution License Agreement
By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.