Implement copy to clipboard (fixes bpython#234)

sebastinas · sebastinas · commit 5bf22e4f2f29 · 2015-01-11T05:44:49.000+01:00
Based on a patch by Keith Dart

Signed-off-by: Sebastian Ramacher &lt;sebastian+dev@ramacher.at&gt;
diff --git a/bpython/cli.py b/bpython/cli.py
@@ -962,6 +962,10 @@ def p_key(self, key):
             self.pastebin()
             return ''
 
+        elif key in key_dispatch[config.copy_clipboard_key]:
+            self.copy2clipboard()
+            return ''
+
         elif key in key_dispatch[config.last_output_key]:
             page(self.stdout_hist[self.prev_block_finished:-4])
             return ''
diff --git a/bpython/clipboard.py b/bpython/clipboard.py
@@ -0,0 +1,67 @@
+# The MIT License
+#
+# Copyright (c) 2015 the bpython authors.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+import subprocess
+import os
+import platform
+from locale import getpreferredencoding
+
+class CopyFailed(Exception):
+    pass
+
+class XClipboard(object):
+    """Manage clipboard with xclip."""
+
+    def copy(self, content):
+        process = subprocess.Popen(['xclip', '-i', '-selection', 'clipboard'],
+                                   stdin=subprocess.PIPE)
+        process.communicate(content.encode(getpreferredencoding()))
+        if process.returncode != 0:
+            raise CopyFailed()
+
+class OSXClipboard(object):
+    """Manage clipboard with pbcopy."""
+
+    def copy(self, content):
+        process = subprocess.Popen(['pbcopy', 'w'], stdin=subprocess.PIPE)
+        process.communicate(content.encode(getpreferredencoding()))
+        if process.returncode != 0:
+            raise CopyFailed()
+
+def command_exists(command):
+    process = subprocess.Popen(['which', command], stderr=subprocess.STDOUT,
+                               stdout=subprocess.PIPE)
+    process.communicate()
+
+    return process.returncode == 0
+
+def get_clipboard():
+    """Get best clipboard handling implemention for current system."""
+
+    if platform.system() == 'Darwin':
+        if command_exists('pbcopy'):
+            return OSXClipboard()
+    if platform.system() in ('Linux', 'FreeBSD', 'OpenBSD') and os.getenv('DISPLAY') is not None:
+        if command_exists('xclip'):
+            return XClipboard()
+
+    return None
diff --git a/bpython/config.py b/bpython/config.py
@@ -82,6 +82,7 @@ def loadini(struct, configfile):
             'edit_current_block': 'C-x',
             'help': 'F1',
             'last_output': 'F9',
+            'copy_clipboard': 'F10',
             'pastebin': 'F8',
             'save': 'C-s',
             'show_source': 'F2',
@@ -139,6 +140,7 @@ def get_key_no_doublebind(attr, already_used={}):
     struct.flush_output = config.getboolean('general', 'flush_output')
 
     struct.pastebin_key = get_key_no_doublebind('pastebin')
+    struct.copy_clipboard_key = get_key_no_doublebind('copy_clipboard')
     struct.save_key = get_key_no_doublebind('save')
     struct.search_key = get_key_no_doublebind('search')
     struct.show_source_key = get_key_no_doublebind('show_source')
diff --git a/bpython/curtsiesfrontend/interaction.py b/bpython/curtsiesfrontend/interaction.py
@@ -143,6 +143,7 @@ def confirm(self, q):
         self.prompt = q
         self.in_confirm = True
         return self.main_greenlet.switch(q)
+
     def file_prompt(self, s):
         """Expected to return a file name, given """
         self.request_greenlet = greenlet.getcurrent()
diff --git a/bpython/curtsiesfrontend/repl.py b/bpython/curtsiesfrontend/repl.py
@@ -547,6 +547,8 @@ def process_key_event(self, e):
             greenlet.greenlet(self.write2file).switch()
         elif e in key_dispatch[self.config.pastebin_key]: # F8 for pastebin
             greenlet.greenlet(self.pastebin).switch()
+        elif e in key_dispatch[self.config.copy_clipboard_key]:
+            greenlet.greenlet(self.copy2clipboard).switch()
         elif e in key_dispatch[self.config.external_editor_key]:
             self.send_session_to_external_editor()
         elif e in key_dispatch[self.config.edit_config_key]:
diff --git a/bpython/repl.py b/bpython/repl.py
@@ -48,6 +48,7 @@
 from bpython._py3compat import PythonLexer, py3
 from bpython.formatter import Parenthesis
 from bpython.translations import _
+from bpython.clipboard import get_clipboard, CopyFailed
 import bpython.autocomplete as autocomplete
 
 
@@ -446,6 +447,7 @@ def __init__(self, interp, config):
         # Necessary to fix mercurial.ui.ui expecting sys.stderr to have this
         # attribute
         self.closed = False
+        self.clipboard = get_clipboard()
 
         pythonhist = os.path.expanduser(self.config.hist_file)
         if os.path.exists(pythonhist):
@@ -768,6 +770,21 @@ def write2file(self):
         else:
             self.interact.notify('Saved to %s.' % (fn, ))
 
+    def copy2clipboard(self):
+        """Copy current content to clipboard."""
+
+        if self.clipboard is None:
+            self.interact.notify(_('No clipboard available.'))
+            return
+
+        content = self.formatforfile(self.getstdout())
+        try:
+            self.clipboard.copy(content)
+        except CopyFailed:
+            self.interact.notify(_('Could not copy to clipboard.'))
+        else:
+            self.interact.notify(_('Copied content to clipboard.'))
+
     def pastebin(self, s=None):
         """Upload to a pastebin and display the URL in the status bar."""
 
