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

appium/options/android/uiautomator2/uiautomator2_server_read_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
+
+UIAUTOMATOR2_SERVER_READ_TIMEOUT = 'uiautomator2ServerReadTimeout'
+
+
+class Uiautomator2ServerReadTimeoutOption(SupportsCapabilities):
+    @property
+    def uiautomator2_server_read_timeout(self) -> Optional[timedelta]:
+        """
+        Maximum timeout to wait for an HTTP response from UiAutomator2Server.
+        """
+        value = self.get_capability(UIAUTOMATOR2_SERVER_READ_TIMEOUT)
+        return None if value is None else timedelta(milliseconds=value)
+
+    @uiautomator2_server_read_timeout.setter
+    def uiautomator2_server_read_timeout(self, value: Union[timedelta, int]) -> None:
+        """
+        Set the maximum timeout to wait for a HTTP response from UiAutomator2Server.
+        Only values greater than zero are accepted. If the given value is too low
+        then expect driver commands to fail with timeout of Xms exceeded error.
+        240000 ms by default
+        """
+        self.set_capability(
+            UIAUTOMATOR2_SERVER_READ_TIMEOUT,
+            int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value,
+        )

appium/options/common/__init__.py

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

appium/options/common/app_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 .supports_capabilities import SupportsCapabilities
+
+APP = 'app'
+
+
+class AppOption(SupportsCapabilities):
+    @property
+    def app(self) -> Optional[str]:
+        """
+        String representing app location.
+        """
+        return self.get_capability(APP)
+
+    @app.setter
+    def app(self, value: str) -> None:
+        """
+        Set the absolute local path for the location of the App.
+        The app must be located on the same machine where Appium
+        server is running.
+        Could also be a valid URL.
+        """
+        self.set_capability(APP, value)

appium/options/common/auto_web_view_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
+
+AUTO_WEB_VIEW = 'autoWebView'
+
+
+class AutoWebViewOption(SupportsCapabilities):
+    @property
+    def auto_web_view(self) -> Optional[bool]:
+        """
+        Whether the driver should try to automatically switch
+        to a web view context after the session is started.
+        """
+        return self.get_capability(AUTO_WEB_VIEW)
+
+    @auto_web_view.setter
+    def auto_web_view(self, value: bool) -> None:
+        """
+        Set whether the driver should try to automatically switch
+        a web view context after the session is started.
+        """
+        self.set_capability(AUTO_WEB_VIEW, value)

appium/options/common/automation_name_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
+
+AUTOMATION_NAME = 'automationName'
+
+
+class AutomationNameOption(SupportsCapabilities):
+    @property
+    def automation_name(self) -> Optional[str]:
+        """
+        String representing the name of the automation engine name.
+        """
+        return self.get_capability(AUTOMATION_NAME)
+
+    @automation_name.setter
+    def automation_name(self, value: str) -> None:
+        """
+        Set the automation driver name to use for the given platform.
+        """
+        self.set_capability(AUTOMATION_NAME, value)

appium/options/common/base.py

@@ -0,0 +1,125 @@
+# 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.
+
+import copy
+from typing import Any, Dict, TypeVar
+
+from selenium.webdriver.common.options import BaseOptions
+
+from .automation_name_option import AutomationNameOption
+from .browser_name_option import BROWSER_NAME, BrowserNameOption
+from .event_timings_option import EventTimingsOption
+from .full_reset_option import FullResetOption
+from .new_command_timeout_option import NewCommandTimeoutOption
+from .no_reset_option import NoResetOption
+from .print_page_source_on_find_failure_option import PrintPageSourceOnFindFailureOption
+
+APPIUM_PREFIX = 'appium:'
+T = TypeVar('T', bound='AppiumOptions')
+PLATFORM_NAME = 'platformName'
+
+
+class AppiumOptions(
+    BaseOptions,
+    BrowserNameOption,
+    AutomationNameOption,
+    EventTimingsOption,
+    PrintPageSourceOnFindFailureOption,
+    NoResetOption,
+    FullResetOption,
+    NewCommandTimeoutOption,
+):
+    _caps: Dict
+    W3C_CAPABILITY_NAMES = frozenset(
+        [
+            'acceptInsecureCerts',
+            BROWSER_NAME,
+            'browserVersion',
+            PLATFORM_NAME,
+            'pageLoadStrategy',
+            'proxy',
+            'setWindowRect',
+            'timeouts',
+            'unhandledPromptBehavior',
+        ]
+    )
+    _OSS_W3C_CONVERSION = {
+        'acceptSslCerts': 'acceptInsecureCerts',
+        'version': 'browserVersion',
+        'platform': PLATFORM_NAME,
+    }
+
+    # noinspection PyMissingConstructor
+    def __init__(self) -> None:
+        self._caps = self.default_capabilities
+        # FIXME: https://github.com/SeleniumHQ/selenium/issues/10755
+        self._ignore_local_proxy = False
+
+    def set_capability(self: T, name: str, value: Any) -> T:  # type: ignore[override]
+        w3c_name = name if name in self.W3C_CAPABILITY_NAMES or ':' in name else f'{APPIUM_PREFIX}{name}'
+        if value is None:
+            if w3c_name in self._caps:
+                del self._caps[w3c_name]
+        else:
+            self._caps[w3c_name] = value
+        return self
+
+    def get_capability(self, name: str) -> Any:
+        """Fetches capability value or None if the capability is not set"""
+        return self._caps[name] if name in self._caps else self._caps.get(f'{APPIUM_PREFIX}{name}')
+
+    def load_capabilities(self: T, caps: Dict[str, Any]) -> T:
+        """Sets multiple capabilities"""
+        for name, value in caps.items():
+            self.set_capability(name, value)
+        return self
+
+    @staticmethod
+    def as_w3c(capabilities: Dict) -> Dict:
+        """
+        Formats given capabilities to a valid W3C session request object
+
+        Args:
+            capabilities: Capabilities mapping
+
+        Returns:
+            W3C session request object
+        """
+
+        def process_key(k: str) -> str:
+            key = AppiumOptions._OSS_W3C_CONVERSION.get(k, k)
+            if key in AppiumOptions.W3C_CAPABILITY_NAMES:
+                return key
+            return key if ':' in key else f'{APPIUM_PREFIX}{key}'
+
+        processed_caps = {process_key(k): v for k, v in copy.deepcopy(capabilities).items()}
+        return {'capabilities': {'firstMatch': [{}], 'alwaysMatch': processed_caps}}
+
+    def to_w3c(self) -> Dict:
+        """
+        Formats the instance to a valid W3C session request object
+
+        :return: W3C session request object
+        """
+        return self.as_w3c(self.to_capabilities())
+
+    def to_capabilities(self) -> Dict:
+        return copy.copy(self._caps)
+
+    @property
+    def default_capabilities(self) -> Dict:
+        return {}

appium/options/common/browser_name_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
+
+BROWSER_NAME = 'browserName'
+
+
+class BrowserNameOption(SupportsCapabilities):
+    @property
+    def browser_name(self) -> Optional[str]:
+        """
+        The name of the browser to run the test on.
+        """
+        return self.get_capability(BROWSER_NAME)
+
+    @browser_name.setter
+    def browser_name(self, value: str) -> None:
+        """
+        Set the name of the browser to run the test on.
+        """
+        self.set_capability(BROWSER_NAME, value)

appium/options/common/bundle_id_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
+
+BUNDLE_ID = 'bundleId'
+
+
+class BundleIdOption(SupportsCapabilities):
+    @property
+    def bundle_id(self) -> Optional[str]:
+        """
+        The bundle identifier of the application to automate.
+        """
+        return self.get_capability(BUNDLE_ID)
+
+    @bundle_id.setter
+    def bundle_id(self, value: str) -> None:
+        """
+        Set the bundle identifier of the application to automate.
+        """
+        self.set_capability(BUNDLE_ID, value)

appium/options/common/clear_system_files_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
+
+CLEAR_SYSTEM_FILES = 'clearSystemFiles'
+
+
+class ClearSystemFilesOption(SupportsCapabilities):
+    @property
+    def clear_system_files(self) -> Optional[bool]:
+        """
+        Whether the driver should delete generated files at the end of a session.
+        """
+        return self.get_capability(CLEAR_SYSTEM_FILES)
+
+    @clear_system_files.setter
+    def clear_system_files(self, value: bool) -> None:
+        """
+        Set whether the driver should delete generated files at the end of a session.
+        """
+        self.set_capability(CLEAR_SYSTEM_FILES, value)

appium/options/common/device_name_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
+
+DEVICE_NAME = 'deviceName'
+
+
+class DeviceNameOption(SupportsCapabilities):
+    @property
+    def device_name(self) -> Optional[str]:
+        """
+        The name of the device.
+        """
+        return self.get_capability(DEVICE_NAME)
+
+    @device_name.setter
+    def device_name(self, value: str) -> None:
+        """
+        Set the name of the device to be used in the test.
+        """
+        self.set_capability(DEVICE_NAME, value)

appium/options/common/enable_performance_logging_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
+
+ENABLE_PERFORMANCE_LOGGING = 'enablePerformanceLogging'
+
+
+class EnablePerformanceLoggingOption(SupportsCapabilities):
+    @property
+    def enable_performance_logging(self) -> Optional[bool]:
+        """
+        Whether to enable additional performance logging.
+        """
+        return self.get_capability(ENABLE_PERFORMANCE_LOGGING)
+
+    @enable_performance_logging.setter
+    def enable_performance_logging(self, value: bool) -> None:
+        """
+        Set whether to enable additional performance logging.
+        """
+        self.set_capability(ENABLE_PERFORMANCE_LOGGING, value)

appium/options/common/event_timings_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
+
+EVENT_TIMINGS = 'eventTimings'
+
+
+class EventTimingsOption(SupportsCapabilities):
+    @property
+    def event_timings(self) -> Optional[bool]:
+        """
+        Whether the driver should to report the timings
+        for various Appium-internal events.
+        """
+        return self.get_capability(EVENT_TIMINGS)
+
+    @event_timings.setter
+    def event_timings(self, value: bool) -> None:
+        """
+        Set whether the driver should to report the timings
+        for various Appium-internal events.
+        """
+        self.set_capability(EVENT_TIMINGS, value)

appium/options/common/full_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
+
+FULL_RESET = 'fullReset'
+
+
+class FullResetOption(SupportsCapabilities):
+    @property
+    def full_reset(self) -> Optional[bool]:
+        """
+        Whether the driver should perform a full reset.
+        """
+        return self.get_capability(FULL_RESET)
+
+    @full_reset.setter
+    def full_reset(self, value: bool) -> None:
+        """
+        Set whether the driver should perform a full reset.
+        """
+        self.set_capability(FULL_RESET, value)

appium/options/common/is_headless_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
+
+IS_HEADLESS = 'isHeadless'
+
+
+class IsHeadlessOption(SupportsCapabilities):
+    @property
+    def is_headless(self) -> Optional[bool]:
+        """
+        Whether the driver should start emulator/simulator in headless mode.
+        """
+        return self.get_capability(IS_HEADLESS)
+
+    @is_headless.setter
+    def is_headless(self, value: bool) -> None:
+        """
+        Set emulator/simulator to start in headless mode (e.g. no UI is shown).
+        It is only applied if the emulator is not running before the test starts.
+        """
+        self.set_capability(IS_HEADLESS, value)

appium/options/common/language_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
+
+LANGUAGE = 'language'
+
+
+class LanguageOption(SupportsCapabilities):
+    @property
+    def language(self) -> Optional[str]:
+        """
+        Language abbreviation to use in a test session.
+        """
+        return self.get_capability(LANGUAGE)
+
+    @language.setter
+    def language(self, value: str) -> None:
+        """
+        Set language abbreviation to use in a test session.
+        """
+        self.set_capability(LANGUAGE, value)