copy to clipboard ipython magic

clip_magic.py

"""
Add copy to clipboard from IPython!
To install, just copy it to your profile/startup directory, typically:

    ~/.ipython/profile_default/startup/

Example usage:

    %clip hello world
    # will store "hello world"
    a = [1, 2, 3]
    %clip a
    # will store "[1, 2, 3]"

You can also use it with cell magic

    In [1]: %%clip
       ...: Even multi
       ...: lines
       ...: work!
       ...:

If you don't have a variable named 'clip' you can rely on automagic:

    clip hey man
    a = [1, 2, 3]
    clip a

"""

import sys

if sys.platform == 'darwin':
    from AppKit import NSPasteboard, NSArray
elif sys.platform.startswith('linux'):
    from subprocess import Popen, PIPE
else:
    raise ImportError("Clip magic only works on osx or linux!")

from IPython.core.magic import register_line_cell_magic

def _copy_to_clipboard(arg):
    arg = str(globals().get(arg) or arg)

    if sys.platform == 'darwin':
        pb = NSPasteboard.generalPasteboard()
        pb.clearContents()
        a = NSArray.arrayWithObject_(arg)
        pb.writeObjects_(a)
    elif sys.platform.startswith('linux'):
        p = Popen(['xsel', '-pi'], stdin=PIPE)
        p.communicate(input=arg)

    print ('Copied to clipboard!')


@register_line_cell_magic
def clip(line, cell=None):
    if line and cell:
        cell = '\n'.join((line, cell))

    _copy_to_clipboard(cell or line)

# We delete it to avoid name conflicts for automagic to work
del clip

Hi, thanks for the script. If anyone wants Python 3 compatibility then change the communicate line to "p.communicate(input=bytes(arg, 'utf-8'))" as communicate needs bytes not unicode. Also on Linux I had to use '-bi' rather than '-pi' (using Linux Mint 64bit).

Windows?

It does not work on ipython 2.3.0, is it possible that the way how cell magic functions are registered has changed? I can't find documentation for the decorators you are using. I'll try to fix it and send you a pull request

this is great, something like this should be built in

Oh wow, this is the best thing ever! The only note is, use "xsel -ib", to copy to clipboard instead of primary selection, it's better that way for everyone.

OSError: [Errno 2] No such file or directory

Removed AppKit dependency for OS X: https://gist.github.com/vpontis/46e5d3154cda92ce3e0f (only works for OS X)

One of the features I was looking forward with Ipython is to copy selected lines from history to my code editor with out using mouse. I have added one more function in your program to copy history of selected line to clipboard. I have made modification in two places in the history.py file of Ipython. If any of you can guide, I would like to push / pass it to the developers.

I made a fork that supports python3: https://gist.github.com/cphyc/47d7dbe756fc2d16d05f6271f647fd03. It's just a matter of adding () around the print statement…

Just to note that for most cases following alias will be enough:
alias ck echo "$$_" | pbcopy

Blast from the past - I just went searching for "how to setup a copy-to-clipboard in IPython like I used to have...and found this, with my previous comments". Thanks to other contributors for their updates too. I'll just verify that using this with my suggestions above on Linux, works for Python 3.11 with IPython 8.10. xsel needs to be installed as a system package and -ib is a better choice on Linux.

In case anyone else comes across this, I made a simple package implementing this as %clip or %%clip: https://pypi.org/project/jupyter-clipmagic/