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

appium/options/windows/windows/create_session_timeout_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 datetime import timedelta
+from typing import Optional, Union
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+CREATE_SESSION_TIMEOUT = 'createSessionTimeout'
+
+
+class CreateSessionTimeoutOption(SupportsCapabilities):
+    @property
+    def create_session_timeout(self) -> Optional[timedelta]:
+        """
+        Timeout used to retry Appium Windows Driver session startup.
+        """
+        value = self.get_capability(CREATE_SESSION_TIMEOUT)
+        return None if value is None else timedelta(milliseconds=value)
+
+    @create_session_timeout.setter
+    def create_session_timeout(self, value: Union[timedelta, int]) -> None:
+        """
+        Set the timeout used to retry Appium Windows Driver session startup.
+        This capability could be used as a workaround for the long startup times
+        of UWP applications (aka Failed to locate opened application window
+        with appId: TestCompany.my_app4!App, and processId: 8480).
+        """
+        self.set_capability(
+            CREATE_SESSION_TIMEOUT, int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value
+        )

appium/options/windows/windows/expreimental_web_driver_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
+
+EXPERIMENTAL_WEB_DRIVER = 'ms:experimental-webdriver'
+
+
+class ExperimentalWebDriverOption(SupportsCapabilities):
+    @property
+    def experimental_webdriver(self) -> Optional[bool]:
+        """
+        Whether to enable experimental features and optimizations.
+        """
+        return self.get_capability(EXPERIMENTAL_WEB_DRIVER)
+
+    @experimental_webdriver.setter
+    def experimental_webdriver(self, value: bool) -> None:
+        """
+        Enables experimental features and optimizations. See Appium Windows
+        Driver release notes for more details on this capability.
+        """
+        self.set_capability(EXPERIMENTAL_WEB_DRIVER, value)

appium/options/windows/windows/wait_for_app_launch_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 datetime import timedelta
+from typing import Optional, Union
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+WAIT_FOR_APP_LAUNCH = 'ms:waitForAppLaunch'
+
+
+class WaitForAppLaunchOption(SupportsCapabilities):
+    @property
+    def wait_for_app_launch(self) -> Optional[timedelta]:
+        """
+        Timeout used to retry Appium Windows Driver session startup.
+        """
+        value = self.get_capability(WAIT_FOR_APP_LAUNCH)
+        return None if value is None else timedelta(seconds=value)
+
+    @wait_for_app_launch.setter
+    def wait_for_app_launch(self, value: Union[timedelta, int]) -> None:
+        """
+        Similar to createSessionTimeout, but is
+        applied on the server side. Enables Appium Windows Driver to wait for
+        a defined amount of time after an app launch is initiated prior to
+        attaching to the application session. The limit for this is 50 seconds.
+        """
+        self.set_capability(WAIT_FOR_APP_LAUNCH, value.total_seconds() if isinstance(value, timedelta) else value)

appium/protocols/__init__.py

@@ -0,0 +1,13 @@
+#!/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.

appium/protocols/webdriver/__init__.py

@@ -0,0 +1,13 @@
+#!/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.

appium/protocols/webdriver/can_execute_commands.py

@@ -0,0 +1,23 @@
+#!/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 typing import Dict, Protocol, Union
+
+from selenium.webdriver.remote.remote_connection import RemoteConnection
+
+
+class CanExecuteCommands(Protocol):
+    command_executor: RemoteConnection
+
+    def execute(self, driver_command: str, params: Union[Dict, None] = None) -> Dict: ...

appium/protocols/webdriver/can_execute_scripts.py

@@ -0,0 +1,27 @@
+#!/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 typing import Any, List, Optional, Protocol
+
+
+class CanExecuteScripts(Protocol):
+    def pin_script(self, script: str, script_key: Optional[Any] = None) -> Any: ...
+
+    def unpin(self, script_key: Any) -> None: ...
+
+    def get_pinned_scripts(self) -> List[str]: ...
+
+    def execute_script(self, script: str, *args: Any) -> Any: ...
+
+    def execute_async_script(self, script: str, *args: Any) -> Any: ...

appium/protocols/webdriver/can_find_elements.py

@@ -0,0 +1,32 @@
+#!/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 typing import TYPE_CHECKING, Dict, List, Protocol, Union, runtime_checkable
+
+if TYPE_CHECKING:
+    from appium.webdriver.webelement import WebElement
+
+
+@runtime_checkable
+class CanFindElements(Protocol):
+    """Protocol for objects that can find web elements.
+
+    Any class implementing this protocol must provide:
+    - find_element(by, value): Find a single element
+    - find_elements(by, value): Find multiple elements
+    """
+
+    def find_element(self, by: str, value: Union[str, Dict, None] = None) -> 'WebElement': ...
+
+    def find_elements(self, by: str, value: Union[str, Dict, None] = None) -> List['WebElement']: ...

appium/protocols/webdriver/can_remember_extension_presence.py

@@ -0,0 +1,23 @@
+#!/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 typing import Protocol, TypeVar
+
+T = TypeVar('T')
+
+
+class CanRememberExtensionPresence(Protocol):
+    def assert_extension_exists(self: T, ext_name: str) -> T: ...
+
+    def mark_extension_absence(self: T, ext_name: str) -> T: ...

appium/version.py

@@ -0,0 +1,22 @@
+#!/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 importlib import metadata
+
+
+def _get_version():
+    return metadata.version('Appium-Python-Client')
+
+
+version = _get_version()

appium/webdriver/__init__.py

@@ -0,0 +1,20 @@
+#!/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.
+
+"""
+Appium Python Client: WebDriver module
+"""
+
+from .webdriver import WebDriver as Remote
+from .webelement import WebElement

appium/webdriver/appium_connection.py

@@ -0,0 +1,65 @@
+#!/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.
+
+import uuid
+from typing import TYPE_CHECKING, Any, Dict
+
+from selenium.webdriver.remote.remote_connection import RemoteConnection
+
+from appium.common.helper import library_version
+
+if TYPE_CHECKING:
+    from urllib.parse import ParseResult
+
+
+PREFIX_HEADER = 'appium/'
+
+HEADER_IDEMOTENCY_KEY = 'X-Idempotency-Key'
+
+
+def _get_new_headers(key: str, headers: Dict[str, str]) -> Dict[str, str]:
+    """Return a new dictionary of heafers without the given key.
+    The key match is case-insensitive."""
+    lower_key = key.lower()
+    return {k: v for k, v in headers.items() if k.lower() != lower_key}
+
+
+class AppiumConnection(RemoteConnection):
+    """
+    A subclass of selenium.webdriver.remote.remote_connection.Remoteconnection.
+
+    The changes are
+
+    * The default user agent
+    * Adds 'X-Idempotency-Key' header in a new session request to avoid proceeding
+        the same request multiple times in the Appium server side.
+        * https://github.com/appium/appium-base-driver/pull/400
+    """
+
+    user_agent = f'{PREFIX_HEADER}{library_version()} ({RemoteConnection.user_agent})'
+    extra_headers = {}
+
+    @classmethod
+    def get_remote_connection_headers(cls, parsed_url: 'ParseResult', keep_alive: bool = True) -> Dict[str, Any]:
+        """Override get_remote_connection_headers in RemoteConnection to control the extra headers.
+        This method will be used in sending a request method in this class.
+        """
+
+        if parsed_url.path.endswith('/session'):
+            # https://github.com/appium/appium-base-driver/pull/400
+            cls.extra_headers[HEADER_IDEMOTENCY_KEY] = str(uuid.uuid4())
+        else:
+            cls.extra_headers = _get_new_headers(HEADER_IDEMOTENCY_KEY, cls.extra_headers)
+
+        return {**super().get_remote_connection_headers(parsed_url, keep_alive=keep_alive), **cls.extra_headers}