Appium-Python-Client 5.1.3__tar.gz → 5.2.1__tar.gz

appium_python_client-5.2.1/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: pip
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "11:00"
+  open-pull-requests-limit: 10

appium_python_client-5.2.1/.github/issue_template.md

@@ -0,0 +1,24 @@
+## 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-5.2.1/.github/workflows/functional-test.yml

@@ -0,0 +1,292 @@
+name: Functional Tests
+
+on:
+  # Run by manual at this time
+  workflow_dispatch:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  ios_test:
+    strategy:
+      fail-fast: false
+      matrix:
+        test_targets:
+          - target: test/functional/ios/safari_tests.py
+            name: func_test_ios1
+
+    runs-on: macos-14
+
+    # Please make sure the available Xcode versions and iOS versions
+    # on the runner images. https://github.com/actions/runner-images
+    env:
+      XCODE_VERSION: 15.3
+      IOS_VERSION: 17.4
+      IPHONE_MODEL: iPhone 15 Plus
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: 'lts/*'
+
+    - name: Select Xcode
+      uses: maxim-lobanov/setup-xcode@v1
+      with:
+        xcode-version: ${{ env.XCODE_VERSION }}
+    - run: defaults write com.apple.iphonesimulator PasteboardAutomaticSync -bool false
+
+    - uses: futureware-tech/simulator-action@v3
+      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 }}
+
+    # needed?
+    - run: brew install ffmpeg
+
+    # Start Appium
+    - run: npm install -g appium
+    - run: |
+        appium driver install xcuitest
+        appium driver run xcuitest build-wda --sdk=${{ env.IOS_VERSION }} --name='${{ env.IPHONE_MODEL }}'
+        appium plugin install images
+        appium plugin install execute-driver
+        nohup appium --use-plugins=images,execute-driver --relaxed-security --log-timestamp --log-no-colors > appium.log &
+
+    - run: |
+        appium driver run xcuitest download-wda-sim  --platform=ios --outdir=${{ github.workspace }}/wda
+      name: Downloading prebuilt WDA
+
+    - name: Set up Python 3.12
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.12
+
+    - name: Install uv
+      run: make install-uv
+
+    - name: Run Tests
+      run: |
+        uv run pytest ${{ matrix.test_targets.target}} --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
+      env:
+        LOCAL_PREBUILT_WDA: ${{ github.workspace }}/wda/WebDriverAgentRunner-Runner.app
+
+    - 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@v4
+
+    - uses: actions/setup-java@v4
+      with:
+        distribution: 'temurin'
+        java-version: '17'
+
+    - name: Install Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: 'lts/*'
+
+    # Start Appium
+    - run: npm install -g appium
+    - run: |
+        appium driver install uiautomator2
+        appium driver install espresso
+        appium plugin install execute-driver
+        nohup appium --use-plugins=execute-driver --relaxed-security --log-timestamp --log-no-colors 2>&1 > appium.log &
+
+    - 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@v3
+      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.12
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.12
+
+    - 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 ${{ 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-14
+            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: 15.4
+      IOS_VERSION: 17.5
+      IPHONE_MODEL: iPhone 15
+      FLUTTER_ANDROID_APP: "https://github.com/AppiumTestDistribution/appium-flutter-server/releases/latest/download/app-debug.apk"
+      FLUTTER_IOS_APP: "https://github.com/AppiumTestDistribution/appium-flutter-server/releases/latest/download/ios.zip"
+
+    steps:
+
+    - uses: actions/checkout@v4
+
+    - uses: actions/setup-java@v4
+      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.12
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.12
+
+    - name: Install Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: 'lts/*'
+
+    - name: Install Appium
+      run: npm install --location=global appium
+
+    - name: Install Android drivers and Run Appium
+      if: matrix.e2e-tests == 'flutter-android'
+      run: |
+        appium driver install uiautomator2
+        appium driver install appium-flutter-integration-driver --source npm
+        nohup appium --allow-insecure=adb_shell --relaxed-security --log-timestamp --log-no-colors 2>&1 > appium_flutter_android.log &
+
+    - 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 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: Save server output
+      if: always() && matrix.e2e-tests == 'flutter-android'
+      uses: actions/upload-artifact@master
+      with:
+        name: appium-flutter-android.log
+        path: appium_flutter_android.log
+
+    - name: Select Xcode
+      if: matrix.e2e-tests == 'flutter-ios'
+      uses: maxim-lobanov/setup-xcode@v1
+      with:
+        xcode-version: ${{ env.XCODE_VERSION }}
+
+    - uses: futureware-tech/simulator-action@v3
+      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 }}
+
+    - name: install dependencies
+      if: matrix.e2e-tests == 'flutter-ios'
+      run: brew install ffmpeg
+
+    - name: Install IOS drivers and Run Appium
+      if: matrix.e2e-tests == 'flutter-ios'
+      run: |
+        appium driver install xcuitest
+        appium driver install appium-flutter-integration-driver --source npm
+        appium driver run xcuitest build-wda
+        nohup appium --allow-insecure=adb_shell --relaxed-security --log-timestamp --log-no-colors 2>&1 > appium_ios.log &
+
+    - name: Run IOS tests
+      if: matrix.e2e-tests == 'flutter-ios'
+      run: |
+        make install-uv
+        export PLATFORM=ios
+        uv run pytest test/functional/flutter_integration/*_test.py --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html

appium_python_client-5.2.1/.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@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          ref: ${{ github.head_ref }}
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+      - name: Install uv
+        run: make install-uv
+      - run: uv lock
+      - uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: "chore: Refresh uv.lock"

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

@@ -0,0 +1,16 @@
+name: Conventional Commits
+on:
+  pull_request:
+    types: [opened, edited, synchronize, reopened]
+
+
+jobs:
+  lint:
+    name: https://www.conventionalcommits.org
+    runs-on: ubuntu-latest
+    steps:
+      - uses: beemojs/conventional-pr-action@v3
+        with:
+          config-preset: angular
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

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

@@ -0,0 +1,27 @@
+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.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install uv
+      run: make install-uv
+    - name: Run Checks
+      run: make check
+    - name: Run Unit Tests
+      run: make unittest

appium_python_client-5.2.1/.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-5.2.1/.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.9.0
+  hooks:
+    # Run the linter.
+    - id: ruff
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format

appium_python_client-5.2.1/.ruff.toml

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