3
���h2T � @ sj d Z dZddlZddlZddlmZmZmZmZmZ ddl Z ddl
Z
ddl Z ddl Z ddl
Z
e jdd�ZdZdZe
j� d kr�d
Znd Zd d
� ZG dd� de�ZG dd� de�Zed�dd�Zdd� Zdd� Zdd� Z dd � Z d d � Z d d � Z d!d"� Z d#d$� Z!G d%d&� d&�Z"d'd(� Z#d)d*� Z$d+d,� Z%d-d.� Z&d/d0� Z'd1d2� Z(e)d�d3d4�Z*e'e( a+a,d5d6d.d,gZ-t,Z.t+Z/dS )7ae
Pyperclip
A cross-platform clipboard module for Python,
with copy & paste functions for plain text.
By Al Sweigart al@inventwithpython.com
BSD License
Usage:
import pyperclip
pyperclip.copy('The text to be copied to the clipboard.')
spam = pyperclip.paste()
if not pyperclip.is_available():
print("Copy functionality unavailable!")
On Windows, no additional modules are needed.
On Mac, the pyobjc module is used, falling back to the pbcopy and pbpaste cli
commands. (These commands should come with OS X.).
On Linux, install xclip or xsel via package manager. For example, in Debian:
sudo apt-get install xclip
sudo apt-get install xsel
Otherwise on Linux, you will need the PyQt5 modules installed.
This module does not work with PyGObject yet.
Cygwin is currently not supported.
Security Note: This module runs programs with these names:
- which
- where
- pbcopy
- pbpaste
- xclip
- xsel
- klipper
- qdbus
A malicious user could rename or add programs with these names, tricking
Pyperclip into running them with whatever permissions the Python process has.
z1.7.0� N)�c_size_t�c_wchar� c_wchar_p� get_errno�sizeofZDISPLAYFz�
Pyperclip could not find a copy/paste mechanism for your system.
For more information, please visit
https://pyperclip.readthedocs.io/en/latest/introduction.html#not-implemented-error
zutf-8�Windows�where�whichc C s t jt| gt jt jd�dkS )N)�stdout�stderrr )�
subprocess�call� WHICH_CMD�PIPE)�name� r �>/tmp/pip-build-5_djhm0z/pandas/pandas/io/clipboard/__init__.py�_executable_existsJ s r c @ s e Zd ZdS )�PyperclipExceptionN)�__name__�
__module__� __qualname__r r r r r T s r c s e Zd Z� fdd�Z� ZS )�PyperclipWindowsExceptionc s$ |dt j� � d�7 }t� j|� d S )Nz (�))�ctypesZWinError�super�__init__)�self�message)� __class__r r r Y s z"PyperclipWindowsException.__init__)r r r r �
__classcell__r r )r r r X s r )�returnc C s2 t tttf}t| |�s*tdt| �j� ���t | �S )NzJonly str, int, float, and bool values can be copied to the clipboard, not )�str�int�float�bool�
isinstancer �typer )�textZ
acceptedTypesr r r �_stringifyText^ s
r) c C s dd� } dd� }| |fS )Nc S s4 t | �} tjddgtjdd�}|j| jt�d� d S )N�pbcopy�wT)�stdin� close_fds)�input)r) r �Popenr � communicate�encode�ENCODING)r( �pr r r �copy_osx_pbcopyi s z2init_osx_pbcopy_clipboard.<locals>.copy_osx_pbcopyc S s, t jddgt jdd�} | j� \}}|jt�S )NZpbpaste�rT)r
r- )r r/ r r0 �decoder2 )r3 r
r r r r �paste_osx_pbcopyn s z3init_osx_pbcopy_clipboard.<locals>.paste_osx_pbcopyr )r4 r7 r r r �init_osx_pbcopy_clipboardh s r8 c C s dd� } dd� }| |fS )Nc S sP t | �} tjj| �j� }|jtj�}tjj � }|j
tj gd� |j |tj � dS )z!Copy string argument to clipboardN)
r) �
FoundationZNSStringZstringWithString_ZnsstringZdataUsingEncoding_ZNSUTF8StringEncoding�AppKit� NSPasteboard�generalPasteboardZdeclareTypes_owner_�NSStringPboardTypeZsetData_forType_)r( ZnewStrZnewData�boardr r r �copy_osx_pyobjcw s
z2init_osx_pyobjc_clipboard.<locals>.copy_osx_pyobjcc S s t jj� } | jt j�}|S )z Returns contents of clipboard)r: r; r< ZstringForType_r= )r> �contentr r r �paste_osx_pyobjc� s
z3init_osx_pyobjc_clipboard.<locals>.paste_osx_pyobjcr )r? rA r r r �init_osx_pyobjc_clipboardv s rB c s� yddl ma W nF tk
rV yddlma W n tk
rP ddlma Y nX Y nX tj� � � d krptg �� � fdd�} td�� fdd� }| |fS )Nr )� QApplicationc s t | �} � j� }|j| � d S )N)r) � clipboardZsetText)r( �cb)�appr r �copy_qt� s z"init_qt_clipboard.<locals>.copy_qt)r! c s � j � } t| j� �S )N)rD r" r( )rE )rF r r �paste_qt� s z#init_qt_clipboard.<locals>.paste_qt)Zqtpy.QtWidgetsrC � ImportErrorZPyQt5.QtWidgetsZ PyQt4.QtGui�instancer" )rG rH r )rF r �init_qt_clipboard� s rK c s0 d� d�d� �fdd� } d � �fdd� }| |fS )
N�cr3 Fc sB t | �} � }|r�}tjdd|gtjdd�}|j| jt�d� d S )N�xclipz
-selectionT)r, r- )r. )r) r r/ r r0 r1 r2 )r( �primary� selectionr3 )�DEFAULT_SELECTION�PRIMARY_SELECTIONr r �
copy_xclip� s z(init_xclip_clipboard.<locals>.copy_xclipc s@ � }| r �}t jdd|dgt jt jdd�}|j� \}}|jt�S )NrM z
-selectionz-oT)r
r r- )r r/ r r0 r6 r2 )rN rO r3 r
r )rP rQ r r � paste_xclip� s
z)init_xclip_clipboard.<locals>.paste_xclip)F)Fr )rR rS r )rP rQ r �init_xclip_clipboard� s
rT c s0 d� d�d� �fdd� } d � �fdd� }| |fS )
Nz-bz-pFc sB t | �} � }|r�}tjd|dgtjdd�}|j| jt�d� d S )N�xselz-iT)r, r- )r. )r) r r/ r r0 r1 r2 )r( rN �selection_flagr3 )rP rQ r r � copy_xsel� s z&init_xsel_clipboard.<locals>.copy_xselc s: � }| r �}t jd|dgt jdd�}|j� \}}|jt�S )NrU z-oT)r
r- )r r/ r r0 r6 r2 )rN rV r3 r
r )rP rQ r r �
paste_xsel� s z'init_xsel_clipboard.<locals>.paste_xsel)F)Fr )rW rX r )rP rQ r �init_xsel_clipboard� s
rY c C s dd� } dd� }| |fS )Nc S s: t | �} tjdddd| jt�gtjdd�}|jd d� d S )N�qdbuszorg.kde.klipperz/klipperZsetClipboardContentsT)r, r- )r. )r) r r/ r1 r2 r r0 )r( r3 r r r � copy_klipper� s
z,init_klipper_clipboard.<locals>.copy_klipperc S sh t jddddgt jdd�} | j� \}}|jt�}t|�dks@t�|jd�sNt�|jd�rd|d d
� }|S ) NrZ zorg.kde.klipperz/klipperZgetClipboardContentsT)r
r- r �
� ���) r r/ r r0 r6 r2 �len�AssertionError�endswith)r3 r
r ZclipboardContentsr r r �
paste_klipper� s
z-init_klipper_clipboard.<locals>.paste_klipperr )r[ rb r r r �init_klipper_clipboard� s rc c C s dd� } t d�dd�}| |fS )Nc S sP t | �} | dkrtjd� d| kr,tjd� tdd��}|j| � W d Q R X d S )N� z\Pyperclip cannot copy a blank string to the clipboard on Cygwin.This is effectively a no-op.�
z0Pyperclip cannot handle \r characters on Cygwin.z/dev/clipboard�wt)r) �warnings�warn�open�write)r( �for r r �copy_dev_clipboard s
z8init_dev_clipboard_clipboard.<locals>.copy_dev_clipboard)r! c S s" t dd��} | j� }W d Q R X |S )Nz/dev/clipboard�rt)ri �read)rk r@ r r r �paste_dev_clipboard s z9init_dev_clipboard_clipboard.<locals>.paste_dev_clipboard)r" )rl ro r r r � init_dev_clipboard_clipboard s
rp c C s G dd� d�} | � | � fS )Nc @ s" e Zd Zdd� Zed�dd�ZdS )z/init_no_clipboard.<locals>.ClipboardUnavailablec _ s t t��d S )N)r �
EXCEPT_MSG)r �args�kwargsr r r �__call__ s z8init_no_clipboard.<locals>.ClipboardUnavailable.__call__)r! c S s dS )NFr )r r r r �__bool__! s z8init_no_clipboard.<locals>.ClipboardUnavailable.__bool__N)r r r rt r% ru r r r r �ClipboardUnavailable s rv r )rv r r r �init_no_clipboard s rw c s, e Zd Z� fdd�Zdd� Zdd� Z� ZS )� CheckedCallc s t � jd|� d S )N�f)r � __setattr__)r ry )r r r r ) s zCheckedCall.__init__c G s* | j |� }| r&t� r&td| j j ��|S )NzError calling )ry r r r )r rr �retr r r rt , s
zCheckedCall.__call__c C s t | j||� d S )N)�setattrry )r �key�valuer r r rz 2 s zCheckedCall.__setattr__)r r r r rt rz r r r )r r rx ( s rx c s� ddl mamamamamamamamam a m
a
m a t j
} t jd�}t| jj��tt t ttttttttt
g �_t�_t| jj��tg�_t�_| jj�tg�_t�_t| jj��g �_t�_t| jj��g �_t�_t| jj��t g�_t�_t| jj�� t tg� _t� _t| jj�� t t g� _t� _t| jj ��
tg�
_t
�
_t| jj �� tg� _t� _t|j ��
t g�
_t �
_d�d� t!j"��fdd���t!j"��fdd ���� ���� �
� � �
�f
d
d �}� ��fd d
�}||fS )Nr ) �BOOL�DWORD�HANDLE�HGLOBAL� HINSTANCE�HMENU�HWND�INT�LPCSTR�LPVOID�UINT�msvcrt� �
c
3 s8 � dddddddddddd� } z
| V W d�| � X dS )z=
Context that provides a valid Windows hwnd.
r s STATICNr )�hwnd)�safeCreateWindowExA�safeDestroyWindowr r �window� s
z&init_windows_clipboard.<locals>.windowc
3 s^ t j � d }d}x(t j � |k r8� | �}|r,P t jd� qW |sFtd��z
dV W d�� X dS )z�
Context manager that opens the clipboard and prevents
other applications from modifying the clipboard content.
g �?Fg{�G�z�?zError calling OpenClipboardN)�time�sleepr )r� �t�success)�
OpenClipboard�safeCloseClipboardr r rD � s
z)init_windows_clipboard.<locals>.clipboardc s� t | �} � � �z}�|��f �� | rz�| �d }��|tt� �}�|�}tjt|�t| �|tt� � �|� �� |� W d Q R X W d Q R X d S )Nr] )r) r r r �memmover )r( r� �count�handleZ
locked_handle)
�CF_UNICODETEXT�
GMEM_MOVEABLErD �safeEmptyClipboard�safeGlobalAlloc�safeGlobalLock�safeGlobalUnlock�safeSetClipboardData�wcslenr� r r � copy_windows� s
z,init_windows_clipboard.<locals>.copy_windowsc s. �d �� �� �} | sdS t | �jS Q R X d S )Nrd )r r~ )r� )r� rD �safeGetClipboardDatar r �
paste_windows� s
z-init_windows_clipboard.<locals>.paste_windows)#Zctypes.wintypesr r� r� r� r� r� r� r� r� r� r� r �windll�CDLLrx Zuser32ZCreateWindowExA�argtypes�restypeZ
DestroyWindowr� ZCloseClipboardZEmptyClipboardZGetClipboardDataZSetClipboardData�kernel32Z GlobalAllocr Z
GlobalLockZ GlobalUnlockr� r �
contextlib�contextmanager)r� r� r� r� r )r� r� r� rD r� r� r� r� r� r� r� r� r� r� r� r �init_windows_clipboard6 sl 4
! r� c C s dd� } dd� }| |fS )Nc S s2 t | �} tjdgtjdd�}|j| jt�d� d S )Nzclip.exeT)r, r- )r. )r) r r/ r r0 r1 r2 )r( r3 r r r �copy_wsl� s z$init_wsl_clipboard.<locals>.copy_wslc S s: t jdddgt jt jdd�} | j� \}}|d d� jt�S )Nzpowershell.exez-commandz
Get-ClipboardT)r
r r- r� ���)r r/ r r0 r6 r2 )r3 r
r r r r � paste_wsl� s z%init_wsl_clipboard.<locals>.paste_wslr )r� r� r r r �init_wsl_clipboard� s r� c & C s� dt j� j� kr.tjjd�rJtjd� t� S n tj dksDt j� dkrJt
� S t j� dkr~t dd��} d | j � krtt
� S W d
Q R X tj d ks�t j� d kr�yd
d
lad
d
laW n tk
r� t� S X t� S t�r~td�r�t� S td�r�t� S td�o�td��r t� S y d
d
laW nj tk
�rv y d
d
laW n@ tk
�rj y d
d
laW n tk
�r^ Y nX t� S Y nX t� S Y nX t� S t � S )z]
Determine the OS/platform and set the copy() and paste() functions
accordingly.
�cygwinz/dev/clipboardzbPyperclip's support for Cygwin is not perfect,see https://github.com/asweigart/pyperclip/issues/55�ntr �Linuxz
/proc/versionr5 � MicrosoftN�macZDarwinr rU rM �klipperrZ ) �platform�system�lower�os�path�existsrg rh rp r r� ri rn r� r: r9 rI r8 rB � HAS_DISPLAYr rY rT rc ZqtpyZPyQt5ZPyQt4rK rw )ry r r r �determine_clipboard� sN r� c C sV t tttttttd�}| |krDdd� |j� D �}t ddj
|�� ���|| � \a a dS )a�
Explicitly sets the clipboard mechanism. The "clipboard mechanism" is how
the copy() and paste() functions interact with the operating system to
implement the copy/paste feature. The clipboard parameter must be one of:
- pbcopy
- pbobjc (default on Mac OS X)
- qt
- xclip
- xsel
- klipper
- windows (default on Windows)
- no (this is what is set when no clipboard mechanism can be found)
)r* ZpyobjcZqtrM rU r� Zwindows�noc S s g | ] }t |��qS r )�repr)�.0�_r r r �
<listcomp>W s z!set_clipboard.<locals>.<listcomp>zArgument must be one of z, N)
r8 rB rK rT rY rc r� rw �keys�
ValueError�join�copy�paste)rD Zclipboard_typesZallowed_clipboard_typesr r r �
set_clipboard; s r� c C s t � \aat| �S )aD
A stub function for copy(), which will load the real copy() function when
called so that the real copy() function is used for later calls.
This allows users to import pyperclip without having determine_clipboard()
automatically run, which will automatically select a clipboard mechanism.
This could be a problem if it selects, say, the memory-heavy PyQt4 module
but the user was just going to immediately call set_clipboard() to use a
different clipboard mechanism.
The lazy loading this stub function implements gives the user a chance to
call set_clipboard() to pick another clipboard mechanism. Or, if the user
simply calls copy() or paste() without calling set_clipboard() first,
will fall back on whatever clipboard mechanism that determine_clipboard()
automatically chooses.
)r� r� r� )r( r r r �lazy_load_stub_copy` s
r� c C s t � \aat� S )aG
A stub function for paste(), which will load the real paste() function when
called so that the real paste() function is used for later calls.
This allows users to import pyperclip without having determine_clipboard()
automatically run, which will automatically select a clipboard mechanism.
This could be a problem if it selects, say, the memory-heavy PyQt4 module
but the user was just going to immediately call set_clipboard() to use a
different clipboard mechanism.
The lazy loading this stub function implements gives the user a chance to
call set_clipboard() to pick another clipboard mechanism. Or, if the user
simply calls copy() or paste() without calling set_clipboard() first,
will fall back on whatever clipboard mechanism that determine_clipboard()
automatically chooses.
)r� r� r� r r r r �lazy_load_stub_pastev s
r� c C s t tkottkS )N)r� r� r� r� r r r r � is_available� s r� r� r� )0�__doc__� __version__r� r r r r r r r� r� r r� rg �getenvr� rq r2 r� r r � RuntimeErrorr r r" r) r8 rB rK rT rY rc rp rw rx r� r� r� r� r� r� r% r� r� r� �__all__Z
clipboard_getZ
clipboard_setr r r r �<module>* sP
& 'I%
|