xbot.web.Browser

この記事の内容
  1. メソッド
  2. get_url()
  3. get_title()
  4. get_text()
  5. get_html()
  6. activate()
  7. navigate()
  8. go_back()
  9. go_forward()
  10. reload()
  11. stop_load()
  12. is_load_completed()
  13. wait_load_completed()
  14. close()
  15. execute_javascript()
  16. scroll_to()
  17. handle_javascript_dialog()
  18. get_javascript_dialog_text()
  19. start_monitor_network()
  20. stop_monitor_network()
  21. get_responses()
  22. wait_appear()
  23. wait_disappear()
  24. find_all()
  25. find_all_by_css()
  26. find_all_by_xpath()
  27. find()
  28. find_by_css()
  29. find_by_xpath()
  30. is_element_displayed()
  31. extract_table()

以下のURL、ページタイトル、ウィンドウ名、要素名は説明用の例です。実際に操作する環境の値に置き換えてください。要素ライブラリに登録する名前も、コード内の指定と一致させてください。

Webページのアクティブ化、ページタイトルの取得、Webページの再読み込み、Webページの読み込みのキャンセルなど、Web要素やWebページに対する各種処理を行います。

メソッド

get_url()

URLを取得します。

get_url(self)

入力パラメータ

なし

戻り値

str:Webページのアドレスを返します。

例1

from xbot import web


def main(args):
    browser = web.get_active()
    url = browser.get_url()

この例の実行ロジック: 開いているWebページオブジェクトを取得 --> URLアドレスを取得

get_title()

ページタイトルを取得します。

get_title(self)

入力パラメータ

なし

戻り値

str:ページタイトルを返します。

例1

from xbot import web


def main(args):
    browser = web.get_active()
    title = browser.get_title()

この例の実行ロジック: 開いているWebページオブジェクトを取得 --> ページタイトルを取得

get_text()

Webページのテキスト内容を取得します。

get_text(self)

入力パラメータ

なし

戻り値

str:Webページのテキスト内容を返します。

例1

from xbot import web


def main(args):
    browser = web.get_active()
    text = browser.get_text()

この例の実行ロジック: 開いているWebページオブジェクトを取得 --> 現在アクティブなWebページのテキスト内容を取得

get_html()

WebページのHTMLを取得します。

get_html(self)

入力パラメータ

なし

戻り値

str:WebページのHTMLを返します。

例1

from xbot import web


def main(args):
    browser = web.get_active()
    html = browser.get_html()

この例の実行ロジック: 開いているWebページオブジェクトを取得 --> 現在アクティブなWebページのHTMLを取得

activate()

対象のWebページをアクティブにします。

activate(self)

入力パラメータ

なし

戻り値

なし

例1

from xbot import web


def main(args):
    browser = web.get('サンプル検索ページ', None, 'chrome')
    browser.activate()

この例の実行ロジック: ページタイトルが「サンプル検索ページ」のWebページオブジェクトを取得 --> そのWebページをアクティブ化

新しいWebページに移動します。

navigate(self, url, load_timeout=20)

入力パラメータ

url:新しいWebページのアドレスです。

load_timeout:読み込みの待機時間(秒)です。デフォルトのタイムアウト時間は20秒です。タイムアウトまでに読み込みが完了しない場合は、UIAError例外をスローします。

戻り値

なし

例1

from xbot import web


def main(args):
    browser = web.get('サンプル検索ページ', None, 'chrome')
    browser.navigate('example.com/shop')

この例の実行ロジック: ページタイトルが「サンプル検索ページ」のWebページオブジェクトを取得 --> そのWebページから商品検索のWebページに移動

go_back()

Webページを前のページに戻します。

go_back(self, load_timeout=20)

入力パラメータ

load_timeout:読み込みの待機時間(秒)です。デフォルトのタイムアウト時間は20秒です。タイムアウトまでに読み込みが完了しない場合は、UIAError例外をスローします。

戻り値

なし

例1

from xbot import web


def main(args):
    browser = web.get('商品検索', None, 'chrome')
    browser.go_back()

この例の実行ロジック: ページタイトルが「商品検索」のWebページを取得し、前のページに戻る

go_forward()

Webページを次のページに進めます。

go_forward(self, load_timeout=20)

入力パラメータ

load_timeout:読み込みの待機時間(秒)です。デフォルトのタイムアウト時間は20秒です。タイムアウトまでに読み込みが完了しない場合は、UIAError例外をスローします。

戻り値

なし

例1

from xbot import web


def main(args):
    browser = web.get('サンプル検索ページ', None, 'chrome')
    browser.go_forward()

この例の実行ロジック: ページタイトルが「サンプル検索ページ」のWebページを取得し、次のページに進む

reload()

Webページを再読み込みします。

reload(self, ignore_cache=False, load_timeout=20)

入力パラメータ

ignore_cache:キャッシュを無効化して更新するかどうかを指定します。デフォルトはFalse(キャッシュを無効化しない)です。

load_timeout:読み込みの待機時間(秒)です。デフォルトのタイムアウト時間は20秒です。タイムアウトまでに読み込みが完了しない場合は、UIAError例外をスローします。

戻り値

なし

例1

from xbot import web


def main(args):
    browser = web.get('サンプル検索ページ', None, 'chrome')
    browser.reload(True)

この例の実行ロジック: ページタイトルが「サンプル検索ページ」のWebページを取得し、キャッシュを無効化せずに再読み込み

stop_load()

Webページの読み込みを停止します。

stop_load(self)

入力パラメータ

なし

戻り値

なし

例1

from xbot import web


def main(args):
    browser = web.get('サンプル検索ページ', None, 'chrome')
    browser.stop_load()

この例の実行ロジック: ページタイトルが「サンプル検索ページ」のWebページを取得し、読み込みを停止

is_load_completed()

Webページの読み込みが完了しているかどうかを判定します。

is_load_completed(self)

入力パラメータ

なし

戻り値

bool:Webページの読み込みが完了しているかどうかを返します。完了している場合はTrue、それ以外の場合はFalseを返します。

例1

from xbot import web


def main(args):
    browser = web.get('サンプル検索ページ', None, 'chrome')
    is_load_completed = browser.is_load_completed()

この例の実行ロジック: ページタイトルが「サンプル検索ページ」のWebページを取得し、読み込みが完了しているかどうかを判定

wait_load_completed()

Webページの読み込みが完了するまで待機します。

wait_load_completed(self, timeout=20)

入力パラメータ

なし

戻り値

なし

例1

from xbot import web


def main(args):
    browser = web.get_active()
    browser.wait_load_completed()

この例の実行ロジック: 現在アクティブなウィンドウを取得し、読み込みが完了するまで待機

close()

Webページを閉じます。

close(self)

入力パラメータ

なし

戻り値

なし

例1

from xbot import web


def main(args):
    browser = web.get_active()
    browser.close()

この例の実行ロジック: 現在アクティブなウィンドウを取得し、閉じる

execute_javascript()

Web要素上でJavaScriptを実行します。

execute_javascript(self, code, argument=None)

入力パラメータ

code:実行するJSスクリプトです。JavaScript関数の形式である必要があります。

argument:JS関数に渡すパラメータです。文字列である必要があります。他のタイプの値を渡す必要がある場合は、あらかじめJSON文字列形式に変換できます。

戻り値

Any:JSスクリプト実行結果を返します。

例1

from xbot import web, print


def main(args):
    page = web.get_active()
    code = """
    function (context, args) {
            // contextはnullです
            // argsは入力パラメータを表します
            return "hello " + args;
    }
    """
    js_result = page.execute_javascript(code, 'james')
    print(js_result) # 'hello james'を出力します

この例の実行ロジック: 現在アクティブなWebページを取得 --> このページ上でJS関数を実行 --> 戻り値を取得して出力

scroll_to()

ページをスクロールします。

scroll_to(self, location='bottom', behavior='instant', top=0, left=0)

入力パラメータ

location:Webページのスクロール先の位置です。'bottom'(最下部にスクロール)、'top'(最上部にスクロール)、または'point'(カスタム位置にスクロール)を選択できます。デフォルトでは最下部にスクロールします。

behavior:Webページのスクロール方法です。'instant'(即時移動)または'smooth'(スムーズスクロール)を設定できます。デフォルト値は'instant'(即時移動)です。

top:スクロール先となる指定位置の縦座標です。

left:スクロール先となる指定位置の横座標です。

戻り値

なし

例1

from xbot import web


def main(args):
    browser = web.get_active()
    browser.scroll_to(location='bottom', behavior='smooth')

この例の実行ロジック: 現在アクティブなWebページを取得 --> マウスを使用してWebページを画面下部までスムーズスクロール

例2

from xbot import web


def main(args):
    browser = web.get_active()
    browser.scroll_to(location='point', behavior='smooth', top=100, left=100)

この例の実行ロジック: 現在アクティブなWebページを取得 --> マウスを使用してWebページをtop:100、left:100の位置までスムーズスクロール

handle_javascript_dialog()

ダイアログボックスを操作(Web)します。

handle_javascript_dialog(self, dialog_result='ok' , text=None, wait_appear_timeout=20)

入力パラメータ

dialog_result:ダウンロードダイアログボックス内でクリックするボタンです。'ok'はダウンロードの確定、'cancel'はダウンロードのキャンセルを表します。

text:Webページのダイアログボックスに入力する内容です。Noneも指定できます。

wait_appear_timeout:ダイアログボックスが表示されるまで待機するタイムアウト時間です。デフォルトは20秒です。ダウンロードダイアログボックスの読み込みがタイムアウトした場合は、UIAError例外をスローします。

戻り値

なし

例1

from xbot import web


def main(args):
    browser = web.get_active()
    browser.handle_javascript_dialog('ok', text='helloword')

この例の実行ロジック: 現在アクティブなWebページを取得 --> 現在のWebページのダイアログボックスを操作し、ダイアログボックスにhellowordを入力

get_javascript_dialog_text()

Webページのダイアログボックスの内容を取得します(Chromeではこの操作をサポートしていません)。

get_javascript_dialog_text(self, wait_appear_timeout=20)

入力パラメータ

wait_appear_timeout:ダイアログボックスが表示されるまで待機するタイムアウト時間です。デフォルトは20秒です。ダウンロードダイアログボックスの読み込みがタイムアウトした場合は、UIAError例外をスローします。

戻り値

str:Webページのダイアログボックスの内容を返します。

例1

from xbot import web


def main(args):
    browser = web.get_active()
    content = browser.get_javascript_dialog_text()

この例の実行ロジック: 現在アクティブなWebページを取得 --> 現在アクティブなWebページ内のダイアログボックスの内容を取得

start_monitor_network()

Web通信の監視を開始します(Chrome、ieではこの操作をサポートしていません)。

start_monitor_network(self)

入力パラメータ

なし

戻り値

なし

例1

from xbot import web


def main(args):
    browser = web.get_active()
    browser.start_monitor_network()
    browser.reload()
    network_result_list = browser.get_responses(url='example.com',use_wildcard=False, resource_type='All')
    browser.stop_monitor_network()

この例の実行ロジック: 現在アクティブなWebページを取得 --> 現在アクティブなWebページの通信の監視を開始 --> Webページを更新 --> リクエスト結果を取得 --> Web通信の監視を停止

stop_monitor_network()

Web通信の監視を停止します(Chrome、ieではこの操作をサポートしていません)。

stop_monitor_network(self)

入力パラメータ

なし

戻り値

なし

例1

現在アクティブなWebページの通信の監視を開始し、リクエスト結果を取得して、最後にWeb通信の監視を停止します。

from xbot import web


def main(args):
    browser = web.get_active()
    browser.start_monitor_network()
    browser.reload()
    network_result_list = browser.get_responses(url='example.com',use_wildcard=False, resource_type='All')
    browser.stop_monitor_network()

この例の実行ロジック: 現在アクティブなWebページを取得 --> 現在アクティブなWebページの通信の監視を開始 --> Webページを更新 --> リクエスト結果を取得 --> Web通信の監視を停止

get_responses()

Webページのリクエスト結果を取得します(Chrome、ieではこの操作をサポートしていません)。

get_responses(self, url, use_wildcard=False,resource_type='All')

入力パラメータ

url:リソースパスURLです。

use_wildcard:ワイルドカードによる一致判定を使用するかどうかを指定します。デフォルトはFalse(あいまい一致)です。Trueの場合は、ワイルドカードによる一致判定を使用します。

resource_type:フィルタリングするWebページのリクエスト結果のタイプです。デフォルトは'All'です。All、XHR、Script、Style sheet、Image、Media、Font、Document、WebSocket、Manifest、TextTrack、Fetch、EventSource、Otherが含まれます。

戻り値

List[dict]:Webページのリクエスト結果のリストを返します。リスト項目は辞書です。

例1

現在アクティブなWebページ内のダイアログボックスの内容を取得します。

from xbot import web


def main(args):
    browser = web.get_active()
    browser.start_monitor_network()
    browser.reload()
    network_result_list = browser.get_responses(url='example.com',use_wildcard=False, resource_type='All')
    browser.stop_monitor_network()

この例の実行ロジック: 現在アクティブなWebページを取得 --> 現在アクティブなWebページの通信の監視を開始 --> Webページを更新 --> リクエスト結果を取得 --> Web通信の監視を停止

wait_appear()

Web要素が表示されるまで待機します。

wait_appear(self, selector_or_element, timeout=20)

入力パラメータ

selector_or_element:検索するセレクタです。strタイプ(要素ライブラリ内の要素を検索)とSelectorタイプ(フロー内ですでに取得したWeb要素オブジェクト)の2つの形式をサポートしています。

timeout:Web要素が表示されるまで待機するタイムアウト時間です。デフォルトのタイムアウト時間は20秒です。

戻り値

bool:Web要素が表示されたかどうかを返します。表示された場合はTrue、それ以外の場合はFalseを返します。

例1

from xbot import web


def main(args):
    browser = web.get_active()
    is_appear = browser.wait_appear('検索ボタン')

この例の実行ロジック: 現在アクティブなWebページを取得 --> 現在アクティブなWebページ内に、要素セレクタ「検索ボタン」に一致するWeb要素が表示されるまで待機

wait_disappear()

Web要素が消失するまで待機します。

wait_disappear(self, selector_or_element, timeout=20)

入力パラメータ

selector_or_element:検索するセレクタです。strタイプ(要素ライブラリ内の要素を検索)とSelectorタイプ(フロー内ですでに取得したWeb要素オブジェクト)の2つの形式をサポートしています。

timeout:Web要素が表示されるまで待機するタイムアウト時間です。デフォルトのタイムアウト時間は20秒です。

戻り値

bool:Web要素が消失したかどうかの結果を返します。消失した場合はTrue、それ以外の場合はFalseを返します。

例1

現在アクティブなWebページ内で、要素セレクタ「検索ボタン」に一致するWeb要素が消失するまで待機します。

from xbot import web


def main(args):
    browser = web.get_active()
    is_disappear = browser.wait_disappear('検索ボタン')

この例の実行ロジック: 現在アクティブなWebページを取得 --> 現在アクティブなWebページ内に表示されている、要素セレクタ「検索ボタン」に一致するWeb要素が消失するまで待機

find_all()

現在のWebページ内で、セレクタに一致する類似Web要素リストを取得します。

find_all(self, selector, timeout=20)

入力パラメータ

selector:検索するセレクタです。strタイプ(要素ライブラリ内の要素を検索)とSelectorタイプ(フロー内ですでに取得したWeb要素オブジェクト)の2つの形式をサポートしています。

timeout:Webページの類似要素リストを取得する際のタイムアウト時間です。デフォルトのタイムアウト時間は20秒です。タイムアウトまでに一致する要素が見つからない場合は、UAIError例外をスローします。

戻り値

List[WebElement]:対象要素に類似するWeb要素リストを返します。

例1

from xbot import web


def main(args):
    browser = web.get_active()
    list_web_element = browser.find_all('検索ボタン')

この例の実行ロジック: 現在アクティブなWebページを取得 --> 現在アクティブなWebページ内で、要素セレクタ「検索ボタン」に一致するすべての要素のリストを取得

find_all_by_css()

現在のWebページ内で、CSSセレクタに一致するWeb要素リストを取得します。

find_all_by_css(self, css_selector, timeout=20)

入力パラメータ

css_selector:文字列タイプのCSSセレクタです。

timeout:Webページの類似要素リストを取得する際のタイムアウト時間です。デフォルトのタイムアウト時間は20秒です。タイムアウトまでに一致する要素が見つからない場合は、UAIError例外をスローします。

戻り値

List[WebElement]:類似Web要素リストを返します。

例1

from xbot import web


def main(args):
    browser = web.get_active()
    list_web_element = browser.find_all_by_css('検索ボタン')

この例の実行ロジック: 現在アクティブなWebページを取得 --> 現在アクティブなWebページ内で、CSSセレクタ「検索ボタン」に一致するすべてのWeb要素のリストを取得

find_all_by_xpath()

現在のWebページ内で、XPathセレクタに一致するWeb要素リストを取得します。

find_all_by_xpath(self, xpath_selector, timeout=20)

入力パラメータ

xpath_selector:XPath構文の文字列です。

timeout:Webページの類似要素リストを取得する際のタイムアウト時間です。デフォルトのタイムアウト時間は20秒です。タイムアウトまでに一致する要素が見つからない場合は、UAIError例外をスローします。

戻り値

List[WebElement]:類似Web要素リストを返します。

例1

from xbot import web


def main(args):
    browser = web.get_active()
    list_web_element = browser.find_all_by_xpath('検索ボタン')

この例の実行ロジック: 現在アクティブなWebページを取得 --> 現在アクティブなWebページ内で、XPathセレクタ「検索ボタン」に一致するすべてのWeb要素の集合を取得

find()

現在のWebページ内で、セレクタに一致するWeb要素オブジェクトを取得します。

find(self, selector, timeout=20)

入力パラメータ

selector:検索するセレクタです。strタイプ(要素ライブラリ内の要素を検索)とSelectorタイプ(フロー内ですでに取得したWeb要素オブジェクト)の2つの形式をサポートしています。

timeout:Webページの類似要素リストを取得する際のタイムアウト時間です。デフォルトのタイムアウト時間は20秒です。タイムアウトまでに一致する要素が見つからない場合は、UAIError例外をスローします。

戻り値

WebElement:対象のWeb要素オブジェクトを返します。

例1

from xbot import web


def main(args):
    browser = web.get_active()
    web_element = browser.find('検索ボタン')

この例の実行ロジック: 現在アクティブなWebページを取得 --> 現在アクティブなWebページ内で、要素セレクタ「検索ボタン」に一致する要素を取得し、最初の要素を返す

find_by_css()

現在のWebページ内で、CSSセレクタに一致するWeb要素オブジェクトを取得します。

find_by_css(self, css_selector, timeout=20)

入力パラメータ

css_selector:文字列タイプのCSSセレクタです。

timeout:Webページの類似要素リストを取得する際のタイムアウト時間です。デフォルトのタイムアウト時間は20秒です。タイムアウトまでに一致する要素が見つからない場合は、UAIError例外をスローします。

戻り値

WebElement:Web要素オブジェクトを返します。

例1

from xbot import web


def main(args):
    browser = web.get_active()
    web_element = browser.find_by_css('#su')

この例の実行ロジック: 現在アクティブなWebページを取得 --> 現在アクティブなWebページ内で、idがsuという条件に一致するWeb要素を取得し、最初の要素を返す

find_by_xpath()

現在のWebページ内で、XPathセレクタに一致するWeb要素オブジェクトを取得します。

find_by_xpath(self, xpath_selector, timeout=20)

入力パラメータ

xpath_selector:XPath構文の文字列です。

timeout:Webページの類似要素リストを取得する際のタイムアウト時間です。デフォルトのタイムアウト時間は20秒です。タイムアウトまでに一致する要素が見つからない場合は、UAIError例外をスローします。

戻り値

WebElement:Web要素オブジェクトを返します。

例1

from xbot import web


def main(args):
    browser = web.get_active()
    web_element = browser.find_by_xpath('//*[@id="su"]')

この例の実行ロジック: 現在アクティブなWebページを取得 --> 現在アクティブなWebページ内で、XPathセレクタ'//*[@id="su"]'に一致するWeb要素を取得し、最初の要素を返す

is_element_displayed()

Web要素が表示されているかどうかを確認します。

is_element_displayed(self, selector)

入力パラメータ

selector:検索するセレクタです。strタイプ(要素ライブラリ内の要素を検索)とSelectorタイプ(フロー内ですでに取得したWeb要素オブジェクト)の2つの形式をサポートしています。

戻り値

bool:Web要素が表示されているかどうかを返します。表示されている場合はTrue、それ以外の場合はFalseを返します。

例1

from xbot import web


def main(args):
    browser = web.get_active()
    is_displayed = browser.is_element_displayed('検索ボタン')

この例の実行ロジック: 現在アクティブなWebページを取得 --> 現在アクティブなWebページ内で、要素セレクタ「検索ボタン」に一致するWeb要素が表示されているかどうかを判定

extract_table()

セレクタに対応する表データを取得します。

*extract_table(self, table_selector, , exclude_thead=False, timeout=20)

入力パラメータ

table_selector:検索する表のセレクタです。strタイプ(要素ライブラリ内のデータテーブル要素を検索)とTableSelectorタイプ(フロー内ですでに取得したデータテーブル要素オブジェクト)の2つの形式をサポートしています。

exclude_thead:表データを複数ページから取得する際に、最初のページの取得結果のヘッダーのみを保持します。デフォルトはFasleで、各ページの取得結果のヘッダーを結果に保持します(表要素にのみ有効です)。

timeout:Webページの類似要素リストを取得する際のタイムアウト時間です。デフォルトのタイムアウト時間は20秒です。タイムアウトまでに一致する要素が見つからない場合は、UAIError例外をスローします。

戻り値

List:Webページ上で対象要素に類似する要素のリストを返します。

例1

from xbot import web
def main(args):
    browser = web.get_active()
    # 表全体を複数ページから取得する際に、各ページの取得結果のヘッダーを結果に保持します(表要素にのみ有効です)
    table_list = browser.extract_table('数据表格',exclude_thead=False)
from xbot import web
def main(args):
    browser = web.get_active()
    # 表全体を複数ページから取得する際に、最初のページの取得結果のヘッダーのみを結果に保持します(表要素にのみ有効です)
    table_list = browser.extract_table('数据表格',exclude_thead=True)

この例の実行ロジック: 現在アクティブなWebページを取得 --> 現在アクティブなWebページ内で、表のセレクタ「数据表格」に一致する要素のリストを取得

APIリファレンスの記事一覧ページの先頭へ ↑