英語がわからないのでGoogle先生に翻訳してもらいました。
>>> help(pyperclip)
help(pyperclip)
pyperclipパッケージに関するヘルプ:
NAME
pyperclip - Pyperclip
DESCRIPTION
プレーンテキストのコピー&ペースト機能を持つ、Python用のクロスプラットフォームのクリップボードモジュールです。
By Al Sweigart al@inventwithpython.com
BSD License
使用法:
import pyperclip
pyperclip.copy('The text to be copied to the clipboard.')
spam = pyperclip.paste()
if not pyperclip.is_available():
print("Copy functionality unavailable!")
Windowsでは、追加のモジュールは必要ありません。
Macでは、pyobjcモジュールが使用され、pbcopyおよびpbpaste cliコマンドに戻ります。 (これらのコマンドはOS Xに付属する必要があります)
Linuxでは、パッケージマネージャーを使用してxclipまたはxselをインストールします。たとえば、Debianでは:
sudo apt-get install xclip
sudo apt-get install xsel
それ以外の場合、LinuxではgtkまたはPyQt5 / PyQt4モジュールがインストールされている必要があります。
gtkとPyQt4モジュールはPython3では利用できませんが、
このモジュールはまだPyGObjectでは動作しません。
注意: Python3でgtkを入手する方法があるようです。
https://askubuntu.com/questions/697397/python3-is-not-supporting-gtk-module
Cygwinは現在サポートされていません。
セキュリティ上の注意: このモジュールは、これらの名前を持つプログラムを実行します。:
- which
- where
- pbcopy
- pbpaste
- xclip
- xsel
- klipper
- qdbus
悪意のあるユーザーは、これらの名前のプログラムの名前を変更したり追加したりすることができます。Pyperclipは、Pythonプロセスの権限によって実行されます。
PACKAGE CONTENTS
__main__
FUNCTIONS
copy = lazy_load_stub_copy(text)
実際のcopy()関数が後の呼び出しで使用されるように呼び出されたときに、実際のcopy()関数をロードするcopy()のスタブ関数。
これにより、ユーザーはdetermin_clipboard()を持たずにpyperclipをインポートできます。
自動的に実行され、自動的にクリップボード機構が選択されます。
これは、メモリ重いPyQt4モジュールを選択すると問題になる可能性があります
ユーザーはすぐにset_clipboard()を呼び出して
異なるクリップボードメカニズム。
このスタブ関数が実装する遅延読み込みは、ユーザーに
set_clipboard()を呼び出して、別のクリップボードメカニズムを選択します。あるいは、ユーザ
最初にset_clipboard()を呼び出さずに単にcopy()またはpaste()を呼び出すだけで、
decide_clipboard()が呼び出すクリップボードのどの機構でも、
自動的に選択されます。
determine_clipboard()
OS /プラットフォームを特定し、それに応じてcopy()とpaste()関数を設定します。
paste = lazy_load_stub_paste()
実際のpaste()関数が後の呼び出しで使用されるように呼び出されたときに実際のpaste()関数をロードするpaste()のスタブ関数。
これにより、ユーザーは自動的にdetermin_clipboard()を実行することなくpyperclipをインポートできます。自動的にクリップボードのメカニズムが選択されます。これは、メモリ重いPyQt4モジュールを選択すると問題になる可能性がありますが、ユーザはただちにset_clipboard()を呼び出して、別のクリップボードメカニズムを使用することになりました。
このスタブ関数が実装する遅延読み込みは、set_clipboard()を呼び出して別のクリップボードメカニズムを選択する機会をユーザに与えます。または、set_clipboard()を最初に呼び出さずに単にcopy()またはpaste()を呼び出すだけであれば、自動的にchoose_clipboard()が選択するクリップボードメカニズムを使用します。
set_clipboard(clipboard)
明示的にクリップボードのメカニズムを設定します。 「クリップボードメカニズム」は、copy()関数とpaste()関数がコピー/ペースト機能を実装するためにオペレーティングシステムとどのように対話するかを示します。 clipboardパラメータは次のいずれかでなければなりません。
- pbcopy
- pbobjc (Mac OS Xのデフォルト)
- gtk
- qt
- xclip
- xsel
- klipper
- windows (Windowsではデフォルト)
- no (これは、クリップボード機構が見つからないときに設定されるものです)
DATA
__all__ = ['copy', 'paste', 'set_clipboard', 'determine_clipboard']
VERSION
1.7.0
FILE
/home/hoge/.local/lib/python3.6/site-packages/pyperclip/__init__.py