implementation of the copy canvas tool #10446

fariza · 2018-02-13T18:32:14Z

PR Summary

Answering to #1987
This is the implementation of the CopyToClipboard tool

GTK3
tk
Qt
Wx
Before it get's merged we need to have the three backends that are supported by the ToolManager

PR Checklist

Has Pytest style unit tests
Code is PEP 8 compliant
New features are documented, with examples if plot related
Documentation is sphinx and numpydoc compliant
Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

fariza · 2018-02-13T18:34:22Z

@tacaswell can you help me out finding people with QT/Tk superpowers to help with the implementation for those two backends

anntzer · 2018-02-13T19:04:35Z

http://doc.qt.io/qt-5/qclipboard.html#setImage
http://www.tcl.tk/man/tcl8.5/TkCmd/clipboard.htm
https://wxpython.org/Phoenix/docs/html/wx.Clipboard.html
seem relevant.

fariza · 2018-02-14T18:01:47Z

@anntzer thanks for the tip, QT was pretty easy

The tk still pending... HELP!!!

anntzer · 2018-02-15T02:27:27Z

lib/matplotlib/rcsetup.py

@@ -1389,6 +1389,7 @@ def _validate_linestyle(ls):
    'keymap.yscale':       [['l'], validate_stringlist],
    'keymap.xscale':       [['k', 'L'], validate_stringlist],
    'keymap.all_axes':     [['a'], validate_stringlist],
+    'keymap.copy':         [('ctrl+c', 'cmd+c', 'shift+ctrl+c'), validate_stringlist],


list instead of tuple? (as above, basically)

@anntzer Done

fariza · 2018-02-26T17:27:31Z

I didn't find a way to do it for tkinter, it seems this is not well supported. So I just emit a warning when called from tk backend

The other option would be to just don't add it in TK, but this means allowing a disparity between backends for default tools. And that is something that we don't really want

timhoffm

Since this code will only be triggered by a user action from a GUI, it‘s probably better to show the warning in a message box. A warning in the console may go unnoticed and the user may wonder why there is no image in the clipboard.

fariza · 2018-03-12T17:01:11Z

@timhoffm I change the message, now it appears in the statusbar

DietmarSchwertberger · 2018-03-20T22:04:32Z

I have just added and tested an implementation for the Wx backends.

I would suggest more consistent names: Qt vs. QT and probably omit the Tool prefix for all backends.
As of now it's inconsistent:

backend_tools.ToolRubberband = RubberbandQt
backend_tools.ToolCopyToClipboard = ToolCopyToClipboardQT

fariza · 2018-03-21T16:40:30Z

@DietmarSchwertberger I agree with the renaming, but it should be done in a separate PR, only for that.
Do you think it would be possible for you to implement what is missing for the WX backend? the toolbar and the modifications of the FigureManager?
It is a little strange to have those tools lying around without using them

DietmarSchwertberger · 2018-03-21T17:00:17Z

@fariza: I've submitted PR #10851 last night for the missing classes.
I have been using the tools before already, but with wx.Button, i.e. the tools were just there to connect canvas and GUI elements.

I would suggest to do the renaming right on this PR, as the names were just introduced.

fariza · 2018-03-21T17:00:26Z

@DietmarSchwertberger when commiting to other's peoples PR you should open a PR against their branch, not commit directly.
I don't know why github accepted your commit. Normally It shoudn't

DietmarSchwertberger · 2018-03-21T17:02:17Z

@fariza : sorry, I thought this would be the standard approach as anntzer suggested this on a previous PR of him.

anntzer · 2018-03-21T17:05:55Z

It's OK if the PR owner gives you ("verbal") permission to do so (which I gave to all devs for just my own PRs).

fariza · 2018-03-21T17:07:20Z

Don't worry, I just wasn't expecting that

fariza · 2018-04-09T18:54:02Z

@anntzer @timhoffm Is something missing?

anntzer · 2018-04-09T20:05:15Z

See #10851 (comment).

DietmarSchwertberger · 2018-04-12T19:19:26Z

I did only test those parts that were used by the wx implementation and things worked as expected.

I agreee with anntzer that some automated testing for the toolmanager tools is required, but we need a volunteer for that.
This PR, the help tool and the wxToolManager are waiting to be merged.
I don't think that we should wait for the testing as this would slow down ToolManager development quite a lot. Is there a plan to make ToolManager the default? 3.1? By then, testing needs to be in place. For now, I think it's more useful to have the code in master where people can actually use and test it.

@fariza I recently found the "Customize" tool of the NavigationToolbar2QT. Do you plan to implement such a tool for the ToolManager? I could contribute the code for the Wx backends, but I won't do for NavigationToolbar.

jklymak · 2018-04-12T19:29:00Z

This is failing all the tests. Probably not going to get merged until that's fixed! Looks like you need to update matplotlibrc.template?

fariza · 2018-04-12T19:53:30Z

@DietmarSchwertberger that QT specific tool is one of the reasons this toolmanager exists, and MEP27 is been a work in progress for a long time.
We don't want to have or at least reduce the number of "backend specific" tools, but that is a big discussion for another day.

anntzer · 2018-04-12T20:40:46Z

Is there a plan to make ToolManager the default? 3.1?

Yes.

I don't think that we should wait for the testing as this would slow down ToolManager development quite a lot.

I'm not bent against that, I just don't have the bandwidth to do a proper review right now, and tests would have helped.

fariza · 2018-04-12T20:56:20Z

@anntzer I agree that we need to test this, but I agree with @DietmarSchwertberger about not holding this PRs because of that.
Is there any other volunteer to review this PRs?

fariza · 2018-04-13T18:08:15Z

@jklymak fixed, "all checks have passed"

fariza · 2018-04-18T18:36:55Z

@anntzer @timhoffm can we look at this now?

anntzer · 2018-04-18T18:39:20Z

lib/matplotlib/backends/_backend_tk.py

@@ -971,11 +971,18 @@ def trigger(self, *args):
        dialog.done = lambda num: dialog.frame.master.withdraw()


+class ToolCopyToClipboardTk(backend_tools.ToolCopyToClipboardBase):
+    def trigger(self, *args, **kwargs):


I would move this to the base class ("The current backend does not implement the copy tool.").

In fact this could even be moved to ToolBase...

anntzer · 2018-04-18T18:48:37Z

lib/matplotlib/backends/_backend_tk.py

-    def trigger(self, *args, **kwargs):
-        message = "Copy tool is not available for Tk backend"
-        self.toolmanager.message_event(message, self)
+    pass


... then you don't need this class anymore.

anntzer · 2018-04-18T19:31:17Z

I would drop shift-ctrl-c as a default shortcut -- it is only useful in context where ctrl-c is not available (because that's an interrupt), not where ctrl-c is already a shortcut for copy.

fariza · 2018-04-18T19:52:17Z

@anntzer it was @efiring that suggested shift+ctrl+c in #1987 (comment) do we keep it?

anntzer · 2018-04-18T20:09:47Z

But he suggested it instead of ctrl-c, not in addition. I would not keep both.

anntzer · 2018-04-18T20:21:22Z

lib/matplotlib/rcsetup.py

@@ -1421,6 +1421,7 @@ def _validate_linestyle(ls):
    'keymap.xscale':       [['k', 'L'], validate_stringlist],
    'keymap.all_axes':     [['a'], validate_stringlist],
    'keymap.help':         [['f1'], validate_stringlist],
+    'keymap.copy':         [('ctrl+c', 'cmd+c'), validate_stringlist],


list, not tuple

timhoffm · 2018-04-18T23:52:51Z

lib/matplotlib/backends/backend_qt5.py

 backend_tools.ToolSaveFigure = SaveFigureQt
 backend_tools.ToolConfigureSubplots = ConfigureSubplotsQt
 backend_tools.ToolSetCursor = SetCursorQt
 backend_tools.ToolRubberband = RubberbandQt
 backend_tools.ToolHelp = HelpQt
+backend_tools.ToolCopyToClipboard = ToolCopyToClipboardQT


All the backend-specific tool classes do not have the "Tool" prefix. While, in general I would recommend to keep the prefix also in the backend specific classes, in the present situation I'm +0.3 not using it for consistency with the existing code. But I'm not familiar with that part of the code and don't know if there are any explicit policies on this. Maybe someone more experienced with that code can comment on this?

Same holds for the other backends.

@timhoffm you are right, we have to make the naming more consistent.
We can make a separate PR fixing all those names at once. I don't think it is relevant here

Do we consider the backend implementations private? If so we can clean up the naming soon and this PR goes in as is.

If not, we need a deprecation cycle. In that case, I‘d prefer to remove the Tool prefix in this PR as well and change everything later together.

As the initial warning states. Tool names might change. So I don't see a problem doing all of them in a single PR

jklymak

I'll merge after giving @timhoffm a little bit if he still want the naming conventions fixed...

fariza · 2018-04-26T19:16:40Z

@timhoffm is it OK if @jklymak merge this?

jklymak · 2018-04-26T19:24:15Z

A week is fine ;-)

alexysong · 2019-11-10T21:54:02Z

Right now does the copy always give you a png? Would be great to support vector formats like svg as well.

I manage to do this with Qt backend on windows, with something like this:

import io
from PySide.QtGui import QApplication, QImage
from matplotlib import pyplot as plt

# do a matplotlib plot

# this saves the plot as svg to clipboard
buf = io.BytesIO()
fig.savefig(buf, format='svg')
data = QtCore.QMimeData()
data.setData('image/svg+xml', buf.getvalue())
QApplication.clipboard().setMimeData(data)

Then I can go to word to paste it as an svg image.
But somehow this doesn't work on macOS, I haven't figured out why.

jdtsmith · 2022-12-24T05:49:39Z

Does copy work with PyQT5 on Mac? I am unable to get anything onto the clipboard with cmd-c.

fariza · 2023-01-20T14:29:17Z

@jdtsmith are you using the toolmanager? it was tested long time ago, I don't have mac to test. If it's not working lets report a bug

jdtsmith · 2023-01-20T16:40:12Z

I figured that out thanks; copy and scroll to zoom both work for me on Mac with this:

import warnings, matplotlib.pyplot as plt
plt.ion()
with warnings.catch_warnings():
  warnings.simplefilter("ignore")
  plt.rcParams['toolbar'] = 'toolmanager' # scrollzoom + Cmd-C copy!

Maybe toolmanager should be the default!

fariza · 2023-01-20T16:44:05Z

Maybe toolmanager should be the default!

Yes I agree, we need to properly pan and execute the transition

frere-jacques · 2024-08-18T06:08:32Z

Did the situation for tk change?

Maybe add a comment in the starting post that tk is not working currently.

anntzer reviewed Feb 15, 2018

View reviewed changes

fariza changed the title ~~WIP: GTK3 implementation of the copy canvas tool~~ WIP: implementation of the copy canvas tool Feb 23, 2018

fariza changed the title ~~WIP: implementation of the copy canvas tool~~ implementation of the copy canvas tool Feb 26, 2018

timhoffm reviewed Mar 4, 2018

View reviewed changes

fariza and others added 5 commits April 18, 2018 14:27

GTK3 implementation of the copy canvas tool

f092377

QT copy to clipboard tool implementation

18df922

Add first implementation of ToolCopyToClipboardWx

86d2968

update rc template

9923703

No copy tool for TK backend

25aceea

fariza force-pushed the copy-tool branch from afb9762 to 25aceea Compare April 18, 2018 18:35

anntzer reviewed Apr 18, 2018

View reviewed changes

Base tool triggers message of not implemented

cff56e5

anntzer reviewed Apr 18, 2018

View reviewed changes

removing unncesary class

2f131e1

fariza added 2 commits April 18, 2018 16:16

removing ctrl+shift+c from copy tool

584bf3e

copy tool keymap as list

e87cb47

anntzer reviewed Apr 18, 2018

View reviewed changes

anntzer approved these changes Apr 18, 2018

View reviewed changes

update rc.template

3866f29

timhoffm reviewed Apr 18, 2018

View reviewed changes

jklymak approved these changes Apr 19, 2018

View reviewed changes

jklymak merged commit 17b6c30 into matplotlib:master Apr 26, 2018

jklymak added this to the v3.0 milestone Apr 26, 2018

awbruch mentioned this pull request Mar 5, 2019

Copy to Clipboard not Enabled by Default #13595

Open

jklymak mentioned this pull request Jul 28, 2020

Add "copy to clipboard" to the Toolbar #1987

Closed

Uh oh!

implementation of the copy canvas tool #10446

implementation of the copy canvas tool #10446

Uh oh!

Conversation

fariza commented Feb 13, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Checklist

Uh oh!

fariza commented Feb 13, 2018

Uh oh!

anntzer commented Feb 13, 2018

Uh oh!

fariza commented Feb 14, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fariza commented Feb 26, 2018

Uh oh!

timhoffm left a comment

Choose a reason for hiding this comment

Uh oh!

fariza commented Mar 12, 2018

Uh oh!

DietmarSchwertberger commented Mar 20, 2018

Uh oh!

fariza commented Mar 21, 2018

Uh oh!

DietmarSchwertberger commented Mar 21, 2018

Uh oh!

fariza commented Mar 21, 2018

Uh oh!

DietmarSchwertberger commented Mar 21, 2018

Uh oh!

anntzer commented Mar 21, 2018

Uh oh!

fariza commented Mar 21, 2018

Uh oh!

fariza commented Apr 9, 2018

Uh oh!

anntzer commented Apr 9, 2018

Uh oh!

DietmarSchwertberger commented Apr 12, 2018

Uh oh!

jklymak commented Apr 12, 2018

Uh oh!

fariza commented Apr 12, 2018

Uh oh!

anntzer commented Apr 12, 2018

Uh oh!

fariza commented Apr 12, 2018

Uh oh!

fariza commented Apr 13, 2018

Uh oh!

fariza commented Apr 18, 2018

Uh oh!

anntzer Apr 18, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anntzer commented Apr 18, 2018

Uh oh!

fariza commented Apr 18, 2018

Uh oh!

anntzer commented Apr 18, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fariza commented Feb 13, 2018 •

edited

Loading

anntzer Apr 18, 2018 •

edited

Loading

anntzer commented Apr 18, 2018 •

edited

Loading

jklymak left a comment •

edited

Loading