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

appium/options/android/common/other/user_profile_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
+
+USER_PROFILE = 'userProfile'
+
+
+class UserProfileOption(SupportsCapabilities):
+    @property
+    def user_profile(self) -> Optional[int]:
+        """
+        Integer identifier of a user profile.
+        """
+        return self.get_capability(USER_PROFILE)
+
+    @user_profile.setter
+    def user_profile(self, value: int) -> None:
+        """
+        Integer identifier of a user profile. By default, the app under test is
+        installed for the currently active user, but in case it is necessary to
+        test how the app performs while being installed for a user profile,
+        which is different from the current one, this capability might
+        come in handy.
+        """
+        self.set_capability(USER_PROFILE, value)

appium/options/android/common/signing/key_alias_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
+
+KEY_ALIAS = 'keyAlias'
+
+
+class KeyAliasOption(SupportsCapabilities):
+    @property
+    def key_alias(self) -> Optional[str]:
+        """
+        Keystore key alias.
+        """
+        return self.get_capability(KEY_ALIAS)
+
+    @key_alias.setter
+    def key_alias(self, value: str) -> None:
+        """
+        The alias of the key in the keystore file provided in keystorePath capability.
+        This option is used in combination with useKeystore, keystorePath,
+        keystorePassword, keyAlias and keyPassword options. Unset by default
+        """
+        self.set_capability(KEY_ALIAS, value)

appium/options/android/common/signing/key_password_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
+
+KEY_PASSWORD = 'keyPassword'
+
+
+class KeyPasswordOption(SupportsCapabilities):
+    @property
+    def key_password(self) -> Optional[str]:
+        """
+        Keystore key password.
+        """
+        return self.get_capability(KEY_PASSWORD)
+
+    @key_password.setter
+    def key_password(self, value: str) -> None:
+        """
+        The password of the key in the keystore file provided in keystorePath capability.
+        This option is used in combination with useKeystore, keystorePath,
+        keystorePassword, keyAlias and keyPassword options. Unset by default
+        """
+        self.set_capability(KEY_PASSWORD, value)

appium/options/android/common/signing/keystore_password_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
+
+KEYSTORE_PASSWORD = 'keystorePassword'
+
+
+class KeystorePasswordOption(SupportsCapabilities):
+    @property
+    def keystore_password(self) -> Optional[str]:
+        """
+        Keystore password.
+        """
+        return self.get_capability(KEYSTORE_PASSWORD)
+
+    @keystore_password.setter
+    def keystore_password(self, value: str) -> None:
+        """
+        The password to the keystore file provided in keystorePath capability.
+        This option is used in combination with useKeystore, keystorePath,
+        keystorePassword, keyAlias and keyPassword options. Unset by default
+        """
+        self.set_capability(KEYSTORE_PASSWORD, value)

appium/options/android/common/signing/keystore_path_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
+
+KEYSTORE_PATH = 'keystorePath'
+
+
+class KeystorePathOption(SupportsCapabilities):
+    @property
+    def keystore_path(self) -> Optional[str]:
+        """
+        The path to keystore.
+        """
+        return self.get_capability(KEYSTORE_PATH)
+
+    @keystore_path.setter
+    def keystore_path(self, value: str) -> None:
+        """
+        The full path to the keystore file on the server filesystem.
+        This option is used in combination with useKeystore, keystorePath,
+        keystorePassword, keyAlias and keyPassword options. Unset by default
+        """
+        self.set_capability(KEYSTORE_PATH, value)

appium/options/android/common/signing/no_sign_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
+
+NO_SIGN = 'noSign'
+
+
+class NoSignOption(SupportsCapabilities):
+    @property
+    def no_sign(self) -> Optional[bool]:
+        """
+        Whether to skip application signing.
+        """
+        return self.get_capability(NO_SIGN)
+
+    @no_sign.setter
+    def no_sign(self, value: bool) -> None:
+        """
+        Set it to true in order to skip application signing. By default
+        all apps are always signed with the default Appium debug signature
+        if they don't have any. This capability cancels all the signing checks
+        and makes the driver to use the application package as is. This option
+        does not affect .apks packages as these are expected to be already signed.
+        """
+        self.set_capability(NO_SIGN, value)

appium/options/android/common/signing/use_keystore_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
+
+USE_KEYSTORE = 'useKeystore'
+
+
+class UseKeystoreOption(SupportsCapabilities):
+    @property
+    def use_keystore(self) -> Optional[bool]:
+        """
+        Whether to use custom keystore.
+        """
+        return self.get_capability(USE_KEYSTORE)
+
+    @use_keystore.setter
+    def use_keystore(self, value: bool) -> None:
+        """
+        Whether to use a custom keystore to sign the app under test.
+        false by default, which means apps are always signed with the default A
+        ppium debug certificate (unless canceled by noSign capability).
+        This option is used in combination with keystorePath, keystorePassword,
+        keyAlias and keyPassword options.
+        """
+        self.set_capability(USE_KEYSTORE, value)

appium/options/android/espresso/activity_options_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 Dict, Optional
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+ACTIVITY_OPTIONS = 'activityOptions'
+
+
+class ActivityOptionsOption(SupportsCapabilities):
+    @property
+    def activity_options(self) -> Optional[Dict]:
+        """
+        Activity options.
+        """
+        return self.get_capability(ACTIVITY_OPTIONS)
+
+    @activity_options.setter
+    def activity_options(self, value: Dict) -> None:
+        """
+        The mapping of custom options for the main app activity that is going to
+        be started. Check
+        https://github.com/appium/appium-espresso-driver#activity-options
+        for more details.
+        """
+        self.set_capability(ACTIVITY_OPTIONS, value)

appium/options/android/espresso/app_locale_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 typing import Dict, Optional
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+APP_LOCALE = 'appLocale'
+
+
+class AppLocaleOption(SupportsCapabilities):
+    @property
+    def app_locale(self) -> Optional[Dict[str, str]]:
+        """
+        Locale for the app under test.
+        """
+        return self.get_capability(APP_LOCALE)
+
+    @app_locale.setter
+    def app_locale(self, value: Dict[str, str]) -> None:
+        """
+        Sets the locale for the app under test. The main difference between this option
+        and the above ones is that this option only changes the locale for the application
+        under test and does not affect other parts of the system. Also, it only uses
+        public APIs for its purpose. See
+        https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers to get the
+        list of available language abbreviations.
+        Example: {"language": "zh", "country": "CN", "variant": "Hans"}.
+        """
+        self.set_capability(APP_LOCALE, value)

appium/options/android/espresso/base.py

@@ -0,0 +1,221 @@
+# 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.android.common.adb.adb_exec_timeout_option import AdbExecTimeoutOption
+from appium.options.android.common.adb.adb_port_option import AdbPortOption
+from appium.options.android.common.adb.allow_delay_adb_option import AllowDelayAdbOption
+from appium.options.android.common.adb.build_tools_version_option import BuildToolsVersionOption
+from appium.options.android.common.adb.clear_device_logs_on_start_option import ClearDeviceLogsOnStartOption
+from appium.options.android.common.adb.ignore_hidden_api_policy_error_option import IgnoreHiddenApiPolicyErrorOption
+from appium.options.android.common.adb.logcat_filter_specs_option import LogcatFilterSpecsOption
+from appium.options.android.common.adb.logcat_format_option import LogcatFormatOption
+from appium.options.android.common.adb.mock_location_app_option import MockLocationAppOption
+from appium.options.android.common.adb.remote_adb_host_option import RemoteAdbHostOption
+from appium.options.android.common.adb.skip_logcat_capture_option import SkipLogcatCaptureOption
+from appium.options.android.common.adb.suppress_kill_server_option import SuppressKillServerOption
+from appium.options.android.common.app.allow_test_packages_option import AllowTestPackagesOption
+from appium.options.android.common.app.android_install_timeout_option import AndroidInstallTimeoutOption
+from appium.options.android.common.app.app_activity_option import AppActivityOption
+from appium.options.android.common.app.app_package_option import AppPackageOption
+from appium.options.android.common.app.app_wait_activity_option import AppWaitActivityOption
+from appium.options.android.common.app.app_wait_duration_option import AppWaitDurationOption
+from appium.options.android.common.app.app_wait_for_launch_option import AppWaitForLaunchOption
+from appium.options.android.common.app.app_wait_package_option import AppWaitPackageOption
+from appium.options.android.common.app.auto_grant_premissions_option import AutoGrantPermissionsOption
+from appium.options.android.common.app.enforce_app_install_option import EnforceAppInstallOption
+from appium.options.android.common.app.intent_action_option import IntentActionOption
+from appium.options.android.common.app.intent_category_option import IntentCategoryOption
+from appium.options.android.common.app.intent_flags_option import IntentFlagsOption
+from appium.options.android.common.app.optional_intent_arguments_option import OptionalIntentArgumentsOption
+from appium.options.android.common.app.remote_apps_cache_limit_option import RemoteAppsCacheLimitOption
+from appium.options.android.common.app.uninstall_other_packages_option import UninstallOtherPackagesOption
+from appium.options.android.common.avd.avd_args_option import AvdArgsOption
+from appium.options.android.common.avd.avd_env_option import AvdEnvOption
+from appium.options.android.common.avd.avd_launch_timeout_option import AvdLaunchTimeoutOption
+from appium.options.android.common.avd.avd_option import AvdOption
+from appium.options.android.common.avd.avd_ready_timeout_option import AvdReadyTimeoutOption
+from appium.options.android.common.avd.gps_enabled_option import GpsEnabledOption
+from appium.options.android.common.avd.network_speed_option import NetworkSpeedOption
+from appium.options.android.common.context.auto_webview_timeout_option import AutoWebviewTimeoutOption
+from appium.options.android.common.context.chrome_logging_prefs_option import ChromeLoggingPrefsOption
+from appium.options.android.common.context.chrome_options_option import ChromeOptionsOption
+from appium.options.android.common.context.chromedriver_args_option import ChromedriverArgsOption
+from appium.options.android.common.context.chromedriver_chrome_mapping_file_option import (
+    ChromedriverChromeMappingFileOption,
+)
+from appium.options.android.common.context.chromedriver_disable_build_check_option import (
+    ChromedriverDisableBuildCheckOption,
+)
+from appium.options.android.common.context.chromedriver_executable_dir_option import ChromedriverExecutableDirOption
+from appium.options.android.common.context.chromedriver_executable_option import ChromedriverExecutableOption
+from appium.options.android.common.context.chromedriver_port_option import ChromedriverPortOption
+from appium.options.android.common.context.chromedriver_ports_option import ChromedriverPortsOption
+from appium.options.android.common.context.chromedriver_use_system_executable_option import (
+    ChromedriverUseSystemExecutableOption,
+)
+from appium.options.android.common.context.ensure_webviews_have_pages_option import EnsureWebviewsHavePagesOption
+from appium.options.android.common.context.extract_chrome_android_package_from_context_name_option import (
+    ExtractChromeAndroidPackageFromContextNameOption,
+)
+from appium.options.android.common.context.native_web_screenshot_option import NativeWebScreenshotOption
+from appium.options.android.common.context.recreate_chrome_driver_sessions_option import (
+    RecreateChromeDriverSessionsOption,
+)
+from appium.options.android.common.context.show_chromedriver_log_option import ShowChromedriverLogOption
+from appium.options.android.common.context.webview_devtools_port_option import WebviewDevtoolsPortOption
+from appium.options.android.common.localization.locale_script_option import LocaleScriptOption
+from appium.options.android.common.locking.skip_unlock_option import SkipUnlockOption
+from appium.options.android.common.locking.unlock_key_option import UnlockKeyOption
+from appium.options.android.common.locking.unlock_strategy_option import UnlockStrategyOption
+from appium.options.android.common.locking.unlock_success_timeout_option import UnlockSuccessTimeoutOption
+from appium.options.android.common.locking.unlock_type_option import UnlockTypeOption
+from appium.options.android.common.mjpeg.mjpeg_screenshot_url_option import MjpegScreenshotUrlOption
+from appium.options.android.common.other.disable_suppress_accessibility_service_option import (
+    DisableSuppressAccessibilityServiceOption,
+)
+from appium.options.android.common.other.user_profile_option import UserProfileOption
+from appium.options.android.common.signing.key_alias_option import KeyAliasOption
+from appium.options.android.common.signing.key_password_option import KeyPasswordOption
+from appium.options.android.common.signing.keystore_password_option import KeystorePasswordOption
+from appium.options.android.common.signing.keystore_path_option import KeystorePathOption
+from appium.options.android.common.signing.no_sign_option import NoSignOption
+from appium.options.android.common.signing.use_keystore_option import UseKeystoreOption
+from appium.options.common.app_option import AppOption
+from appium.options.common.auto_web_view_option import AutoWebViewOption
+from appium.options.common.automation_name_option import AUTOMATION_NAME
+from appium.options.common.base import PLATFORM_NAME, AppiumOptions
+from appium.options.common.clear_system_files_option import ClearSystemFilesOption
+from appium.options.common.device_name_option import DeviceNameOption
+from appium.options.common.enable_performance_logging_option import EnablePerformanceLoggingOption
+from appium.options.common.is_headless_option import IsHeadlessOption
+from appium.options.common.language_option import LanguageOption
+from appium.options.common.locale_option import LocaleOption
+from appium.options.common.orientation_option import OrientationOption
+from appium.options.common.other_apps_option import OtherAppsOption
+from appium.options.common.platform_version_option import PlatformVersionOption
+from appium.options.common.skip_log_capture_option import SkipLogCaptureOption
+from appium.options.common.system_port_option import SystemPortOption
+from appium.options.common.udid_option import UdidOption
+
+from .activity_options_option import ActivityOptionsOption
+from .app_locale_option import AppLocaleOption
+from .espresso_build_config_option import EspressoBuildConfigOption
+from .espresso_server_launch_timeout_option import EspressoServerLaunchTimeoutOption
+from .force_espresso_rebuild_option import ForceEspressoRebuildOption
+from .intent_options_option import IntentOptionsOption
+from .show_gradle_log_option import ShowGradleLogOption
+
+
+class EspressoOptions(
+    AppiumOptions,
+    AppOption,
+    OrientationOption,
+    UdidOption,
+    LanguageOption,
+    LocaleOption,
+    IsHeadlessOption,
+    SkipLogCaptureOption,
+    AutoWebViewOption,
+    DeviceNameOption,
+    ClearSystemFilesOption,
+    EnablePerformanceLoggingOption,
+    OtherAppsOption,
+    SystemPortOption,
+    AppPackageOption,
+    AppActivityOption,
+    AppWaitActivityOption,
+    AppWaitPackageOption,
+    AppWaitDurationOption,
+    AndroidInstallTimeoutOption,
+    AppWaitForLaunchOption,
+    IntentCategoryOption,
+    IntentActionOption,
+    IntentFlagsOption,
+    OptionalIntentArgumentsOption,
+    AutoGrantPermissionsOption,
+    UninstallOtherPackagesOption,
+    AllowTestPackagesOption,
+    RemoteAppsCacheLimitOption,
+    EnforceAppInstallOption,
+    LocaleScriptOption,
+    AdbPortOption,
+    PlatformVersionOption,
+    RemoteAdbHostOption,
+    AdbExecTimeoutOption,
+    ClearDeviceLogsOnStartOption,
+    BuildToolsVersionOption,
+    SkipLogcatCaptureOption,
+    SuppressKillServerOption,
+    IgnoreHiddenApiPolicyErrorOption,
+    MockLocationAppOption,
+    LogcatFormatOption,
+    LogcatFilterSpecsOption,
+    AllowDelayAdbOption,
+    AvdOption,
+    AvdLaunchTimeoutOption,
+    AvdReadyTimeoutOption,
+    AvdArgsOption,
+    AvdEnvOption,
+    NetworkSpeedOption,
+    GpsEnabledOption,
+    UseKeystoreOption,
+    KeystorePathOption,
+    KeystorePasswordOption,
+    KeyAliasOption,
+    KeyPasswordOption,
+    NoSignOption,
+    SkipUnlockOption,
+    UnlockKeyOption,
+    UnlockStrategyOption,
+    UnlockSuccessTimeoutOption,
+    UnlockTypeOption,
+    MjpegScreenshotUrlOption,
+    AutoWebviewTimeoutOption,
+    ChromeLoggingPrefsOption,
+    ChromeOptionsOption,
+    ChromedriverArgsOption,
+    ChromedriverChromeMappingFileOption,
+    ChromedriverDisableBuildCheckOption,
+    ChromedriverExecutableDirOption,
+    ChromedriverExecutableOption,
+    ChromedriverPortOption,
+    ChromedriverPortsOption,
+    ChromedriverUseSystemExecutableOption,
+    EnsureWebviewsHavePagesOption,
+    ExtractChromeAndroidPackageFromContextNameOption,
+    NativeWebScreenshotOption,
+    RecreateChromeDriverSessionsOption,
+    ShowChromedriverLogOption,
+    WebviewDevtoolsPortOption,
+    DisableSuppressAccessibilityServiceOption,
+    UserProfileOption,
+    EspressoBuildConfigOption,
+    EspressoServerLaunchTimeoutOption,
+    ForceEspressoRebuildOption,
+    ShowGradleLogOption,
+    IntentOptionsOption,
+    ActivityOptionsOption,
+    AppLocaleOption,
+):
+    @property
+    def default_capabilities(self) -> Dict:
+        return {
+            AUTOMATION_NAME: 'Espresso',
+            PLATFORM_NAME: 'Android',
+        }

appium/options/android/espresso/espresso_build_config_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.
+
+import json
+from typing import Any, Dict, Optional, Union
+
+from appium.options.common.supports_capabilities import SupportsCapabilities
+
+ESPRESSO_BUILD_CONFIG = 'espressoBuildConfig'
+
+
+class EspressoBuildConfigOption(SupportsCapabilities):
+    @property
+    def espresso_build_config(self) -> Optional[Union[Dict[str, Any], str]]:
+        """
+        Espresso build config.
+        """
+        value = self.get_capability(ESPRESSO_BUILD_CONFIG)
+        try:
+            return json.loads(value)
+        except Exception:
+            return value
+
+    @espresso_build_config.setter
+    def espresso_build_config(self, value: Union[Dict[str, Any], str]) -> None:
+        """
+        This config allows to customize several important properties of
+        Espresso server. Refer to
+        https://github.com/appium/appium-espresso-driver#espresso-build-config
+        for more information on how to properly construct such config.
+        """
+        self.set_capability(ESPRESSO_BUILD_CONFIG, value if isinstance(value, str) else json.dumps(value, ensure_ascii=False))