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

appium/options/common/locale_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 .supports_capabilities import SupportsCapabilities
+
+LOCALE = 'locale'
+
+
+class LocaleOption(SupportsCapabilities):
+    @property
+    def locale(self) -> Optional[str]:
+        """
+        Locale abbreviation to use in a test session.
+        """
+        return self.get_capability(LOCALE)
+
+    @locale.setter
+    def locale(self, value: str) -> None:
+        """
+        Set locale abbreviation to use in a test session.
+        """
+        self.set_capability(LOCALE, value)

appium/options/common/new_command_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 .supports_capabilities import SupportsCapabilities
+
+NEW_COMMAND_TIMEOUT = 'newCommandTimeout'
+
+
+class NewCommandTimeoutOption(SupportsCapabilities):
+    @property
+    def new_command_timeout(self) -> Optional[timedelta]:
+        """
+        The allowed time before seeing a new server command.
+        """
+        value = self.get_capability(NEW_COMMAND_TIMEOUT)
+        return None if value is None else timedelta(seconds=value)
+
+    @new_command_timeout.setter
+    def new_command_timeout(self, value: Union[timedelta, int]) -> None:
+        """
+        Set the allowed time before seeing a new server command.
+        The value could either be provided as timedelta instance or an integer number of seconds.
+        """
+        self.set_capability(NEW_COMMAND_TIMEOUT, value.total_seconds() if isinstance(value, timedelta) else value)

appium/options/common/no_reset_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 .supports_capabilities import SupportsCapabilities
+
+NO_RESET = 'noReset'
+
+
+class NoResetOption(SupportsCapabilities):
+    @property
+    def no_reset(self) -> Optional[bool]:
+        """
+        Whether the driver should not perform a reset.
+        """
+        return self.get_capability(NO_RESET)
+
+    @no_reset.setter
+    def no_reset(self, value: bool) -> None:
+        """
+        Set whether the driver should not perform a reset.
+        """
+        self.set_capability(NO_RESET, value)

appium/options/common/orientation_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 .supports_capabilities import SupportsCapabilities
+
+ORIENTATION = 'orientation'
+
+
+class OrientationOption(SupportsCapabilities):
+    @property
+    def orientation(self) -> Optional[str]:
+        """
+        The orientation of the device's screen.
+        Usually this is either 'PORTRAIT' or 'LANDSCAPE'.
+        """
+        return self.get_capability(ORIENTATION)
+
+    @orientation.setter
+    def orientation(self, value: str) -> None:
+        """
+        Set the orientation of the device's screen.
+        Usually this is either 'PORTRAIT' or 'LANDSCAPE'.
+        """
+        self.set_capability(ORIENTATION, value)

appium/options/common/other_apps_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 .supports_capabilities import SupportsCapabilities
+
+OTHER_APPS = 'otherApps'
+
+
+class OtherAppsOption(SupportsCapabilities):
+    @property
+    def other_apps(self) -> Optional[str]:
+        """
+        Locations of apps to install before running a test.
+        """
+        return self.get_capability(OTHER_APPS)
+
+    @other_apps.setter
+    def other_apps(self, value: str) -> None:
+        """
+        Set locations of apps to install before running a test.
+        Each item could be separated with a single comma.
+        """
+        self.set_capability(OTHER_APPS, value)

appium/options/common/platform_version_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 .supports_capabilities import SupportsCapabilities
+
+PLATFORM_VERSION = 'platformVersion'
+
+
+class PlatformVersionOption(SupportsCapabilities):
+    @property
+    def platform_version(self) -> Optional[str]:
+        """
+        The platform version of an emulator or a real device.
+        This capability is used for device autodetection if udid is not provided.
+        """
+        return self.get_capability(PLATFORM_VERSION)
+
+    @platform_version.setter
+    def platform_version(self, value: str) -> None:
+        """
+        Set the platform version of an emulator or a real device.
+        This capability is used for device autodetection if udid is not provided.
+        """
+        self.set_capability(PLATFORM_VERSION, value)

appium/options/common/postrun_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 Dict, Optional
+
+from .supports_capabilities import SupportsCapabilities
+
+POSTRUN = 'postrun'
+
+
+class PostrunOption(SupportsCapabilities):
+    @property
+    def postrun(self) -> Optional[Dict[str, str]]:
+        """
+        System script which is supposed to be executed upon
+        driver session quit.
+        """
+        return self.get_capability(POSTRUN)
+
+    @postrun.setter
+    def postrun(self, value: Dict[str, str]) -> None:
+        """
+        Set a system script to execute upon driver session quit.
+        """
+        self.set_capability(POSTRUN, value)

appium/options/common/prerun_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 Dict, Optional
+
+from .supports_capabilities import SupportsCapabilities
+
+PRERUN = 'prerun'
+
+
+class PrerunOption(SupportsCapabilities):
+    @property
+    def prerun(self) -> Optional[Dict[str, str]]:
+        """
+        System script which is supposed to be executed before
+        a driver session is initialised.
+        """
+        return self.get_capability(PRERUN)
+
+    @prerun.setter
+    def prerun(self, value: Dict[str, str]) -> None:
+        """
+        Set a system script which is supposed to be executed before
+        a driver session is initialised.
+        """
+        self.set_capability(PRERUN, value)

appium/options/common/print_page_source_on_find_failure_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 .supports_capabilities import SupportsCapabilities
+
+PRINT_PAGE_SOURCE_ON_FIND_FAILURE = 'printPageSourceOnFindFailure'
+
+
+class PrintPageSourceOnFindFailureOption(SupportsCapabilities):
+    @property
+    def print_page_source_on_find_failure(self) -> Optional[bool]:
+        """
+        Whether the driver should print the page source to the log
+        if a find failure occurs.
+        """
+        return self.get_capability(PRINT_PAGE_SOURCE_ON_FIND_FAILURE)
+
+    @print_page_source_on_find_failure.setter
+    def print_page_source_on_find_failure(self, value: bool) -> None:
+        """
+        Set whether the driver should print the page source to the log
+        if a find failure occurs.
+        """
+        self.set_capability(PRINT_PAGE_SOURCE_ON_FIND_FAILURE, value)

appium/options/common/skip_log_capture_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 .supports_capabilities import SupportsCapabilities
+
+SKIP_LOG_CAPTURE = 'skipLogCapture'
+
+
+class SkipLogCaptureOption(SupportsCapabilities):
+    @property
+    def skip_log_capture(self) -> Optional[bool]:
+        """
+        Whether the driver should not record device logs.
+        """
+        return self.get_capability(SKIP_LOG_CAPTURE)
+
+    @skip_log_capture.setter
+    def skip_log_capture(self, value: bool) -> None:
+        """
+        Set whether the driver should not record device logs.
+        """
+        self.set_capability(SKIP_LOG_CAPTURE, value)

appium/options/common/supports_capabilities.py

@@ -0,0 +1,26 @@
+# 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, Protocol, TypeVar
+
+T = TypeVar('T')
+
+
+class SupportsCapabilities(Protocol):
+    def set_capability(self: T, name: str, value: Any) -> T: ...
+
+    def get_capability(self: T, name: str) -> Any: ...

appium/options/common/system_host_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
+
+SYSTEM_HOST = 'systemHost'
+
+
+class SystemHostOption(SupportsCapabilities):
+    @property
+    def system_host(self) -> Optional[str]:
+        """
+        The name of the host for the internal server to listen on.
+        """
+        return self.get_capability(SYSTEM_HOST)
+
+    @system_host.setter
+    def system_host(self, value: str) -> None:
+        """
+        Set the name of the host for the internal server to listen on.
+        """
+        self.set_capability(SYSTEM_HOST, value)

appium/options/common/system_port_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
+
+SYSTEM_PORT = 'systemPort'
+
+
+class SystemPortOption(SupportsCapabilities):
+    @property
+    def system_port(self) -> Optional[int]:
+        """
+        The number of the port for the internal server to listen on.
+        """
+        return self.get_capability(SYSTEM_PORT)
+
+    @system_port.setter
+    def system_port(self, value: int) -> None:
+        """
+        Set the number of the port for the internal server to listen on.
+        """
+        self.set_capability(SYSTEM_PORT, value)

appium/options/common/udid_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 .supports_capabilities import SupportsCapabilities
+
+UDID = 'udid'
+
+
+class UdidOption(SupportsCapabilities):
+    @property
+    def udid(self) -> Optional[str]:
+        """
+        The unique identifier of the device under test.
+        """
+        return self.get_capability(UDID)
+
+    @udid.setter
+    def udid(self, value: str) -> None:
+        """
+        Set the unique identifier of the device under test.
+        """
+        self.set_capability(UDID, value)

appium/options/flutter_integration/__init__.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python
+
+# Licensed 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 .base import FlutterOptions

appium/options/flutter_integration/base.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 Dict
+
+from appium.options.common.automation_name_option import AUTOMATION_NAME
+from appium.options.common.base import AppiumOptions
+from appium.options.flutter_integration.flutter_element_wait_timeout_option import FlutterElementWaitTimeOutOption
+from appium.options.flutter_integration.flutter_enable_mock_camera_option import FlutterEnableMockCameraOption
+from appium.options.flutter_integration.flutter_server_launch_timeout_option import FlutterServerLaunchTimeOutOption
+from appium.options.flutter_integration.flutter_system_port_option import FlutterSystemPortOption
+
+
+class FlutterOptions(
+    AppiumOptions,
+    FlutterElementWaitTimeOutOption,
+    FlutterEnableMockCameraOption,
+    FlutterServerLaunchTimeOutOption,
+    FlutterSystemPortOption,
+):
+    @property
+    def default_capabilities(self) -> Dict:
+        return {
+            AUTOMATION_NAME: 'FlutterIntegration',
+        }

appium/options/flutter_integration/flutter_element_wait_timeout_option.py

@@ -0,0 +1,50 @@
+# 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_ELEMENT_WAIT_TIMEOUT = 'flutterElementWaitTimeout'
+
+
+class FlutterElementWaitTimeOutOption(SupportsCapabilities):
+    @property
+    def flutter_element_wait_timeout(self) -> Optional[timedelta]:
+        """
+        Maximum timeout to wait for element for Flutter integration test
+
+        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_ELEMENT_WAIT_TIMEOUT)
+
+    @flutter_element_wait_timeout.setter
+    def flutter_element_wait_timeout(self, value: Union[timedelta, int]) -> None:
+        """
+        Sets the maximum timeout to wait for a Flutter element in an integration test.
+        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_ELEMENT_WAIT_TIMEOUT,
+            (int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value),
+        )