Commit81ed659

authored

Merge pull request#30489 from meeseeksmachine/auto-backport-of-pr-30486-on-v3.10.5-doc

Backport PR#30486 on branch v3.10.5-doc (doc: Update warnings about python-build-standalone)

2 parentsca6a289 +25a97fd commit81ed659Copy full SHA for 81ed659

File tree

+22

-14

lines changed

+22

-14

lines changed

Lines changed: 14 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -28,11 +28,20 @@ precompiled wheel for your OS and Python.`
`28`	`28`
`29`	`29`	`..note::`
`30`	`30`
`31`		`- The following backends work out of the box: Agg, ps, pdf, svg`
`32`		`-`
`33`		`- Python is typically shipped with tk bindings which are used by`
`34`		- TkAgg. Notably, python-build-standalone – used by ``uv`` – does
`35`		`- not include tk bindings that are usable by Matplotlib.`
	`31`	`+ The following non-interactive backends work out of the box: Agg,`
	`32`	`+ ps, pdf, svg`
	`33`	`+`
	`34`	`+ The TkAgg interactive backend also typically works out of the box.`
	`35`	`+ It requires Tk bindings, which are usually provided via the Python`
	`36`	+ standard library's ``tkinter`` module. On some OSes, you may need
	`37`	+ to install a separate package like ``python3-tk`` to add this
	`38`	`+ component of the standard library.`
	`39`	`+`
	`40`	+ Some tools like ``uv`` make use of Python builds from the
	`41`	`+ python-build-standalone project, which only gained usable Tk`
	`42`	`+ bindings recently (August 2025). If you are having trouble with the`
	`43`	+ TkAgg backend, ensure you have an up-to-date build, e.g. ``uv self
	`44`	+ update && uv python upgrade --reinstall``.
`36`	`45`
`37`	`46`	`For support of other GUI frameworks, LaTeX rendering, saving`
`38`	`47`	`animations and a larger selection of file formats, you can`

Lines changed: 8 additions & 9 deletions

Original file line number	Diff line number	Diff line change
`@@ -29,20 +29,19 @@`
`29`	`29`
`30`	`30`	`..warning::`
`31`	`31`
`32`		- If you install Python with ``uv`` then the ``tkagg`` backend
`33`		`- will not be available because python-build-standalone (used by uv`
`34`		`- to distribute Python) does not contain tk bindings that are usable by`
`35`		- Matplotlib (see `this issue`_ for details). If you want Matplotlib
`36`		`- to be able to display plots in a window, you should install one of`
`37`		- the other:ref:`supported GUI frameworks<optional_dependencies>`,
`38`		`- e.g.`
	`32`	`+ uv usually installs its own versions of Python from the`
	`33`	`+ python-build-standalone project, and only recent versions of those`
	`34`	+ Python builds (August 2025) work properly with the ``tkagg`` backend
	`35`	`+ for displaying plots in a window. Please make sure you are using uv`
	`36`	+ 0.8.7 or newer (update with e.g. ``uv self update``) and that your
	`37`	+ bundled Python installs are up to date (with ``uv python upgrade
	`38`	+ --reinstall``). Alternatively, you can use one of the other
	`39`	+:ref:`supported GUI frameworks<optional_dependencies>`, e.g.
`39`	`40`
`40`	`41`	`..code-block::bash`
`41`	`42`
`42`	`43`	`uv add matplotlib pyside6`
`43`	`44`
`44`		`- .. _this issue:https://github.com/astral-sh/uv/issues/6893#issuecomment-2565965851`
`45`		`-`
`46`	`45`	`..tab-item::other`
`47`	`46`
`48`	`47`	:ref:`install-official`

Comments

(0)