docs: Update README with the new options format (appium#722)

mykola-mokhnach · web-flow · commit a2bba19360a6 · 2022-06-13T18:33:27.000+02:00
diff --git a/README.md b/README.md
@@ -104,37 +104,38 @@ environment:
 
 ```python
 # Android environment
-import unittest
 from appium import webdriver
+# Options are only available since client version 2.3.0
+# If you use an older client then switch to desired_capabilities
+# instead: https://github.com/appium/python-client/pull/720
+from appium.options.android import UiAutomator2Options
 from appium.webdriver.common.appiumby import AppiumBy
 
-desired_caps = dict(
-    platformName='Android',
-    platformVersion='10',
-    automationName='uiautomator2',
-    deviceName='Android Emulator',
-    app=PATH('../../../apps/selendroid-test-app.apk')
-)
-self.driver = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps)
+options = UiAutomator2Options().\
+    set_capability('platformVersion', '10').\
+    set_capability('deviceName', 'Android Emulator').\
+    set_capability('app', PATH('../../../apps/selendroid-test-app.apk'))
+# Appium1 points to http://127.0.0.1:4723/wd/hub by default 
+self.driver = webdriver.Remote('http://127.0.0.1:4723', options=options)
 el = self.driver.find_element(by=AppiumBy.ACCESSIBILITY_ID, value='item')
 el.click()
 ```
 
 ```python
 # iOS environment
-import unittest
 from appium import webdriver
+# Options are only available since client version 2.3.0
+# If you use an older client then switch to desired_capabilities
+# instead: https://github.com/appium/python-client/pull/720
+from appium.options.ios import XCUITestOptions
 from appium.webdriver.common.appiumby import AppiumBy
 
-desired_caps = dict(
-    platformName='iOS',
-    platformVersion='13.4',
-    automationName='xcuitest',
-    deviceName='iPhone Simulator',
-    app=PATH('../../apps/UICatalog.app.zip')
-)
-
-self.driver = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps)
+options = XCUITestOptions().\
+    set_capability('platformVersion', '13.4').\
+    set_capability('deviceName', 'iPhone Simulator').\
+    set_capability('app', PATH('../../apps/UICatalog.app.zip'))
+# Appium1 points to http://127.0.0.1:4723/wd/hub by default 
+self.driver = webdriver.Remote('http://127.0.0.1:4723', options=options)
 el = self.driver.find_element(by=AppiumBy.ACCESSIBILITY_ID, value='item')
 el.click()
 ```
@@ -151,37 +152,44 @@ If your Selenium/Appium server decorates the new session capabilities response w
 Then python client will switch its endpoint to the one specified by the values of those keys.
 
 ```python
-import unittest
 from appium import webdriver
-
-desired_caps = dict(
-    platformName='iOS',
-    platformVersion='13.4',
-    automationName='xcuitest',
-    deviceName='iPhone Simulator',
-    app=PATH('../../apps/UICatalog.app.zip')
+# Options are only available since client version 2.3.0
+# If you use an older client then switch to desired_capabilities
+# instead: https://github.com/appium/python-client/pull/720
+from appium.options.ios import XCUITestOptions
+
+options = XCUITestOptions().load_capabilities({
+    'platformVersion': '13.4',
+    'deviceName': 'iPhone Simulator',
+    'app': PATH('../../apps/UICatalog.app.zip'),
+})
+
+self.driver = webdriver.Remote(
+    # Appium1 points to http://127.0.0.1:4723/wd/hub by default 
+    'http://127.0.0.1:4723', 
+    options=options, 
+    direct_connection=True
 )
-
-self.driver = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps, direct_connection=True)
 ```
 
 ## Relax SSL validation
 
 `strict_ssl` option allows you to send commands to an invalid certificate host like a self-signed one.
 
 ```python
-import unittest
 from appium import webdriver
-
-desired_caps = dict(
-    platformName='iOS',
-    platformVersion='13.4',
-    automationName='xcuitest',
-    deviceName='iPhone Simulator',
-    app=PATH('../../apps/UICatalog.app.zip')
-)
-
-self.driver = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps, strict_ssl=False)
+# Options are only available since client version 2.3.0
+# If you use an older client then switch to desired_capabilities
+# instead: https://github.com/appium/python-client/pull/720
+from appium.options.common import AppiumOptions
+
+options = AppiumOptions()
+options.platform_name = 'mac'
+options.automation_name = 'safari'
+options.set_capability('browser_name', 'safari')
+
+# Appium1 points to http://127.0.0.1:4723/wd/hub by default 
+self.driver = webdriver.Remote('http://127.0.0.1:4723', options=options, strict_ssl=False)
 ```
 
 ## Documentation
