xbot.web.Element

この記事の内容
  1. メソッド
  2. parent()
  3. children()
  4. child_at()
  5. previous_sibling()
  6. next_sibling()
  7. click()
  8. dblclick()
  9. input()
  10. clipboard_input()
  11. focus()
  12. hover()
  13. get_text()
  14. get_html()
  15. get_value()
  16. set_value()
  17. check()
  18. select()
  19. select_multiple()
  20. select_by_index()
  21. select_multiple_by_index()
  22. get_select_options()
  23. set_attribute()
  24. get_attribute()
  25. get_all_attributes()
  26. get_bounding()
  27. extract_table()
  28. screenshot()
  29. screenshot_to_clipboard()
  30. is_checked()
  31. is_enabled
  32. is_displayed()
  33. drag_to()
  34. get_all_select_items()
  35. get_selected_item()
  36. upload()
  37. download()
  38. extract_table()

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

類似するWeb要素の取得、対象要素の親要素・子要素の検索、要素のクリックなど、Web要素を操作します。

メソッド

parent()

現在の要素の親要素を取得します。

parent(self)

入力パラメータ

なし

戻り値

WebElement:現在の要素の親要素を返します。

例1

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    web_element = browser.find('検索ボタン')
    parent_element = web_element.parent()

この例の実行ロジック: Chromeブラウザでサンプル検索ページのWebページを開きます --> 要素名が「検索ボタン」のWeb要素オブジェクトを取得します --> このオブジェクトの親要素を取得します。

children()

現在の要素のすべての子要素を取得します。

children(self)

入力パラメータ

なし

戻り値

List[WebElement]:現在の要素のすべての子要素を返します。

例1

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    web_element = browser.find('検索ボタン')
    children_elements = web_element.children()

この例の実行ロジック: Chromeブラウザでサンプル検索ページのWebページを開きます --> 要素名が「検索ボタン」のWeb要素オブジェクトを取得します ---> このオブジェクトの子要素のリストを取得します。

child_at()

インデックスを指定して子要素を取得します。

child_at(self)

入力パラメータ

index:子要素の位置を示すインデックスです。0から数えます。

戻り値

WebElement:指定位置の子要素を返します。

例1

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    web_element = browser.find('左上角的菜单栏')
    child_element = web_element.child_at(0)

この例の実行ロジック: Chromeブラウザでサンプル検索ページのWebページを開きます --> 要素名が「左上角的菜单栏」のWeb要素オブジェクトを取得します --> このオブジェクトの子要素のうち、最初の子要素を取得します。

previous_sibling()

同じ階層にある直前の兄弟要素を取得します。

previous_sibling(self)

入力パラメータ

なし

戻り値

WebElement:同じ階層にある直前の兄弟要素を返します。

例1

from xbot import web

def main(args):
    browser = web.create('example.com', 'chrome')
    web_element = browser.find('左上角的菜单栏')
    child_element = web_element.previous_sibling()

この例の実行ロジック: Chromeブラウザでサンプル検索ページのWebページを開きます --> 要素名が「左上角的菜单栏」のWeb要素オブジェクトを取得します --> このオブジェクトと同じ階層にある直前の兄弟要素を取得します。

next_sibling()

同じ階層にある直後の兄弟要素を取得します。

next_sibling(self)

入力パラメータ

なし

戻り値

WebElement:同じ階層にある直後の兄弟要素を返します。

例1

from xbot import web

def main(args):
    browser = web.create('example.com', 'chrome')
    web_element = browser.find('左上角的菜单栏')
    child_element = web_element.next_sibling()

この例の実行ロジック: Chromeブラウザでサンプル検索ページのWebページを開きます --> 要素名が「左上角的菜单栏」のWeb要素オブジェクトを取得します --> このオブジェクトと同じ階層にある直後の兄弟要素を取得します。

click()

現在のWeb要素をシングルクリックします。

click(self, button='left', simulative=True, keys='none', delay_after=1, move_mouse=False, anchor=None)

入力パラメータ

button:クリックするマウスボタンです。'left' または 'right' を指定できます。デフォルトは 'left'(マウスの左ボタン)です。

simulative:マウスクリックを再現するかどうかを指定します。省略時のデフォルトはTrue(マウスクリックを再現)です。

move_mouse:マウスの移動軌跡を表示するかどうかを指定します。デフォルトは Trueで、マウスの移動軌跡を表示します。

keys:マウスのクリック時に使用する修飾キー入力です。使用できる修飾キーは、none、alt、ctrl、shift および winです。デフォルトは 'none' です。

delay_after:実行成功後の待機時間です。デフォルトの待機時間は 1sです。

anchor:アンカーです。マウスで要素をクリックする位置とオフセットを表すタプルです。Noneを指定できます。デフォルト値は None(対象の中心をオフセットなしでクリック)です。パラメータの構造は次のとおりです。

sudoku_part:マウスでクリックする位置です。デフォルトでは中心をクリックします。

パラメータの内容 説明
'topLeft' 左上
'topCenter' 上部中央
'topRight' 右上
'middleLeft' 左中央
'middleCenter' 中心
'middleRight' 右中央
'bottomLeft' 左下
'bottomCenter' 下部中央
'bottomRight' 右下
'random' ランダムな位置

offset_x:マウス位置の水平方向のオフセットです。

offset_y:マウス位置の垂直方向のオフセットです。

戻り値

なし

例1

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    browser.find('検索ボタン').click(button='left', move_mouse=True)

この例の実行ロジック: Chromeブラウザでサンプル検索ページのWebページを開きます --> 要素名が「検索ボタン」のWeb要素オブジェクトを取得します --> マウスクリックを再現して、この要素をクリックします。

例2

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    browser.find('検索ボタン').click(button='left', move_mouse=True, anchor=('topLeft', 100, 100))

この例の実行ロジック: Chromeブラウザでサンプル検索ページのWebページを開きます --> 要素名が「検索ボタン」のWeb要素オブジェクトを取得します ---> 要素の左上から水平方向に 10、垂直方向に 10 オフセットした位置を、マウスの左ボタンでシングルクリックします。

dblclick()

現在のWeb要素をダブルクリックします。

dblclick(self, simulative=True, delay_after=1, move_mouse=False, anchor=None)

入力パラメータ

simulative:マウスクリックを再現するかどうかを指定します。省略時のデフォルトはTrue(マウスクリックを再現)です。

move_mouse:マウスの移動軌跡を表示するかどうかを指定します。デフォルトは Trueで、マウスの移動軌跡を表示します。

delay_after:実行成功後の待機時間です。デフォルトの待機時間は 1sです。

anchor:アンカーです。マウスで要素をクリックする位置とオフセットを表すタプルです。Noneを指定できます。デフォルト値は None(対象の中心をオフセットなしでクリック)です。パラメータの構造は次のとおりです。

sudoku_part:マウスでダブルクリックする位置です。デフォルトでは中心をダブルクリックします。

パラメータの内容 説明
'topLeft' 左上
'topCenter' 上部中央
'topRight' 右上
'middleLeft' 左中央
'middleCenter' 中心
'middleRight' 右中央
'bottomLeft' 左下
'bottomCenter' 下部中央
'bottomRight' 右下
'random' ランダムな位置

offset_x:マウス位置の水平方向のオフセットです。

offset_y:マウス位置の垂直方向のオフセットです。

戻り値

なし

例1

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    browser.find('検索ボタン').dblclick(move_mouse=True, anchor=('topLeft', 100, 100))

この例の実行ロジック: Chromeブラウザでサンプル検索ページのWebページを開きます --> 要素名が「検索ボタン」のWeb要素オブジェクトを取得します ---> 要素の左上から水平方向に 10、垂直方向に 10 オフセットした位置を、マウスでダブルクリックします。

例2

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    browser.find('検索ボタン').dblclick(move_mouse=True)

この例の実行ロジック: Chromeブラウザでサンプル検索ページのWebページを開きます ---> 要素名が「検索ボタン」のWeb要素オブジェクトを取得します --> マウスの左ボタンでこの要素をダブルクリックします。

input()

Webページの入力欄に入力します。input(self, text: str, simulative=True, append=False, contains_hotkey=False, force_img_ENG=False, send_key_delay=50, focus_timeout=1000, delay_after=1, anchor=None)

入力パラメータ

text:win32入力欄に入力するテキスト内容です。

simulative:マウスクリックを再現するかどうかを指定します。省略時のデフォルトはTrue(マウスクリックを再現)です。

driver_input:ドライバーによる入力を使用するかどうかを指定します。このパラメータは非サイレントモードの場合にのみ無効になります。デフォルト値はFalse(使用しない)です。

append:追加入力するかどうかを指定します。追加入力では、入力欄の既存の内容を保持します。省略時のデフォルト値はFalse(末尾に追記しない)です。

contains_hotkey:入力内容にショートカットキーが含まれるかどうかを指定します。このオプションは、キーボード入力を再現する場合にのみ有効です。デフォルト値はFalse(ショートカットキーを含まない)です。

send_key_delay:2回のキー操作の間の時間間隔です(Dr.Roboブラウザではこのパラメータは無効です)。デフォルトは50msです。

delay_after:実行成功後の待機時間です。デフォルトの待機時間は 1sです。

anchor:アンカーです。マウスで要素をクリックする位置とオフセットを表すタプルです。Noneを指定できます。デフォルト値は None(対象の中心をオフセットなしでクリック)です。パラメータの構造は次のとおりです。

sudoku_part:マウスをホバーさせる位置です。デフォルトでは中心にホバーします。次の位置も設定できます。

パラメータの内容 説明
'topLeft' 左上にホバーします
'topCenter' 上部中央にホバーします
'topRight' 右上にホバーします
'middleLeft' 左中央にホバーします
'middleCenter' 中心にホバーします
'middleRight' 右中央にホバーします
'bottomLeft' 左下にホバーします
'bottomCenter' 下部中央にホバーします
'bottomRight' 右下にホバーします

offset_x:マウス位置の水平方向のオフセットです。

offset_y:マウス位置の垂直方向のオフセットです。

focus_timeout:フォーカスのタイムアウト時間(フォーカスの取得から入力操作までの間隔)です。デフォルトは1000ミリ秒です。

戻り値

なし

例1

from xbot import web
from . import package


def main(args):
    browser = web.create('example.com', 'chrome')
    input_element=browser.find('输入框')
    input_element.input('Dr.Robo')

この例の実行ロジック: Chromeブラウザでサンプル検索ページのWebページを開きます --> 要素名が「输入框」のWeb要素オブジェクトを取得します --> 要素に Dr.Robo を入力します。

例2

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    input_element=browser.find('输入框')
    input_element.input('hello world', anchor=('topLeft', 100, 100))

この例の実行ロジック: Chromeブラウザでサンプル検索ページのWebページを開きます --> 要素名が「输入框」のWeb要素オブジェクトを取得します --> 要素の左上から水平方向に 10、垂直方向に 10 オフセットした位置をマウスでシングルクリックし、その後、要素に Dr.Robo を入力します。

clipboard_input()

クリップボードを使用してWebページの入力欄に入力します(入力メソッドに関する問題を効果的に回避できます)。

clipboard_input(self, text: str, append=False, delay_after=1, anchor=None,focus_timeout=1000)

入力パラメータ

text:win32入力欄に入力するテキスト内容です。

simulative:マウスクリックを再現するかどうかを指定します。省略時のデフォルトはTrue(マウスクリックを再現)です。

append:追加入力するかどうかを指定します。追加入力では、入力欄の既存の内容を保持します。省略時のデフォルト値はFalse(末尾に追記しない)です。

delay_after:実行成功後の待機時間です。デフォルトの待機時間は 1sです。

anchor:アンカーです。マウスで要素をクリックする位置とオフセットを表すタプルです。Noneを指定できます。デフォルト値は None(対象の中心をオフセットなしでクリック)です。パラメータの構造は次のとおりです。

sudoku_part:マウスをホバーさせる位置です。デフォルトでは中心にホバーします。

パラメータの内容 説明
'topLeft' 左上にホバーします
'topCenter' 上部中央にホバーします
'topRight' 右上にホバーします
'middleLeft' 左中央にホバーします
'middleCenter' 中心にホバーします
'middleRight' 右中央にホバーします
'bottomLeft' 左下にホバーします
'bottomCenter' 下部中央にホバーします
'bottomRight' 右下にホバーします

offset_x:マウス位置の水平方向のオフセットです。

offset_y:マウス位置の垂直方向のオフセットです。

focus_timeout:フォーカスのタイムアウト時間(フォーカスの取得から入力操作までの間隔)です。デフォルトは1000ミリ秒です。

戻り値

なし

例1

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    input_element=browser.find('输入框')
    input_element.clipboard_input('hello world', append=True)

この例の実行ロジック: Chromeブラウザでサンプル検索ページのWebページを開きます --> 要素名が「输入框」のWeb要素オブジェクトを取得します --> クリップボードを使用して、要素に hello world を書き込みます。

例2

Chromeブラウザでサンプル検索ページのWebページを開き、要素セレクター「输入框」に一致する要素オブジェクトを返して使用し、その後、要素に hello world を追記します。

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    input_element=browser.find('输入框')
    input_element.clipboard_input('hello world', append=True, 
                                           anchor=('topLeft', 100, 100))

この例の実行ロジック: Chromeブラウザでサンプル検索ページのWebページを開きます --> 要素名が「输入框」のWeb要素オブジェクトを取得します --> 要素の左上から水平方向に 10、垂直方向に 10 オフセットした位置をマウスでシングルクリックし、その後、クリップボードを使用して、要素に hello world を書き込みます。

focus()

現在の要素を選択(アクティブに)します。

focus(self)

入力パラメータ

なし

戻り値

なし

例1

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    browser.find('输入框').focus()

この例の実行ロジック: Chromeブラウザでサンプル検索ページのWebページを開きます --> 要素名が「输入框」の要素オブジェクトを選択し、その要素を選択します。

hover()

現在の要素にマウスをホバーさせます。

hover(self, simulative=True, delay_after=1)

入力パラメータ

simulative:人によるホバー操作を再現するかどうかを指定します。省略時のデフォルトはTrue(人によるホバー操作を再現)です。

delay_after:実行成功後の待機時間です。デフォルトの待機時間は 1sです。

戻り値

なし

例1

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    browser.find('输入框').hover()

この例の実行ロジック: Chromeブラウザでサンプル検索ページのWebページを開きます --> 要素名が「输入框」の要素オブジェクトにマウスをホバーさせます。

get_text()

現在のWeb要素のテキスト内容を取得します。

get_text(self)

入力パラメータ

なし

戻り値

str:現在のWeb要素のテキスト内容を返します。

例1

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    value = browser.find('输入框').get_text()

この例の実行ロジック: Chromeブラウザでサンプル検索ページのWebページを開きます --> 名称が「输入框」のWeb要素のテキスト内容を取得します。

get_html()

現在のWeb要素のhtml内容を取得します。

get_html(self)

入力パラメータ

なし

戻り値

str:現在のWeb要素のhtml内容を返します。

例1

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    html = browser.find("検索ボタン").get_html()

この例の実行ロジック: Chromeブラウザでサンプル検索ページのWebページを開きます --> 名称が「検索ボタン」のWeb要素のhtml内容を取得します。

get_value()

現在のWeb要素の値を取得します。

get_value(self)

入力パラメータ

なし

戻り値

str:現在のWeb要素の値を返します。

例1

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    value = browser.find('输入框').get_value()

この例の実行ロジック: Chromeブラウザでサンプル検索ページのWebページを開きます --> 名称が「输入框」のWeb要素の値を取得します。

set_value()

現在のWeb要素の値を設定します。

set_value(self, value: str)

入力パラメータ

value:Web要素に設定するテキスト値です。

戻り値

なし

例1

from xbot import web
from . import package


def main(args):
    browser = web.create('example.com', 'chrome')
    browser.find('输入框').set_value('hello world')

この例の実行ロジック: Chromeブラウザでサンプル検索ページのWebページを開きます --> 名称が「输入框」のWeb要素の値を hello world に設定します。

check()

Webページのチェックボックスを設定します。

check(self, mode='check', delay_after=1)

入力パラメータ

mode:Webページのチェックボックスを設定した結果です。'check'(選択)、'uncheck'(選択解除)または'toggle'(状態を切り替える)を指定できます。デフォルトは check(選択)です。

戻り値

なし

例1

from xbot import web


def main(args):
    browser = web.create('https://login.example.com/v2/?login', 'chrome')
    browser.find('用户名登录').click()
    browser.find('下次自动登录').check('check')

この例の実行ロジック: Chromeブラウザでサンプル検索ページのログインページを開きます --> 名称が「用户名登录」のWebチェックボックス要素を検索します --> このチェックボックス要素を選択済みに設定します。

select()

選択肢の内容に基づいて、単一選択のWebドロップダウンリスト要素を設定します。

select(self, item: str, mode='fuzzy', delay_after=1)

入力パラメータ

item:設定するWebドロップダウンリスト要素の項目のテキスト内容です。

mode:項目を検索する際の一致モードです。'fuzzy'(あいまい一致)、'exact'(完全一致)または'regex'(正規表現一致)を選択できます。デフォルトはあいまい一致です。

delay_after:実行成功後の待機時間です。デフォルトの時間は1sです。

戻り値

なし

例1

from xbot import web


def main(args):
    browser = web.create('example.com/shop', 'chrome')
    browser.find('用户名').select('张三')

この例の実行ロジック: Chromeブラウザで商品検索のWebページを開きます --> 名称が「用户名」のWebドロップダウンリスト要素を検索します --> 完全一致を使用して内容が「张三」の項目を検索し、現在の選択項目に設定します。

select_multiple()

選択肢の内容に基づいて、単一選択のWebドロップダウンリスト要素を設定します。

select_multiple(self, items: typing.List[str], mode='fuzzy', append=False, delay_after=1)

入力パラメータ

items:チェックを入れるWebドロップダウンリスト要素のリストです。

mode:項目を検索する際の一致モードです。'fuzzy'(あいまい一致)、'exact'(完全一致)または'regex'(正規表現一致)を選択できます。デフォルトはあいまい一致です。

append:追加で設定するかどうかを指定します。デフォルト値はFalse(追加しない)です。

delay_after:実行成功後の待機時間です。デフォルトの時間は1sです。

戻り値

なし

例1

Chromeで xxxx のWebページを開き、要素セレクター「多选下拉框」に一致するドロップダウンリスト要素を検索し、その後、

from xbot import web


def main(args):
    browser = web.create('www.xxx.com', 'chrome')
    browser.find('多选下拉框').select_multiple(['张三','李四', '王五'])

この例の実行ロジック: ChromeブラウザでWebページを開きます --> 名称が「多选下拉框」のWebドロップダウンリスト要素を検索します --> 完全一致を使用して内容が「张三」「李四」「王五」の項目を検索し、すべてにチェックを入れます。

select_by_index()

インデックスに基づいて、単一選択のWebドロップダウンリスト要素を設定します。

select_by_index(self, index: int, delay_after=1)

入力パラメータ

index:設定する単一選択のWebドロップダウンリスト要素の位置です。位置は0から始まります。

delay_after:実行成功後の待機時間です。デフォルトの時間は1sです。

戻り値

なし

例1

Chromeで商品検索のログインページを開き、要素セレクター「用户名」に一致するドロップダウンリスト要素を検索してから設定します。

from xbot import web


def main(args):
    browser = web.create('example.com/shop', 'chrome')
    browser.find('用户名').select_by_index(1)

この例の実行ロジック: Chromeブラウザで商品検索のWebページを開きます --> 名称が「用户名」のWebドロップダウンリスト要素を検索します --> ドロップダウンリスト内でインデックスが 1 の項目を検索し、チェックを入れます。

select_multiple_by_index()

インデックスに基づいて、複数選択のWebドロップダウンリスト要素を設定します。

select_multiple_by_index(self, indexes: typing.List[int], append=False, delay_after=1)

入力パラメータ

indexes:設定する単一選択のWebドロップダウンリスト要素の位置のリストです。位置は0から始まります。

append:追加で設定するかどうかを指定します。デフォルト値はFalse(追加しない)です。

delay_after:実行成功後の待機時間です。デフォルトの時間は1sです。

戻り値

なし

例1

from xbot import web


def main(args):
    browser = web.create('www.xxx.com', 'chrome')
    browser.find('多选下拉框').select_multiple_by_index([1,3,5])

このサンプルの実行ロジック: ChromeブラウザでWebページを開きます --> 多选下拉框 という名前のWebページのドロップダウンリスト要素を見つけます --> ドロップダウンリストのインデックスが 1、3、5 の項目を選択状態にします

get_select_options()

Webページのドロップダウンリストの値を取得します

get_select_options(self)

入力パラメータ

なし

戻り値

List[Tuple]:ドロップダウンリストの値(選択肢、選択肢の値、選択状態)のリストを返します

サンプル1

from xbot import web


def main(args):
    browser = web.create('www.xxx.com', 'chrome')
    list_value = browser.find('下拉框').get_select_options()

このサンプルの実行ロジック: Chromeブラウザで xxx のWebページを開きます --> 下拉框 という名前のWebページのドロップダウンリスト要素を見つけ、その値を取得します

set_attribute()

Webページの要素の属性値を設定します

set_attribute(self, name: str, value: str)

入力パラメータ

name:要素の属性名です

value:設定する要素の属性値です

戻り値

なし

サンプル1

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    browser.find('検索ボタン').set_attribute('height', '100')

このサンプルの実行ロジック: Chromeブラウザで サンプル検索ページ のWebページを開きます --> 検索ボタン という名前のWebページの要素を見つけ、その要素の height を 100 に設定します

get_attribute()

Webページの要素の属性値を取得します

get_attribute(self, name: str)

入力パラメータ

name:要素の属性名です

戻り値

str:Webページの要素の対象属性の属性値を返します

サンプル1

from xbot import web
from . import package


def main(args):
    browser = web.create('example.com', 'chrome')
    height = browser.find('検索ボタン').get_attribute('height')

このサンプルの実行ロジック: Chromeブラウザで サンプル検索ページ のWebページを開きます --> 検索ボタン という名前のWebページの要素を見つけ、その要素の height 属性の値を取得します

get_all_attributes()

Webページの要素のすべての属性値を取得します

get_all_attributes(self)

入力パラメータ

なし

戻り値

List[Tuple]:対象のWebページの要素のすべての属性名と属性値の組み合わせのリストを返します

サンプル1

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    list_tuple = browser.find('検索ボタン').get_all_attributes()

このサンプルの実行ロジック: Chromeブラウザで サンプル検索ページ のWebページを開きます --> 検索ボタン という名前のWebページの要素を見つけ、その要素のすべての属性値を取得します

get_bounding()

Webページの要素の境界枠の属性の組み合わせを取得します

get_bounding(self, to96dpi=True)

入力パラメータ

to96dpi:境界枠の属性を96dpiに対応する属性値に変換するかどうかを指定します

戻り値

Tuple:Webページの要素の境界枠の属性の組み合わせを返します。例:('x', 'y', 'width', 'height')

サンプル1

Chromeで サンプル検索ページ のWebページを開き、要素セレクター 検索ボタン に一致する要素を検索して、その要素の境界枠の属性情報を取得します

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    list_tuple = browser.find('検索ボタン').get_bounding()

このサンプルの実行ロジック: Chromeブラウザで サンプル検索ページ のWebページを開きます --> 検索ボタン という名前のWebページの要素を見つけ、その要素の境界枠の属性情報を取得します

extract_table()

現在の要素が属する表の内容をリストとして取得します

extract_table(self)

入力パラメータ

なし

戻り値

List[Tuple]: データテーブルの内容を返します

サンプル1

from xbot import web


def main(args):
    browser = web.create('www.xxx.com', 'chrome')
    list_tuple = browser.find('数据表格').extract_table()

このサンプルの実行ロジック: Chromeブラウザで サンプル検索ページ のWebページを開きます --> 数据表格 という名前のWebページのデータテーブル要素を見つけ、表の内容を取得します

screenshot()

対象要素のスクリーンショットを撮影し、画像を保存します

screenshot(self, folder_path, filename=None)

入力パラメータ

folder_path:要素のスクリーンショット画像を保存するパスです

filename:スクリーンショット画像の保存時の名前です。空にすることもでき、空の場合は現在時刻に基づいてファイル名を自動生成します

戻り値

なし

サンプル1

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    browser.find('検索ボタン').screenshot('D:\\', filename='123.png')

このサンプルの実行ロジック: Chromeブラウザで サンプル検索ページ のWebページを開きます --> 検索ボタン という名前のWebページの要素を見つけ、その要素のスクリーンショットを撮影し、結果を 123.png という名前で D: の直下に保存します

screenshot_to_clipboard()

対象要素のスクリーンショットを撮影し、画像をクリップボードに保存します

screenshot_to_clipboard(self)

入力パラメータ

なし

戻り値

なし

サンプル1

Chromeで サンプル検索ページ のWebページを開き、要素セレクター 検索ボタン に一致する要素を検索して、その要素のスクリーンショットを撮影します

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    browser.find('検索ボタン').screenshot_to_clipboard()

このサンプルの実行ロジック: Chromeブラウザで サンプル検索ページ のWebページを開きます --> 検索ボタン という名前のWebページの要素を見つけ、その要素のスクリーンショットを撮影し、結果をクリップボードに追加します

is_checked()

Webページのチェックボックス要素が選択されているかどうかを判定します

is_checked(self)

入力パラメータ

なし

戻り値

bool:要素の選択状態を返します。選択されている場合はTrue、それ以外の場合はFalseを返します

サンプル1

Chromeで xxx のWebページを開き、要素セレクター 复选框 に一致する要素を検索し、

from xbot import web


def main(args):
    browser = web.create('www.xxx.com', 'chrome')
    is_checked = browser.find('复选框').is_checked()

このサンプルの実行ロジック: Chromeブラウザで xxx のWebページを開きます --> 复选框 という名前のWebページの要素を見つけ、その要素が選択されているかどうかを判定します

is_enabled

Webページの要素が使用可能かどうかを判定します

is_enabled(self)

入力パラメータ

なし

戻り値

bool:要素が使用可能かどうかを返します。使用可能な場合はTrue、それ以外の場合はFalseを返します

サンプル1

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    is_enabled = browser.find('検索ボタン').is_enabled()

is_displayed()

Webページの要素が表示されるかどうかを判定します

is_displayed(self)

入力パラメータ

なし

戻り値

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

サンプル1

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    is_displayed = browser.find('検索ボタン').is_displayed()

このサンプルの実行ロジック: Chromeブラウザで サンプル検索ページ のWebページを開きます --> 検索ボタン という名前のWebページの要素を見つけ、その要素が表示されるかどうかを判定します

drag_to()

Webページの要素を指定位置にドラッグします

drag_to(self, simulative=True, behavior='smooth', top=0, left=0, delay_after=1)

入力パラメータ

simulative:マウスクリックを再現するかどうかを指定します。省略した場合のデフォルト値はTrue(マウスクリックを再現)です

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

top:カスタム位置にスクロールする際の縦座標です

left:カスタム位置にスクロールする際の横座標です

delay_after:コマンドの実行に成功した後の待機時間です。デフォルト値は1秒です

戻り値

なし

サンプル1

Chromeブラウザで xxx のWebページを開き、要素セレクター 可移动元素 に一致する要素を検索し、

from xbot import web


def main(args):
    browser = web.create('example.com', 'chrome')
    browser.find('可移动元素').drag_to(simulative=True, behavior='smooth', 
                                      top=100, left=100)

このサンプルの実行ロジック: Chromeブラウザで サンプル検索ページ のWebページを開きます --> 可移动元素 という名前のWebページの要素を見つけ、人のドラッグ操作を再現して要素を top:100、left:100 の位置に移動します

get_all_select_items()

Webページのドロップダウンリスト要素のすべての選択肢を取得します

get_all_select_items(self)

入力パラメータ

なし

戻り値

List[str]:Webページのドロップダウンリストのすべての選択肢のリストを返します

サンプル1

現在のWebページの 下拉框 要素のすべての選択肢を取得します

from xbot import web


def main(args):
    browser = web.get_active()
    element = browser.find('下拉框')
    values = element.get_all_select_items()

get_selected_item()

Webページのドロップダウンリストで現在選択されている項目を取得します

get_selected_item(self)

入力パラメータ

なし

戻り値

List[str]:Webページのドロップダウンリストで現在選択されているすべての項目のリストを返します

サンプル1

from xbot import web


def main(args):
    browser = web.get_active()
    element = browser.find('下拉框')
    values = element.get_selected_item()

このサンプルの実行ロジック: 現在開いているWebページのオブジェクトを取得します --> 下拉框 という名前のWebページの要素を見つけます --> その要素で現在選択されているすべての項目を取得します

upload()

アップロードボタンのクリック、ファイル選択ダイアログでのアップロードするファイルの入力など、一連の操作を自動で実行します

upload(self, file_names, clipboard_input=True, focus_timeout=1000, dialog_timeout=20)

入力パラメータ

file_names:アップロードするファイルのリストです。例:[r"C:\test.txt",r"C:\text1.txt"]

clipboard_input:ファイル選択にクリップボード入力を使用するかどうかを指定します。デフォルト値はTrue(クリップボードを使用)です

focus_timeout:フォーカスのタイムアウト時間(フォーカスの取得と入力操作の間隔)です。デフォルト値は1000ミリ秒です

dialog_timeout:アップロードボタンをクリックした後、ファイル選択ダイアログを待機する最大時間です。単位は秒です

戻り値

なし

サンプル1

import xbot
from xbot import print, sleep
from . import package


def main(args):
    web_object = xbot.web.create("https://www.w3schools.com/tags/tryit.asp?filename=tryhtml5_input_type_file","chrome")
    web_object.find("上传按钮").upload([r'D:\logo.gif'])

このサンプルの実行ロジック: Google Chromeブラウザで www.w3schools.com のWebページを開きます --> 上传按钮 という名前のWebページの要素を見つけます --> Dドライブの logo.gif ファイルをアップロードします

download()

ダウンロードボタンのクリック、ファイル保存ダイアログでの保存するファイルの情報の入力など、一連の操作を自動で実行します

download(self, file_folder, file_name, wait_complete=True, wait_complete_timeout=300, clipboard_input=True, focus_timeout=1000, dialog_timeout=20)

入力パラメータ

file_folder:ダウンロードするファイルを保存するフォルダです

file_name:保存時のカスタムファイル名です。空の場合は、ダウンロードするリソースのデフォルトのファイル名を使用します

wait_complete:ダウンロードの完了を待機するかどうかを指定します。デフォルト値はTrue(ダウンロードの完了を待機)です

wait_complete_timeout:ダウンロードの待機タイムアウト時間です。単位は秒で、デフォルト値は300秒です

clipboard_input:ファイル選択にクリップボード入力を使用するかどうかを指定します。デフォルト値はTrue(クリップボードを使用)です

focus_timeout:フォーカスのタイムアウト時間(フォーカスの取得と入力操作の間隔)です。デフォルト値は1000ミリ秒です

dialog_timeout:アップロードボタンをクリックした後、ファイル選択ダイアログを待機する最大時間です。単位は秒です

戻り値

str:ダウンロードしたファイルの保存先の位置を返します

サンプル1

import xbot
from xbot import print, sleep
from .import package


def main(args):
    web_object = web.create("example.com", "chrome")
    web_object.find("検索入力欄").input("サンプルアプリ{enter}", contains_hotkey=True)
    download_file_name = web_object.find("立即下载").download("D:\\", "SampleInstaller.exe", wait_complete=True,wait_complete_timeout=300)
    print(download_file_name)

このサンプルの実行ロジック: Google Chromeブラウザで サンプル検索ページ のWebページを開きます --> 検索入力欄 という名前のWebページの要素を見つけ、サンプルアプリ と入力してEnterキーを押下します --> 立即下载 という名前のWebページの要素を見つけ、ダウンロードしてローカルに保存します --> ファイルのダウンロード先の位置を出力します

extract_table()

「表データを取得」で表全体の内容をリストとして取得します

サンプル1 単ページを取得

from xbot import web
def main(args):
    browser = xbot.web.get_active() 
    rows = browser.extract_table('数据列表')  #rowsは2次元の表です。例:[['a', 'b'], ['c', 'd']]

サンプル2 複数ページを取得

from xbot import web
def main(args):
    table = []  # tableの最終結果は2次元の表です。例:[['a', 'b'], ['c', 'd']]
    browser = xbot.web.get_active()
    for i in range(1):
        rows = browser.extract_table('数据列表')
        table.extend(rows)  # 1ページ分のデータを追加します
        if i == 1 - 1:  # 最後のページでは次のページをクリックする必要はありません
            break
        browser.find('按钮').click()  # 次のページをクリックします
        xbot.sleep(2)  # 非同期データの読み込み完了を待機します(必須ではありません)

このサンプルの実行ロジック: 現在開いているWebページのオブジェクトを取得します --> 整表数据表格 という名前のWebページの要素を見つけます --> 表全体に対して「表データを取得」を実行します

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