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

appium/options/android/common/avd/avd_args_option.py

@@ -0,0 +1,38 @@
+# 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
+
+AVD_ARGS = 'avdArgs'
+
+
+class AvdArgsOption(SupportsCapabilities):
+    @property
+    def avd_args(self) -> Optional[str]:
+        """
+        Emulator command line arguments.
+        """
+        return self.get_capability(AVD_ARGS)
+
+    @avd_args.setter
+    def avd_args(self, value: str) -> None:
+        """
+        Set emulator command line arguments.
+        """
+        self.set_capability(AVD_ARGS, value)

appium/options/android/common/avd/avd_env_option.py

@@ -0,0 +1,38 @@
+# 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 Dict, Optional
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+AVD_ENV = 'avdEnv'
+
+
+class AvdEnvOption(SupportsCapabilities):
+    @property
+    def avd_env(self) -> Optional[Dict[str, str]]:
+        """
+        Mapping of emulator environment variables.
+        """
+        return self.get_capability(AVD_ENV)
+
+    @avd_env.setter
+    def avd_env(self, value: Dict[str, str]) -> None:
+        """
+        Set the mapping of emulator environment variables.
+        """
+        self.set_capability(AVD_ENV, value)

appium/options/android/common/avd/avd_launch_timeout_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 datetime import timedelta
+from typing import Optional, Union
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+AVD_LAUNCH_TIMEOUT = 'avdLaunchTimeout'
+
+
+class AvdLaunchTimeoutOption(SupportsCapabilities):
+    @property
+    def avd_launch_timeout(self) -> Optional[timedelta]:
+        """
+        Timeout to wait until Android Emulator is started.
+        """
+        value = self.get_capability(AVD_LAUNCH_TIMEOUT)
+        return None if value is None else timedelta(milliseconds=value)
+
+    @avd_launch_timeout.setter
+    def avd_launch_timeout(self, value: Union[timedelta, int]) -> None:
+        """
+        Maximum timeout to wait until Android Emulator is started.
+        60000 ms by default.
+        """
+        self.set_capability(AVD_LAUNCH_TIMEOUT, int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value)

appium/options/android/common/avd/avd_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
+
+AVD = 'avd'
+
+
+class AvdOption(SupportsCapabilities):
+    @property
+    def avd(self) -> Optional[str]:
+        """
+        Name of Android emulator to run the test on.
+        """
+        return self.get_capability(AVD)
+
+    @avd.setter
+    def avd(self, value: str) -> None:
+        """
+        The name of Android emulator to run the test on.
+        Names of currently installed emulators could be listed using
+        avdmanager list avd command. If the emulator with the given name
+        is not running then it is going to be started before a test.
+        """
+        self.set_capability(AVD, value)

appium/options/android/common/avd/avd_ready_timeout_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 datetime import timedelta
+from typing import Optional, Union
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+AVD_READY_TIMEOUT = 'avdReadyTimeout'
+
+
+class AvdReadyTimeoutOption(SupportsCapabilities):
+    @property
+    def avd_ready_timeout(self) -> Optional[timedelta]:
+        """
+        Timeout to wait until Android Emulator is fully booted and is ready for usage.
+        """
+        value = self.get_capability(AVD_READY_TIMEOUT)
+        return None if value is None else timedelta(milliseconds=value)
+
+    @avd_ready_timeout.setter
+    def avd_ready_timeout(self, value: Union[timedelta, int]) -> None:
+        """
+        Maximum timeout to wait until Android Emulator is fully booted and is ready for usage.
+        60000 ms by default
+        """
+        self.set_capability(AVD_READY_TIMEOUT, int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value)

appium/options/android/common/avd/gps_enabled_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
+
+GPS_ENABLED = 'gpsEnabled'
+
+
+class GpsEnabledOption(SupportsCapabilities):
+    @property
+    def gps_enabled(self) -> Optional[bool]:
+        """
+        State of the GPS service on emulator.
+        """
+        return self.get_capability(GPS_ENABLED)
+
+    @gps_enabled.setter
+    def gps_enabled(self, value: bool) -> None:
+        """
+        Set whether to enable (true) or disable (false) GPS service in the Emulator.
+        Unset by default, which means to not change the current value.
+        """
+        self.set_capability(GPS_ENABLED, value)

appium/options/android/common/avd/network_speed_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
+
+NETWORK_SPEED = 'networkSpeed'
+
+
+class NetworkSpeedOption(SupportsCapabilities):
+    @property
+    def network_speed(self) -> Optional[str]:
+        """
+        Desired network speed limit for the emulator.
+        """
+        return self.get_capability(NETWORK_SPEED)
+
+    @network_speed.setter
+    def network_speed(self, value: str) -> None:
+        """
+        Sets the desired network speed limit for the emulator.
+        It is only applied if the emulator is not running before
+        the test starts. See emulator command line arguments description
+        for more details.
+        """
+        self.set_capability(NETWORK_SPEED, value)

appium/options/android/common/context/auto_webview_timeout_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 datetime import timedelta
+from typing import Optional, Union
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+AUTO_WEBVIEW_TIMEOUT = 'autoWebviewTimeout'
+
+
+class AutoWebviewTimeoutOption(SupportsCapabilities):
+    @property
+    def auto_webview_timeout(self) -> Optional[timedelta]:
+        """
+        Set the maximum timeout to wait until a web view is
+        available if autoWebview capability is set to true. 2000 ms by default.
+        """
+        value = self.get_capability(AUTO_WEBVIEW_TIMEOUT)
+        return None if value is None else timedelta(milliseconds=value)
+
+    @auto_webview_timeout.setter
+    def auto_webview_timeout(self, value: Union[timedelta, int]) -> None:
+        """
+        Timeout to wait until a web view is available.
+        """
+        self.set_capability(AUTO_WEBVIEW_TIMEOUT, int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value)

appium/options/android/common/context/chrome_logging_prefs_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 Any, Dict, Optional
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+CHROME_LOGGING_PREFS = 'chromeLoggingPrefs'
+
+
+class ChromeLoggingPrefsOption(SupportsCapabilities):
+    @property
+    def chrome_logging_prefs(self) -> Optional[Dict[str, Any]]:
+        """
+        Chrome logging preferences.
+        """
+        return self.get_capability(CHROME_LOGGING_PREFS)
+
+    @chrome_logging_prefs.setter
+    def chrome_logging_prefs(self, value: Dict[str, Any]) -> None:
+        """
+        Chrome logging preferences mapping. Basically the same as
+        [goog:loggingPrefs](https://newbedev.com/
+        getting-console-log-output-from-chrome-with-selenium-python-api-bindings).
+        It is set to {"browser": "ALL"} by default.
+        """
+        self.set_capability(CHROME_LOGGING_PREFS, value)

appium/options/android/common/context/chrome_options_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 Any, Dict, Optional
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+CHROME_OPTIONS = 'chromeOptions'
+
+
+class ChromeOptionsOption(SupportsCapabilities):
+    @property
+    def chrome_options(self) -> Optional[Dict[str, Any]]:
+        """
+        Chrome options.
+        """
+        return self.get_capability(CHROME_OPTIONS)
+
+    @chrome_options.setter
+    def chrome_options(self, value: Dict[str, Any]) -> None:
+        """
+        A mapping, that allows to customize chromedriver options.
+        See https://chromedriver.chromium.org/capabilities for the list
+        of available entries.
+        """
+        self.set_capability(CHROME_OPTIONS, value)

appium/options/android/common/context/chromedriver_args_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 List, Optional
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+CHROMEDRIVER_ARGS = 'chromedriverArgs'
+
+
+class ChromedriverArgsOption(SupportsCapabilities):
+    @property
+    def chromedriver_args(self) -> Optional[List[str]]:
+        """
+        Array of chromedriver CLI arguments.
+        """
+        return self.get_capability(CHROMEDRIVER_ARGS)
+
+    @chromedriver_args.setter
+    def chromedriver_args(self, value: List[str]) -> None:
+        """
+        Array of chromedriver [command line
+        arguments](http://www.assertselenium.com/java/list-of-chrome-driver-command-line-arguments/).
+        Note, that not all command line arguments that are available for the desktop
+        browser are also available for the mobile one.
+        """
+        self.set_capability(CHROMEDRIVER_ARGS, value)

appium/options/android/common/context/chromedriver_chrome_mapping_file_option.py

@@ -0,0 +1,43 @@
+# 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
+
+CHROMEDRIVER_CHROME_MAPPING_FILE = 'chromedriverChromeMappingFile'
+
+
+class ChromedriverChromeMappingFileOption(SupportsCapabilities):
+    @property
+    def chromedriver_chrome_mapping_file(self) -> Optional[str]:
+        """
+        Full path to the chromedrivers mapping file is located.
+        """
+        return self.get_capability(CHROMEDRIVER_CHROME_MAPPING_FILE)
+
+    @chromedriver_chrome_mapping_file.setter
+    def chromedriver_chrome_mapping_file(self, value: str) -> None:
+        """
+        Full path to the chromedrivers mapping file. This file is used to statically
+        map webview/browser versions to the chromedriver versions that are capable
+        of automating them. Read [Automatic Chromedriver Discovery](https://github.com/
+        appium/appium/blob/master/docs/en/writing-running-appium/web/
+        chromedriver.md#automatic-discovery-of-compatible-chromedriver)
+        article for more details.
+        """
+        self.set_capability(CHROMEDRIVER_CHROME_MAPPING_FILE, value)

appium/options/android/common/context/chromedriver_disable_build_check_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
+
+CHROMEDRIVER_DISABLE_BUILD_CHECK = 'chromedriverDisableBuildCheck'
+
+
+class ChromedriverDisableBuildCheckOption(SupportsCapabilities):
+    @property
+    def chromedriver_disable_build_check(self) -> Optional[bool]:
+        """
+        Whether to disable the compatibility validation between the current
+        chromedriver and the destination browser/web view.
+        """
+        return self.get_capability(CHROMEDRIVER_DISABLE_BUILD_CHECK)
+
+    @chromedriver_disable_build_check.setter
+    def chromedriver_disable_build_check(self, value: bool) -> None:
+        """
+        Being set to true disables the compatibility validation between the current
+        chromedriver and the destination browser/web view. Use it with care.
+        false by default.
+        """
+        self.set_capability(CHROMEDRIVER_DISABLE_BUILD_CHECK, value)

appium/options/android/common/context/chromedriver_executable_dir_option.py

@@ -0,0 +1,43 @@
+# 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
+
+CHROMEDRIVER_EXECUTABLE_DIR = 'chromedriverExecutableDir'
+
+
+class ChromedriverExecutableDirOption(SupportsCapabilities):
+    @property
+    def chromedriver_executable_dir(self) -> Optional[str]:
+        """
+        Full path to the folder where chromedriver executables are located.
+        """
+        return self.get_capability(CHROMEDRIVER_EXECUTABLE_DIR)
+
+    @chromedriver_executable_dir.setter
+    def chromedriver_executable_dir(self, value: str) -> None:
+        """
+        Full path to the folder where chromedriver executables are located.
+        This folder is used then to store the downloaded chromedriver executables
+        if automatic download is enabled. Read [Automatic Chromedriver
+        Discovery](https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/
+        web/chromedriver.md#automatic-discovery-of-compatible-chromedriver)
+        article for more details.
+        """
+        self.set_capability(CHROMEDRIVER_EXECUTABLE_DIR, value)

appium/options/android/common/context/chromedriver_executable_option.py

@@ -0,0 +1,38 @@
+# 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
+
+CHROMEDRIVER_EXECUTABLE = 'chromedriverExecutable'
+
+
+class ChromedriverExecutableOption(SupportsCapabilities):
+    @property
+    def chromedriver_executable(self) -> Optional[str]:
+        """
+        Path to the chromedriver executable on the server file system.
+        """
+        return self.get_capability(CHROMEDRIVER_EXECUTABLE)
+
+    @chromedriver_executable.setter
+    def chromedriver_executable(self, value: str) -> None:
+        """
+        Full path to the chromedriver executable on the server file system.
+        """
+        self.set_capability(CHROMEDRIVER_EXECUTABLE, value)

appium/options/android/common/context/chromedriver_port_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
+
+CHROMEDRIVER_PORT = 'chromedriverPort'
+
+
+class ChromedriverPortOption(SupportsCapabilities):
+    @property
+    def chromedriver_port(self) -> Optional[int]:
+        """
+        Local port number to use for Chromedriver communication.
+        """
+        return self.get_capability(CHROMEDRIVER_PORT)
+
+    @chromedriver_port.setter
+    def chromedriver_port(self, value: int) -> None:
+        """
+        The port number to use for Chromedriver communication.
+        Any free port number is selected by default if unset.
+        """
+        self.set_capability(CHROMEDRIVER_PORT, value)