feat: define AppiumClientConfig #1070

KazuCocoa · 2024-11-28T09:10:38Z

BREAKING CHANGE: Some of WebDriver.Remote constructor arguments were moved to AppiumClientConfig:

direct_connection
keep_alive
strict_ssl

https://github.com/SeleniumHQ/selenium/blob/trunk/py/selenium/webdriver/remote/client_config.py

testerxiaodong · 2025-02-21T19:35:19Z

When will this PR be merged?

README.md

mykola-mokhnach · 2025-03-02T21:50:55Z

appium/webdriver/webdriver.py

        options: Union[AppiumOptions, List[AppiumOptions], None] = None,
-        client_config: Optional[ClientConfig] = None,
+        client_config: Optional[AppiumClientConfig] = None,
    ):
        if isinstance(command_executor, str):


would it be possible to extract this logic into a separate method, so super class init would be the very first call there?

super class init would be the very first call there?

Actually we could by modifying here like below:

def __init__( self, command_executor: AppiumConnection, client_config: AppiumClientConfig, extensions: Optional[List['WebDriver']] = None, file_detector: Optional[FileDetector] = None, options: Union[AppiumOptions, List[AppiumOptions], None] = None, ):

Then, a new method will help to build client_config and command_executor.

To avoid handling string of command_executor in selenium, which uses ClientConfig, I have added these lines to keep using AppiumClientConfig as appium python client for such a string case (to keep providing similar syntax to webdriver.Remote for selenium and appium)

appium/webdriver/webdriver.py

…nto use-client-config

Copilot

Pull Request Overview

This PR introduces the new AppiumClientConfig to centralize client configuration while deprecating legacy direct connection arguments, which is a breaking change. Key changes include:

New file appium/webdriver/client_config.py defining the AppiumClientConfig.
Updates in tests and migration documentation to use the new client_config parameter.
Modifications in WebDriver initialization to integrate AppiumClientConfig for command executor creation.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File	Description
appium/webdriver/client_config.py	Introduces the new AppiumClientConfig class.
test/unit/webdriver/webdriver_test.py	Updates tests to use client_config instead of direct_connection.
README.md	Provides migration guide and updates examples for new config usage.
appium/webdriver/webdriver.py	Updates WebDriver and connection logic to integrate AppiumClientConfig.

Comments suppressed due to low confidence (1)

appium/webdriver/client_config.py:28

Consider rephrasing 'If enables' to 'If enabled' for grammatical correctness in the argument description.

            direct_connection: If enables [directConnect](https://github.com/appium/python-client?tab=readme-ov-file#direct-connect-urls) feature.

appium/webdriver/webdriver.py

README.md

test/unit/webdriver/webdriver_test.py

Co-authored-by: Copilot <[email protected]>

mykola-mokhnach · 2025-03-17T07:50:20Z

README.md

+        SERVER_URL_BASE = 'http://127.0.0.1:4723'
+        # before
+        driver = webdriver.Remote(
+            SERVER_URL_BASE,


I would still prefer to keep the url positional argument
I believe most of the clients have the remote client arguments defined as (url, options), so this change would require all of them to change the code, which is a major inconvenience.

upd: I can observe the below code supports such feature, so we just need to mention that in documents

Sounds good.

The ClinetConfig requires remote_server_addr https://github.com/SeleniumHQ/selenium/blob/dbf3daef5519b0a35a8408510854ec7766455c66/py/selenium/webdriver/remote/client_config.py#L80C9-L80C27 so current example is to reduce adding remote_server_addr to both, but actually current one will confuse users.

I'll add this.

mykola-mokhnach · 2025-03-17T07:51:55Z

appium/webdriver/webdriver.py

@@ -174,6 +174,27 @@ def add_command(self) -> Tuple[str, str]:
        raise NotImplementedError()


+def _get_remote_connection_and_client_config(
+    command_executor: Union[str, AppiumConnection], client_config: Optional[AppiumClientConfig]


should the optional value be assigned to None by default?

Either is fine. Just wanted to let the caller explicitly set both

appium/webdriver/webdriver.py

…nto use-client-config

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

mykola-mokhnach · 2025-03-19T11:37:31Z

README.md

@@ -59,6 +59,36 @@ For example, some changes in the Selenium binding could break the Appium client.
 > to keep compatible version combinations.


+### Quick migration guide from v4 to v5
+- This change affecs only for a user who speficies `keep_alive`, `direct_connection` and `strict_ssl` arguments for `webdriver.Remote`:


This change affects only user who specify ...

mykola-mokhnach · 2025-03-19T11:37:42Z

README.md

@@ -59,6 +59,36 @@ For example, some changes in the Selenium binding could break the Appium client.
 > to keep compatible version combinations.


+### Quick migration guide from v4 to v5
+- This change affecs only for a user who speficies `keep_alive`, `direct_connection` and `strict_ssl` arguments for `webdriver.Remote`:
+    - Please use `AppiumClientConfig` as `client_config` arguemnt as below:


typo arguemnt

as below -> similar to how it is specified below

mykola-mokhnach · 2025-03-19T11:41:46Z

README.md

+            client_config=client_config
+        )
+        ```
+        - Note that you can keep using `webdriver.Remote(url, options=options, client_config=client_config)` format as well. Then, the `remote_server_addr` in `AppiumClientConfig` will prior than the `url` specified via `webdriver.Remote`


Then, the ... -> In such case the remote_server_addr argument of AppiumClientConfig constructor would have priority over the url argument of webdriver.Remote constructor

mykola-mokhnach · 2025-03-19T11:44:09Z

appium/webdriver/webdriver.py

+    if client_config is None:
+        # Do not keep None to avoid warnings in Selenium
+        # which can prevent with ClientConfig instance usage.
+        client_config = AppiumClientConfig(remote_server_addr=command_executor)


would it be possible to do the same without reassigning method arguments?

KazuCocoa added 10 commits November 28, 2024 01:07

initial implementation

27cb0ca

remove

7823cd7

add appium/webdriver/client_config.py

ce1f243

Merge branch 'master' into use-client-config

d31812d

Merge branch 'master' into use-client-config

c658460

remove duplicated args

09e0c59

remove duplicated args

dd19cff

fix typo

3c1c02f

Merge branch 'master' into use-client-config

0fbbb8e

Merge branch 'master' into use-client-config

69f086e

KazuCocoa added 3 commits February 22, 2025 22:06

Merge branch 'master' into use-client-config

bf0c96a

add file_detector and remove redundant config

2aabd72

add test to check remote_server_addr priority

9569035

mykola-mokhnach reviewed Mar 2, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

mykola-mokhnach reviewed Mar 2, 2025

View reviewed changes

appium/webdriver/webdriver.py Outdated Show resolved Hide resolved

mykola-mokhnach reviewed Mar 2, 2025

View reviewed changes

appium/webdriver/webdriver.py Show resolved Hide resolved

KazuCocoa added 4 commits March 10, 2025 00:19

remove PLR0913, address http://127.0.0.1:4723

2bdbea8

update the readme

b7fdaa4

add comment

d52e243

fix typo

b06ed8e

KazuCocoa changed the title ~~[wip]: define AppiumClientConfig~~ feat: define AppiumClientConfig Mar 10, 2025

KazuCocoa added 5 commits March 10, 2025 00:26

Merge branch 'master' into use-client-config

671aa78

extract

64a6553

extract and followed the selenium

2b19e2e

Merge branch 'use-client-config' of github.com:appium/python-client i…

9262c78

…nto use-client-config

add comment

f56de0d

KazuCocoa marked this pull request as ready for review March 12, 2025 07:12

Merge branch 'master' into use-client-config

2a33f0d

Update webdriver.py

299f283

KazuCocoa requested a review from Copilot March 16, 2025 23:39

Copilot AI reviewed Mar 16, 2025

View reviewed changes

appium/webdriver/webdriver.py Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

test/unit/webdriver/webdriver_test.py Outdated Show resolved Hide resolved

Apply suggestions from code review

5bf6cc6

Co-authored-by: Copilot <[email protected]>

mykola-mokhnach reviewed Mar 17, 2025

View reviewed changes

appium/webdriver/webdriver.py Show resolved Hide resolved

KazuCocoa added 4 commits March 17, 2025 01:40

update readme

72b2e42

remove redundant command_executor check

8139b41

Merge branch 'use-client-config' of github.com:appium/python-client i…

7fc6113

…nto use-client-config

modify a bit

25b5af0

KazuCocoa requested a review from Copilot March 18, 2025 05:30

Copilot AI reviewed Mar 18, 2025

View reviewed changes

mykola-mokhnach approved these changes Mar 19, 2025

View reviewed changes

mykola-mokhnach reviewed Mar 19, 2025

View reviewed changes

KazuCocoa added 2 commits March 21, 2025 19:59

fix typo and apply comment

b727e1f

use new variable

f27054f

KazuCocoa merged commit 525d5b8 into master Mar 21, 2025
11 checks passed

KazuCocoa deleted the use-client-config branch March 21, 2025 15:41

feat: define AppiumClientConfig #1070

feat: define AppiumClientConfig #1070

Uh oh!

Conversation

KazuCocoa commented Nov 28, 2024 • edited by mykola-mokhnach Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

testerxiaodong commented Feb 21, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mykola-mokhnach Mar 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

KazuCocoa commented Nov 28, 2024 •

edited by mykola-mokhnach

Loading

mykola-mokhnach Mar 19, 2025 •

edited

Loading