Appium-Python-Client 5.2.0__py3-none-any.whl

appium/options/ios/xcuitest/simulator/reset_on_session_start_only_option.py

@@ -0,0 +1,41 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from typing import Optional
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+RESET_ON_SESSION_START_ONLY = 'resetOnSessionStartOnly'
+
+
+class ResetOnSessionStartOnlyOption(SupportsCapabilities):
+    @property
+    def reset_on_session_start_only(self) -> Optional[bool]:
+        """
+        Whether to perform Simulator reset on test session finish (false) or not (true).
+        """
+        return self.get_capability(RESET_ON_SESSION_START_ONLY)
+
+    @reset_on_session_start_only.setter
+    def reset_on_session_start_only(self, value: bool) -> None:
+        """
+        Whether to perform reset on test session finish (false) or not (true).
+        Keeping this variable set to true and Simulator running (the default
+        behaviour since version 1.6.4) may significantly shorten the duration of
+        test session initialization.
+        """
+        self.set_capability(RESET_ON_SESSION_START_ONLY, value)

appium/options/ios/xcuitest/simulator/scale_factor_option.py

@@ -0,0 +1,44 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from typing import Optional
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+SCALE_FACTOR = 'scaleFactor'
+
+
+class ScaleFactorOption(SupportsCapabilities):
+    @property
+    def scale_factor(self) -> Optional[str]:
+        """
+        Simulator scale factor.
+        """
+        return self.get_capability(SCALE_FACTOR)
+
+    @scale_factor.setter
+    def scale_factor(self, value: str) -> None:
+        """
+        Simulator scale factor. This is useful to have if the default resolution
+        of simulated device is greater than the actual display resolution.
+        So you can scale the simulator to see the whole device screen without scrolling.
+        Acceptable values for simulators running Xcode SDK 8 and older are: '1.0',
+        '0.75', '0.5', '0.33' and '0.25', where '1.0' means 100% scale.
+        For simulators running Xcode SDK 9 and above the value could be any valid
+        positive float number.
+        """
+        self.set_capability(SCALE_FACTOR, value)

appium/options/ios/xcuitest/simulator/shutdown_other_simulators_option.py

@@ -0,0 +1,44 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from typing import Optional
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+SHUTDOWN_OTHER_SIMULATORS = 'shutdownOtherSimulators'
+
+
+class ShutdownOtherSimulatorsOption(SupportsCapabilities):
+    @property
+    def shutdown_other_simulators(self) -> Optional[bool]:
+        """
+        Whether to shut down of other booted simulators except of the current one.
+        """
+        return self.get_capability(SHUTDOWN_OTHER_SIMULATORS)
+
+    @shutdown_other_simulators.setter
+    def shutdown_other_simulators(self, value: bool) -> None:
+        """
+        If this capability set to true and the current device under test is an iOS
+        Simulator then Appium will try to shut down all the other running Simulators
+        before to start a new session. This might be useful while executing webview
+        tests on different devices, since only one device can be debugged remotely
+        at once due to an Apple bug. The capability only has an effect if
+        --relaxed-security command line argument is provided to the server.
+        Defaults to false.
+        """
+        self.set_capability(SHUTDOWN_OTHER_SIMULATORS, value)

appium/options/ios/xcuitest/simulator/simulator_devices_set_path_option.py

@@ -0,0 +1,41 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from typing import Optional
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+SIMULATOR_DEVICES_SET_PATH = 'simulatorDevicesSetPath'
+
+
+class SimulatorDevicesSetPathOption(SupportsCapabilities):
+    @property
+    def simulator_devices_set_path(self) -> Optional[str]:
+        """
+        Alternative path to the simulator devices set.
+        """
+        return self.get_capability(SIMULATOR_DEVICES_SET_PATH)
+
+    @simulator_devices_set_path.setter
+    def simulator_devices_set_path(self, value: str) -> None:
+        """
+        This capability allows to set an alternative path to the simulator devices
+        set in case you have multiple sets deployed on your local system. Such
+        feature could be useful if you, for example, would like to save disk space
+        on the main system volume.
+        """
+        self.set_capability(SIMULATOR_DEVICES_SET_PATH, value)

appium/options/ios/xcuitest/simulator/simulator_pasteboard_automatic_sync_option.py

@@ -0,0 +1,42 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from typing import Optional
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+SIMULATOR_PASTEBOARD_AUTOMATIC_SYNC = 'simulatorPasteboardAutomaticSync'
+
+
+class SimulatorPasteboardAutomaticSyncOption(SupportsCapabilities):
+    @property
+    def simulator_pasteboard_automatic_sync(self) -> Optional[bool]:
+        """
+        Pasteboard automation sync state.
+        """
+        return self.get_capability(SIMULATOR_PASTEBOARD_AUTOMATIC_SYNC)
+
+    @simulator_pasteboard_automatic_sync.setter
+    def simulator_pasteboard_automatic_sync(self, value: bool) -> None:
+        """
+        Handle the -PasteboardAutomaticSync flag when simulator process launches.
+        It could improve launching simulator performance not to sync pasteboard with
+        the system when this value is off. on forces the flag enabled. system does
+        not provide the flag to the launching command. on, off, or system is available.
+        They are case-insensitive. Defaults to off.
+        """
+        self.set_capability(SIMULATOR_PASTEBOARD_AUTOMATIC_SYNC, value)

appium/options/ios/xcuitest/simulator/simulator_startup_timeout_option.py

@@ -0,0 +1,46 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from datetime import timedelta
+from typing import Optional, Union
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+SIMULATOR_STARTUP_TIMEOUT = 'simulatorStartupTimeout'
+
+
+class SimulatorStartupTimeoutOption(SupportsCapabilities):
+    @property
+    def simulator_startup_timeout(self) -> Optional[timedelta]:
+        """
+        Simulator startup timeout.
+        """
+        value = self.get_capability(SIMULATOR_STARTUP_TIMEOUT)
+        return None if value is None else timedelta(milliseconds=value)
+
+    @simulator_startup_timeout.setter
+    def simulator_startup_timeout(self, value: Union[timedelta, int]) -> None:
+        """
+        Allows to change the default timeout for Simulator startup.
+        By default, this value is set to 120000ms (2 minutes),
+        although the startup could take longer on a weak hardware
+        or if other concurrent processes use much system resources
+        during the boot up procedure.
+        """
+        self.set_capability(
+            SIMULATOR_STARTUP_TIMEOUT, int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value
+        )

appium/options/ios/xcuitest/simulator/simulator_trace_pointer_option.py

@@ -0,0 +1,41 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from typing import Optional
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+SIMULATOR_TRACE_POINTER = 'simulatorTracePointer'
+
+
+class SimulatorTracePointerOption(SupportsCapabilities):
+    @property
+    def simulator_trace_pointer(self) -> Optional[bool]:
+        """
+        Whether to highlight pointer moves in the Simulator window.
+        """
+        return self.get_capability(SIMULATOR_TRACE_POINTER)
+
+    @simulator_trace_pointer.setter
+    def simulator_trace_pointer(self, value: bool) -> None:
+        """
+        Set whether to highlight pointer moves in the Simulator window.
+        The Simulator UI client must be shut down before the session
+        startup in order for this capability to be applied properly.
+        false by default.
+        """
+        self.set_capability(SIMULATOR_TRACE_POINTER, value)

appium/options/ios/xcuitest/simulator/simulator_window_center_option.py

@@ -0,0 +1,41 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from typing import Optional
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+SIMULATOR_WINDOW_CENTER = 'simulatorWindowCenter'
+
+
+class SimulatorWindowCenterOption(SupportsCapabilities):
+    @property
+    def simulator_window_center(self) -> Optional[str]:
+        """
+        Simulator window center coordinates.
+        """
+        return self.get_capability(SIMULATOR_WINDOW_CENTER)
+
+    @simulator_window_center.setter
+    def simulator_window_center(self, value: str) -> None:
+        """
+        Allows to explicitly set the coordinates of Simulator window center
+        for Xcode9+ SDK. This capability only has an effect if Simulator
+        window has not been opened yet for the current session before it started.
+        e.g. "{-100.0,100.0}" or "{500,500}", spaces are not allowed
+        """
+        self.set_capability(SIMULATOR_WINDOW_CENTER, value)

appium/options/ios/xcuitest/wda/allow_provisioning_device_regitration_option.py

@@ -0,0 +1,40 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from typing import Optional
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+ALLOW_PROVISIONING_DEVICE_REGISTRATION = 'allowProvisioningDeviceRegistration'
+
+
+class AllowProvisioningDeviceRegistrationOption(SupportsCapabilities):
+    @property
+    def allow_provisioning_device_registration(self) -> Optional[bool]:
+        """
+        Whether to allow xcodebuild to register your destination device on the developer portal.
+        """
+        return self.get_capability(ALLOW_PROVISIONING_DEVICE_REGISTRATION)
+
+    @allow_provisioning_device_registration.setter
+    def allow_provisioning_device_registration(self, value: bool) -> None:
+        """
+        Allow xcodebuild to register your destination device on the developer portal
+        if necessary. Requires a developer account to have been added in Xcode's Accounts
+        preference pane. Defaults to false.
+        """
+        self.set_capability(ALLOW_PROVISIONING_DEVICE_REGISTRATION, value)

appium/options/ios/xcuitest/wda/auto_accept_alerts_option.py

@@ -0,0 +1,39 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from typing import Optional
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+AUTO_ACCEPT_ALERTS = 'autoAcceptAlerts'
+
+
+class AutoAcceptAlertsOption(SupportsCapabilities):
+    @property
+    def auto_accept_alerts(self) -> Optional[bool]:
+        """
+        Whether to accept all alerts automatically.
+        """
+        return self.get_capability(AUTO_ACCEPT_ALERTS)
+
+    @auto_accept_alerts.setter
+    def auto_accept_alerts(self, value: bool) -> None:
+        """
+        Accept all iOS alerts automatically if they pop up. This includes privacy
+        access permission alerts (e.g., location, contacts, photos). Default is false.
+        """
+        self.set_capability(AUTO_ACCEPT_ALERTS, value)

appium/options/ios/xcuitest/wda/auto_disimiss_alerts_option.py

@@ -0,0 +1,39 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from typing import Optional
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+AUTO_DISMISS_ALERTS = 'autoDismissAlerts'
+
+
+class AutoDismissAlertsOption(SupportsCapabilities):
+    @property
+    def auto_dismiss_alerts(self) -> Optional[bool]:
+        """
+        Whether to dismiss all alerts automatically.
+        """
+        return self.get_capability(AUTO_DISMISS_ALERTS)
+
+    @auto_dismiss_alerts.setter
+    def auto_dismiss_alerts(self, value: bool) -> None:
+        """
+        Dismiss all iOS alerts automatically if they pop up. This includes privacy
+        access permission alerts (e.g., location, contacts, photos). Default is false.
+        """
+        self.set_capability(AUTO_DISMISS_ALERTS, value)

appium/options/ios/xcuitest/wda/derived_data_path_option.py

@@ -0,0 +1,41 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from typing import Optional
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+DERIVED_DATA_PATH = 'derivedDataPath'
+
+
+class DerivedDataPathOption(SupportsCapabilities):
+    @property
+    def derived_data_path(self) -> Optional[str]:
+        """
+        Path to the derived data WDA folder.
+        """
+        return self.get_capability(DERIVED_DATA_PATH)
+
+    @derived_data_path.setter
+    def derived_data_path(self, value: str) -> None:
+        """
+        Use along with usePrebuiltWDA capability and choose where to search for the existing WDA app.
+        If the capability is not set then Xcode will store the derived data in the default root
+        taken from preferences.
+        It also makes sense to choose different folders for parallel WDA sessions.
+        """
+        self.set_capability(DERIVED_DATA_PATH, value)

appium/options/ios/xcuitest/wda/disable_automatic_screenshots_option.py

@@ -0,0 +1,40 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from typing import Optional
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+DISABLE_AUTOMATIC_SCREENSHOTS = 'disableAutomaticScreenshots'
+
+
+class DisableAutomaticScreenshotsOption(SupportsCapabilities):
+    @property
+    def disable_automatic_screenshots(self) -> Optional[bool]:
+        """
+        Whether to disable automatic XCTest screenshots.
+        """
+        return self.get_capability(DISABLE_AUTOMATIC_SCREENSHOTS)
+
+    @disable_automatic_screenshots.setter
+    def disable_automatic_screenshots(self, value: bool) -> None:
+        """
+        Disable automatic screenshots taken by XCTest at every interaction.
+        Default is up to WebDriverAgent's config to decide, which currently
+        defaults to true.
+        """
+        self.set_capability(DISABLE_AUTOMATIC_SCREENSHOTS, value)

appium/options/ios/xcuitest/wda/force_app_launch_option.py

@@ -0,0 +1,42 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from typing import Optional
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+FORCE_APP_LAUNCH = 'forceAppLaunch'
+
+
+class ForceAppLaunchOption(SupportsCapabilities):
+    @property
+    def force_app_launch(self) -> Optional[bool]:
+        """
+        Whether to enforce app restart on session startup.
+        """
+        return self.get_capability(FORCE_APP_LAUNCH)
+
+    @force_app_launch.setter
+    def force_app_launch(self, value: bool) -> None:
+        """
+        Specify if the app should be forcefully restarted if it is already
+        running on session startup. This capability only has an effect if an
+        application identifier has been passed to the test session (either
+        explicitly, by setting bundleId, or implicitly, by providing app).
+        Default is true unless noReset capability is set to true.
+        """
+        self.set_capability(FORCE_APP_LAUNCH, value)

appium/options/ios/xcuitest/wda/keychain_password_option.py

@@ -0,0 +1,39 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from typing import Optional
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+KEYCHAIN_PASSWORD = 'keychainPassword'
+
+
+class KeychainPasswordOption(SupportsCapabilities):
+    @property
+    def keychain_password(self) -> Optional[str]:
+        """
+        Custom keychain password.
+        """
+        return self.get_capability(KEYCHAIN_PASSWORD)
+
+    @keychain_password.setter
+    def keychain_password(self, value: str) -> None:
+        """
+        Custom keychain password. The keychain is expected to
+        contain the private development key.
+        """
+        self.set_capability(KEYCHAIN_PASSWORD, value)