Merge pull request #17555 from anntzer/win32appusermodelid

QuLogic · web-flow · commit 31aa0867f9c5 · 2020-06-22T23:13:05.000-04:00
Set Win32 AppUserModelId to fix taskbar icons.
diff --git a/lib/matplotlib/backends/_backend_tk.py b/lib/matplotlib/backends/_backend_tk.py
@@ -856,6 +856,8 @@ def new_figure_manager_given_figure(cls, num, figure):
         Create a new figure manager instance for the given figure.
         """
         with _restore_foreground_window_at_end():
+            if cbook._get_running_interactive_framework() is None:
+                cbook._setup_new_guiapp()
             window = tk.Tk(className="matplotlib")
             window.withdraw()
 
diff --git a/lib/matplotlib/backends/backend_gtk3.py b/lib/matplotlib/backends/backend_gtk3.py
@@ -935,4 +935,5 @@ def trigger_manager_draw(manager):
     @staticmethod
     def mainloop():
         if Gtk.main_level() == 0:
+            cbook._setup_new_guiapp()
             Gtk.main()
diff --git a/lib/matplotlib/backends/backend_qt5.py b/lib/matplotlib/backends/backend_qt5.py
@@ -125,6 +125,7 @@ def _create_qApp():
                 pass
             qApp = QtWidgets.QApplication(["matplotlib"])
             qApp.lastWindowClosed.connect(qApp.quit)
+            cbook._setup_new_guiapp()
         else:
             qApp = app
 
diff --git a/lib/matplotlib/backends/backend_wx.py b/lib/matplotlib/backends/backend_wx.py
@@ -1674,6 +1674,7 @@ def new_figure_manager(cls, num, *args, **kwargs):
         if wxapp is None:
             wxapp = wx.App(False)
             wxapp.SetExitOnFrameDelete(True)
+            cbook._setup_new_guiapp()
             # Retain a reference to the app object so that it does not get
             # garbage collected.
             _BackendWx._theWxApp = wxapp
diff --git a/lib/matplotlib/cbook/__init__.py b/lib/matplotlib/cbook/__init__.py
@@ -28,6 +28,7 @@
 import numpy as np
 
 import matplotlib
+from matplotlib import _c_internal_utils
 from .deprecation import (
     deprecated, warn_deprecated,
     _rename_parameter, _delete_parameter, _make_keyword_only,
@@ -2342,3 +2343,17 @@ def _backend_module_name(name):
     """
     return (name[9:] if name.startswith("module://")
             else "matplotlib.backends.backend_{}".format(name.lower()))
+
+
+def _setup_new_guiapp():
+    """
+    Perform OS-dependent setup when Matplotlib creates a new GUI application.
+    """
+    # Windows: If not explicit app user model id has been set yet (so we're not
+    # already embedded), then set it to "matplotlib", so that taskbar icons are
+    # correct.
+    try:
+        _c_internal_utils.Win32_GetCurrentProcessExplicitAppUserModelID()
+    except OSError:
+        _c_internal_utils.Win32_SetCurrentProcessExplicitAppUserModelID(
+            "matplotlib")
diff --git a/setupext.py b/setupext.py
@@ -338,6 +338,11 @@ def get_extensions(self):
         add_libagg_flags_and_sources(ext)
         FreeType().add_flags(ext)
         yield ext
+        # c_internal_utils
+        ext = Extension(
+            "matplotlib._c_internal_utils", ["src/_c_internal_utils.c"],
+            libraries={"win32": ["ole32", "shell32"]}.get(sys.platform, []))
+        yield ext
         # contour
         ext = Extension(
             "matplotlib._contour", [
diff --git a/src/_c_internal_utils.c b/src/_c_internal_utils.c
@@ -0,0 +1,61 @@
+#define PY_SSIZE_T_CLEAN
+#include <Python.h>
+#ifdef _WIN32
+#include <Objbase.h>
+#include <Shobjidl.h>
+#endif
+
+static PyObject* mpl_GetCurrentProcessExplicitAppUserModelID(PyObject* module)
+{
+#ifdef _WIN32
+    wchar_t* appid = NULL;
+    HRESULT hr = GetCurrentProcessExplicitAppUserModelID(&appid);
+    if (FAILED(hr)) {
+        return PyErr_SetFromWindowsErr(hr);
+    }
+    PyObject* py_appid = PyUnicode_FromWideChar(appid, -1);
+    CoTaskMemFree(appid);
+    return py_appid;
+#else
+    Py_RETURN_NONE;
+#endif
+}
+
+static PyObject* mpl_SetCurrentProcessExplicitAppUserModelID(PyObject* module, PyObject* arg)
+{
+#ifdef _WIN32
+    wchar_t* appid = PyUnicode_AsWideCharString(arg, NULL);
+    if (!appid) {
+        return NULL;
+    }
+    HRESULT hr = SetCurrentProcessExplicitAppUserModelID(appid);
+    PyMem_Free(appid);
+    if (FAILED(hr)) {
+        return PyErr_SetFromWindowsErr(hr);
+    }
+    Py_RETURN_NONE;
+#else
+    Py_RETURN_NONE;
+#endif
+}
+
+static PyMethodDef functions[] = {
+    {"Win32_GetCurrentProcessExplicitAppUserModelID",
+     (PyCFunction)mpl_GetCurrentProcessExplicitAppUserModelID, METH_NOARGS,
+     "Win32_GetCurrentProcessExplicitAppUserModelID()\n--\n\n"
+     "Wrapper for Windows's GetCurrentProcessExplicitAppUserModelID.  On \n"
+     "non-Windows platforms, always returns None."},
+    {"Win32_SetCurrentProcessExplicitAppUserModelID",
+     (PyCFunction)mpl_SetCurrentProcessExplicitAppUserModelID, METH_O,
+     "Win32_SetCurrentProcessExplicitAppUserModelID(appid, /)\n--\n\n"
+     "Wrapper for Windows's SetCurrentProcessExplicitAppUserModelID.  On \n"
+     "non-Windows platforms, a no-op."},
+    {NULL, NULL}};  // sentinel.
+static PyModuleDef util_module = {
+    PyModuleDef_HEAD_INIT, "_c_internal_utils", "", 0, functions, NULL, NULL, NULL, NULL};
+
+#pragma GCC visibility push(default)
+PyMODINIT_FUNC PyInit__c_internal_utils(void)
+{
+    return PyModule_Create(&util_module);
+}
