[py] Type event firing script execution results#17536
Open
adamtheturtle wants to merge 1 commit into
Open
Conversation
Member
|
Thank you, @adamtheturtle for this code suggestion. The support packages contain example code that many users find helpful, but they do not necessarily represent After reviewing the change, unless it is a critical fix or a feature that is needed for Selenium We actively encourage people to add the wrapper and helper code that makes sense for them to their own frameworks. |
Contributor
Review Summary by QodoAdd return type annotations to event firing script methods
WalkthroughsDescription• Add explicit Any return type annotations to script execution methods • Align EventFiringWebDriver type hints with base WebDriver API • Add missing type hint for script parameter in execute_async_script Diagramflowchart LR
A["EventFiringWebDriver methods"] -- "Add Any return type" --> B["execute_script"]
A -- "Add Any return type + script type hint" --> C["execute_async_script"]
B -- "Match base WebDriver API" --> D["Type consistency"]
C -- "Match base WebDriver API" --> D
File Changes1. py/selenium/webdriver/support/event_firing_webdriver.py
|
Contributor
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.
Summary
Add explicit
Anyreturn annotations toEventFiringWebDriver.execute_scriptandexecute_async_script.Details
The wrapped
WebDrivermethods return arbitrary JavaScript result values, not only dictionaries. The baseWebDrivermethods are already annotated as returningAny; this updates the event-firing wrapper to match that public API and avoid untyped wrapper methods.Validation
uv run --with ruff ruff check --config py/pyproject.toml py/selenium/webdriver/support/event_firing_webdriver.pypython3 -m compileall -q py/selenium/webdriver/support/event_firing_webdriver.py