[py] Adding Note to enable_webextensions() regarding CDP (plus gen docstring updates)

[shbenzer]

User description

🔗 Related Issues

Adds docstring discussed in #15794

💥 What does this PR do?

Adds docstring discussed in #15794 and makes general docstring QOL upgrades

🔄 Types of changes

• Cleanup (formatting, renaming)

---

PR Type

Documentation

---

Description

• Standardized docstring format from :Args: to Parameters: section

• Added important CDP limitation note to enable_webextensions() method

• Enhanced docstring formatting and structure consistency

---

Changes walkthrough 📝

	Relevant files
Documentation	options.py Standardize docstrings and add CDP warning                              py/selenium/webdriver/chromium/options.py Converted all :Args: sections to standardized Parameters: format Added detailed note about CDP limitations when webextensions enabled Improved docstring formatting and structure consistency Enhanced return value documentation format +34/-19

---

Need help?

Type /help how to ... in the comments thread for any questions about Qodo Merge usage.

Check out the documentation for more information.

[qodo-merge-pro]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Documentation Inconsistency The add_experimental_option method docstring lacks the standardized Parameters: section header while other methods have been updated to use this format. This creates inconsistency in the documentation style. def add_experimental_option(self, name: str, value: Union[str, int, dict, list[str]]) -> None: """Adds an experimental option which is passed to chromium. Parameters: ---------- name: The experimental option name. value: The option value. """ self._experimental_options[name] = value Missing Docstring The getter property enable_webextensions has an incomplete docstring that only contains the return description but lacks proper formatting and structure compared to other methods in the file. """:Returns: Whether webextension support is enabled for Chromium-based browsers. True if webextension support is enabled, False otherwise. """ return self._enable_webextensions

[qodo-merge-pro]

PR Code Suggestions ✨

No code suggestions found for the PR.

[shbenzer]

@cgoldberg new format script is great, nice job

[cgoldberg]

LGTM, but we should also improve the error that is raised when this situation occurs.

In py/selenium/webdriver/remote/webdriver.py, in the _get_cdp_details method, you can change this:

        if self.caps.get("browserName") == "chrome":
            debugger_address = self.caps.get("goog:chromeOptions").get("debuggerAddress")
        elif self.caps.get("browserName") == "MicrosoftEdge":
            debugger_address = self.caps.get("ms:edgeOptions").get("debuggerAddress")

to something like this:

        try:
            if self.caps.get("browserName") == "chrome":
                debugger_address = self.caps.get("goog:chromeOptions").get("debuggerAddress")
            elif self.caps.get("browserName") == "MicrosoftEdge":
                debugger_address = self.caps.get("ms:edgeOptions").get("debuggerAddress")
        except AttributeError:
            raise WebDriverException("Can't get debugger address.")

This will raise the exception if you try start_devtools() or bidi_connection().

[shbenzer]

Test failure appears unrelated as changes were only made to Remote webdriver and docstrings

[navin772]

LGTM!

[cgoldberg]

LGTM