You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Adds exception messages for errors which have an additional doc on the website for better troubleshooting.
🔄 Types of changes
New feature (non-breaking change which adds functionality and tests!)
PR Type
Enhancement
Description
• Add documentation URL support to Python exception classes
• Enhance error messages with troubleshooting links for better user experience
• Implement custom __init__ methods for five exception classes
Changes walkthrough 📝
Relevant files
Enhancement
exceptions.py
Enhanced exception classes with documentation URLs
py/selenium/common/exceptions.py
• Added custom init methods to five exception classes • Enhanced error messages with documentation URLs for troubleshooting • Implemented support message formatting with SUPPORT_MSG and ERROR_URL
• Modified ElementNotVisibleException, ElementNotInteractableException, ElementClickInterceptedException, InvalidSessionIdException, and SessionNotCreatedException
The code concatenates msg parameter with support message without checking if msg is None, which could result in error messages starting with "None;" when no message is provided
The code references SUPPORT_MSG and ERROR_URL constants that are not visible in the diff, need to verify these are properly defined and imported in the module
-with_support = f"{msg}; {SUPPORT_MSG} {ERROR_URL}#elementnotvisibleexception"+with_support = f"{msg or ''}; {SUPPORT_MSG} {ERROR_URL}#elementnotvisibleexception" if msg else f"{SUPPORT_MSG} {ERROR_URL}#elementnotvisibleexception"
Apply / Chat
Suggestion importance[1-10]: 6
__
Why: The suggestion correctly points out that if the msg parameter is None, the f-string formatting will result in an undesirable "None;" prefix in the error message. The proposed fix handles this case, improving the quality of the exception message.
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
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.
User description
💥 What does this PR do?
Adds exception messages for errors which have an additional doc on the website for better troubleshooting.
🔄 Types of changes
PR Type
Enhancement
Description
• Add documentation URL support to Python exception classes
• Enhance error messages with troubleshooting links for better user experience
• Implement custom
__init__methods for five exception classesChanges walkthrough 📝
exceptions.py
Enhanced exception classes with documentation URLspy/selenium/common/exceptions.py
• Added custom
initmethods to five exception classes• Enhanced
error messages with documentation URLs for troubleshooting
•
Implemented support message formatting with
SUPPORT_MSGandERROR_URL• Modified ElementNotVisibleException,
ElementNotInteractableException, ElementClickInterceptedException,
InvalidSessionIdException, and SessionNotCreatedException