[py] fixed a bug in bidi/session.py by removing mutable object as default value for function argument.

[sandeepsuryaprasad]

User description

Thanks for contributing to Selenium!
A PR well described will help maintainers to quickly review and merge it

Before submitting your PR, please check our contributing guidelines.
Avoid large PRs, help reviewers by making them as simple and short as possible.

Description

• Generally it is not a good idea to have mutable objects as default values for function arguments.
• In functions session_subscribe and session_unsubscribe, the function parameter browsing_contexts had a mutable object as default value.
• In this PR I have defaulted browsing_contexts to None as default value to the parameter.

Motivation and Context

It is not recommended/safe to assign mutable objects as default values for function parameters.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• I have read the contributing document.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.
• All new and existing tests passed.

---

PR Type

Bug fix, Enhancement

---

Description

• Fixed a bug in bidi/session.py by changing the default value of the browsing_contexts parameter to None in the session_subscribe and session_unsubscribe functions to avoid using mutable objects as default values.
• Added checks to initialize browsing_contexts as an empty list if it is None in the session_subscribe and session_unsubscribe functions.
• Fixed linting issues in support/relative_locator.py by adjusting the formatting of @overload method definitions.

---

Changes walkthrough 📝

	Relevant files
Bug fix	session.py Fix mutable default argument in session_subscribe and session_unsubscribe py/selenium/webdriver/common/bidi/session.py Changed default value of browsing_contexts parameter to None in session_subscribe and session_unsubscribe functions. Added checks to initialize browsing_contexts as an empty list if it is None. +6/-2
Enhancement	relative_locator.py Fix linting issues in `relative_locator.py`                            py/selenium/webdriver/support/relative_locator.py Fixed linting issues by adjusting the formatting of @overload method definitions. +20/-10

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[codiumai-pr-agent-pro]

PR Reviewer Guide 🔍

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review Code Improvement The change from a mutable default argument to None with a conditional initialization to an empty list is a good practice to avoid potential bugs related to mutable default arguments. Code Improvement Similar to the previous function, this change also improves the function definition by removing a mutable default argument.

[codiumai-pr-agent-pro]

PR Code Suggestions ✨

Category	Suggestion	Score
Possible issue	Add validation for the distance parameter to ensure it is non-negative For the near method, consider validating the distance parameter to ensure it is a non-negative integer. This validation can prevent runtime errors and enforce that the distance parameter adheres to expected values. py/selenium/webdriver/support/relative_locator.py [171] def near(self, element_or_locator: Union[WebElement, LocatorType], distance: int = 50) -> "RelativeBy": + if not isinstance(distance, int) or distance < 0: + raise ValueError("Distance must be a non-negative integer") Apply this suggestion Suggestion importance[1-10]: 9 Why: Adding validation for the distance parameter is a crucial improvement that prevents potential runtime errors and ensures the parameter adheres to expected values.	9
Best practice	Use immutable default arguments where possible To avoid potential issues with mutable default arguments, consider using a tuple for events if the function does not modify this parameter. This change ensures that the default argument is not only immutable but also safe from unintended side-effects. py/selenium/webdriver/common/bidi/session.py [19] -def session_subscribe(*events, browsing_contexts=None): +def session_subscribe(*events: tuple, browsing_contexts=None): Apply this suggestion Suggestion importance[1-10]: 7 Why: Using a tuple for events ensures immutability and avoids potential issues with mutable default arguments. However, it is a minor improvement since the function does not modify events.	7
Maintainability	Simplify method overloads by removing redundant default None The above method's overload can be simplified by removing the unnecessary None default for element_or_locator in the second overload, as it does not add value and the main method already handles None as a default. py/selenium/webdriver/support/relative_locator.py [95] -def above(self, element_or_locator: None = None) -> "NoReturn": +def above(self, element_or_locator: None) -> "NoReturn": Apply this suggestion Suggestion importance[1-10]: 5 Why: Removing the redundant default None simplifies the overload but does not significantly impact functionality or readability.	5

[sandeepsuryaprasad]

@diemol can you please trigger the workflow for this PR as well. Thanks!

[sandeepsuryaprasad]

@diemol can you please trigger the workflow for this PR..

[sandeepsuryaprasad]

@diemol @AutomatedTester @titusfortner @pujagani can someone trigger the workflow for this PR please.. it's been more than couple of months since I raised it.. Thanks!