Don't bother with checking backends at setup time.

anntzer · anntzer · commit a9dc5665eb7c · 2017-11-17T13:37:20.000-08:00
We can just default to trying all backends in order until one loads.
Only backends actually requiring a compiled component need to be handled
in setupext.py now.

Move the `mpl-data/*.glade` entry into a recursive glob for the
Matplotlib SetupPackage (as there are no more entries for Gtk3).

As a side benefit, we don't need any multiprocessing craziness in
setupext.py anymore...
diff --git a/.gitignore b/.gitignore
@@ -50,11 +50,6 @@ ehthumbs.db
 Icon?
 Thumbs.db
 
-# Things specific to this project #
-###################################
-lib/matplotlib/mpl-data/matplotlib.conf
-lib/matplotlib/mpl-data/matplotlibrc
-
 # Documentation generated files #
 #################################
 # sphinx build directory
diff --git a/lib/matplotlib/mpl-data/matplotlibrc b/lib/matplotlib/mpl-data/matplotlibrc
@@ -0,0 +1 @@
+
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -955,9 +955,13 @@ def _validate_linestyle(ls):
 
 # a map from key -> value, converter
 defaultParams = {
-    'backend':           ['Agg', validate_backend],  # agg is certainly
-                                                      # present
-    'backend_fallback':  [True, validate_bool],  # agg is certainly present
+    'backend':           [["macosx",
+                           "qt5agg", "qt4agg",
+                           "gtk3agg", "gtk3cairo", "gtkagg",
+                           "tkagg",
+                           "wxagg",
+                           "agg", "cairo"], validate_backend],
+    'backend_fallback':  [True, validate_bool],
     'backend.qt4':       ['PyQt4', validate_qt4],
     'backend.qt5':       ['PyQt5', validate_qt5],
     'webagg.port':       [8988, validate_int],
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -36,9 +36,8 @@
 # referring to the module name (which must be in the PYTHONPATH) as
 # 'module://my_backend'.
 #
-# If you omit this parameter, it will always default to "Agg", which is a
-# non-interactive backend.
-backend      : $TEMPLATE_BACKEND
+# Try the backends in the given order until one successfully loads.
+# backend : macosx, qt5agg, qt4agg, gtk3agg, gtk3cairo, gtkagg, tkagg, wxagg, agg, cairo
 
 # If you are using the Qt4Agg backend, you can choose here
 # to use the PyQt4 bindings or the newer PySide bindings to
diff --git a/setup.py b/setup.py
@@ -76,20 +76,11 @@
     setupext.Tests(),
     setupext.Toolkits_Tests(),
     'Optional backend extensions',
-    # These backends are listed in order of preference, the first
-    # being the most preferred.  The first one that looks like it will
-    # work will be selected as the default backend.
     setupext.BackendMacOSX(),
-    setupext.BackendQt5(),
-    setupext.BackendQt4(),
-    setupext.BackendGtk3Agg(),
-    setupext.BackendGtk3Cairo(),
     setupext.BackendGtkAgg(),
     setupext.BackendTkAgg(),
-    setupext.BackendWxAgg(),
     setupext.BackendGtk(),
     setupext.BackendAgg(),
-    setupext.BackendCairo(),
     setupext.Windowing(),
     'Optional LaTeX dependencies',
     setupext.DviPng(),
@@ -133,9 +124,7 @@ def run(self):
 cmdclass['test'] = NoopTestCommand
 cmdclass['build_ext'] = BuildExtraLibraries
 
-# One doesn't normally see `if __name__ == '__main__'` blocks in a setup.py,
-# however, this is needed on Windows to avoid creating infinite subprocesses
-# when using multiprocessing.
+
 if __name__ == '__main__':
     # These are distutils.setup parameters that the various packages add
     # things to.
@@ -147,7 +136,6 @@ def run(self):
     package_dir = {'': 'lib'}
     install_requires = []
     setup_requires = []
-    default_backend = None
 
     # If the user just queries for information, don't bother figuring out which
     # packages to build or install.
@@ -183,10 +171,6 @@ def run(self):
                         required_failed.append(package)
                 else:
                     good_packages.append(package)
-                    if (isinstance(package, setupext.OptionalBackendPackage) and
-                            package.runtime_check() and
-                            default_backend is None):
-                        default_backend = package.name
         print_raw('')
 
         # Abort if any of the required packages can not be built.
@@ -216,17 +200,6 @@ def run(self):
             install_requires.extend(package.get_install_requires())
             setup_requires.extend(package.get_setup_requires())
 
-        # Write the default matplotlibrc file
-        if default_backend is None:
-            default_backend = 'svg'
-        if setupext.options['backend']:
-            default_backend = setupext.options['backend']
-        with open('matplotlibrc.template') as fd:
-            template = fd.read()
-        template = Template(template)
-        with open('lib/matplotlib/mpl-data/matplotlibrc', 'w') as fd:
-            fd.write(template.safe_substitute(TEMPLATE_BACKEND=default_backend))
-
         # Build in verbose mode if requested
         if setupext.options['verbose']:
             for mod in ext_modules:
@@ -237,10 +210,8 @@ def run(self):
         for mod in ext_modules:
             mod.finalize()
 
-    extra_args = {}
-
     # Finally, pass this all along to distutils to do the heavy lifting.
-    distrib = setup(
+    setup(
         name="matplotlib",
         version=__version__,
         description="Python plotting package",
@@ -274,5 +245,4 @@ def run(self):
         # check for zip safety.
         zip_safe=False,
         cmdclass=cmdclass,
-        **extra_args
     )
diff --git a/setupext.py b/setupext.py
