Posted at

Python help(pyautogui)

More than 1 year has passed since last update.

僕は英語がわからないのでGoogle先生に翻訳してもらいました。


>>> help(pyautogui)


help(pyautogui)

Help on package pyautogui:

NAME
pyautogui - IMPORTANT NOTE!

DESCRIPTION
Mac OS Xでこのモジュールを使用するには、PyObjCモジュールがインストールされている必要があります。
For Python 3, run:
sudo pip3 install pyobjc-core
sudo pip3 install pyobjc
For Python 2, run:
sudo pip install pyobjc-core
sudo pip install pyobjc
(インストーラにはいくつかのバグがあります。最初にpyobjc-coreをインストールしてください。
そうしないと、インストールには永遠の時間がかかります。)

Linuxでこのモジュールを使用するには、Xlibモジュールがインストールされている必要があります。
For Python 3, run:
sudo pip3 install python3-Xlib
For Python 2, run:
sudo pip install Xlib

Windowsでこのモジュールを使用するには、他に何も必要ありません。

スクリーンショット機能を使用するにはPIL / Pillowが必要です。

PACKAGE CONTENTS
__main__
_pyautogui_java
_pyautogui_osx
_pyautogui_win
_pyautogui_x11
_window_win
screenshotUtil
tweens

SUBMODULES
platformModule

CLASSES
builtins.Exception(builtins.BaseException)
FailSafeException

class FailSafeException(builtins.Exception)
| すべての非終了例外の共通基本クラス。
|
| メソッドの解決順序:
| FailSafeException
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| ここで定義されたデータ記述子:
|
| __weakref__
| オブジェクトへの弱い参照のリスト(定義されている場合)
|
| ----------------------------------------------------------------------
| builtins.Exceptionから継承されたメソッド:
|
| __init__(self, /, *args, **kwargs)
| 自己を初期化する。正確な署名については、help(type(self))を参照してください。
|
| __new__(*args, **kwargs) from builtins.type
| 新しいオブジェクトを作成して返します。
| 正確な署名については、help(type)を参照してください。
|
| ----------------------------------------------------------------------
| builtins.BaseExceptionから継承されたメソッド:
|
| __delattr__(self, name, /)
| Implement delattr(self, name).
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| helper for pickle
|
| __repr__(self, /)
| Return repr(self).
|
| __setattr__(self, name, value, /)
| Implement setattr(self, name, value).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| builtins.BaseExceptionから継承したデータ記述子:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args

FUNCTIONS
click(x=None, y=None, clicks=1, interval=0.0, button='left', duration=0.0, tween=<function linear at 0xb553902c>, pause=None, _pause=True)
マウスボタンを押し下げてすぐに解除します。

xおよびyパラメータは、マウスイベントの発生場所を示します。Noneの場合、現在のマウス位置が使用されます。
float値の場合、切り捨てられます。画面の境界の外にある場合、イベントは画面の端で発生します。

Args:
x (int, float, None, tuple, optional): クリックが発生する画面上のx位置。デフォルトではありません。タプルの場合、これはxとyに使用されます。
y (int, float, None, optional): クリックが発生する画面上のy位置。デフォルトではありません。
clicks (int, optional): 実行するクリック数。デフォルトでは1です。たとえば、2を渡すとダブルクリックが行われます。
interval (float, optional): クリック数が1より大きい場合の各クリック間の秒数。デフォルトは0.0で、クリック間では一時停止しません。
button (str, int, optional): マウスボタンがクリックされました。 '左'、 '中'、 '右'(または1,2、または3)のいずれかでなければなりません。デフォルトでは 'left'です。

Returns:
None

Raises:
ValueError: ボタンが 'left'、 'middle'、 'right'、1,2,3のいずれでもない場合

displayMousePosition(xOffset=0, yOffset=0)
この関数は、コマンドラインから実行するためのものです。マウスカーソルの位置とRGBが自動的に表示されます。

doubleClick(x=None, y=None, interval=0.0, button='left', duration=0.0, tween=<function linear at 0xb553902c>, pause=None, _pause=True)
ダブルクリックを実行します。

これはclick( 'left'、x、y、2、interval)のラッパー関数です。

xおよびyパラメータは、マウスイベントの発生場所を示します。 Noneの場合、現在のマウス位置が使用されます。 float値の場合、切り捨てられます。画面の境界の外にある場合、イベントは画面の端で発生します。

Args:
x (int, float, None, tuple, optional): クリックが発生する画面上のx位置。デフォルトではありません。タプルの場合、これはxとyに使用されます。
y (int, float, None, optional): クリックが発生する画面上のy位置。デフォルトではありません。
interval (float, optional): クリック数が1より大きい場合の各クリック間の秒数。デフォルトは0.0で、クリック間では一時停止しません。
button (str, int, optional): マウスボタンがクリックされました。 '左'、 '中'、 '右'(または1,2、または3)のいずれかでなければなりません。デフォルトでは 'left'です。

Returns:
None

Raises:
ValueError: ボタンが 'left'、 'middle'、 'right'、1,2,3,4,5,6、または7のいずれかでない場合

dragRel(xOffset=0, yOffset=0, duration=0.0, tween=<function linear at 0xb553902c>, button='left', pause=None, _pause=True, mouseDownUp=True)
マウスのドラッグ(ボタンを押したままマウスを動かす)を、現在の位置を基準にして画面上の点に移動します。

xおよびyパラメータは、マウスイベントの発生場所を示します。 Noneの場合、現在のマウス位置が使用されます。 float値の場合、切り捨てられます。画面の境界の外にある場合、イベントは画面の端で発生します。

Args:
x (int, float, None, tuple, optional): カーソルを移動する距離(負の値の場合)または右(正の値の場合)。デフォルトでは0です。タプルの場合、これはxOffsetとyOffsetに使用されます。
y (int, float, None, optional): カーソルを移動する距離(負の値の場合)または下(正の値の場合)。デフォルトでは0です。
duration (float, optional): マウスカーソルを新しいxy座標に移動するのにかかる時間。 0の場合は、マウスカーソルが瞬時に移動します。デフォルトでは0.0です。
tween (func, optional): 持続時間が0でない場合に使用されるトゥイーン関数。デフォルトではリニアトゥイーンが使用されます。詳細については、tweens.pyファイルを参照してください。
button (str, int, optional): マウスボタンがクリックされました。 '左'、 '中'、 '右'(または1,2、または3)のいずれかでなければなりません。デフォルトでは 'left'です。
mouseDownUp (True, False): trueの場合、mouseUp / Downアクションは実行されません。複数の(小さな)アクションをドラッグすることができます。デフォルトでは 'True'です。

Returns:
None

dragTo(x=None, y=None, duration=0.0, tween=<function linear at 0xb553902c>, button='left', pause=None, _pause=True, mouseDownUp=True)
画面上のポイントまでマウスドラッグ(ボタンを押したままマウスを移動)を実行します。

xおよびyパラメータは、マウスイベントの発生場所を示します。 Noneの場合、現在のマウス位置が使用されます。 float値の場合、切り捨てられます。画面の境界の外にある場合、イベントは画面の端で発生します。

Args:
x (int, float, None, tuple, optional): カーソルを移動する距離(負の値の場合)または右(正の値の場合)。デフォルトでは0です。タプルの場合、これはxとyに使用されます。
y (int, float, None, optional): カーソルを移動する距離(負の値の場合)または下(正の値の場合)。デフォルトでは0です。
duration (float, optional): マウスカーソルを新しいxy座標に移動するのにかかる時間。 0の場合は、マウスカーソルが瞬時に移動します。デフォルトでは0.0です。
tween (func, optional): 持続時間が0でない場合に使用されるトゥイーン関数。デフォルトではリニアトゥイーンが使用されます。詳細については、tweens.pyファイルを参照してください。
button (str, int, optional): マウスボタンがクリックされました。 '左'、 '中'、 '右'(または1,2、または3)のいずれかでなければなりません。デフォルトでは 'left'です。
mouseDownUp (True, False): trueの場合、mouseUp / Downアクションは実行されません。複数の(小さな)アクションをドラッグすることができます。デフォルトでは 'True'です。

Returns:
None

getPointOnLine(x1, y1, x2, y2, n)
2つのx、y座標で定義された線に沿って割合nを進んだ点の(x、y)タプルを返します。

pytweeningモジュールからコピーされました。

hotkey(*args, **kwargs)
指定した順序で渡された引数をキーダウンしてから、逆の順序でキーの解放を実行します。

ホットキー( 'ctrl'、 'shift'、 'c')を呼び出すと、 "Ctrl-Shift-C"ホットキー/キーボードショートカットが実行されます。

Args:
key(s) (str): 一連のキーを順番に押す。これは、キーストリングのリストでもあります。
interval (float, optional): 各プレスの間の秒数。プレス間で一時停止しないように、デフォルトでは0.0です。

Returns:
None

hscroll(clicks, x=None, y=None, pause=None, _pause=True)
オペレーティングシステムによってサポートされている場合、マウススクロールホイールの明示的な水平スクロールを実行します。 (現在のところLinuxのみ)

xおよびyパラメータは、マウスイベントの発生場所を示します。 Noneの場合、現在のマウス位置が使用されます。 float値の場合、切り捨てられます。画面の境界の外にある場合、イベントは画面の端で発生します。

Args:
clicks (int, float): 実行するスクロールの量。
x (int, float, None, tuple, optional): クリックが発生する画面上のx位置。デフォルトではありません。タプルの場合、これはxとyに使用されます。
y (int, float, None, optional): クリックが発生する画面上のy位置。デフォルトではありません。

Returns:
None

isShiftCharacter(character)
キー文字が大文字であっても、シフトの場合は真を返す。

isValidKey(key)
指定されたキーが現在のプラットフォームのPyAutoGUIのキーボード関連関数に渡す有効な値である場合はブール値を返します。

PyAutoGUIキーボード関数に無効な値を渡すことは、現在例外を発生させないノーオペレーションなので、この関数はここにあります。

一部のキーは、一部のプラットフォームでのみ有効です。たとえば、 'esc'はすべてのプラットフォームでエスケープキーに有効ですが、 'browserback'はWindowsオペレーティングシステムでのみ使用されます。

Args:
key (str): キー値。

Returns:
bool: keyが有効な値の場合はtrue、そうでない場合はfalse。

keyDown(key, pause=None, _pause=True)
リリースなしでキーボード・キー・プレスを実行します。これにより、そのキーが押された状態になります。

注意: 何らかの理由で、キーボードキーがテキストフィールドに押されているようなキーリピートが発生しないように見えます。

Args:
key (str): 押されるべきキー。有効な名前はKEYBOARD_KEYSにリストされています。

Returns:
None

keyUp(key, pause=None, _pause=True)
キーボード・キー・リリースを行います(あらかじめ押さないでください)。

Args:
key(文字列):解放されるべきキー。有効な名前はKEYBOARD_KEYSにリストされています。

Returns:
None

linear(n)
トリビアルリニアトゥイーン機能

pytweeningモジュールからコピーされました。

middleClick(x=None, y=None, duration=0.0, tween=<function linear at 0xb553902c>, pause=None, _pause=True)
マウスの中央ボタンをクリックします。

これはclick( 'right'、x、y)のラッパー関数です。

xおよびyパラメータは、マウスイベントの発生場所を示します。 Noneの場合、現在のマウス位置が使用されます。 float値の場合、切り捨てられます。画面の境界の外にある場合、イベントは画面の端で発生します。

Args:
x (int, float, None, tuple, optional): クリックが発生する画面上のx位置。デフォルトではありません。タプルの場合、これはxとyに使用されます。
y (int, float, None, optional): クリックが発生する画面上のy位置。デフォルトではありません。

Returns:
None

mouseDown(x=None, y=None, button='left', duration=0.0, tween=<function linear at 0xb553902c>, pause=None, _pause=True)
マウスボタンを押し下げる(ただし上には移動しない)。

xおよびyパラメータは、マウスイベントの発生場所を示します。 Noneの場合、現在のマウス位置が使用されます。 float値の場合、切り捨てられます。画面の境界の外にある場合、イベントは画面の端で発生します。

Args:
x (int, float, None, tuple, optional): マウスが押された位置のx位置。デフォルトではありません。タプルの場合、これはxとyに使用されます。
y (int, float, None, optional): マウスが押された画面上のy位置。デフォルトではありません。
button (str, int, optional): マウスボタンが押された。 '左'、 '中'、 '右'(または1,2、または3)のいずれかでなければなりません。デフォルトでは 'left'です。

Returns:
None

Raises:
ValueError: ボタンが 'left'、 'middle'、 'right'、1,2,3のいずれでもない場合

mouseUp(x=None, y=None, button='left', duration=0.0, tween=<function linear at 0xb553902c>, pause=None, _pause=True)
マウスボタンを離します(ただし、あらかじめ下ろさないでください)。

xおよびyパラメータは、マウスイベントの発生場所を示します。 Noneの場合、現在のマウス位置が使用されます。 float値の場合、切り捨てられます。画面の境界の外にある場合、イベントは画面の端で発生します。

Args:
x (int, float, None, tuple, optional): マウスが上がっている画面上のx位置。デフォルトではありません。タプルの場合、これはxとyに使用されます。
y (int, float, None, optional): 画面上でマウスが上がっている位置のyの位置。デフォルトではありません。
button (str, int, optional): マウスボタンがリリースされました。 '左'、 '中'、 '右'(または1,2、または3)のいずれかでなければなりません。デフォルトでは 'left'です。

Returns:
None

Raises:
ValueError: ボタンが 'left'、 'middle'、 'right'、1,2,3のいずれでもない場合

moveRel(xOffset=None, yOffset=None, duration=0.0, tween=<function linear at 0xb553902c>, pause=None, _pause=True)
マウスカーソルを画面上の現在の位置に対する相対位置に移動します。

xおよびyパラメータは、マウスイベントの発生場所を示します。 Noneの場合、現在のマウス位置が使用されます。 float値の場合、切り捨てられます。画面の境界の外にある場合、イベントは画面の端で発生します。

Args:
x (int, float, None, tuple, optional): カーソルを移動する距離(負の値の場合)または右(正の値の場合)。デフォルトでは0です。タプルの場合、これはxとyに使用されます。
y (int, float, None, optional): カーソルを移動する距離(負の値の場合)または下(正の値の場合)。デフォルトでは0です。
duration (float, optional): マウスカーソルを新しいxy座標に移動するのにかかる時間。 0の場合は、マウスカーソルが瞬時に移動します。デフォルトでは0.0です。
tween (func, optional): 持続時間が0でない場合に使用されるトゥイーン関数。デフォルトではリニアトゥイーンが使用されます。詳細については、tweens.pyファイルを参照してください。

Returns:
None

moveTo(x=None, y=None, duration=0.0, tween=<function linear at 0xb553902c>, pause=None, _pause=True)
マウスカーソルを画面上のあるポイントに移動します。

xおよびyパラメータは、マウスイベントの発生場所を示します。 Noneの場合、現在のマウス位置が使用されます。 float値の場合、切り捨てられます。画面の境界の外にある場合、イベントは画面の端で発生します。

Args:
x (int, float, None, tuple, optional): クリックが発生する画面上のx位置。デフォルトではありません。タプルの場合、これはxとyに使用されます。
y (int, float, None, optional): クリックが発生する画面上のy位置。デフォルトではありません。
duration (float, optional): マウスカーソルをxy座標に移動するのにかかる時間。 0の場合は、マウスカーソルが瞬時に移動します。デフォルトでは0.0です。
tween (func, optional): 持続時間が0でない場合に使用されるトゥイーン関数。デフォルトではリニアトゥイーンが使用されます。詳細については、tweens.pyファイルを参照してください。

Returns:
None

onScreen(x, y=None)
指定されたxy座標が画面上にあるかどうかを返します。

Args:
引数は2つの別々の値であり、最初の引数はxで、2番目の引数はyであるか、2つの値を持つシーケンスの1つの引数、最初のxと2番目のyがあります。例:onScreen(x、y)またはonScreen([x、y])

Returns:
bool: xy座標が現在の解像度で画面上にある場合はtrue、そうでない場合はFalseです。

position(x=None, y=None)
マウスカーソルの現在のxy座標を2整数のタプルとして返します。

Args:
x (int、None、optional) - Noneでない場合、この引数は戻り値のxをオーバーライドします。
y (int, None, optional) - Noneでない場合、この引数は戻り値のyをオーバーライドします。

Returns:
マウスカーソルの現在のxy座標の (x, y) タプル。

press(keys, presses=1, interval=0.0, pause=None, _pause=True)
キーボードキーを押し下げてからリリースします。

Args:
key (str, list): 押されるべきキー。有効な名前はKEYBOARD_KEYSにリストされています。このような文字列のリストにすることもできます。
presses (integer, optiional): 1回のプレスで、デフォルトでプレス繰り返し回数1
interval (float, optional): 各プレスの間の秒数。プレス間のポーズがないため、デフォルトでは0.0です。
pause (float, optional): 関数処理の最後で何秒になるか。機能プロセスの終了時に一時停止しないためのデフォルトはありません。
Returns:
None

rightClick(x=None, y=None, duration=0.0, tween=<function linear at 0xb553902c>, pause=None, _pause=True)
マウスの右ボタンをクリックします。

これはclick('right', x, y) のラッパー関数です。

xおよびyパラメータは、マウスイベントの発生場所を示します。 Noneの場合、現在のマウス位置が使用されます。 float値の場合、切り捨てられます。画面の境界の外にある場合、イベントは画面の端で発生します。

Args:
x (int, float, None, tuple, optional): クリックが発生する画面上のx位置。デフォルトではありません。タプルの場合、これはxとyに使用されます。
y (int, float, None, optional): クリックが発生する画面上のy位置。デフォルトではありません。

Returns:
None

scroll(clicks, x=None, y=None, pause=None, _pause=True)
マウスのスクロールホイールのスクロールを実行します。

これが垂直スクロールであるか水平スクロールであるかは、基本となるオペレーティングシステムによって異なります。

xおよびyパラメータは、マウスイベントの発生場所を示します。 Noneの場合、現在のマウス位置が使用されます。 float値の場合、切り捨てられます。画面の境界の外にある場合、イベントは画面の端で発生します。

Args:
clicks (int, float): 実行するスクロールの量。
x (int, float, None, tuple, optional): クリックが発生する画面上のx位置。デフォルトではありません。タプルの場合、これはxとyに使用されます。
y (int, float, None, optional): クリックが発生する画面上のy位置。デフォルトではありません。

Returns:
None

size()
画面の幅と高さを2整数のタプルとして返します。

Returns:
画面サイズの (幅, 高さ) タプル(ピクセル単位)。

tripleClick(x=None, y=None, interval=0.0, button='left', duration=0.0, tween=<function linear at 0xb553902c>, pause=None, _pause=True)
トリプルクリックを行います..

これはclick('left', x, y, 3, interval) のラッパー関数です。

xおよびyパラメータは、マウスイベントの発生場所を示します。 Noneの場合、現在のマウス位置が使用されます。 float値の場合、切り捨てられます。画面の境界の外にある場合、イベントは画面の端で発生します。

Args:
x (int, float, None, tuple, optional): クリックが発生する画面上のx位置。デフォルトではありません。タプルの場合、これはxとyに使用されます。
y (int, float, None, optional): クリックが発生する画面上のy位置。デフォルトではありません。
interval (float, optional): クリック数が1より大きい場合の各クリック間の秒数。デフォルトは0.0で、クリック間では一時停止しません。
button (str, int, optional): マウスボタンがクリックされました。 '左'、 '中'、 '右'(または1,2、または3)のいずれかでなければなりません。デフォルトでは 'left'です。

Returns:
None

Raises:
ValueError: ボタンが 'left'、 'middle'、 'right'、1,2,3,4,5,6、または7のいずれかでない場合

typewrite(message, interval=0.0, pause=None, _pause=True)
メッセージ内の各文字に対して、キーボードキーを押し下げてからリリースを実行します。

メッセージ引数は文字列のリストでもよく、この場合、有効なキーボード名を使用できます。

これは一連のキーボード・プレスを実行し、キーを押さないため、キーボード・ショートカットを実行するために使用することはできません。これにはhotkey()関数を使います。

Args:
message (str, list): 文字列の場合、押される文字。リストの場合は、キーのキー名を順番に押します。有効な名前はKEYBOARD_KEYSにリストされています。
interval (float, optional): 各プレスの間の秒数。プレス間で一時停止しないように、デフォルトでは0.0です。

Returns:
None

vscroll(clicks, x=None, y=None, pause=None, _pause=True)
マウスのスクロールホイールがオペレーティングシステムでサポートされている場合は、明示的に垂直スクロールを実行します。 (現在のところLinuxのみ)

xおよびyパラメータは、マウスイベントの発生場所を示します。 Noneの場合、現在のマウス位置が使用されます。 float値の場合、切り捨てられます。画面の境界の外にある場合、イベントは画面の端で発生します。

Args:
clicks (int, float): 実行するスクロールの量。
x (int, float, None, tuple, optional): クリックが発生する画面上のx位置。デフォルトではありません。タプルの場合、これはxとyに使用されます。
y (int, float, None, optional): クリックが発生する画面上のy位置。デフォルトではありません。

Returns:
None

DATA
FAILSAFE = True
KEYBOARD_KEYS = ['\t', '\n', '\r', ' ', '!', '"', '#', '$', '%', '&', ...
KEY_NAMES = ['\t', '\n', '\r', ' ', '!', '"', '#', '$', '%', '&', "'",...
MINIMUM_DURATION = 0.1
MINIMUM_SLEEP = 0.05
PAUSE = 0.1
absolute_import = _Feature((2, 5, 0, 'alpha', 1), (3, 0, 0, 'alpha', 0...
division = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192...
print_function = _Feature((2, 6, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0)...

VERSION
0.9.38

FILE
/home/hoge/.local/lib/python3.6/site-packages/pyautogui/__init__.py