refactor: update parameter documentation to use 'Args' format for consistency across multiple classes

iampopovich · iampopovich · commit a14f153c1e66 · 2025-10-26T06:25:27.000+07:00
diff --git a/py/selenium/webdriver/common/bidi/permissions.py b/py/selenium/webdriver/common/bidi/permissions.py
@@ -55,16 +55,14 @@ def set_permission(
     ) -> None:
         """Sets a permission state for a given permission descriptor.
 
-        Parameters:
-        -----------
+        Args:
             descriptor: The permission name (str) or PermissionDescriptor object.
-                       Examples: "geolocation", "camera", "microphone"
+              Examples: "geolocation", "camera", "microphone".
             state: The permission state (granted, denied, prompt).
             origin: The origin for which the permission is set.
             user_context: The user context id (optional).
 
         Raises:
-        ------
             ValueError: If the permission state is invalid.
         """
         if state not in [PermissionState.GRANTED, PermissionState.DENIED, PermissionState.PROMPT]:
diff --git a/py/selenium/webdriver/common/bidi/session.py b/py/selenium/webdriver/common/bidi/session.py
@@ -44,18 +44,16 @@ def __init__(
     ):
         """Initialize UserPromptHandler.
 
-        Parameters:
-        -----------
-            alert: Handler type for alert prompts
-            before_unload: Handler type for beforeUnload prompts
-            confirm: Handler type for confirm prompts
-            default: Default handler type for all prompts
-            file: Handler type for file picker prompts
-            prompt: Handler type for prompt dialogs
+        Args:
+            alert: Handler type for alert prompts.
+            before_unload: Handler type for beforeUnload prompts.
+            confirm: Handler type for confirm prompts.
+            default: Default handler type for all prompts.
+            file: Handler type for file picker prompts.
+            prompt: Handler type for prompt dialogs.
 
         Raises:
-        ------
-            ValueError: If any handler type is not valid
+            ValueError: If any handler type is not valid.
         """
         for field_name, value in [
             ("alert", alert),
@@ -81,8 +79,7 @@ def to_dict(self) -> dict[str, str]:
         """Convert the UserPromptHandler to a dictionary for BiDi protocol.
 
         Returns:
-        -------
-            Dict[str, str]: Dictionary representation suitable for BiDi protocol
+            Dictionary representation suitable for BiDi protocol.
         """
         field_mapping = {
             "alert": "alert",
@@ -126,14 +123,13 @@ def unsubscribe(self, *events, browsing_contexts=None):
         return command_builder("session.unsubscribe", params)
 
     def status(self):
-        """
-        The session.status command returns information about the remote end's readiness
-        to create new sessions and may include implementation-specific metadata.
+        """The session.status command returns information about the remote end's readiness.
+
+        Returns information about the remote end's readiness to create new sessions
+        and may include implementation-specific metadata.
 
-        Returns
-        -------
-        dict
-            Dictionary containing the ready state (bool), message (str) and metadata
+        Returns:
+            Dictionary containing the ready state (bool), message (str) and metadata.
         """
         cmd = command_builder("session.status", {})
         return self.conn.execute(cmd)
diff --git a/py/selenium/webdriver/common/bidi/storage.py b/py/selenium/webdriver/common/bidi/storage.py
@@ -43,8 +43,7 @@ def to_dict(self) -> dict:
         """Converts the BytesValue to a dictionary.
 
         Returns:
-        -------
-            Dict: A dictionary representation of the BytesValue.
+            A dictionary representation of the BytesValue.
         """
         return {"type": self.type, "value": self.value}
 
@@ -78,13 +77,11 @@ def __init__(
     def from_dict(cls, data: dict) -> "Cookie":
         """Creates a Cookie instance from a dictionary.
 
-        Parameters:
-        -----------
+        Args:
             data: A dictionary containing the cookie information.
 
         Returns:
-        -------
-            Cookie: A new instance of Cookie.
+            A new instance of Cookie.
         """
         # Validation for empty strings
         name = data.get("name")
@@ -137,8 +134,7 @@ def to_dict(self) -> dict[str, Any]:
         """Converts the CookieFilter to a dictionary.
 
         Returns:
-        -------
-            Dict: A dictionary representation of the CookieFilter.
+            A dictionary representation of the CookieFilter.
         """
         result: dict[str, Any] = {}
         if self.name is not None:
@@ -173,13 +169,11 @@ def __init__(self, user_context: Optional[str] = None, source_origin: Optional[s
     def from_dict(cls, data: dict) -> "PartitionKey":
         """Creates a PartitionKey instance from a dictionary.
 
-        Parameters:
-        -----------
+        Args:
             data: A dictionary containing the partition key information.
 
         Returns:
-        -------
-            PartitionKey: A new instance of PartitionKey.
+            A new instance of PartitionKey.
         """
         return cls(
             user_context=data.get("userContext"),
@@ -198,7 +192,6 @@ def to_dict(self) -> dict:
         """Converts the BrowsingContextPartitionDescriptor to a dictionary.
 
         Returns:
-        -------
             Dict: A dictionary representation of the BrowsingContextPartitionDescriptor.
         """
         return {"type": self.type, "context": self.context}
@@ -216,7 +209,6 @@ def to_dict(self) -> dict:
         """Converts the StorageKeyPartitionDescriptor to a dictionary.
 
         Returns:
-        -------
             Dict: A dictionary representation of the StorageKeyPartitionDescriptor.
         """
         result = {"type": self.type}
@@ -286,13 +278,11 @@ def __init__(self, cookies: list[Cookie], partition_key: PartitionKey):
     def from_dict(cls, data: dict) -> "GetCookiesResult":
         """Creates a GetCookiesResult instance from a dictionary.
 
-        Parameters:
-        -----------
+        Args:
             data: A dictionary containing the get cookies result information.
 
         Returns:
-        -------
-            GetCookiesResult: A new instance of GetCookiesResult.
+            A new instance of GetCookiesResult.
         """
         cookies = [Cookie.from_dict(cookie) for cookie in data.get("cookies", [])]
         partition_key = PartitionKey.from_dict(data.get("partitionKey", {}))
@@ -309,13 +299,11 @@ def __init__(self, partition_key: PartitionKey):
     def from_dict(cls, data: dict) -> "SetCookieResult":
         """Creates a SetCookieResult instance from a dictionary.
 
-        Parameters:
-        -----------
+        Args:
             data: A dictionary containing the set cookie result information.
 
         Returns:
-        -------
-            SetCookieResult: A new instance of SetCookieResult.
+            A new instance of SetCookieResult.
         """
         partition_key = PartitionKey.from_dict(data.get("partitionKey", {}))
         return cls(partition_key=partition_key)
@@ -331,13 +319,11 @@ def __init__(self, partition_key: PartitionKey):
     def from_dict(cls, data: dict) -> "DeleteCookiesResult":
         """Creates a DeleteCookiesResult instance from a dictionary.
 
-        Parameters:
-        -----------
+        Args:
             data: A dictionary containing the delete cookies result information.
 
         Returns:
-        -------
-            DeleteCookiesResult: A new instance of DeleteCookiesResult.
+            A new instance of DeleteCookiesResult.
         """
         partition_key = PartitionKey.from_dict(data.get("partitionKey", {}))
         return cls(partition_key=partition_key)
@@ -354,16 +340,20 @@ def get_cookies(
         filter: Optional[CookieFilter] = None,
         partition: Optional[Union[BrowsingContextPartitionDescriptor, StorageKeyPartitionDescriptor]] = None,
     ) -> GetCookiesResult:
-        """Retrieves cookies that match the given parameters.
+        """Gets cookies matching the specified filter.
 
-        Parameters:
-        -----------
-            filter: Optional filter to match cookies.
-            partition: Optional partition descriptor.
+        Args:
+            filter: Optional filter to specify which cookies to retrieve.
+            partition: Optional partition key to limit the scope of the operation.
 
         Returns:
-        -------
-            GetCookiesResult: The result of the get cookies command.
+            A GetCookiesResult containing the cookies and partition key.
+
+        Example:
+            result = await storage.get_cookies(
+                filter=CookieFilter(name="sessionId"),
+                partition=PartitionKey(...)
+            )
         """
         params = {}
         if filter is not None:
@@ -381,14 +371,12 @@ def set_cookie(
     ) -> SetCookieResult:
         """Sets a cookie in the browser.
 
-        Parameters:
-        -----------
+        Args:
             cookie: The cookie to set.
             partition: Optional partition descriptor.
 
         Returns:
-        -------
-            SetCookieResult: The result of the set cookie command.
+            The result of the set cookie command.
         """
         params = {"cookie": cookie.to_dict()}
         if partition is not None:
@@ -404,14 +392,12 @@ def delete_cookies(
     ) -> DeleteCookiesResult:
         """Deletes cookies that match the given parameters.
 
-        Parameters:
-        -----------
+        Args:
             filter: Optional filter to match cookies to delete.
             partition: Optional partition descriptor.
 
         Returns:
-        -------
-            DeleteCookiesResult: The result of the delete cookies command.
+            The result of the delete cookies command.
         """
         params = {}
         if filter is not None:
diff --git a/py/selenium/webdriver/common/bidi/webextension.py b/py/selenium/webdriver/common/bidi/webextension.py
@@ -34,15 +34,13 @@ def install(self, path=None, archive_path=None, base64_value=None) -> dict:
 
         You must provide exactly one of the parameters.
 
-        Parameters:
-        -----------
-            path: Path to an extension directory
-            archive_path: Path to an extension archive file
-            base64_value: Base64 encoded string of the extension archive
+        Args:
+            path: Path to an extension directory.
+            archive_path: Path to an extension archive file.
+            base64_value: Base64 encoded string of the extension archive.
 
         Returns:
-        -------
-            Dict: A dictionary containing the extension ID.
+            A dictionary containing the extension ID.
         """
         if sum(x is not None for x in (path, archive_path, base64_value)) != 1:
             raise ValueError("Exactly one of path, archive_path, or base64_value must be provided")
@@ -70,10 +68,9 @@ def install(self, path=None, archive_path=None, base64_value=None) -> dict:
     def uninstall(self, extension_id_or_result: Union[str, dict]) -> None:
         """Uninstalls a web extension from the remote end.
 
-        Parameters:
-        -----------
+        Args:
             extension_id_or_result: Either the extension ID as a string or the result dictionary
-                                   from a previous install() call containing the extension ID.
+              from a previous install() call containing the extension ID.
         """
         if isinstance(extension_id_or_result, dict):
             extension_id = extension_id_or_result.get("extension")
diff --git a/py/selenium/webdriver/common/options.py b/py/selenium/webdriver/common/options.py
@@ -201,7 +201,7 @@ class BaseOptions(metaclass=ABCMeta):
         bool when getting, None when setting.
     """
 
-    strict_file_interactability : o = _BaseOptionsDescriptor("strictFileInteractability")
+    strict_file_interactability = _BaseOptionsDescriptor("strictFileInteractability")
     """Gets and Sets whether session is about file interactability.
 
     Usage:
