Python ADB応用編：複雑なUI操作から自動化スクリプトの安定運用まで

プログラミング

これまでの記事[1],[2]で、PythonとADBを使ったAndroid自動化の基礎と、基本的なADBコマンドの自動化レシピについて学びました。しかし、ADB単体では、画面上の特定のボタンをタップしたり、リストをスクロールしたりといったGUI要素に直接働きかけるUI操作は困難です。

本記事では、PythonによるAndroid自動化をさらに深掘りし、

  • より複雑なUI操作を実現するためのライブラリ
  • 自動化スクリプトの運用中に発生しがちな共通のトラブルとその解決策

に焦点を当てます。開発者やテスターが直面する課題を解決し、より堅牢で高度なAndroid自動化環境を構築するための知識を提供します。

スポンサーリンク

より高度なAndroid自動化を目指す：周辺知識とライブラリ

ADBはデバイスとの低レベルな通信を可能にしますが、GUI操作を直接的に行う機能は持ちません。そこで、以下のようなUI自動化ライブラリと組み合わせることで、自動化の範囲を大きく広げることができます。

UI自動化ライブラリとの連携（UI Automator, Appium）

ADB単体では難しいUI操作（例: 特定のテキストを持つボタンのタップ、要素の検索、テキストフィールドへの入力など）は、専門のUI自動化ライブラリを組み合わせることで実現可能です。

UI Automator (uiautomator2)

  •  Googleが提供するAndroidのUIテストフレームワーク「UI Automator」をPythonから利用できるようにしたライブラリがuiautomator2です。内部でADBを利用しており、高速かつ安定したUI操作が可能です。特定のテキストやリソースIDを持つ要素を探して操作できるため、画面の変更に強い自動化スクリプトを作成できます。

  • 特徴: AndroidネイティブのUIテストフレームワークをPythonから簡単に利用でき、要素の識別が強力です。
  • インストール: pip install uiautomator2
  • 簡単な使用例:

    Python

    import uiautomator2 as u2
import time

# デバイスへの接続（adb serverが起動している前提）
d = u2.connect() # デバイスが一つだけ接続されている場合
# またはシリアル番号を指定: d = u2.connect('YOUR_DEVICE_SERIAL')

print(f"接続中のデバイス: {d.info}")

# アプリの起動 (例: 設定アプリ)
d.app_start('com.android.settings')
time.sleep(2)

# テキストで要素を検索してタップ
if d(text="Wi-Fi").exists:
    d(text="Wi-Fi").click()
    print("Wi-Fi設定をタップしました。")
    time.sleep(2)
    d.press("back") # 戻るボタン
else:
    print("Wi-Fi設定が見つかりませんでした。")

d.app_stop('com.android.settings')
print("設定アプリを終了しました。")

Appium

  •  Androidだけでなく、iOSやWebアプリなど、複数のプラットフォームに対応したオープンソースのUIテスト自動化フレームワークです。Selenium WebDriverプロトコルを実装しており、Python, Java, C#など様々なプログラミング言語でテストスクリプトを作成できます。Appiumも内部でADBを利用してAndroidデバイスと通信します。大規模なクロスプラットフォームテストに適しています。
  • 特徴: 複数プラットフォーム対応、幅広い言語サポート、WebDriverプロトコルによる汎用性。
  • インストール: pip install Appium-Python-Client (Appiumサーバーのインストールも別途必要)
  • 使用例: (Appiumサーバーの起動やWebDriverの初期化など、複雑なセットアップが必要です)

エラーハンドリングとロギング

自動化スクリプトは、デバイスの状態変化、ネットワークの問題、予期せぬUIの変更など、様々な要因によってエラーが発生する可能性があります。スクリプトの安定性を高め、問題発生時の原因究明を容易にするためには、適切なエラーハンドリングとロギングが不可欠です。

  • try-exceptブロック
    •  Pythonのtry-except構文を積極的に使用し、例外が発生した場合の処理（例: エラーメッセージの出力、リトライ処理、スクリプトの停止など）を記述します。これにより、スクリプトが途中で予期せず終了するのを防ぎます。
  • ロギング
    •  Pythonの標準ライブラリloggingを使用し、スクリプトの実行状況やエラー情報をログファイルに出力することで、問題発生時の原因特定やデバッグ作業を容易にします。ログレベル（DEBUG, INFO, WARNING, ERROR, CRITICAL）を適切に使い分け、必要な情報だけを記録するようにします。

複数デバイスの管理

複数のAndroidデバイスに対して同時にまたは順番にADB操作やUIテストを実行する必要がある場合、各デバイスのシリアル番号を識別子として、スクリプトで管理する仕組みが必要です。

python-adbやuiautomator2は、接続時にシリアル番号を指定することで、特定のデバイスにターゲットを絞ることができます。これにより、並行テストやデバイスファームの管理など、高度なテストシナリオを構築できます。

よくあるトラブルと解決策

PythonとADBを用いた自動化を進める上で、いくつか遭遇しやすいトラブルがあります。それぞれの原因と具体的な解決策を以下に示します。

adbコマンドが見つからない

  • 現象
    •  Pythonスクリプトからsubprocessでadbコマンドを呼び出す際に、「’adb’ は、内部コマンドまたは外部コマンド、操作可能なプログラムまたはバッチ ファイルとして認識されていません。」のようなエラーが出る（Windowsの場合）。
  • 原因
    •  ADBの実行ファイル（adb.exeなど）がシステムのPATH環境変数に登録されていない、または登録されているパスが間違っている。
  • 解決策
    • 「ADB（Android Debug Bridge）のセットアップ」の項目（記事1参照）を再確認し、platform-toolsフォルダのパスが正しく環境変数PATHに追加されていることを確認してください。
    • 環境変数を変更した場合は、新しいコマンドプロンプトやターミナルを開き直す必要があります。これは、環境変数の変更が既存のシェルセッションに反映されないためです。
    • adb --versionを実行し、ADBが正しく認識されているか確認します。

デバイスが認識されない

  • 現象
    •  adb-shellでdevice.connect()が失敗する、またはsubprocess.run("adb devices")を実行してもデバイスが表示されない。
  • 原因
    • デバイスのUSBデバッグがオフになっている。
    • PCにデバイスドライバがインストールされていない、または古い。
    • USBケーブルが不良、またはPCのUSBポートに問題がある。
    • PCとデバイスが正常に接続されていない（特に、初回接続時の「USBデバッグを許可しますか？」のプロンプトを許可していない）。
    • adb serverが起動していない、または異常終了している。
  • 解決策:
    • デバイスの「開発者向けオプション」から「USBデバッグ」がオンになっているか再確認。
    • PCに適切なデバイスドライバ（特にGoogle USB Driverや各Androidメーカーのドライバ）がインストールされているか確認。必要であればデバイスメーカーの公式サイトから最新版をダウンロード・更新。
    • 別のUSBケーブルやUSBポートを試す。
    • デバイスとPCを接続し直し、デバイス画面に表示される「USBデバッグを許可しますか？」のポップアップで「このパソコンからの接続を常に許可する」にチェックを入れ「許可」をタップ。
    • コマンドプロンプト/ターミナルでadb kill-serverを実行後、adb start-serverを実行してADBサーバーを再起動する。

スクリプトが途中で止まる/エラーになる

  • 現象
    •  スクリプトが途中でハングアップする、または予期せぬエラーメッセージが表示される。
  • 原因
    • 非同期操作（例: スクリーンショット保存後のファイルプル）におけるタイミングの問題。デバイス側の処理が完了する前に次のコマンドを実行しようとしている。
    • デバイスの応答遅延や一時的な切断。
    • 存在しないファイルやパスへのアクセス、または誤った権限での操作。
    • 特定のADBコマンドの出力形式が予期したものと異なり、パースに失敗している。
    • メモリ不足やCPU負荷過多など、デバイス側のリソース不足。
  • 解決策:
    • ファイル保存やコマンド実行後にtime.sleep()で十分な待機時間を設ける。特にUI操作を伴う場合は、画面遷移や要素の読み込みを待つために長めに設定する。
    • try-exceptブロックを多用し、エラーが発生した場合の処理（例: エラーメッセージの出力、リトライ、例外のログ記録）を記述することで、スクリプトの堅牢性を高める。
    • エラーメッセージを注意深く読み、原因に応じたデバッグを行う。
    • adb logcatを使用してデバイスのシステムログを確認し、エラーの原因を探る。
    • 複雑なUI操作にはuiautomator2やAppiumなど、より高レベルなUI自動化ライブラリの使用を検討する。これらのライブラリは、要素の存在確認や待機メカニズムを内蔵しているため、より安定したスクリプトを作成できます。
スポンサーリンク
スポンサーリンク

まとめ

本記事では、PythonによるAndroid自動化をさらに一歩進め、UI操作の自動化と、自動化スクリプトを安定して運用するためのトラブルシューティングについて詳しく解説しました。

  • ADB単体では難しいUI操作は、uiautomator2やAppiumといったUI自動化ライブラリと組み合わせることで実現可能です。これらのライブラリは、要素の識別と操作を強力にサポートします。
  • 自動化スクリプトの信頼性と堅牢性を高めるためには、エラーハンドリングとロギングが不可欠です。try-exceptブロックとloggingモジュールを積極的に活用しましょう。
  • よくあるトラブル（ADB認識エラー、デバイス接続問題、スクリプト実行エラー）に対する具体的な解決策を理解し、冷静に対処することで、効率的なデバッグと安定した自動化環境の維持が可能になります。

PythonとADB、そしてUI自動化ライブラリを組み合わせることで、あなたはAndroidデバイスの操作を隅々まで自動化し、開発・テストの効率を極限まで高めることができます。これらの知識が、あなたのプロジェクト成功の一助となることを願っています。

スポンサーリンク

コメント

タイトルとURLをコピーしました