From 5f76bf2ea0b079548e21a3911bed9b6ae2d8ffaa Mon Sep 17 00:00:00 2001
From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
Date: Sun, 6 Jan 2019 11:13:07 +0100
Subject: [PATCH] Cleanup matplotlib.use
---
.../2019-01-06-TH-use-param.rst | 7 +++
lib/matplotlib/__init__.py | 44 ++++++++-----------
2 files changed, 26 insertions(+), 25 deletions(-)
create mode 100644 doc/api/next_api_changes/2019-01-06-TH-use-param.rst
diff --git a/doc/api/next_api_changes/2019-01-06-TH-use-param.rst b/doc/api/next_api_changes/2019-01-06-TH-use-param.rst
new file mode 100644
index 000000000000..82647ee75936
--- /dev/null
+++ b/doc/api/next_api_changes/2019-01-06-TH-use-param.rst
@@ -0,0 +1,7 @@
+API Changes
+```````````
+
+The first parameter of `matplotlib.use` has been renamed from *arg* to
+*backend*. This will only affect cases where that parameter has been set
+as a keyword argument. The common usage pattern as a positional argument
+``matplotlib.use('Qt5Agg')`` is not affected.
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
index 923bc41170dd..8be6aff04d7f 100644
--- a/lib/matplotlib/__init__.py
+++ b/lib/matplotlib/__init__.py
@@ -1184,13 +1184,13 @@ def __exit__(self, exc_type, exc_value, exc_tb):
@cbook._rename_parameter("3.1", "arg", "backend")
def use(backend, warn=False, force=True):
"""
- Set the matplotlib backend to one of the known backends.
+ Select the backend used for rendering and GUI integration.
Parameters
----------
backend : str
- The backend to switch to. This can either be one of the
- 'standard' backend names:
+ The backend to switch to. This can either be one of the standard
+ backend names, which are case-insensitive:
- interactive backends:
GTK3Agg, GTK3Cairo, MacOSX, nbAgg,
@@ -1202,20 +1202,15 @@ def use(backend, warn=False, force=True):
or a string of the form: ``module://my.module.name``.
- Note: Standard backend names are case-insensitive here.
+ warn : bool, optional, default: False
+ If True and not *force*, warn that the call will have no effect if
+ this is called after pyplot has been imported and a backend is set up.
- *arg* is a deprecated synonym for this parameter.
- warn : bool, optional
- If True, warn if this is called after pyplot has been imported
- and a backend is set up.
-
- defaults to False.
-
- force : bool, optional
+ force : bool, optional, default: True
If True, attempt to switch the backend. An ImportError is raised if
an interactive backend is selected, but another interactive
- backend has already started. This defaults to True.
+ backend has already started.
See Also
--------
@@ -1224,20 +1219,19 @@ def use(backend, warn=False, force=True):
"""
name = validate_backend(backend)
- # if setting back to the same thing, do nothing
- if (dict.__getitem__(rcParams, 'backend') == name):
+ if dict.__getitem__(rcParams, 'backend') == name:
+ # Nothing to do if the requested backend is already set
pass
-
- # Check if we have already imported pyplot and triggered
- # backend selection, do a bit more work
elif 'matplotlib.pyplot' in sys.modules:
- # If we are here then the requested is different than the current.
+ # pyplot has already been imported (which triggered backend selection)
+ # and the requested backend is different from the current one.
+
# If we are going to force the switch, never warn, else, if warn
# is True, then direct users to `plt.switch_backend`
if (not force) and warn:
cbook._warn_external(
- ("matplotlib.pyplot as already been imported, "
- "this call will have no effect."))
+ "matplotlib.pyplot has already been imported, "
+ "this call will have no effect.")
# if we are going to force switching the backend, pull in
# `switch_backend` from pyplot. This will only happen if
@@ -1245,11 +1239,11 @@ def use(backend, warn=False, force=True):
if force:
from matplotlib.pyplot import switch_backend
switch_backend(name)
- # Finally if pyplot is not imported update both rcParams and
- # rcDefaults so restoring the defaults later with rcdefaults
- # won't change the backend. This is a bit of overkill as 'backend'
- # is already in style.core.STYLE_BLACKLIST, but better to be safe.
else:
+ # Finally if pyplot is not imported update both rcParams and
+ # rcDefaults so restoring the defaults later with rcdefaults
+ # won't change the backend. This is a bit of overkill as 'backend'
+ # is already in style.core.STYLE_BLACKLIST, but better to be safe.
rcParams['backend'] = rcParamsDefault['backend'] = name
pFad - Phonifier reborn
Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies:
Alternative Proxy
pFad Proxy
pFad v3 Proxy
pFad v4 Proxy