Skip to content

Commit 09e0c59

Browse files
committed
remove duplicated args
1 parent c658460 commit 09e0c59

File tree

3 files changed

+43
-10
lines changed

3 files changed

+43
-10
lines changed

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,35 @@ For example, some changes in the Selenium binding could break the Appium client.
5858
> to keep compatible version combinations.
5959

6060

61+
### Quick migration guide from v4 to v5
62+
- Please use `AppiumClientConfig` as `client_config` arguemnt in favor of client arguments below
63+
- `keep_alive`, `direct_connection` and `strict_ssl` arguments.
64+
```python
65+
SERVER_URL_BASE = 'http://127.0.0.1:4723'
66+
# before
67+
driver = webdriver.Remote(
68+
SERVER_URL_BASE,
69+
options=UiAutomator2Options().load_capabilities(desired_caps),
70+
direct_connection=True,
71+
keep_alive=False,
72+
strict_ssl=False
73+
)
74+
75+
# after
76+
from appium.webdriver.client_config import AppiumClientConfig
77+
client_config = AppiumClientConfig(
78+
remote_server_addr=SERVER_URL_BASE,
79+
direct_connection=True,
80+
keep_alive=False,
81+
ignore_certificates=True,
82+
)
83+
driver = webdriver.Remote(
84+
SERVER_URL_BASE,
85+
options=UiAutomator2Options().load_capabilities(desired_caps),
86+
client_config=client_config
87+
)
88+
```
89+
6190
### Quick migration guide from v3 to v4
6291
- Removal
6392
- `MultiAction` and `TouchAction` are removed. Please use W3C WebDriver actions or `mobile:` extensions
@@ -273,6 +302,7 @@ from appium import webdriver
273302
# If you use an older client then switch to desired_capabilities
274303
# instead: https://github.com/appium/python-client/pull/720
275304
from appium.options.ios import XCUITestOptions
305+
from appium.webdriver.client_config import AppiumClientConfig
276306
277307
# load_capabilities API could be used to
278308
# load options mapping stored in a dictionary
@@ -282,11 +312,16 @@ options = XCUITestOptions().load_capabilities({
282312
'app': '/full/path/to/app/UICatalog.app.zip',
283313
})
284314
315+
client_config = AppiumClientConfig(
316+
remote_server_addr='http://127.0.0.1:4723',
317+
direct_connection=True
318+
)
319+
285320
driver = webdriver.Remote(
286321
# Appium1 points to http://127.0.0.1:4723/wd/hub by default
287322
'http://127.0.0.1:4723',
288323
options=options,
289-
direct_connection=True
324+
client_config=client_config
290325
)
291326
```
292327

appium/webdriver/client_config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
from selenium.webdriver.remote.client_config import ClientConfig
1414

1515

16-
class AppiumClientConfg(ClientConfig):
16+
class AppiumClientConfig(ClientConfig):
1717
def __init__(self, remote_server_addr: str, *args, **kwargs):
1818
self._direct_connection = kwargs.pop('direct_connection', False)
1919
super().__init__(remote_server_addr, *args, **kwargs)

appium/webdriver/webdriver.py

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
from appium.webdriver.common.appiumby import AppiumBy
3232

3333
from .appium_connection import AppiumConnection
34-
from .client_config import AppiumClientConfg
34+
from .client_config import AppiumClientConfig
3535
from .errorhandler import MobileErrorHandler
3636
from .extensions.action_helpers import ActionHelpers
3737
from .extensions.android.activities import Activities
@@ -204,17 +204,15 @@ class WebDriver(
204204
):
205205
def __init__( # noqa: PLR0913
206206
self,
207-
command_executor: Union[str, AppiumConnection] = 'http://127.0.0.1:4444/wd/hub',
207+
command_executor: Union[str, AppiumConnection] = 'http://127.0.0.1:4723',
208208
extensions: Optional[List['WebDriver']] = None,
209209
options: Union[AppiumOptions, List[AppiumOptions], None] = None,
210-
client_config: Optional[AppiumClientConfg] = None,
210+
client_config: Optional[AppiumClientConfig] = None,
211211
):
212-
if client_config is None:
213-
# TODO: when command_executor is not string
214-
client_config = AppiumClientConfg(remote_server_addr=command_executor)
215-
216212
if isinstance(command_executor, str):
217-
command_executor = AppiumConnection(remote_server_addr=command_executor, client_config=client_config)
213+
if client_config is None:
214+
client_config = AppiumClientConfig(remote_server_addr=command_executor)
215+
command_executor = AppiumConnection(client_config=client_config)
218216

219217
super().__init__(
220218
command_executor=command_executor,

0 commit comments

Comments
 (0)