xbot.win32
この記事の内容
以下のURL、ページタイトル、ウィンドウ名、要素名は説明用の例です。実際に操作する環境の値に置き換えてください。要素ライブラリに登録する名前も、コード内の指定と一致させてください。
このインターフェースは、主にウィンドウやデスクトップに関連するオブジェクトを操作します。また、人の操作をシミュレートする機能を呼び出すこともできます。
メソッド
get()
タイトルまたはクラス名でウィンドウを取得します。
get(title, class_name=None, use_wildcard=False)
入力パラメータ
title:指定するウィンドウタイトルです。
class_name:指定するウィンドウのクラス名です。デフォルト値はNoneです。
use_wildcard:ワイルドカードを使用して照合するかどうかを指定します。デフォルト値はFalse(あいまい一致)です。
戻り値
Win32Window:取得したウィンドウオブジェクトを返します。
例1
from xbot import win32
def main(args):
wnd = win32.get('サンプルチャット')
print(wnd)
この例の実行ロジック: タイトルが サンプルチャット のウィンドウオブジェクトを取得します --> ウィンドウオブジェクトを出力します。
例2
from xbot import win32
def main(args):
wnd = win32.get('hello*',class_name=None,use_wildcard=True)
print(wnd)
この例の実行ロジック: ワイルドカードによる照合を使用して、タイトルが hello で始まるウィンドウオブジェクトを取得します --> ウィンドウオブジェクトを出力します。
get_by_handle()
ウィンドウハンドルでウィンドウを取得します。
get_by_handle(0x01014A )
入力パラメータ
0x01014A :指定するウィンドウハンドルです。
戻り値
Win32Window:取得したウィンドウオブジェクトを返します。
例1
from xbot import win32
def main(args):
wnd = win32.get_by_handle(0x01014A)
この例の実行ロジック: ハンドルが 0x01014A のウィンドウオブジェクトを取得します。
get_by_selector()
セレクターでウィンドウを取得します。
get_by_selector(selector=None)
入力パラメータ
selector:検索するセレクターです。str型(要素ライブラリ内の要素を検索)とSelector型(フロー内ですでに取得したウィンドウオブジェクト)の2つの形式に対応しています。
戻り値
Win32Window:セレクターに一致するウィンドウオブジェクトを返します。
例1
from xbot import win32
def main(args):
wnd = win32.get_by_selector("窗格")
この例の実行ロジック: 要素ライブラリ内の「窗格」という名前の要素に一致するウィンドウオブジェクトを取得します。
get_desktop()
デスクトップオブジェクトを取得します。
get_desktop()
入力パラメータ
なし
戻り値
Win32Window:取得したデスクトップオブジェクトを返します。
例1
from xbot import win32
def main(args):
wnd = win32.get_desktop()
この例の実行ロジック: パソコンのデスクトップオブジェクトを取得します。
minimize_all()
すべてのウィンドウを最小化します。
minimize_all()
入力パラメータ
なし
戻り値
なし
例1
from xbot import win32
def main(args):
win32.minimize_all()
この例の実行ロジック: タスクバーにあるすべてのウィンドウを最小化します。
mouse_move()
指定位置にマウスカーソルを移動します。
mouse_move(point_x, point_y, relative_to='screen', move_speed='instant', delay_after=1)
入力パラメータ
point_x:指定する座標の横座標です。整数で指定します。
point_y:指定する座標の縦座標です。整数で指定します。
relative_to:指定座標への移動の基準となる位置を指定します。デフォルトではデスクトップを基準に移動します。基準の指定方法は次の3種類です。
- 'screen':デスクトップを基準にします。
- 'window':現在開いている(アクティブな)ウィンドウを基準にします。
- 'position':現在のデータがある位置を基準にします。
move_speed:指定座標にマウスカーソルを移動する速度です。デフォルトでは目標座標に瞬間移動します。次の4種類の速度を選択できます。
- 'instant':瞬間
- 'fast':高速
- 'middle':中速
- 'slow':低速
delay_after:実行成功後の待機時間です。デフォルトでは1s待機します。
戻り値
なし
例1
from xbot import win32
def main(args):
win32.mouse_move(100, 100, 'screen', 'slow', 1)
この例の実行ロジック:画面を基準とする座標位置 x=100,y=100 にマウスカーソルを低速で移動し、実行完了後に 1s 待機します。
send_keys()
キーボード入力をシミュレートして、指定したキーボードのキーを入力します。ショートカットキーも含めることができます。
send_keys(keys='', send_key_delay, hardware_driver_input, delay_after)
入力パラメータ
keys:入力をシミュレートするキーボードのキーです。
send_key_delay:2回のキー入力の間の時間間隔です。デフォルトは50ms(ミリ秒)です。
hardware_driver_input:ハードウェアドライバーを使用して入力するかどうかを指定します。デフォルトはFalseです。
delay_after:実行成功後の待機時間です。デフォルトでは1s待機します。
戻り値
なし
例1
from xbot import win32
def main(args):
win32.send_keys(keys='hello world {enter}',send_key_delay=50,delay_after=1)
この例の実行ロジック:キーボード入力をシミュレートして hello world を入力し、Enterキーを押します。入力間隔は50msで、キーボードドライバーによる入力は使用せず、実行完了後に 1s 待機します。
例2
from xbot import win32
def main(args):
win32.send_keys(keys='hello world {enter}',send_key_delay=50, hardware_driver_input=True,delay_after=1)
この例の実行ロジック: キーボード入力をシミュレートして hello world を入力し、Enterキーを押します。入力間隔は50msで、キーボードドライバーによる入力を使用し、実行完了後に 1s 待機します。
mouse_click()
マウスの左ボタンのシングルクリックやダブルクリックなど、マウスの操作をシミュレートします。
mouse_click(button='left', click_type='click', keys='none', delay_after=1)
入力パラメータ
button:クリックするマウスのボタンです。'left' または 'right' を渡すことができます。デフォルトは 'left'(マウスの左ボタン)です。
click_type:マウスボタンのクリック方法です。'click'(マウスのシングルクリック)、'dbclick'(マウスのダブルクリック)、'down'(マウスボタンの押下)、'up'(マウスボタンを離す)の4種類があります。デフォルトはシングルクリックです。
keys:マウスクリック時の修飾キー入力です。使用できる修飾キーは、none、alt、ctrl、shift および win です。デフォルトは空です。
delay_after:実行成功後の待機時間です。デフォルトでは 1s 待機します。
戻り値
なし
例1
from xbot import win32
def main(args):
win32.mouse_click('left', 'dbclick', 'alt', 1)
この例の実行ロジック: キーボードの Alt キーを押してから、マウスの左ボタンをダブルクリックします。
mouse_wheel()
マウスホイールのスクロールをシミュレートします。デフォルトでは下方向にスクロールします。
mouse_wheel(wheel_direction='down', wheel_times, keys='none', delay_after=1)
パラメータ
wheel_direction:マウスホイールの回転方向です。'up' と 'down' を選択できます。デフォルトでは下方向にスクロールします。
wheel_times:マウスホイールをスクロールする回数です。デフォルトでは1回スクロールします。
keys:マウスクリック時の修飾キー入力です。使用できる修飾キーは、none、alt、ctrl、shift および win です。デフォルトは空です。
delay_after:実行成功後の待機時間です。デフォルトでは 1s 待機します。
戻り値
なし
例1
from xbot import win32
def main(args):
win32.mouse_wheel('down', 3, 'alt', 1)
この例の実行ロジック: キーボードの Alt キーを押したまま、マウスホイールを下方向に 3 回スクロールし、実行成功後に 1s 待機します。
get_mouse_position()
デスクトップまたは現在選択されている(アクティブな)ウィンドウを基準とするマウスカーソルの座標位置を取得します。
get_mouse_position(relative_to='screen')
パラメータ
relative_to:マウスカーソルの位置の基準となるオブジェクトです。'screen'(画面の左上を基準とする位置)と 'currentactivatedwindow'(現在選択されている(アクティブな)ウィンドウを基準とする位置)を選択できます。デフォルトは画面全体です。
戻り値
tuple:一組の座標値をタプル型で返します。
例1
from xbot import win32
def main(args):
position = win32.get_mouse_position('screen')
print(position)
この例の実行ロジック: 画面の左上を基準とするマウスカーソルの座標を取得します --> 取得した座標を出力します。
exists()
ウィンドウが存在するかどうかを判定します。
exists(window)
パラメータ
window:Win32Windowオブジェクトです。
戻り値
bool:ウィンドウが存在するかどうかを返します。存在する場合はTrue、それ以外の場合はFalseを返します。
例1
import xbot
def main(args):
wnd = xbot.win32.get('新建文本')
is_exists = xbot.win32.exists(wnd)
print(is_exists)
この例の実行ロジック: タイトルが 新建文本 のウィンドウオブジェクトを取得し、ウィンドウが存在するかどうかを判定します --> 存在するかどうかの結果を出力します。
manual_motion_on()
ランダム操作モードを開始し、複数のコマンド(開始から終了までの区間内のコマンド)を、人の操作習慣をシミュレートしてまとめて実行します。
manual_motion_on(motion_move, motion_click)
パラメータ
motion_move:人の操作をシミュレートし、ランダムな経路と速度でマウスカーソルを移動します。デフォルトは True です。
motion_click:人の操作をシミュレートし、要素内のランダムな位置をクリックします。デフォルトは True です。
戻り値
なし
例1
import xbot
def main(args):
xbot.win32.manual_motion_on(True,True)
win = xbot.win32.get_active()
win.find('test').click()
xbot.win32.manual_motion_off() # このコマンドはmanual_motion_on と組み合わせて使用する必要があります
この例の実行ロジック: ランダム操作モードを開始します --> 現在アクティブなウィンドウオブジェクトを取得します --> 現在のウィンドウ内で 'test' という名前のソフトウェア要素を見つけてクリックします --> ランダム操作モードを終了します。
manual_motion_off
ランダム操作モードを終了します。
manual_motion_off()
パラメータ
なし
戻り値
なし
例
import xbot
def main(args):
xbot.win32.manual_motion_on(True,True)
win = xbot.win32.get_active()
win.find('test').click()
xbot.win32.manual_motion_off()
この例の実行ロジック: ランダム操作モードを開始します --> 現在アクティブなウィンドウオブジェクトを取得します --> 現在のウィンドウ内で 'test' という名前のソフトウェア要素を見つけてクリックします --> ランダム操作モードを終了します。