Activate rules to prevent exception handling anti-patterns#11282
Merged
lukasmasuch merged 4 commits intodevelopfrom May 6, 2025
Merged
Activate rules to prevent exception handling anti-patterns#11282lukasmasuch merged 4 commits intodevelopfrom
lukasmasuch merged 4 commits intodevelopfrom
Conversation
lukasmasuch
changed the title
Contributor
✅ PR preview is ready!
|
lukasmasuch
added
security-assessment-completed
change:other
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
sfc-gh-lmasuch
changed the title
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR activates additional linting rules aimed at preventing exception handling anti‐patterns throughout the codebase. Key changes include switching from _LOGGER.error to _LOGGER.exception for improved logging of exceptions, standardizing exception types (e.g. using RuntimeError or TypeError), and updating linter configurations in .ruff.toml.
- Updated logging calls across multiple server and connection modules.
- Revised exception raises to use more specific exception types.
- Refined linter ignore settings in .ruff.toml to enforce the new TRY lint rules.
Reviewed Changes
Copilot reviewed 29 out of 29 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| lib/streamlit/web/server/media_file_handler.py | Changed logging from _LOGGER.error to _LOGGER.exception for missing file errors. |
| lib/streamlit/web/server/component_request_handler.py | Updated exception logging and error sanitization during file read errors. |
| lib/streamlit/web/server/browser_websocket_handler.py | Replaced RuntimeError with TypeError for incorrect message payload types. |
| lib/streamlit/web/bootstrap.py | Switched error logging to _LOGGER.exception when loading secrets. |
| lib/streamlit/runtime/scriptrunner/script_runner.py | Updated exception type from Exception to RuntimeError and simplified re-raising exceptions. |
| lib/streamlit/runtime/caching/storage/cache_storage_protocol.py | Renamed InvalidCacheStorageContext to InvalidCacheStorageContextError. |
| lib/streamlit/connections/snowflake_connection.py | Adjusted exception handling for Snowflake connection errors. |
| .ruff.toml | Added new TRY lint rules and updated per-file ignore patterns to accommodate them. |
Comments suppressed due to low confidence (3)
lib/streamlit/web/server/media_file_handler.py:90
- Ensure that using _LOGGER.exception here provides sufficient context for troubleshooting without exposing sensitive internal details. Verify that logging the full stack trace is appropriate for the production environment.
_LOGGER.exception("MediaFileHandler: Missing file %s", absolute_path)
lib/streamlit/web/server/browser_websocket_handler.py:215
- Ensure that replacing RuntimeError with TypeError accurately reflects the type-checking failure and that the exception message clearly indicates that string messages are not supported.
raise TypeError( # noqa: TRY301
.ruff.toml:122
- [nitpick] Review and update the .ruff.toml configuration to ensure that the new TRY lint rules integrate well with existing exception logging patterns and do not cause unintended false positives.
"TRY003", # Checks for exception messages that are not defined in the exception class itself.
Contributor
📉 Python coverage change detectedThe Python unit test coverage has decreased by 0.0330%
💡 Consider adding more unit tests to maintain or improve coverage. Coverage by files
|
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) |
sfc-gh-bnisco
approved these changes
May 6, 2025
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
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
Activates linting rules to prevent exception handling anti-patterns in Python:
Contribution License Agreement
By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.