Remove matplotlibrc.template.

anntzer · anntzer · commit d572ccd7db3d · 2021-03-24T11:09:24.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -54,8 +54,6 @@ Thumbs.db
 
 # Things specific to this project #
 ###################################
-lib/matplotlib/mpl-data/matplotlib.conf
-lib/matplotlib/mpl-data/matplotlibrc
 tutorials/intermediate/CL01.png
 tutorials/intermediate/CL02.png
 
diff --git a/lib/matplotlib/mpl-data/matplotlibrc b/lib/matplotlib/mpl-data/matplotlibrc
@@ -78,7 +78,7 @@
 ##     PS PDF SVG Template
 ## You can also deploy your own backend outside of Matplotlib by referring to
 ## the module name (which must be in the PYTHONPATH) as 'module://my_backend'.
-#backend: Agg
+#backend:
 
 ## The port to use for the web server in the WebAgg backend.
 #webagg.port: 8988
diff --git a/setup.py b/setup.py
@@ -66,6 +66,9 @@
     ]
 
 
+cmdclass = versioneer.get_cmdclass()
+
+
 # From https://bugs.python.org/issue26689
 def has_flag(self, flagname):
     """Return whether a flag name is supported on the specified compiler."""
@@ -200,9 +203,38 @@ def build_extensions(self):
         return super().build_extensions()
 
 
-cmdclass = versioneer.get_cmdclass()
+def update_matplotlibrc(path):
+    # Update the matplotlibrc file if packagers want to change the default
+    # backend.
+    template_lines = path.read_text().splitlines(True)
+    backend_line_idx, = [  # Also asserts that there is a single such line.
+        idx for idx, line in enumerate(template_lines)
+        if line.startswith("#backend:")]
+    template_lines[backend_line_idx] = (
+        "#backend: {}".format(setupext.options["backend"])
+        if setupext.options["backend"]
+        else "#backend:")
+    path.write_text("".join(template_lines))
+
+
+class BuildPy(cmdclass['build_py']):
+    def run(self):
+        super().run()
+        update_matplotlibrc(
+            Path(self.build_lib, "matplotlib/mpl-data/matplotlibrc"))
+
+
+class Sdist(cmdclass['sdist']):
+    def make_release_tree(self, base_dir, files):
+        super().make_release_tree(base_dir, files)
+        update_matplotlibrc(
+            Path(base_dir, "lib/matplotlib/mpl-data/matplotlibrc"))
+
+
 cmdclass['test'] = NoopTestCommand
 cmdclass['build_ext'] = BuildExtraLibraries
+cmdclass['build_py'] = BuildPy
+cmdclass['sdist'] = Sdist
 
 
 package_data = {}  # Will be filled below by the various components.
@@ -243,18 +275,6 @@ def build_extensions(self):
             package_data.setdefault(key, [])
             package_data[key] = list(set(val + package_data[key]))
 
-    # Write the default matplotlibrc file
-    with open('matplotlibrc.template') as fd:
-        template_lines = fd.read().splitlines(True)
-    backend_line_idx, = [  # Also asserts that there is a single such line.
-        idx for idx, line in enumerate(template_lines)
-        if line.startswith('#backend:')]
-    if setupext.options['backend']:
-        template_lines[backend_line_idx] = (
-            'backend: {}'.format(setupext.options['backend']))
-    with open('lib/matplotlib/mpl-data/matplotlibrc', 'w') as fd:
-        fd.write(''.join(template_lines))
-
 setup(  # Finally, pass this all along to distutils to do the heavy lifting.
     name="matplotlib",
     version=__version__,
diff --git a/tutorials/introductory/customizing.py b/tutorials/introductory/customizing.py
@@ -200,7 +200,7 @@
 # A sample matplotlibrc file
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~
 #
-# .. literalinclude:: ../../../matplotlibrc.template
+# .. literalinclude:: ../../../lib/matplotlib/mpl-data/matplotlibrc
 #
 #
 # .. _ggplot: https://ggplot2.tidyverse.org/

Original file line number	Diff line number	Diff line change
`@@ -200,7 +200,7 @@`
`200`	`200`	`# A sample matplotlibrc file`
`201`	`201`	`# ~~~~~~~~~~~~~~~~~~~~~~~~~~`
`202`	`202`	`#`
`203`		`-# .. literalinclude:: ../../../matplotlibrc.template`
	`203`	`+# .. literalinclude:: ../../../lib/matplotlib/mpl-data/matplotlibrc`
`204`	`204`	`#`
`205`	`205`	`#`
`206`	`206`	`# .. _ggplot: https://ggplot2.tidyverse.org/`