xbot.web

この記事の内容
  1. メソッド
  2. create()
  3. get()
  4. get_active()
  5. get_all()
  6. get_cookies()
  7. get_cookies_v2()
  8. set_cookie()
  9. remove_cookie()
  10. close_all()
  11. handle_save_dialog()
  12. handle_upload_dialog()

example.com は説明用のアドレスです。実際に操作する Web サイトの URL に置き換えてください。

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

Webページを開く、Webページを閉じるなど、Webページに対してさまざまな操作を行います。

メソッド

create()

Webページを開きます。

create(url, mode='cef' ,load_timeout=20, stop_if_timeout=False, silent_running=False, executable_path=None, arguments=None)

入力パラメータ

url:対象のURLです。

mode:ブラウザの種類です。現在サポートされているブラウザは次のとおりです。

modeの値 説明
'cef' Dr.Roboブラウザ(デフォルト値)
'chrome' Google Chrome
'ie' Internet Explorer
'edge' Microsoft Edge
APP_DIR\ChromiumBrowser.config ファイル内のProductName(APP_DIRはインストール先を表すプレースホルダーで、実際のパスに置き換える必要があります) カスタムブラウザ / フィンガープリントブラウザ

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

stop_if_timeout:Webページの読み込みがタイムアウトした場合に、Webページの読み込みを停止するかどうかを指定します。デフォルトはFalse(読み込みを停止しない)です。

silent_running:実行時にマウスとキーボードの操作を奪わないようにするかどうかを指定します。デフォルトはFalseです。

executable_path:ブラウザの実行ファイルのパスです。デフォルトはNoneで、デフォルト値を使用します。

arguments:コマンドライン引数です。対象のブラウザでサポートされているコマンドラインである必要があります。デフォルトはNoneです。

戻り値

WebBrowser:開いたWebページのオブジェクトを返します。

例1

from xbot import web
def main(args):
    web_object = web.create('example.com', 'chrome', load_timeout=20)

この例の実行内容: Chromeブラウザを使用してサンプル検索ページを開きます。

get()

URLまたはページタイトルに基づいてWebページを取得します。

get(title=None, url=None, mode='cef', load_timeout=20, use_wildcard=False, stop_if_timeout=False, open_page=False, page_url=None, silent_running=False)

入力パラメータ

title:Webページのページタイトルです。

url:URLです。

mode:ブラウザの種類です。現在サポートされているブラウザには、APP_DIR\ChromiumBrowser.config ファイル内のProductName(APP_DIRはインストール先を表すプレースホルダーで、実際のパスに置き換える必要があります)があります。

modeの値 説明
'cef' Dr.Roboブラウザ(デフォルト値)
'chrome' Google Chrome
'ie' Internet Explorer
'edge' Microsoft Edge
APP_DIR\ChromiumBrowser.config ファイル内のProductName(APP_DIRはインストール先を表すプレースホルダーで、実際のパスに置き換える必要があります) カスタムブラウザ / フィンガープリントブラウザ

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

use_wildcard:ワイルドカードを使用して照合するかどうかを指定します。デフォルトはFalse(使用しない)です。Trueの場合、複数のWebページが一致すると、最後に開いたWebページを返します。

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

open_page:urlまたはtitleによる照合に失敗した場合に、新しいWebページを開くかどうかを指定します。デフォルトはFalse(開かない)です。

page_url:open_page=Trueの場合に、開くWebページのURLを指定します。

silent_running:実行時にマウスとキーボードの操作を奪わないようにするかどうかを指定します。デフォルトはFalseです。

戻り値

WebBrowser:取得したWebページのオブジェクトを返します。

例1

from xbot import web

def main(args):
    web_object = web.get('サンプル検索ページ', None, 'chrome', load_timeout=20, use_wildcard=False)

この例の実行内容: あいまい一致を使用して、Chromeブラウザでページタイトルが「サンプル検索ページ」で始まるWebページのオブジェクトを検索します。

例2

from xbot import web

def main(args):
    web_object = web.get('サンプル検索ページ*', None, 'chrome', load_timeout=20, use_wildcard=True)

この例の実行内容: ワイルドカードを使用して、Chromeブラウザでページタイトルが「サンプル検索ページ」で始まるWebページのオブジェクトを検索します。

get_active()

現在選択されている、またはアクティブなWebページを取得します。

get_active(mode='cef', load_timeout=20, stop_if_timeout=False, silent_running=False)

入力パラメータ

mode:ブラウザの種類です。現在サポートされているブラウザは次のとおりです。

modeの値 説明
'cef' Dr.Roboブラウザ(デフォルト値)
'chrome' Google Chrome
'ie' Internet Explorer
'edge' Microsoft Edge
APP_DIR\ChromiumBrowser.config ファイル内のProductName(APP_DIRはインストール先を表すプレースホルダーで、実際のパスに置き換える必要があります) カスタムブラウザ / フィンガープリントブラウザ

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

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

silent_running:実行時にマウスとキーボードの操作を奪わないようにするかどうかを指定します。デフォルトはFalseです。

戻り値

WebBrowser:取得したWebページのオブジェクトを返します。

例1

from xbot import web
def main(args):
    web_object = web.get_active('chrome', load_timeout=20)

この例の実行内容: Chromeブラウザで現在アクティブなWebページのオブジェクトを取得します。

get_all()

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

get_all(mode='cef', title=None, url=None, use_wildcard=False, silent_running=False)

入力パラメータ

mode:ブラウザの種類です。現在サポートされているブラウザは次のとおりです。

modeの値 説明
'cef' Dr.Roboブラウザ(デフォルト値)
'chrome' Google Chrome
'ie' Internet Explorer
'edge' Microsoft Edge
APP_DIR\ChromiumBrowser.config ファイル内のProductName(APP_DIRはインストール先を表すプレースホルダーで、実際のパスに置き換える必要があります) カスタムブラウザ / フィンガープリントブラウザ

title:Webページのページタイトルです。

url:URLです。

use_wildcard:ワイルドカードを使用して照合するかどうかを指定します。デフォルトはFalse(使用しない)です。Trueの場合、複数のWebページが一致すると、最後に開いたWebページを返します。

silent_running:実行時にマウスとキーボードの操作を奪わないようにするかどうかを指定します。デフォルトはFalseです。

戻り値

WebBrowser:取得したWebページのオブジェクトを返します。

戻り値

List[WebBrowser]:Webオブジェクトリストを返します。

例1

from xbot import web

def main(args):
    web_objects = web.get_all('chrome')

この例の実行内容: Chromeブラウザで現在開いているすべてのWebページのオブジェクトを取得します。

get_cookies()

ブラウザのCookie情報を取得します。

get_cookies(mode='cef' , url=None, name=None, domain=None, path=None)

入力パラメータ

mode:ブラウザの種類です。現在サポートされているブラウザは次のとおりです。

modeの値 説明
'cef' Dr.Roboブラウザ(デフォルト値)
'chrome' Google Chrome
'ie' Internet Explorer
'edge' Microsoft Edge
APP_DIR\ChromiumBrowser.config ファイル内のProductName(APP_DIRはインストール先を表すプレースホルダーで、実際のパスに置き換える必要があります) カスタムブラウザ / フィンガープリントブラウザ

url:指定したurlに基づいて、対応するcookieを検索します。たとえば、url='https://example.com'を指定すると、そのWebページのcookieを取得します。デフォルト値はNoneです。

name:cookieのnameに基づいてcookieを絞り込みます。デフォルト値はNoneです。

domain:cookieのdomainに基づいてcookieを絞り込みます。デフォルト値はNoneです。

path:cookieのpathに基づいてcookieを絞り込みます。デフォルト値はNoneです。

戻り値

List[dict]:絞り込んだcookieのリストを返します。リスト項目は辞書です。

例1

Chromeブラウザのcookie情報を取得します。

from xbot import web

def main(args):
    get_explorer_cookie('cef')
    pass

def get_explorer_cookie(mode):
    # ブラウザのcookieを取得します
    cookie_list = web.get_cookies(mode)
    print(cookie_list)
    for cookie in cookie_list:
        print(cookie['name'] + '    '+cookie['value'])

この例の実行内容: Dr.Roboブラウザのすべてのcookieを取得します --> 絞り込んだcookieのすべてのフィールドを出力します。

get_cookies_v2()

ブラウザのCookie情報を取得します。PartitionKeyに対応しています。

get_cookies_v2(mode='cef', name=None, url=None, domain=None, path=None, partition_key=None, secure=None, session=None)

入力パラメータ

mode:ブラウザの種類です。現在サポートされているブラウザは次のとおりです。

modeの値 説明
'cef' Dr.Roboブラウザ(デフォルト値)
'chrome' Google Chrome
'ie' Internet Explorer
'edge' Microsoft Edge
'firefox' Firefoxブラウザ
APP_DIR\ChromiumBrowser.config ファイル内のProductName(APP_DIRはインストール先を表すプレースホルダーで、実際のパスに置き換える必要があります) カスタムブラウザ / フィンガープリントブラウザ

name:指定したnameに基づいてcookieを絞り込みます。値が空の場合、nameの絞り込み条件は無視されます。デフォルト値はNoneです。

url:指定したURL(たとえば、'')に基づいてcookieを絞り込みます。値が空の場合、urlの絞り込み条件は無視されます(IEでは空にできません)。デフォルト値はNoneです。

domain:cookieのdomainに基づいてcookieを絞り込みます。デフォルト値はNoneです。

path:cookieのpathに基づいてcookieを絞り込みます。デフォルト値はNoneです。

partition_key:cookieのpartition keyに基づいてcookieを絞り込みます。デフォルト値はNoneです。cookieにPartitionKeyが含まれている場合、PartitionKeyを指定しなければ取得できません。

secure:secureを指定します。指定せずにNoneの場合は無視され、secureかどうかによるCookie集合の絞り込みは行いません。Trueの場合はsecureのCookie集合を取得し、Falseの場合はsecureではないCookie集合を取得します。ブラウザの種類がIEの場合、このパラメータは無視されます。

session:sessionを指定します。指定せずにNoneの場合は無視され、セッションCookieかどうかによるCookie集合の絞り込みは行いません。Trueの場合はセッションCookie集合を取得し、Falseの場合は永続Cookie集合を取得します。ブラウザの種類がIEの場合、このパラメータは無視されます。

戻り値

List[dict]:絞り込んだcookieのリストを返します。リスト項目は辞書です。

例1

ChromeブラウザでPartitionKeyが https://example.com のCookie情報を取得します。

from xbot import web

def main(args):
    get_explorer_cookie('chrome')
    pass

def get_explorer_cookie(mode):
    # ブラウザのcookieを取得します
    cookie_list = web.get_cookies(mode, partition_key="https://example.com")
    print(cookie_list)
    for cookie in cookie_list:
        print(cookie['name'] + '    '+cookie['value'])

ブラウザのCookie情報を設定します。

set_cookie(url, mode='cef', name=None ,value=None, sessionCookie=True, expires=100, domain=None, path=None, httpOnly=False, secure=False):

入力パラメータ

url:指定したURL(たとえば、'')に基づいてcookieを設定します。このパラメータは必須です。

mode:ブラウザの種類です。現在サポートされているブラウザは次のとおりです。

modeの値 説明
'cef' Dr.Roboブラウザ(デフォルト値)
'chrome' Google Chrome
'ie' Internet Explorer
'edge' Microsoft Edge
'firefox' Firefoxブラウザ
APP_DIR\ChromiumBrowser.config ファイル内のProductName(APP_DIRはインストール先を表すプレースホルダーで、実際のパスに置き換える必要があります) カスタムブラウザ / フィンガープリントブラウザ

name:指定したnameに基づいてcookieを設定します。このパラメータは必須です。

value:指定したvalueに基づいてcookieを設定します。値が空の場合は無視されます。デフォルト値はNoneです。

domain:指定したdomainに基づいてcookieを設定します。デフォルト値はNoneです。

path:指定したpathに基づいてcookieを設定します。デフォルト値はNoneです。

sessionCookie:デフォルトはTrueで、セッションcookieとして設定され、ブラウザを閉じると無効になります。Falseの場合は永続cookieとして設定され、cookieの有効期間を指定する必要があります。

expires:永続cookieには有効期間(cookieが有効になってから無効になるまでの時間間隔、単位は秒)を設定する必要があります。デフォルトは100秒です。

secure:このcookieをSecureとしてマークするかどうかを設定します。デフォルトはFalseです。

session:このcookieをHttpOnlyとしてマークするかどうかを設定します。デフォルトはFalseです。

例1

Chromeブラウザで、URLがhttps://example.com、name="test"のcookieを設定します。

from xbot import web

def main(args):
    web.set_cookie('https://example.com', mode="chrome", name="test")
    pass

ブラウザのCookie情報を取得し、cookie urlとcookie nameで指定したcookieを削除します。

remove_cookie(url, name, mode='cef')

入力パラメータ

mode:ブラウザの種類です。現在サポートされているブラウザは次のとおりです。

modeの値 説明
'cef' Dr.Roboブラウザ(デフォルト値)
'chrome' Google Chrome
'ie' Internet Explorer
'edge' Microsoft Edge
'firefox' Firefoxブラウザ
APP_DIR\ChromiumBrowser.config ファイル内のProductName(APP_DIRはインストール先を表すプレースホルダーで、実際のパスに置き換える必要があります) カスタムブラウザ / フィンガープリントブラウザ

cookie url:削除するcookieのURLです。

cookie name:削除するcookieの名称です。

例1

Edgeブラウザから、サンプルサイトの「session_id」というcookie情報を削除します。

from xbot import web

def main(args):
    web.remove_cookie('https://example.com', 'session_id', 'edge')
    pass

この例の実行内容: remove_cookie関数を使用します --> Edgeブラウザから、サンプルサイトの「session_id」という名前のcookie情報を削除します。

close_all()

すべてのWebページを閉じます。

close_all(mode='cef' , task_kill=False )

入力パラメータ

mode:ブラウザの種類です。現在サポートされているブラウザは次のとおりです。

modeの値 説明
'cef' Dr.Roboブラウザ(デフォルト値)
'chrome' Google Chrome
'ie' Internet Explorer
'edge' Microsoft Edge
APP_DIR\ChromiumBrowser.config ファイル内のProductName(APP_DIRはインストール先を表すプレースホルダーで、実際のパスに置き換える必要があります) カスタムブラウザ / フィンガープリントブラウザ

task_kill:ブラウザプロセスを終了するかどうかを指定します。デフォルトはFalse(終了しない)です。

戻り値

なし

例1

from xbot import web

def main(args):
    web.close_all('chrome')

この例の実行内容: Chromeブラウザで現在開いているすべてのWebページを閉じます。

handle_save_dialog()

Webページのダウンロードダイアログを処理します。

handle_save_dialog(file_folder, dialog_result='ok', mode='cef', * , file_name=None,wait_appear_timeout=20,focus_timeout=600)

入力パラメータ

file_folder:ファイル保存パスです。

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

mode:ブラウザの種類です。現在サポートされているブラウザは次のとおりです。

modeの値 説明
'cef' Dr.Roboブラウザ(デフォルト値)
'chrome' Google Chrome
'ie' Internet Explorer
'edge' Microsoft Edge
APP_DIR\ChromiumBrowser.config ファイル内のProductName(APP_DIRはインストール先を表すプレースホルダーで、実際のパスに置き換える必要があります) カスタムブラウザ / フィンガープリントブラウザ

file_name:ファイル名です。デフォルト値はNoneです(ダウンロードするリソースに重複しないファイル名を生成します)。

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

focus_timeout:フォーカスのタイムアウト時間(ダイアログの表示と入力操作の間隔)です。デフォルトは600ミリ秒です。

戻り値

なし

例1

from xbot import web

def main(args):
    web.handle_save_dialog('D:\\', 'ok', 'chrome', file_name='123.txt', wait_appear_timeout=20)

この例の実行内容: Chromeブラウザでダウンロードダイアログを処理し、対象ファイルの名前を"123.txt"に変更して、Dドライブのルートディレクトリに保存します。

handle_upload_dialog()

Webページのアップロードダイアログを処理します。

handle_upload_dialog(filename, dialog_result='ok', mode='cef', * , wait_appear_timeout=20)

入力パラメータ

file_folder:ファイル保存パスです。

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

mode:ブラウザの種類です。現在サポートされているブラウザは次のとおりです。

modeの値 説明
'cef' Dr.Roboブラウザ(デフォルト値)
'chrome' Google Chrome
'ie' Internet Explorer
'edge' Microsoft Edge
APP_DIR\ChromiumBrowser.config ファイル内のProductName(APP_DIRはインストール先を表すプレースホルダーで、実際のパスに置き換える必要があります) カスタムブラウザ / フィンガープリントブラウザ

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

戻り値

なし

例1

from xbot import web

def main(args):
    web.handle_upload_dialog('D:\\123.txt', 'ok', 'chrome', wait_appear_timeout=20)

この例の実行内容: ChromeブラウザでWebページのアップロードダイアログを処理し、D:\123.textファイルをアップロードします。

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