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

appium/__init__.py

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

appium/common/__init__.py

@@ -0,0 +1,17 @@
+#!/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: Common classes
+"""

appium/common/exceptions.py

@@ -0,0 +1,26 @@
+#!/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 selenium.common.exceptions import InvalidSwitchToTargetException
+
+
+class NoSuchContextException(InvalidSwitchToTargetException):
+    """Thrown when context target to be switched doesn't exist.
+
+    To find the current set of active contexts, you can get a list
+    of the active contexts in the following way:
+
+        print(driver.contexts)
+
+    """

appium/common/helper.py

@@ -0,0 +1,42 @@
+#!/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 base64
+from typing import Any, Dict
+
+from appium import version as appium_version
+
+
+def extract_const_attributes(cls: type) -> Dict[str, Any]:
+    """Return dict with constants attributes and values in the class(e.g. {'VAL1': 1, 'VAL2': 2})
+
+    Args:
+        cls: Class to be extracted constants
+
+    Returns:
+        dict with constants attributes and values in the class
+    """
+    return {attr: value for attr, value in vars(cls).items() if not callable(getattr(cls, attr)) and attr.isupper()}
+
+
+def library_version() -> str:
+    """Return a version of this python library"""
+
+    return appium_version.version
+
+
+def encode_file_to_base64(file_path: str) -> str:
+    """Return base64 encoded string for given file"""
+    with open(file_path, 'rb') as file:
+        return base64.b64encode(file.read()).decode('utf-8')

appium/common/logger.py

@@ -0,0 +1,28 @@
+#!/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 logging
+import sys
+
+
+def setup_logger(level: int = logging.NOTSET) -> None:
+    logger.propagate = False
+    logger.setLevel(level)
+    handler = logging.StreamHandler(stream=sys.stderr)
+    logger.addHandler(handler)
+
+
+# global logger
+logger = logging.getLogger(__name__)
+setup_logger()

appium/options/android/__init__.py

@@ -0,0 +1,2 @@
+from .espresso.base import EspressoOptions
+from .uiautomator2.base import UiAutomator2Options

appium/options/android/common/adb/adb_exec_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
+
+ADB_EXEC_TIMEOUT = 'adbExecTimeout'
+
+
+class AdbExecTimeoutOption(SupportsCapabilities):
+    @property
+    def adb_exec_timeout(self) -> Optional[timedelta]:
+        """
+        Maximum time to wait until single ADB command is executed.
+        """
+        value = self.get_capability(ADB_EXEC_TIMEOUT)
+        return None if value is None else timedelta(milliseconds=value)
+
+    @adb_exec_timeout.setter
+    def adb_exec_timeout(self, value: Union[timedelta, int]) -> None:
+        """
+        Maximum time to wait until single ADB command is executed.
+        20000 ms by default.
+        """
+        self.set_capability(ADB_EXEC_TIMEOUT, int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value)

appium/options/android/common/adb/adb_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
+
+ADB_PORT = 'adbPort'
+
+
+class AdbPortOption(SupportsCapabilities):
+    @property
+    def adb_port(self) -> Optional[int]:
+        """
+        Number of the port where ADB is running.
+        """
+        return self.get_capability(ADB_PORT)
+
+    @adb_port.setter
+    def adb_port(self, value: int) -> None:
+        """
+        Set number of the port where ADB is running. 5037 by default
+        """
+        self.set_capability(ADB_PORT, value)

appium/options/android/common/adb/allow_delay_adb_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
+
+ALLOW_DELAY_ADB = 'allowDelayAdb'
+
+
+class AllowDelayAdbOption(SupportsCapabilities):
+    @property
+    def allow_delay_adb(self) -> Optional[bool]:
+        """
+        Whether to prevent the emulator to use -delay-adb feature.
+        """
+        return self.get_capability(ALLOW_DELAY_ADB)
+
+    @allow_delay_adb.setter
+    def allow_delay_adb(self, value: bool) -> None:
+        """
+        Being set to false prevents emulator to use -delay-adb feature to detect its startup.
+        See https://github.com/appium/appium/issues/14773 for more details.
+        """
+        self.set_capability(ALLOW_DELAY_ADB, value)

appium/options/android/common/adb/build_tools_version_option.py

@@ -0,0 +1,42 @@
+# 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
+
+BUILD_TOOLS_VERSION = 'buildToolsVersion'
+
+
+class BuildToolsVersionOption(SupportsCapabilities):
+    @property
+    def build_tools_version(self) -> Optional[str]:
+        """
+        Version of Android build tools to use.
+        """
+        return self.get_capability(BUILD_TOOLS_VERSION)
+
+    @build_tools_version.setter
+    def build_tools_version(self, value: str) -> None:
+        """
+        The version of Android build tools to use. By default, UiAutomator2
+        driver uses the most recent version of build tools installed on
+        the machine, but sometimes it might be necessary to give it a hint
+        (let say if there is a known bug in the most recent tools version).
+        Example: 28.0.3
+        """
+        self.set_capability(BUILD_TOOLS_VERSION, value)

appium/options/android/common/adb/clear_device_logs_on_start_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
+
+CLEAR_DEVICE_LOGS_ON_START = 'clearDeviceLogsOnStart'
+
+
+class ClearDeviceLogsOnStartOption(SupportsCapabilities):
+    @property
+    def clear_device_logs_on_start(self) -> Optional[bool]:
+        """
+        Makes the driver to delete all the existing logs in the
+        device buffer before starting a new test.
+        """
+        return self.get_capability(CLEAR_DEVICE_LOGS_ON_START)
+
+    @clear_device_logs_on_start.setter
+    def clear_device_logs_on_start(self, value: bool) -> None:
+        """
+        If set to true then the driver deletes all the existing logs in the
+        device buffer before starting a new test.
+        """
+        self.set_capability(CLEAR_DEVICE_LOGS_ON_START, value)

appium/options/android/common/adb/ignore_hidden_api_policy_error_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
+
+IGNORE_HIDDEN_API_POLICY_ERROR = 'ignoreHiddenApiPolicyError'
+
+
+class IgnoreHiddenApiPolicyErrorOption(SupportsCapabilities):
+    @property
+    def ignore_hidden_api_policy_error(self) -> Optional[bool]:
+        """
+        Whether to ignore a failure while changing hidden API access policies.
+        """
+        return self.get_capability(IGNORE_HIDDEN_API_POLICY_ERROR)
+
+    @ignore_hidden_api_policy_error.setter
+    def ignore_hidden_api_policy_error(self, value: bool) -> None:
+        """
+        Being set to true ignores a failure while changing hidden API access policies.
+        Could be useful on some devices, where access to these policies has been locked by its vendor.
+        false by default.
+        """
+        self.set_capability(IGNORE_HIDDEN_API_POLICY_ERROR, value)

appium/options/android/common/adb/logcat_filter_specs_option.py

@@ -0,0 +1,42 @@
+# 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
+
+LOGCAT_FILTER_SPECS = 'logcatFilterSpecs'
+
+
+class LogcatFilterSpecsOption(SupportsCapabilities):
+    @property
+    def logcat_filter_specs(self) -> Optional[str]:
+        """
+        Logcat filter format.
+        """
+        return self.get_capability(LOGCAT_FILTER_SPECS)
+
+    @logcat_filter_specs.setter
+    def logcat_filter_specs(self, value: str) -> None:
+        """
+        Series of tag[:priority] where tag is a log component tag (or * for all)
+        and priority is: V Verbose, D Debug, I Info, W Warn, E Error, F Fatal,
+        S Silent (suppress all output). '' means ':d' and tag by itself means tag:v.
+        If not specified on the commandline, filterspec is set from ANDROID_LOG_TAGS.
+        If no filterspec is found, filter defaults to '*:I'.
+        """
+        self.set_capability(LOGCAT_FILTER_SPECS, value)

appium/options/android/common/adb/logcat_format_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
+
+LOGCAT_FORMAT = 'logcatFormat'
+
+
+class LogcatFormatOption(SupportsCapabilities):
+    @property
+    def logcat_format(self) -> Optional[str]:
+        """
+        Log print format.
+        """
+        return self.get_capability(LOGCAT_FORMAT)
+
+    @logcat_format.setter
+    def logcat_format(self, value: str) -> None:
+        """
+        The log print format, where format is one of: brief process tag thread raw time
+        threadtime long. threadtime is the default value.
+        """
+        self.set_capability(LOGCAT_FORMAT, value)

appium/options/android/common/adb/mock_location_app_option.py

@@ -0,0 +1,42 @@
+# 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
+
+MOCK_LOCATION_APP = 'mockLocationApp'
+
+
+class MockLocationAppOption(SupportsCapabilities):
+    @property
+    def mock_location_app(self) -> Optional[str]:
+        """
+        Identifier of the app, which is used as a system mock location provider.
+        """
+        return self.get_capability(MOCK_LOCATION_APP)
+
+    @mock_location_app.setter
+    def mock_location_app(self, value: str) -> None:
+        """
+        Sets the package identifier of the app, which is used as a system mock location
+        provider since Appium 1.18.0+. This capability has no effect on emulators.
+        If the value is set to null or an empty string, then Appium will skip the mocked
+        location provider setup procedure. Defaults to Appium Setting package
+        identifier (io.appium.settings).
+        """
+        self.set_capability(MOCK_LOCATION_APP, value)

appium/options/android/common/adb/remote_adb_host_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
+
+REMOTE_ADB_HOST = 'remoteAdbHost'
+
+
+class RemoteAdbHostOption(SupportsCapabilities):
+    @property
+    def remote_adb_host(self) -> Optional[str]:
+        """
+        Address of the host where ADB is running.
+        """
+        return self.get_capability(REMOTE_ADB_HOST)
+
+    @remote_adb_host.setter
+    def remote_adb_host(self, value: str) -> None:
+        """
+        Address of the host where ADB is running (the value of -H ADB command line option).
+        Localhost by default.
+        """
+        self.set_capability(REMOTE_ADB_HOST, value)

appium/options/android/common/adb/skip_logcat_capture_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
+
+SKIP_LOGCAT_CAPTURE = 'skipLogcatCapture'
+
+
+class SkipLogcatCaptureOption(SupportsCapabilities):
+    @property
+    def skip_logcat_capture(self) -> Optional[bool]:
+        """
+        Whether to delete all the existing logs in the
+        device buffer before starting a new test.
+        """
+        return self.get_capability(SKIP_LOGCAT_CAPTURE)
+
+    @skip_logcat_capture.setter
+    def skip_logcat_capture(self, value: bool) -> None:
+        """
+        Being set to true disables automatic logcat output collection during the test run.
+        false by default
+        """
+        self.set_capability(SKIP_LOGCAT_CAPTURE, value)

appium/options/android/common/adb/suppress_kill_server_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
+
+SUPPRESS_KILL_SERVER = 'suppressKillServer'
+
+
+class SuppressKillServerOption(SupportsCapabilities):
+    @property
+    def suppress_kill_server(self) -> Optional[bool]:
+        """
+        Prevents the driver from ever killing the ADB server explicitly.
+        """
+        return self.get_capability(SUPPRESS_KILL_SERVER)
+
+    @suppress_kill_server.setter
+    def suppress_kill_server(self, value: bool) -> None:
+        """
+        Being set to true prevents the driver from ever killing the ADB server explicitly.
+        Could be useful if ADB is connected wirelessly. false by default.
+        """
+        self.set_capability(SUPPRESS_KILL_SERVER, value)