You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
114 lines
4.1 KiB
114 lines
4.1 KiB
# Copyright 2021 Spencer Phillip Young
|
|
# Copyright 2022 Alessandro Astone
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
"""
|
|
Provides the clipboard functionality for Linux via ``wl-copy``/``wl-paste``
|
|
"""
|
|
import warnings
|
|
|
|
from .base import ClipboardBase, ClipboardSetupException, ClipboardException
|
|
from typing import Union
|
|
import shutil
|
|
import subprocess
|
|
|
|
|
|
class WaylandClipboard(ClipboardBase):
|
|
def __init__(self):
|
|
self.wl_copy = shutil.which('wl-copy')
|
|
self.wl_paste = shutil.which('wl-paste')
|
|
if not self.wl_copy or not self.wl_paste:
|
|
raise ClipboardSetupException(
|
|
"wl-clipboard must be installed. " "Please install wl-clipboard using your system package manager"
|
|
)
|
|
|
|
def copy(self, data: Union[str, bytes], encoding: str = None) -> None:
|
|
"""
|
|
Copy data into the clipboard
|
|
|
|
:param data: the data to be copied to the clipboard. Can be str or bytes.
|
|
:param encoding: same meaning as in ``subprocess.Popen``.
|
|
:return: None
|
|
"""
|
|
args = [ self.wl_copy ]
|
|
if isinstance(data, bytes):
|
|
if encoding is not None:
|
|
warnings.warn(
|
|
"encoding specified with a bytes argument. "
|
|
"Encoding option will be ignored. "
|
|
"To remove this warning, omit the encoding parameter or specify it as None",
|
|
stacklevel=2,
|
|
)
|
|
proc = subprocess.Popen(
|
|
args,
|
|
stdin=subprocess.PIPE,
|
|
encoding=encoding,
|
|
)
|
|
elif isinstance(data, str):
|
|
proc = subprocess.Popen(
|
|
args,
|
|
stdin=subprocess.PIPE,
|
|
text=True,
|
|
encoding=encoding,
|
|
)
|
|
else:
|
|
raise TypeError(f"data argument must be of type str or bytes, not {type(data)}")
|
|
stdout, stderr = proc.communicate(data)
|
|
if proc.returncode != 0:
|
|
raise ClipboardException(
|
|
f"Copy failed. wl-copy returned code: {proc.returncode!r} "
|
|
f"Stderr: {stderr!r} "
|
|
f"Stdout: {stdout!r}"
|
|
)
|
|
|
|
def paste(self, encoding: str = None, text: bool = None, errors: str = None):
|
|
"""
|
|
Retrieve data from the clipboard
|
|
|
|
:param encoding: same meaning as in ``subprocess.run``
|
|
:param text: same meaning as in ``subprocess.run``
|
|
:param errors: same meaning as in ``subprocess.run``
|
|
:return: the clipboard contents. return type is binary by default.
|
|
If any of ``encoding``, ``errors``, or ``text`` are specified, the result type is str
|
|
"""
|
|
args = [ self.wl_paste, '--no-newline' ]
|
|
if encoding or text or errors:
|
|
completed_proc = subprocess.run(
|
|
args,
|
|
stdin=subprocess.PIPE,
|
|
stdout=subprocess.PIPE,
|
|
stderr=subprocess.PIPE,
|
|
text=text,
|
|
encoding=encoding,
|
|
)
|
|
else:
|
|
completed_proc = subprocess.run(
|
|
args, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE
|
|
)
|
|
|
|
if completed_proc.returncode != 0:
|
|
raise ClipboardException(
|
|
f"Copy failed. wl-paste returned code: {completed_proc.returncode!r} "
|
|
f"Stderr: {completed_proc.stderr!r} "
|
|
f"Stdout: {completed_proc.stdout!r}"
|
|
)
|
|
return completed_proc.stdout
|
|
|
|
def clear(self):
|
|
"""
|
|
Clear the clipboard contents
|
|
|
|
:return:
|
|
"""
|
|
self.copy('')
|