Pythonのpyperclipモジュールでクリップボードへのコピー＆ペーストを簡単に実現する方法

はじめに

本記事では、pyperclipモジュールを使用して、クリップボードへのコピーとペーストを行う方法を解説します。pyperclipはクロスプラットフォーム対応のライブラリで、Python 2とPython 3の両方で動作します。

クリップボード経由でのコピー＆ペーストは、プログラムの出力結果を別のファイルやソフトウェアに貼り付けたい場合など、さまざまな場面で非常に役立ちます。

セットアップ方法

pyperclipモジュールはPythonに標準で同梱されていないため、利用するには事前にインストールが必要です。インストールにはPIPパッケージマネージャーを使用します。

ターミナル（コマンドプロンプト）を起動し、以下のコマンドを実行してください。

pip install pyperclip

インストールが完了したら、Pythonスクリプト内でモジュールをインポートします。

import pyperclip

テキストをクリップボードにコピーする

テキストをクリップボードにコピーするには、pyperclip.copy()関数を使用します。

import pyperclip
pyperclip.copy("Hello world!")

上記のコードを実行すると、「Hello world!」という文字列がクリップボードにコピーされ、すぐに貼り付けられる状態になります。

クリップボードからテキストを貼り付ける

サンプルコード

import pyperclip
text = pyperclip.paste()
print(text)

実行結果

Hello world!

クリップボードに格納されている最新の内容を取得するには、pyperclip.paste()関数を使用します。

新しい内容のコピーを検知して貼り付ける

プロジェクトによっては、あるメッセージをコピーした後、別の新しいメッセージがコピーされるのを待ってから貼り付けたいケースがあります。

そのような場合は、pyperclip.waitForNewPaste()関数を使用します。

サンプルコード

import pyperclip
pyperclip.copy("Hello world!")
text = pyperclip.paste()
print(text)
pyperclip.copy('Hello world!')
text = pyperclip.waitForNewPaste()
print(text)

実行結果

Hello world! Random message copied

注意： 上記の例では、プログラムは新しくコピーされたテキストを出力した後に終了します。waitForNewPaste()が検知できるのは、既存の内容と異なる新しいテキストのみです。つまり、新しくコピーする内容は「Hello world!」以外である必要があります。

もしクリップボードの内容が以前と同じであっても貼り付け処理を実行したい場合は、代わりにpyperclip.waitForPaste()関数を使用してください。

また、クリップボードに保存され、貼り付けられるデータは常に文字列型（String）である点にも留意してください。

まとめ

本記事では、pyperclipモジュールを使って、テキスト（文字列）をクリップボードにコピーしたり、クリップボードから貼り付けたりする方法を学びました。

この機能を活用すれば、データを頻繁にコピー＆ペーストして表を作成するような作業を自動化する、シンプルなツールを開発することもできます。

pyperclipにはほかにもさまざまな活用シーンがあり、クロスプラットフォーム対応のため、Linux、macOS、Windowsのいずれの環境でも同じように使用できます。