selenium

[Python] seleniumで要素が存在するかチェックする方法

2025-01-18更新日: 2025-01-18

Seleniumを使用して要素が存在するかを確認するには、find_elementメソッドを使用します。

要素が見つからない場合、NoSuchElementExceptionが発生するため、例外処理を使ってチェックします。

具体的には、try-exceptブロックでfind_elementを実行し、例外が発生しなければ要素が存在することを確認できます。

また、find_elementsメソッドを使うと、要素が存在しない場合でも空のリストが返されるため、例外処理を避けることができます。

目次から探す

Seleniumで要素の存在を確認する基本的な方法
find_elementとfind_elementsの違い
要素の存在を確認するための例外処理
要素の存在を確認するための待機処理
応用例：要素の存在確認を効率化する方法
応用例：要素が存在しない場合の処理
応用例：要素の存在確認をテストに組み込む
まとめ

Seleniumで要素の存在を確認する基本的な方法

Webスクレイピングや自動テストを行う際、特定の要素が存在するかどうかを確認することは非常に重要です。

ここでは、Seleniumを使用して要素の存在を確認する基本的な方法を解説します。

find_elementメソッドを使った要素の確認

find_elementメソッドは、指定した条件に一致する最初の要素を取得します。

要素が存在しない場合は、NoSuchElementExceptionが発生します。

from selenium import webdriver
from selenium.common.exceptions import NoSuchElementException
# WebDriverのインスタンスを作成
driver = webdriver.Chrome()
# 指定したURLにアクセス
driver.get("https://example.com")
try:
    # 要素を取得
    element = driver.find_element("id", "element_id")
    print("要素が見つかりました。")
except NoSuchElementException:
    print("要素が見つかりませんでした。")
# WebDriverを終了
driver.quit()

要素が見つかりました。

find_elementsメソッドを使った要素の確認

find_elementsメソッドは、指定した条件に一致するすべての要素をリストとして取得します。

要素が存在しない場合は、空のリストが返されます。

from selenium import webdriver
# WebDriverのインスタンスを作成
driver = webdriver.Chrome()
# 指定したURLにアクセス
driver.get("https://example.com")
# 要素を取得
elements = driver.find_elements("class name", "element_class")
if elements:
    print(f"{len(elements)} 個の要素が見つかりました。")
else:
    print("要素が見つかりませんでした。")
# WebDriverを終了
driver.quit()

3 個の要素が見つかりました。

NoSuchElementExceptionを使った例外処理

要素が存在しない場合に発生するNoSuchElementExceptionを利用して、エラーハンドリングを行うことができます。

これにより、プログラムがクラッシュするのを防ぎ、適切な処理を行うことが可能です。

from selenium import webdriver
from selenium.common.exceptions import NoSuchElementException
# WebDriverのインスタンスを作成
driver = webdriver.Chrome()
# 指定したURLにアクセス
driver.get("https://example.com")
try:
    # 要素を取得
    element = driver.find_element("id", "non_existent_id")
except NoSuchElementException:
    print("要素が見つかりませんでした。適切な処理を行います。")
# WebDriverを終了
driver.quit()

要素が見つかりませんでした。適切な処理を行います。

要素が表示されているかの確認 (is_displayedメソッド)

要素が存在していても、表示されていない場合があります。

is_displayedメソッドを使用することで、要素が表示されているかどうかを確認できます。

from selenium import webdriver
from selenium.common.exceptions import NoSuchElementException
# WebDriverのインスタンスを作成
driver = webdriver.Chrome()
# 指定したURLにアクセス
driver.get("https://example.com")
try:
    # 要素を取得
    element = driver.find_element("id", "element_id")
    if element.is_displayed():
        print("要素は表示されています。")
    else:
        print("要素は表示されていません。")
except NoSuchElementException:
    print("要素が見つかりませんでした。")
# WebDriverを終了
driver.quit()

要素は表示されています。

これらの方法を使うことで、Seleniumを利用した要素の存在確認がスムーズに行えます。

次のセクションでは、find_elementとfind_elementsの違いについて詳しく解説します。

find_elementとfind_elementsの違い

Seleniumには、要素を取得するための2つの主要なメソッド、find_elementとfind_elementsがあります。

これらのメソッドは似ていますが、異なる用途と動作を持っています。

ここでは、それぞれの特徴と使い方、どちらを使うべきかの判断基準について解説します。

find_elementの特徴と使い方

find_elementメソッドは、指定した条件に一致する最初の要素を取得します。

このメソッドは、要素が存在しない場合にNoSuchElementExceptionをスローします。

特徴

単一要素の取得: 最初に見つかった要素のみを返します。
例外処理が必要: 要素が見つからない場合は例外が発生します。

使い方

from selenium import webdriver
from selenium.common.exceptions import NoSuchElementException
# WebDriverのインスタンスを作成
driver = webdriver.Chrome()
# 指定したURLにアクセス
driver.get("https://example.com")
try:
    # 要素を取得
    element = driver.find_element("id", "element_id")
    print("要素が見つかりました。")
except NoSuchElementException:
    print("要素が見つかりませんでした。")
# WebDriverを終了
driver.quit()

要素が見つかりました。

find_elementsの特徴と使い方

find_elementsメソッドは、指定した条件に一致するすべての要素をリストとして取得します。

要素が存在しない場合は、空のリストが返されます。

特徴

複数要素の取得: 条件に一致するすべての要素をリストで返します。
空リストの返却: 要素が見つからない場合は空のリストが返されるため、例外処理が不要です。

使い方

from selenium import webdriver
# WebDriverのインスタンスを作成
driver = webdriver.Chrome()
# 指定したURLにアクセス
driver.get("https://example.com")
# 要素を取得
elements = driver.find_elements("class name", "element_class")
if elements:
    print(f"{len(elements)} 個の要素が見つかりました。")
else:
    print("要素が見つかりませんでした。")
# WebDriverを終了
driver.quit()

3 個の要素が見つかりました。

どちらを使うべきかの判断基準

find_elementとfind_elementsのどちらを使用するかは、取得したい要素の数や状況によって異なります。

以下の基準を参考にしてください。

使用シーン	メソッド	説明
単一の要素を取得したい場合	`find_element`	最初の一致する要素を取得。例外処理が必要。
複数の要素を取得したい場合	`find_elements`	一致するすべての要素をリストで取得。空リストが返る。
要素が存在するかどうかを確認したい場合	`find_element`	要素が存在しない場合は例外が発生。
要素の数を確認したい場合	`find_elements`	一致する要素の数を簡単に確認できる。

このように、要素の取得方法を選択する際は、目的に応じて適切なメソッドを選ぶことが重要です。

次のセクションでは、要素の存在を確認するための例外処理について詳しく解説します。

要素の存在を確認するための例外処理

Seleniumを使用して要素を取得する際、要素が存在しない場合に発生する例外を適切に処理することが重要です。

ここでは、例外処理の基本的な使い方や、特にNoSuchElementExceptionについて詳しく解説します。

try-exceptブロックの基本的な使い方

Pythonでは、try-exceptブロックを使用して例外を処理します。

tryブロック内に実行したいコードを記述し、exceptブロック内に例外が発生した場合の処理を記述します。

基本的な構文

try:
    # 例外が発生する可能性のあるコード
except ExceptionType:
    # 例外が発生した場合の処理

try:
    # 0で割り算を試みる
    result = 10 / 0
except ZeroDivisionError:
    print("ゼロで割ることはできません。")

ゼロで割ることはできません。

このように、try-exceptブロックを使うことで、エラーが発生してもプログラムがクラッシュするのを防ぎ、適切な処理を行うことができます。

NoSuchElementExceptionの詳細

NoSuchElementExceptionは、Seleniumで要素を取得しようとした際に、指定した条件に一致する要素が見つからない場合に発生する例外です。

この例外を捕捉することで、要素が存在しない場合の処理を行うことができます。

例外の発生例

from selenium import webdriver
from selenium.common.exceptions import NoSuchElementException
driver = webdriver.Chrome()
driver.get("https://example.com")
try:
    # 存在しない要素を取得しようとする
    element = driver.find_element("id", "non_existent_id")
except NoSuchElementException:
    print("要素が見つかりませんでした。")
driver.quit()

要素が見つかりませんでした。

例外処理を使った要素確認の実装例

以下は、try-exceptブロックを使用して要素の存在を確認し、存在しない場合には適切なメッセージを表示する実装例です。

from selenium import webdriver
from selenium.common.exceptions import NoSuchElementException
# WebDriverのインスタンスを作成
driver = webdriver.Chrome()
# 指定したURLにアクセス
driver.get("https://example.com")
try:
    # 要素を取得
    element = driver.find_element("id", "element_id")
    print("要素が見つかりました。")
except NoSuchElementException:
    print("要素が見つかりませんでした。適切な処理を行います。")
# WebDriverを終了
driver.quit()

要素が見つかりませんでした。適切な処理を行います。

このように、try-exceptブロックを使用することで、要素の存在を確認し、エラーが発生した場合でもプログラムが正常に動作し続けることができます。

次のセクションでは、要素の存在を確認するための待機処理について解説します。

要素の存在を確認するための待機処理

Webページの要素は、ページの読み込みや動的なコンテンツの生成によって、すぐには存在しない場合があります。

そのため、要素の存在を確認するためには待機処理が重要です。

ここでは、Seleniumでの待機処理の方法について解説します。

WebDriverWaitを使った待機処理

WebDriverWaitは、指定した条件が満たされるまで待機するためのクラスです。

これにより、要素が存在するまでの時間を柔軟に設定できます。

基本的な使い方

from selenium import webdriver
from selenium.webdriver.support.ui import WebDriverWait
from selenium.webdriver.support import expected_conditions as EC
# WebDriverのインスタンスを作成
driver = webdriver.Chrome()
# 指定したURLにアクセス
driver.get("https://example.com")
# 最大10秒間待機
wait = WebDriverWait(driver, 10)
# 要素が見つかるまで待機
element = wait.until(EC.presence_of_element_located(("id", "element_id")))
print("要素が見つかりました。")
# WebDriverを終了
driver.quit()

expected_conditionsモジュールの活用

expected_conditionsモジュールは、待機条件を定義するための便利な関数を提供します。

これにより、要素が存在するか、表示されているか、クリック可能かなど、さまざまな条件を指定できます。

from selenium.webdriver.support import expected_conditions as EC
# 要素がクリック可能になるまで待機
element = wait.until(EC.element_to_be_clickable(("id", "button_id")))
element.click()

presence_of_element_locatedの使い方

presence_of_element_locatedは、指定した条件に一致する要素がDOMに存在するかどうかを確認するための条件です。

この条件を使用することで、要素がページに追加されるのを待つことができます。

from selenium.webdriver.common.by import By
# 要素がDOMに存在するまで待機
element = wait.until(EC.presence_of_element_located((By.ID, "element_id")))
print("要素がDOMに存在します。")

暗黙的待機 (implicitly_wait) の使い方と注意点

暗黙的待機は、WebDriverが要素を探す際に、指定した時間だけ待機する設定です。

これにより、要素が見つかるまでの待機時間を自動的に設定できます。

使い方

from selenium import webdriver
# WebDriverのインスタンスを作成
driver = webdriver.Chrome()
# 最大10秒間の暗黙的待機を設定
driver.implicitly_wait(10)
# 要素を取得
element = driver.find_element("id", "element_id")
print("要素が見つかりました。")
# WebDriverを終了
driver.quit()

注意点

全体に適用: 暗黙的待機は、すべての要素検索に適用されるため、特定の要素に対してのみ待機を設定したい場合は、WebDriverWaitを使用する方が適切です。
混在使用の注意: WebDriverWaitと暗黙的待機を同時に使用すると、予期しない動作を引き起こす可能性があるため、どちらか一方を選択することが推奨されます。

これらの待機処理を適切に使用することで、要素の存在を確認する際のエラーを減らし、より安定した自動化スクリプトを作成することができます。

次のセクションでは、要素の存在確認を効率化する方法について解説します。

応用例：要素の存在確認を効率化する方法

要素の存在確認を効率化するためには、カスタム関数を作成したり、複数の要素を一度に確認したりする方法があります。

ここでは、これらの応用例について詳しく解説します。

カスタム関数を使った要素確認の自動化

カスタム関数を作成することで、要素の存在確認を簡潔に行うことができます。

これにより、コードの再利用性が向上し、可読性も高まります。

from selenium import webdriver
from selenium.common.exceptions import NoSuchElementException
def is_element_present(driver, by, value):
    try:
        driver.find_element(by, value)
        return True
    except NoSuchElementException:
        return False
# WebDriverのインスタンスを作成
driver = webdriver.Chrome()
driver.get("https://example.com")
# 要素の存在を確認
if is_element_present(driver, "id", "element_id"):
    print("要素が見つかりました。")
else:
    print("要素が見つかりませんでした。")
driver.quit()

複数の要素を一度に確認する方法

複数の要素を一度に確認する場合、find_elementsメソッドを使用して、リストとして取得することができます。

これにより、要素の数を簡単に確認できます。

from selenium import webdriver
# WebDriverのインスタンスを作成
driver = webdriver.Chrome()
driver.get("https://example.com")
# 複数の要素を取得
elements = driver.find_elements("class name", "element_class")
if elements:
    print(f"{len(elements)} 個の要素が見つかりました。")
else:
    print("要素が見つかりませんでした。")
driver.quit()

要素が動的に変化する場合の対処法

動的に変化する要素に対しては、WebDriverWaitを使用して、要素が特定の状態になるまで待機することが重要です。

これにより、要素が表示されるまでの時間を考慮できます。

from selenium import webdriver
from selenium.webdriver.support.ui import WebDriverWait
from selenium.webdriver.support import expected_conditions as EC
driver = webdriver.Chrome()
driver.get("https://example.com")
wait = WebDriverWait(driver, 10)
# 要素が表示されるまで待機
element = wait.until(EC.visibility_of_element_located(("id", "dynamic_element_id")))
print("動的要素が表示されました。")
driver.quit()

要素が非表示の場合の確認方法

要素が非表示の場合でも、存在を確認することができます。

is_displayedメソッドを使用して、要素が表示されているかどうかを確認します。

from selenium import webdriver
from selenium.common.exceptions import NoSuchElementException
driver = webdriver.Chrome()
driver.get("https://example.com")
try:
    element = driver.find_element("id", "element_id")
    if element.is_displayed():
        print("要素は表示されています。")
    else:
        print("要素は非表示です。")
except NoSuchElementException:
    print("要素が見つかりませんでした。")
driver.quit()

これらの方法を活用することで、要素の存在確認を効率化し、より柔軟で安定した自動化スクリプトを作成することができます。

次のセクションでは、要素の存在確認をテストに組み込む方法について解説します。

応用例：要素が存在しない場合の処理

要素が存在しない場合の処理は、Webスクレイピングや自動テストにおいて非常に重要です。

適切なエラーメッセージを表示したり、代替処理を行ったり、リトライ処理を実装することで、スクリプトの安定性を向上させることができます。

ここでは、これらの応用例について詳しく解説します。

要素が存在しない場合のエラーメッセージ表示

要素が見つからない場合には、ユーザーにわかりやすいエラーメッセージを表示することが重要です。

これにより、何が問題であるかを明確に伝えることができます。

from selenium import webdriver
from selenium.common.exceptions import NoSuchElementException
# WebDriverのインスタンスを作成
driver = webdriver.Chrome()
driver.get("https://example.com")
try:
    # 要素を取得
    element = driver.find_element("id", "non_existent_id")
except NoSuchElementException:
    print("エラー: 指定した要素が見つかりませんでした。")
driver.quit()

エラー: 指定した要素が見つかりませんでした。

要素が存在しない場合の代替処理

要素が存在しない場合には、代替処理を行うことで、プログラムの流れを維持することができます。

たとえば、別の要素を操作したり、デフォルトの値を設定したりすることが考えられます。

from selenium import webdriver
from selenium.common.exceptions import NoSuchElementException
# WebDriverのインスタンスを作成
driver = webdriver.Chrome()
driver.get("https://example.com")
try:
    # 要素を取得
    element = driver.find_element("id", "non_existent_id")
    print("要素が見つかりました。")
except NoSuchElementException:
    print("要素が見つかりませんでした。代替処理を行います。")
    # 代替処理
    default_value = "デフォルト値"
    print(f"代替値: {default_value}")
driver.quit()

要素が見つかりませんでした。代替処理を行います。
代替値: デフォルト値

要素が存在しない場合のリトライ処理

要素が存在しない場合にリトライ処理を実装することで、一時的な問題を回避し、要素が見つかるまで再試行することができます。

リトライの回数や待機時間を設定することが重要です。

from selenium import webdriver
from selenium.common.exceptions import NoSuchElementException
import time
# WebDriverのインスタンスを作成
driver = webdriver.Chrome()
driver.get("https://example.com")
max_retries = 3
for attempt in range(max_retries):
    try:
        # 要素を取得
        element = driver.find_element("id", "element_id")
        print("要素が見つかりました。")
        break  # 要素が見つかったらループを抜ける
    except NoSuchElementException:
        print(f"要素が見つかりませんでした。リトライ中... (試行回数: {attempt + 1})")
        time.sleep(2)  # 2秒待機
if attempt == max_retries - 1:
    print("最大リトライ回数に達しました。要素が見つかりませんでした。")
driver.quit()

要素が見つかりませんでした。リトライ中... (試行回数: 1)
要素が見つかりませんでした。リトライ中... (試行回数: 2)
要素が見つかりませんでした。最大リトライ回数に達しました。要素が見つかりませんでした。

これらの方法を活用することで、要素が存在しない場合の処理を適切に行い、スクリプトの安定性を向上させることができます。

次のセクションでは、要素の存在確認をテストに組み込む方法について解説します。

応用例：要素の存在確認をテストに組み込む

Seleniumを使用して要素の存在確認をテストに組み込むことで、Webアプリケーションの動作を自動的に検証することができます。

ここでは、Seleniumを使った自動テストの基本、要素の存在確認をテストケースに組み込む方法、テスト結果のログ出力方法について解説します。

Seleniumを使った自動テストの基本

Seleniumは、Webアプリケーションの自動テストを行うための強力なツールです。

テストスクリプトを作成することで、ブラウザを自動的に操作し、特定の要素が存在するかどうかを確認できます。

基本的な流れ

WebDriverのインスタンスを作成: 使用するブラウザのWebDriverをインスタンス化します。
テスト対象のURLにアクセス: テストを行うWebページにアクセスします。
要素の存在確認: find_elementやfind_elementsを使用して要素の存在を確認します。
結果の評価: 要素が存在するかどうかに基づいてテスト結果を評価します。
WebDriverを終了: テストが完了したらWebDriverを終了します。

要素の存在確認をテストケースに組み込む方法

要素の存在確認をテストケースに組み込むことで、特定の機能が正しく動作しているかを検証できます。

以下は、要素の存在確認を含むテストケースの例です。

from selenium import webdriver
from selenium.common.exceptions import NoSuchElementException
import unittest
class TestElementPresence(unittest.TestCase):
    def setUp(self):
        # WebDriverのインスタンスを作成
        self.driver = webdriver.Chrome()
        self.driver.get("https://example.com")
    def test_element_exists(self):
        try:
            # 要素を取得
            element = self.driver.find_element("id", "element_id")
            self.assertTrue(element.is_displayed(), "要素は表示されていません。")
        except NoSuchElementException:
            self.fail("要素が見つかりませんでした。")
    def tearDown(self):
        # WebDriverを終了
        self.driver.quit()
if __name__ == "__main__":
    unittest.main()

この例では、unittestフレームワークを使用して、要素の存在を確認するテストケースを作成しています。

テスト結果のログ出力方法

テスト結果をログに出力することで、テストの実行状況を把握しやすくなります。

Pythonのloggingモジュールを使用して、テスト結果をログファイルに記録することができます。

import logging
from selenium import webdriver
from selenium.common.exceptions import NoSuchElementException
import unittest
# ログ設定
logging.basicConfig(filename='test_log.log', level=logging.INFO)
class TestElementPresence(unittest.TestCase):
    def setUp(self):
        self.driver = webdriver.Chrome()
        self.driver.get("https://example.com")
    def test_element_exists(self):
        try:
            element = self.driver.find_element("id", "element_id")
            self.assertTrue(element.is_displayed(), "要素は表示されていません。")
            logging.info("テスト成功: 要素が見つかりました。")
        except NoSuchElementException:
            logging.error("テスト失敗: 要素が見つかりませんでした。")
            self.fail("要素が見つかりませんでした。")
    def tearDown(self):
        self.driver.quit()
if __name__ == "__main__":
    unittest.main()