【Python】クリップボードを操作（テキストのコピー、貼り付け）する方法：pyperclip

pyperclipモジュールとは

pyperclipモジュールはパソコンのクリップボードとテキストのやり取りを行えるモジュールです。つまりクリップボードに文字列をコピーしたり、クリップボードの文字列を取得することができるということです。

Pythonでクリップボードが操作できることによって、メールやWord、Excelなどのドキュメントに貼り付けることが簡単にできます。

本記事では現時点（2022年1月）で最新のバージョン1.8.2を使用しています。

pyperclipのインストール

pyperclipはPythonには標準で備わっていません。そのため次のようにpipコマンドでインストールしてください。

pip install pyperclip

pyperclipのインポート

pyperclipモジュールを使用するには、まずpyperclipをインポートする必要があります。

>>> import pyperclip

クリップボードへのコピー：copy()

クリップボードに文字列をコピーするにはpyperclip.copy()メソッドを使用します。

copy()メソッドを使用することで、一つずつクリップボードに文字列をコピーできます。

>>> import pyperclip
>>> pyperclip.copy('Hello world')

クリップボードの文字列を貼り付け（取得）：paste()

クリップボードの文字列を貼り付ける（取得）にはpyperclip.paste()メソッドを使用します。

>>> import pyperclip
>>> pyperclip.copy('Hello world')
>>> pyperclip.paste()
'Hello world'

ここで注意が必要なのがpaste()メソッドの返り値は、クリップボードにコピーされた最新の文字列です。Windowsの「クリップボードの履歴」機能のように過去にコピーされた文字列は取得できません。Windowsの「クリップボードの履歴」機能については以下記事をご参照ください。

【Windows10】進化したクリップボード！コピー履歴を一覧表示して貼り付ける方法

またpaste()メソッドで返されるのはすべて文字列str型です。copy()メソッドで整数int型をコピーしたとしても、paste()メソッドで返されるのは文字列str型です。

>>> import pyperclip
>>> pyperclip.copy(54)
>>> type(pyperclip.paste())
str

paste()メソッドで整数int型を返すようにするにはint()またはfloat()を使用しましょう。

>>> import pyperclip
>>> pyperclip.copy(54)
>>> type(int(pyperclip.paste()))
int

クリップボードへのコピーを監視：waitForNewPaste()

クリップボードへのコピーを監視するにはpyperclip.waitForNewPaste()メソッドを使用します。waitForNewPaste()メソッドを実行するとプログラムは待機状態となり、新しい文字列がコピーされるとコピーされた文字列が返されます。

waitForNewPaste()メソッドの引数に待機時間（秒数）を指定できます。待機時間を過ぎた場合、次のように例外が発生します。

>>> pyperclip.waitForNewPaste(2)
PyperclipTimeoutException: waitForNewPaste() timed out after 2 seconds.

waitForNewPaste()で待機時間を設定する場合は、例外が発生することも考慮して例外処理を行うようにしましょう。

import pyperclip

try:
    pyperclip.waitForNewPaste(2)
except Exception as e:
    print(e)

【Python】エラー発生時にプログラムを止めないで続ける方法：例外処理（try、except）