Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug]: tkinter backend changes DPI awareness context of entire process on Windows #21875

Open
daniilS opened this issue Dec 6, 2021 · 3 comments
Labels
Milestone

Comments

@daniilS
Copy link
Contributor

daniilS commented Dec 6, 2021

Bug summary

_BackendTk.new_figure_manager_given_figure calls _c_internal_utils.Win32_SetProcessDpiAwareness_max, which affects the entire process attached to the script, and all windows part of it, rather than just the matplotlib output window.

Ideally, the DPI awareness context should only be changed for the current thread before a matplotlib window is drawn and returned to the previous value afterwards, or at the very least there should be an option to disable the DPI change.

Code for reproduction

# reproduces the bug when run on a high DPI display on Windows

import tkinter as tk
from tkinter import ttk

import matplotlib
matplotlib.use('TkAgg')  # in case other GUI libraries are installed
import matplotlib.pyplot as plt

root = tk.Tk()

button = ttk.Button(root, text="Run matplotlib.pyplot.subplots",
                    command=plt.subplots)
button.pack(padx=30, pady=30)

root.wait_window()  #root.mainloop seems to prevent DPI updates

Actual outcome

The scaling of the window changes.

Expected outcome

The scaling of the window shouldn't change just because subplots was called.

Additional information

Introduced in #19167

Operating system

Windows 10

Matplotlib Version

3.5.0

Matplotlib Backend

TkAgg

Python version

3.9.6

Jupyter version

No response

Installation

pip

@richardsheridan
Copy link
Contributor

richardsheridan commented Dec 6, 2021

As a workaround you can call ctypes.windll.shcore.SetProcessDpiAwareness(0) before engaging the TkAgg backend. It might be good to have a setting that causes TkAgg to skip setting DPI awareness since the semantics of it are weird.

@tacaswell tacaswell added this to the v3.5.1 milestone Dec 6, 2021
@daniilS
Copy link
Contributor Author

daniilS commented Dec 6, 2021

A potential way of avoiding this issue in Windows 10 version 1803 onwards would be to use SetThreadDpiHostingBehavior and SetThreadDpiAwarenessContext to only apply the scaling to a matplotlib popup window. Having a setting to disable it would always be good though when using an API call that applies to the entire process.

@QuLogic QuLogic modified the milestones: v3.5.1, v3.5.2 Dec 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants