Appium-Python-Client 2.6.1__tar.gz → 6.0.2__tar.gz

appium_python_client-6.0.2/.github/actions/setup-appium-server/action.yml

@@ -0,0 +1,65 @@
+name: 'Start Appium Server'
+description: 'Start Appium server with configurable arguments and wait for startup'
+
+inputs:
+  port:
+    description: 'Appium server port'
+    required: false
+    default: '4723'
+  host:
+    description: 'Appium server host'
+    required: false
+    default: '127.0.0.1'
+  timeout:
+    description: 'Timeout in seconds to wait for server startup'
+    required: false
+    default: '25'
+  server_args:
+    description: 'Additional server arguments (space-separated)'
+    required: false
+    default: ''
+  log_file:
+    description: 'Log file name'
+    required: false
+    default: 'appium.log'
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Start Appium server
+      shell: bash
+      run: |
+        nohup appium server \
+          --port=${{ inputs.port }} \
+          --address=${{ inputs.host }} \
+          --log-no-colors \
+          --log-timestamp \
+          --keep-alive-timeout 1200 \
+          ${{ inputs.server_args }} \
+          2>&1 > ${{ inputs.log_file }} &
+
+    - name: Wait for Appium server to start
+      shell: bash
+      run: |
+        TIMEOUT_SEC=${{ inputs.timeout }}
+        INTERVAL_SEC=1
+
+        start_time=$(date +%s)
+        while true; do
+          current_time=$(date +%s)
+          elapsed=$((current_time - start_time))
+
+          if nc -z ${{ inputs.host }} ${{ inputs.port }}; then
+            echo "Appium server is running after $elapsed seconds"
+            cat ${{ inputs.log_file }}
+            exit 0
+          fi
+
+          if [[ "$elapsed" -ge "$TIMEOUT_SEC" ]]; then
+            echo "${elapsed} seconds timeout reached: Appium server is NOT running"
+            exit 1
+          fi
+
+          echo "Waiting $elapsed seconds for Appium server to start..."
+          sleep "$INTERVAL_SEC"
+        done

appium_python_client-6.0.2/.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+- package-ecosystem: uv
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "11:00"
+  open-pull-requests-limit: 10
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: weekly
+    time: "11:00"
+  open-pull-requests-limit: 10
+  commit-message:
+    prefix: "ci"
+    include: "scope"

appium_python_client-6.0.2/.github/issue_template.md

@@ -0,0 +1,23 @@
+## The problem
+
+Briefly describe the issue you are experiencing (or the feature you want to see added to Appium). Tell us what you were trying to do and what happened instead. Remember, this is _not_ a place to ask questions. For that, go to http://discuss.appium.io!
+
+
+## Environment
+- Appium version (or git revision) that exhibits the issue:
+- Last Appium version that did not exhibit the issue (if applicable):
+- Desktop OS/version used to run Appium:
+- Node.js version (unless using Appium.app|exe):
+- Mobile platform/version under test:
+- Real device or emulator/simulator:
+- Appium CLI or Appium.app|exe:
+
+## Details
+
+If necessary, describe the problem you have been experiencing in more detail.
+
+## Link to Appium Logs
+
+Create a [GIST](https://gist.github.com) which is a paste of your _full_ Appium logs, and link them here.
+
+## Code To reproduce issue

appium_python_client-6.0.2/.github/workflows/functional-test.yml

@@ -0,0 +1,368 @@
+name: Functional Tests
+
+on:
+  # Run by manual at this time
+  workflow_dispatch:
+  pull_request:
+    branches: [ master ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+env:
+  APPIUM_TEST_SERVER_PORT: '4723'
+  APPIUM_TEST_SERVER_HOST: '127.0.0.1'
+  PYTHONUNBUFFERED: 1
+
+jobs:
+  ios_test:
+    strategy:
+      fail-fast: false
+      matrix:
+        test_targets:
+          - target: test/functional/ios/safari_tests.py
+            name: func_test_ios1
+
+    runs-on: macos-15
+
+    # Please make sure the available Xcode versions and iOS versions
+    # on the runner images. https://github.com/actions/runner-images
+    env:
+      XCODE_VERSION: '16.4'
+      IOS_VERSION: '18.5'
+      IPHONE_MODEL: 'iPhone 16 Plus'
+      PREBUILT_WDA_PATH: ${{ github.workspace }}/wda/WebDriverAgentRunner-Runner.app
+
+    steps:
+    - uses: actions/checkout@v7
+
+    - name: Install Node.js
+      uses: actions/setup-node@v7
+      with:
+        node-version: 'lts/*'
+
+    - name: Select Xcode
+      uses: maxim-lobanov/setup-xcode@v1
+      with:
+        xcode-version: ${{ env.XCODE_VERSION }}
+
+    - name: Install Appium and drivers
+      run: |
+        npm install -g appium
+        appium driver install xcuitest
+        appium driver run xcuitest download-wda-sim  --platform=ios --outdir=$(dirname "$PREBUILT_WDA_PATH")
+
+    - name: Start Appium server
+      uses: ./.github/actions/setup-appium-server
+      with:
+        port: ${{ env.APPIUM_TEST_SERVER_PORT }}
+        host: ${{ env.APPIUM_TEST_SERVER_HOST }}
+        server_args: '--relaxed-security'
+
+    - name: Start iOS Simulator UI
+      run: |
+        defaults write com.apple.iphonesimulator PasteboardAutomaticSync -bool false
+        open -Fn "$(xcode-select --print-path)/Applications/Simulator.app"
+    - name: Prepare iOS simulator
+      uses: futureware-tech/simulator-action@v5
+      with:
+        model: ${{ env.IPHONE_MODEL }}
+        os_version: ${{ env.IOS_VERSION }}
+        wait_for_boot: true
+        shutdown_after_job: false
+
+    - name: Finalize iOS simulator boot
+      run: xcrun --sdk iphonesimulator --show-sdk-version
+
+    - name: Set up Python
+      uses: actions/setup-python@v7
+      with:
+        python-version: 3.14
+
+    - name: Cache uv modules
+      uses: actions/cache@v6
+      with:
+        path: |
+          ~/.cache/uv
+          .venv
+        key: ${{ runner.os }}-uv-shared-${{ hashFiles('**/uv.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-uv-shared-
+
+    - name: Install uv
+      run: make install-uv
+
+    - name: Run Tests
+      run: |
+        uv run pytest -v ${{ matrix.test_targets.target}} \
+          --doctest-modules \
+          --junitxml=junit/test-results.xml \
+          --cov=com \
+          --cov-report=xml \
+          --cov-report=html
+      env:
+        LOCAL_PREBUILT_WDA: ${{ env.PREBUILT_WDA_PATH }}
+
+    - name: Save server output
+      if: ${{ always() }}
+      uses: actions/upload-artifact@master
+      with:
+        name: appium-ios-${{matrix.test_targets.name}}.log
+        path: appium.log
+
+
+  android_test:
+    strategy:
+      fail-fast: false
+      matrix:
+        test_targets:
+          - target: test/functional/android/appium_service_tests.py test/functional/android/chrome_tests.py test/functional/android/bidi_tests.py
+            name: func_test_android1
+
+    runs-on: ubuntu-latest
+
+    env:
+      API_LEVEL: 29
+      ARCH: x86
+
+    steps:
+    - uses: actions/checkout@v7
+
+    - uses: actions/setup-java@v6.0.0
+      with:
+        distribution: 'temurin'
+        java-version: '17'
+
+    - name: Install ffmpeg
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y ffmpeg
+
+    - name: Install Node.js
+      uses: actions/setup-node@v7
+      with:
+        node-version: 'lts/*'
+
+    - name: Install Appium and drivers
+      run: |
+        npm install -g appium
+        appium driver install uiautomator2
+        appium driver install espresso
+        appium plugin install execute-driver
+
+    - name: Start Appium server
+      uses: ./.github/actions/setup-appium-server
+      with:
+        port: ${{ env.APPIUM_TEST_SERVER_PORT }}
+        host: ${{ env.APPIUM_TEST_SERVER_HOST }}
+        server_args: '--relaxed-security --use-plugins=execute-driver'
+
+    - name: Enable KVM group perms
+      run: |
+        echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
+        sudo udevadm control --reload-rules
+        sudo udevadm trigger --name-match=kvm
+
+    - name: AVD cache
+      uses: actions/cache@v6
+      id: avd-cache
+      with:
+        path: |
+          ~/.android/avd/*
+          ~/.android/adb*
+        key: avd-${{ env.API_LEVEL }}
+    - name: Create AVD and generate snapshot for caching
+      if: steps.avd-cache.outputs.cache-hit != 'true'
+      uses: reactivecircus/android-emulator-runner@v2
+      with:
+        api-level: ${{ env.API_LEVEL }}
+        arch: ${{ env.ARCH }}
+        target: google_apis
+        force-avd-creation: false
+        emulator-options: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
+        disable-animations: false
+        script: echo "Generated AVD snapshot for caching."
+
+    - name: Set up Python 3.14
+      uses: actions/setup-python@v7
+      with:
+        python-version: 3.14
+
+    - name: Cache uv modules
+      uses: actions/cache@v6
+      with:
+        path: |
+          ~/.cache/uv
+          .venv
+        key: ${{ runner.os }}-uv-shared-${{ hashFiles('**/uv.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-uv-shared-
+
+    - name: Run tests
+      uses: reactivecircus/android-emulator-runner@v2
+      with:
+        api-level: ${{ env.API_LEVEL }}
+        arch: ${{ env.ARCH }}
+        script: |
+          make install-uv
+          uv run pytest -v ${{ matrix.test_targets.target}} --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
+        target: google_apis
+        profile: Nexus 5X
+        disable-spellchecker: true
+        disable-animations: true
+
+      env:
+        ANDROID_SDK_VERSION: ${{ env.API_LEVEL }}
+        APPIUM_DRIVER: ${{matrix.test_targets.automation_name}}
+        IGNORE_VERSION_SKIP: true
+        CI: true
+
+    - name: Save server output
+      if: ${{ always() }}
+      uses: actions/upload-artifact@master
+      with:
+        name: appium-android-${{matrix.test_targets.name}}.log
+        path: appium.log
+
+  flutter_e2e_test:
+    # These flutter integration driver tests are maintained by: MummanaSubramanya
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - platform: macos-15
+            e2e-tests: flutter-ios
+          - platform: ubuntu-latest
+            e2e-tests: flutter-android
+
+    runs-on: ${{ matrix.platform }}
+
+    env:
+      API_LEVEL: 28
+      ARCH: x86
+      CI: true
+      XCODE_VERSION: 16.4
+      IOS_VERSION: 18.5
+      IPHONE_MODEL: iPhone 16
+      FLUTTER_ANDROID_APP: "https://github.com/AppiumTestDistribution/appium-flutter-server/releases/download/0.0.33/app-debug.apk"
+      FLUTTER_IOS_APP: "https://github.com/AppiumTestDistribution/appium-flutter-server/releases/download/0.0.33/ios.zip"
+      PREBUILT_WDA_PATH: ${{ github.workspace }}/wda/WebDriverAgentRunner-Runner.app
+
+    steps:
+
+    - uses: actions/checkout@v7
+
+    - uses: actions/setup-java@v6.0.0
+      if: matrix.e2e-tests == 'flutter-android'
+      with:
+        distribution: 'zulu'
+        java-version: '17'
+
+    - name: Enable KVM group perms
+      if: matrix.e2e-tests == 'flutter-android'
+      run: |
+        echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
+        sudo udevadm control --reload-rules
+        sudo udevadm trigger --name-match=kvm
+
+    - name: Set up Python 3.14
+      uses: actions/setup-python@v7
+      with:
+        python-version: 3.14
+
+    - name: Install Node.js
+      uses: actions/setup-node@v7
+      with:
+        node-version: 'lts/*'
+
+    - name: Select Xcode
+      if: matrix.e2e-tests == 'flutter-ios'
+      uses: maxim-lobanov/setup-xcode@v1
+      with:
+        xcode-version: ${{ env.XCODE_VERSION }}
+
+    - name: Install Appium and drivers
+      if: matrix.e2e-tests == 'flutter-android'
+      run: |
+        npm install --location=global appium
+        appium driver install uiautomator2
+        appium driver install appium-flutter-integration-driver --source npm
+
+    - name: Install Appium and drivers
+      if: matrix.e2e-tests == 'flutter-ios'
+      run: |
+        npm install --location=global appium
+        appium driver install xcuitest
+        appium driver run xcuitest download-wda-sim  --platform=ios --outdir=$(dirname "$PREBUILT_WDA_PATH")
+        appium driver install appium-flutter-integration-driver --source npm
+
+    - name: Start Appium server
+      uses: ./.github/actions/setup-appium-server
+      with:
+        port: ${{ env.APPIUM_TEST_SERVER_PORT }}
+        host: ${{ env.APPIUM_TEST_SERVER_HOST }}
+        server_args: '--relaxed-security'
+        log_file: appium-${{ matrix.e2e-tests }}.log
+
+    - name: Cache uv modules
+      uses: actions/cache@v6
+      with:
+        path: |
+          ~/.cache/uv
+          .venv
+        key: ${{ runner.os }}-uv-shared-${{ hashFiles('**/uv.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-uv-shared-
+
+    - name: Run Android tests
+      if: matrix.e2e-tests == 'flutter-android'
+      uses: reactivecircus/android-emulator-runner@v2
+      with:
+        api-level: ${{ env.API_LEVEL }}
+        script: |
+          make install-uv
+          uv run pytest -v test/functional/flutter_integration/*_test.py --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
+        target: default
+        disable-spellchecker: true
+        disable-animations: true
+
+    - name: Start iOS Simulator UI
+      if: matrix.e2e-tests == 'flutter-ios'
+      run: |
+        defaults write com.apple.iphonesimulator PasteboardAutomaticSync -bool false
+        open -Fn "$(xcode-select --print-path)/Applications/Simulator.app"
+
+    - uses: futureware-tech/simulator-action@v5
+      if: matrix.e2e-tests == 'flutter-ios'
+      with:
+        # https://github.com/actions/runner-images/blob/main/images/macos/macos-14-arm64-Readme.md
+        model: ${{ env.IPHONE_MODEL }}
+        os_version: ${{ env.IOS_VERSION }}
+        wait_for_boot: true
+        shutdown_after_job: false
+
+    - name: Finalize iOS simulator boot
+      if: matrix.e2e-tests == 'flutter-ios'
+      run: xcrun --sdk iphonesimulator --show-sdk-version
+
+    - name: Run IOS tests
+      if: matrix.e2e-tests == 'flutter-ios'
+      run: |
+        make install-uv
+        export PLATFORM=ios
+        uv run pytest -v test/functional/flutter_integration/*_test.py \
+          --doctest-modules \
+          --junitxml=junit/test-results.xml \
+          --cov=com \
+          --cov-report=xml \
+          --cov-report=html
+      env:
+        LOCAL_PREBUILT_WDA: ${{ env.PREBUILT_WDA_PATH }}
+
+    - name: Save server output
+      if: ${{ always() }}
+      uses: actions/upload-artifact@master
+      with:
+        name: appium-${{ matrix.e2e-tests }}.log
+        path: appium-${{ matrix.e2e-tests }}.log

appium_python_client-6.0.2/.github/workflows/lock-update.yml

@@ -0,0 +1,31 @@
+name: Update uv.lock
+
+on:
+  pull_request:
+    types: [ opened, synchronize ]
+    paths:
+      - 'pyproject.toml'
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  uv-lock-update:
+    if: github.actor == 'dependabot[bot]'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          ref: ${{ github.head_ref }}
+      - name: Set up Python
+        uses: actions/setup-python@v7
+        with:
+          python-version: '3.12'
+      - name: Install uv
+        run: make install-uv
+      - run: uv lock
+      - uses: stefanzweifel/git-auto-commit-action@v7
+        with:
+          commit_message: "chore: Refresh uv.lock"

appium_python_client-6.0.2/.github/workflows/pr-title.yml

@@ -0,0 +1,10 @@
+name: Conventional Commits
+on:
+  pull_request:
+    types: [opened, edited, synchronize, reopened]
+
+jobs:
+  lint:
+    uses: appium/appium-workflows/.github/workflows/pr-title.yml@main
+    with:
+      config-preset: angular

appium_python_client-6.0.2/.github/workflows/publish.yml

@@ -0,0 +1,50 @@
+name: Release
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ master ]
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Set up Python
+        uses: actions/setup-python@v7
+        with:
+          python-version: '3.12'
+
+      - name: Install uv
+        run: make install-uv
+
+      - name: Semantic Release Version
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: uv run semantic-release version
+
+      - name: Check if dist directory exists
+        id: check_dist
+        run: |
+          if [ -d "dist" ]; then
+            echo "exists=true" >> $GITHUB_OUTPUT
+          else
+            echo "exists=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Publish to PyPI
+        if: steps.check_dist.outputs.exists == 'true'
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/
+
+      - name: Publish GitHub Release
+        if: steps.check_dist.outputs.exists == 'true'
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: uv run semantic-release publish

appium_python_client-6.0.2/.github/workflows/unit-test.yml

@@ -0,0 +1,36 @@
+name: Unit tests
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test-ubuntu:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+    steps:
+    - uses: actions/checkout@v7
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v7
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Cache uv modules
+      uses: actions/cache@v6
+      with:
+        path: |
+          ~/.cache/uv
+          .venv
+        key: ${{ runner.os }}-uv-shared-${{ hashFiles('**/uv.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-uv-shared-
+    - name: Install uv
+      run: make install-uv
+    - name: Run Checks
+      run: make check
+    - name: Run Unit Tests
+      run: make unittest

appium_python_client-6.0.2/.gitignore

@@ -0,0 +1,30 @@
+.DS_Store
+
+*~
+*#
+*._*
+*.log
+*.log.*
+_*/
+
+*.pyc
+*.egg-info
+
+MANIFEST
+
+build
+dist
+
+# Cache
+.cache
+__pycache__
+.idea
+.pytest_cache
+.mypy_cache
+
+# Virtual Environments
+venv*
+.venv
+.tox
+
+.coverage

appium_python_client-6.0.2/.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+  - repo: local
+    hooks:
+      - id: ruff-check
+        name: ruff check
+        entry: uv run ruff check
+        language: system
+        types_or: [python, pyi]
+        args: [--fix, --show-fixes]
+
+      - id: ruff-format
+        name: ruff format
+        entry: uv run ruff format
+        language: system
+        types_or: [python, pyi]

appium_python_client-6.0.2/.ruff.toml

@@ -0,0 +1,29 @@
+line-length = 128
+indent-width = 4
+
+[lint]
+select = [
+    "F",    # Pyflakes
+    "PL",   # Pylint
+    "I",    # isort
+    "PERF", # perflint
+    "FURB", # Refurb
+    "SIM",  # Simplify
+    "UP",   # Upgrade
+]
+
+[lint.per-file-ignores]
+"__init__.py" = [
+    # import violations
+    "E402"
+]
+"**/{test,docs}/*" = [
+    # https://docs.astral.sh/ruff/rules/magic-value-comparison/
+    "PLR2004"
+]
+
+[lint.pylint]
+max-args = 6
+
+[format]
+quote-style = "single"