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

appium/options/flutter_integration/flutter_enable_mock_camera_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 appium.options.common.supports_capabilities import SupportsCapabilities
+
+FLUTTER_ENABLE_MOCK_CAMERA = 'flutterEnableMockCamera'
+
+
+class FlutterEnableMockCameraOption(SupportsCapabilities):
+    @property
+    def flutter_enable_mock_camera(self) -> bool:
+        """
+        Get state of the mock camera for Flutter integration test
+
+        Returns:
+            bool: A boolean indicating whether the mock camera is enabled (True) or disabled (False).
+        """
+        return self.get_capability(FLUTTER_ENABLE_MOCK_CAMERA)
+
+    @flutter_enable_mock_camera.setter
+    def flutter_enable_mock_camera(self, value: bool) -> None:
+        """
+        Setter method enable or disable the mock camera for Flutter integration test
+        Default state is `False`
+
+        Args:
+            value (bool): A boolean value indicating whether to enable (True) or disable (False) the mock camera.
+        """
+        self.set_capability(FLUTTER_ENABLE_MOCK_CAMERA, value)

appium/options/flutter_integration/flutter_server_launch_timeout_option.py

@@ -0,0 +1,51 @@
+# 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
+
+FLUTTER_SERVER_LAUNCH_TIMEOUT = 'flutterServerLaunchTimeout'
+
+
+class FlutterServerLaunchTimeOutOption(SupportsCapabilities):
+    @property
+    def flutter_server_launch_timeout(self) -> Optional[timedelta]:
+        """
+        Gets the current timeout for launching the Flutter server in a Flutter application.
+
+        Returns:
+            Optional[timedelta]: The timeout value as a `timedelta` object if set, or `None` if the timeout is not defined.
+
+        """
+        return self.get_capability(FLUTTER_SERVER_LAUNCH_TIMEOUT)
+
+    @flutter_server_launch_timeout.setter
+    def flutter_server_launch_timeout(self, value: Union[timedelta, int]) -> None:
+        """
+        Sets the timeout for launching the Flutter server in Flutter application.
+        Default timeout is 5000ms
+
+        Args:
+            value (Union[timedelta, int]): The timeout value, either as a `timedelta` object or an integer in milliseconds.
+                If provided as a `timedelta`, it will be converted to milliseconds.
+        """
+        self.set_capability(
+            FLUTTER_SERVER_LAUNCH_TIMEOUT,
+            (int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value),
+        )

appium/options/flutter_integration/flutter_system_port_option.py

@@ -0,0 +1,45 @@
+# 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
+
+FLUTTER_SYSTEM_PORT = 'flutterSystemPort'
+
+
+class FlutterSystemPortOption(SupportsCapabilities):
+    @property
+    def flutter_system_port(self) -> Optional[int]:
+        """
+        Get flutter system port for Flutter integration tests.
+
+        Returns:
+            int: returns the port number
+        """
+        return self.get_capability(FLUTTER_SYSTEM_PORT)
+
+    @flutter_system_port.setter
+    def flutter_system_port(self, value: int) -> None:
+        """
+        Sets the system port for Flutter integration tests.
+        By default the first free port from 10000..11000 range is selected
+
+        Args:
+            value (int): The port number to be used for the Flutter server.
+        """
+        self.set_capability(FLUTTER_SYSTEM_PORT, value)

appium/options/gecko/__init__.py

@@ -0,0 +1 @@
+from .base import GeckoOptions

appium/options/gecko/android_storage_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
+
+ANDROID_STORAGE = 'androidStorage'
+
+
+class AndroidStorageOption(SupportsCapabilities):
+    @property
+    def android_storage(self) -> Optional[str]:
+        """
+        The currently set storage type.
+        """
+        return self.get_capability(ANDROID_STORAGE)
+
+    @android_storage.setter
+    def android_storage(self, value: str) -> None:
+        """
+        See https://firefox-source-docs.mozilla.org/testing/geckodriver
+        /Flags.html#code-android-storage-var-android-storage-var-code
+        """
+        self.set_capability(ANDROID_STORAGE, value)

appium/options/gecko/base.py

@@ -0,0 +1,51 @@
+# 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
+
+from appium.options.common.automation_name_option import AUTOMATION_NAME
+from appium.options.common.base import AppiumOptions
+from appium.options.common.system_port_option import SystemPortOption
+
+from .android_storage_option import AndroidStorageOption
+from .firefox_options_option import FirefoxOptionsOption
+from .marionette_port_option import MarionettePortOption
+from .verbosity_option import VerbosityOption
+
+
+class GeckoOptions(
+    AppiumOptions,
+    AndroidStorageOption,
+    FirefoxOptionsOption,
+    MarionettePortOption,
+    SystemPortOption,
+    VerbosityOption,
+):
+    @SystemPortOption.system_port.setter  # type: ignore
+    def system_port(self, value: int) -> None:
+        """
+        The number of the port for the driver to listen on. Must be unique
+        for each session. If not provided then the driver will try to detect
+        it automatically.
+        """
+        SystemPortOption.system_port.fset(self, value)  # type: ignore
+
+    @property
+    def default_capabilities(self) -> Dict:
+        return {
+            AUTOMATION_NAME: 'Gecko',
+        }

appium/options/gecko/firefox_options_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 Any, Dict, Optional
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+FIREFOX_OPTIONS = 'moz:firefoxOptions'
+
+
+class FirefoxOptionsOption(SupportsCapabilities):
+    @property
+    def firefox_options(self) -> Optional[Dict[str, Any]]:
+        """
+        Firefox options mapping.
+        """
+        return self.get_capability(FIREFOX_OPTIONS)
+
+    @firefox_options.setter
+    def firefox_options(self, value: Dict[str, Any]) -> None:
+        """
+        See https://developer.mozilla.org/en-US/docs/Web/WebDriver/Capabilities/firefoxOptions
+        """
+        self.set_capability(FIREFOX_OPTIONS, value)

appium/options/gecko/marionette_port_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
+
+MARIONETTE_PORT = 'marionettePort'
+
+
+class MarionettePortOption(SupportsCapabilities):
+    @property
+    def marionette_port(self) -> Optional[int]:
+        """
+        The number of the port for the Marionette server to listen on.
+        """
+        return self.get_capability(MARIONETTE_PORT)
+
+    @marionette_port.setter
+    def marionette_port(self, value: int) -> None:
+        """
+        Selects the port for Geckodriver’s connection to the Marionette
+        remote protocol. The existing Firefox instance must have Marionette
+        enabled. To enable the remote protocol in Firefox, you can pass the
+        -marionette flag. Unless the marionette.port preference has been
+        user-set, Marionette will listen on port 2828, which is the default
+        value for this capability.
+        """
+        self.set_capability(MARIONETTE_PORT, value)

appium/options/gecko/verbosity_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
+
+VERBOSITY = 'verbosity'
+
+
+class VerbosityOption(SupportsCapabilities):
+    @property
+    def verbosity(self) -> Optional[str]:
+        """
+        The verbosity level of driver logging.
+        """
+        return self.get_capability(VERBOSITY)
+
+    @verbosity.setter
+    def verbosity(self, value: str) -> None:
+        """
+        The verbosity level of driver logging.
+        By default, minimum verbosity is applied.
+        Either 'debug' or 'trace'.
+        """
+        self.set_capability(VERBOSITY, value)

appium/options/ios/__init__.py

@@ -0,0 +1,2 @@
+from .safari.base import SafariOptions
+from .xcuitest.base import XCUITestOptions

appium/options/ios/safari/automatic_inspection_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
+
+AUTOMATIC_INSPECTION = 'safari:automaticInspection'
+
+
+class AutomaticInspectionOption(SupportsCapabilities):
+    @property
+    def automatic_inspection(self) -> Optional[bool]:
+        """
+        Whether to use automatic inspection.
+        """
+        return self.get_capability(AUTOMATIC_INSPECTION)
+
+    @automatic_inspection.setter
+    def automatic_inspection(self, value: bool) -> None:
+        """
+        This capability instructs Safari to preload the Web Inspector and JavaScript
+        debugger in the background prior to returning a newly-created window.
+        To pause the test's execution in JavaScript and bring up Web Inspector's
+        Debugger tab, you can simply evaluate a debugger statement in the test page.
+        """
+        self.set_capability(AUTOMATIC_INSPECTION, value)

appium/options/ios/safari/automatic_profiling_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
+
+AUTOMATIC_PROFILING = 'safari:automaticProfiling'
+
+
+class AutomaticProfilingOption(SupportsCapabilities):
+    @property
+    def automatic_profiling(self) -> Optional[bool]:
+        """
+        Whether to use automatic profiling.
+        """
+        return self.get_capability(AUTOMATIC_PROFILING)
+
+    @automatic_profiling.setter
+    def automatic_profiling(self, value: bool) -> None:
+        """
+        This capability instructs Safari to preload the Web Inspector and start
+        a Timeline recording in the background prior to returning a newly-created
+        window. To view the recording, open the Web Inspector through Safari's
+        Develop menu.
+        """
+        self.set_capability(AUTOMATIC_PROFILING, value)

appium/options/ios/safari/base.py

@@ -0,0 +1,51 @@
+# 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
+
+from appium.options.common.automation_name_option import AUTOMATION_NAME
+from appium.options.common.base import PLATFORM_NAME, AppiumOptions
+
+from .automatic_inspection_option import AutomaticInspectionOption
+from .automatic_profiling_option import AutomaticProfilingOption
+from .device_name_option import DeviceNameOption
+from .device_type_option import DeviceTypeOption
+from .device_udid_option import DeviceUdidOption
+from .platform_build_version_option import PlatformBuildVersionOption
+from .platform_version_option import PlatformVersionOption
+from .use_simulator_option import UseSimulatorOption
+from .webkit_webrtc_option import WebkitWebrtcOption
+
+
+class SafariOptions(
+    AppiumOptions,
+    AutomaticInspectionOption,
+    AutomaticProfilingOption,
+    DeviceNameOption,
+    DeviceTypeOption,
+    DeviceUdidOption,
+    PlatformBuildVersionOption,
+    PlatformVersionOption,
+    UseSimulatorOption,
+    WebkitWebrtcOption,
+):
+    @property
+    def default_capabilities(self) -> Dict:
+        return {
+            PLATFORM_NAME: 'iOS',
+            AUTOMATION_NAME: 'Safari',
+        }

appium/options/ios/safari/device_name_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
+
+DEVICE_NAME = 'safari:deviceName'
+
+
+class DeviceNameOption(SupportsCapabilities):
+    @property
+    def device_name(self) -> Optional[str]:
+        """
+        String representing the name of the device.
+        """
+        return self.get_capability(DEVICE_NAME)
+
+    @device_name.setter
+    def device_name(self, value: str) -> None:
+        """
+        safaridriver will only create a session using hosts whose device name
+        matches the value of safari:deviceName. Device names are compared
+        case-insensitively. NOTE: Device names for connected devices are shown in
+        iTunes. If Xcode is installed, device names for connected devices are available
+        via the output of instruments(1) and in the Devices and Simulators window
+        (accessed in Xcode via "Window -> Devices and Simulators").
+        """
+        self.set_capability(DEVICE_NAME, value)

appium/options/ios/safari/device_type_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
+
+DEVICE_TYPE = 'safari:deviceType'
+
+
+class DeviceTypeOption(SupportsCapabilities):
+    @property
+    def device_type(self) -> Optional[str]:
+        """
+        String representing the type of the device.
+        """
+        return self.get_capability(DEVICE_TYPE)
+
+    @device_type.setter
+    def device_type(self, value: str) -> None:
+        """
+        If the value of safari:deviceType is 'iPhone', safaridriver will only create a session
+        using an iPhone device or iPhone simulator. If the value of safari:deviceType is 'iPad',
+        safaridriver will only create a session using an iPad device or iPad simulator.
+        Values of safari:deviceType are compared case-insensitively.
+        """
+        self.set_capability(DEVICE_TYPE, value)

appium/options/ios/safari/device_udid_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
+
+DEVICE_UDID = 'safari:deviceUDID'
+
+
+class DeviceUdidOption(SupportsCapabilities):
+    @property
+    def device_udid(self) -> Optional[str]:
+        """
+        String representing the UDID of the device.
+        """
+        return self.get_capability(DEVICE_UDID)
+
+    @device_udid.setter
+    def device_udid(self, value: str) -> None:
+        """
+        safaridriver will only create a session using hosts whose device UDID
+        matches the value of safari:deviceUDID. Device UDIDs are compared
+        case-insensitively. NOTE: If Xcode is installed, UDIDs for connected
+        devices are available via the output of instruments(1) and in the
+        Devices and Simulators window (accessed in Xcode via
+        "Window -> Devices and Simulators").
+        """
+        self.set_capability(DEVICE_UDID, value)