Move setup.cfg to mplsetup.cfg.

anntzer · anntzer · commit 93b5c0fb08b5 · 2021-08-21T14:06:27.000+02:00
... in order to avoid having to jump through hoops to work around the
fact that distutils/setuptools also intend to use setup.cfg just for
themselves.
diff --git a/.github/workflows/cibuildwheel.yml b/.github/workflows/cibuildwheel.yml
@@ -60,10 +60,6 @@ jobs:
           CIBW_BUILD: "cp37-* cp38-*"
           CIBW_ARCHS: aarch64
 
-      - name: Copy setup.cfg to configure wheel
-        run: |
-          cp setup.cfg.template setup.cfg
-
       - name: Build wheels for CPython 3.9
         run: |
           python -m cibuildwheel --output-dir dist
diff --git a/.gitignore b/.gitignore
@@ -41,7 +41,7 @@ dist
 pip-wheel-metadata/*
 # tox testing tool
 .tox
-setup.cfg
+mplsetup.cfg
 # generated by setuptools_scm
 lib/matplotlib/_version.py
 
diff --git a/ci/check_wheel_licenses.py b/ci/check_wheel_licenses.py
@@ -5,7 +5,6 @@
 included.
 
 To run:
-    $ cp setup.cfg.template setup.cfg
     $ python3 setup.py bdist_wheel
     $ ./ci/check_wheel_licenses.py
 """
diff --git a/doc/api/next_api_changes/development/XXXXX-AL.rst b/doc/api/next_api_changes/development/XXXXX-AL.rst
@@ -0,0 +1,8 @@
+Matplotlib-specific build options have moved from ``setup.cfg`` to ``mplsetup.cfg``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+... in order to avoid conflicting with the use of :file:`setup.cfg` by
+``setuptools``.
+
+Note that the path to this configuration file can still be set via the
+:envvar:`MPLSETUPCFG` environment variable, which allows one to keep using the
+same file before and after this change.
diff --git a/doc/devel/dependencies.rst b/doc/devel/dependencies.rst
@@ -104,7 +104,7 @@ rasterize characters differently) and of Qhull.  As an exception, Matplotlib
 defaults to the system version of FreeType on AIX.
 
 To force Matplotlib to use a copy of FreeType or Qhull already installed in
-your system, create a :file:`setup.cfg` file with the following contents:
+your system, create a :file:`mplsetup.cfg` file with the following contents:
 
 .. code-block:: cfg
 
diff --git a/doc/faq/environment_variables_faq.rst b/doc/faq/environment_variables_faq.rst
@@ -29,10 +29,10 @@ Environment variables
 
 .. envvar:: MPLSETUPCFG
 
-   This optional variable can be set to the full path of a :file:`setup.cfg`
+   This optional variable can be set to the full path of a :file:`mplsetup.cfg`
    configuration file used to customize the Matplotlib build.  By default, a
-   :file:`setup.cfg` file in the root of the Matplotlib source tree will be
-   read.  Supported build options are listed in :file:`setup.cfg.template`.
+   :file:`mplsetup.cfg` file in the root of the Matplotlib source tree will be
+   read.  Supported build options are listed in :file:`mplsetup.cfg.template`.
 
 .. envvar:: PATH
 
diff --git a/doc/users/installing_source.rst b/doc/users/installing_source.rst
@@ -65,12 +65,12 @@ docs.
 If you would like to build from a tarball, grab the latest *tar.gz* release
 file from `the PyPI files page <https://pypi.org/project/matplotlib/>`_.
 
-We provide a `setup.cfg`_ file which you can use to customize the build
+We provide a `mplsetup.cfg`_ file which you can use to customize the build
 process. For example, which default backend to use, whether some of the
 optional libraries that Matplotlib ships with are installed, and so on.  This
 file will be particularly useful to those packaging Matplotlib.
 
-.. _setup.cfg: https://raw.githubusercontent.com/matplotlib/matplotlib/master/setup.cfg.template
+.. _mplsetup.cfg: https://raw.githubusercontent.com/matplotlib/matplotlib/master/mplsetup.cfg.template
 
 If you are building your own Matplotlib wheels (or sdists) on Windows, note
 that any DLLs that you copy into the source tree will be packaged too.
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -1204,7 +1204,7 @@ def _init_tests():
         _log.warning(
             f"Matplotlib is not built with the correct FreeType version to "
             f"run tests.  Rebuild without setting system_freetype=1 in "
-            f"setup.cfg.  Expect many image comparison failures below.  "
+            f"mplsetup.cfg.  Expect many image comparison failures below.  "
             f"Expected freetype version {LOCAL_FREETYPE_VERSION}.  "
             f"Found freetype version {ft2font.__freetype_version__}.  "
             "Freetype build type is {}local".format(
diff --git a/mplsetup.cfg.template b/mplsetup.cfg.template
@@ -1,9 +1,4 @@
-# Rename this file to setup.cfg to modify Matplotlib's build options.
-
-[metadata]
-license_files = LICENSE/*
-
-[egg_info]
+# Rename this file to mplsetup.cfg to modify Matplotlib's build options.
 
 [libs]
 # By default, Matplotlib builds with LTO, which may be slow if you re-compile
diff --git a/setup.cfg b/setup.cfg
@@ -0,0 +1,5 @@
+# NOTE: Matplotlib-specific configuration options have been moved to
+# mplsetup.cfg.template.
+
+[metadata]
+license_files = LICENSE/*
diff --git a/setup.py b/setup.py
@@ -1,6 +1,6 @@
 """
-The matplotlib build options can be modified with a setup.cfg file. See
-setup.cfg.template for more information.
+The Matplotlib build options can be modified with a mplsetup.cfg file. See
+mplsetup.cfg.template for more information.
 """
 
 # NOTE: This file must remain Python 2 compatible for the foreseeable future,
@@ -35,14 +35,6 @@
 import setuptools.command.test
 import setuptools.command.sdist
 
-# The setuptools version of sdist adds a setup.cfg file to the tree.
-# We don't want that, so we simply remove it, and it will fall back to
-# vanilla distutils.
-try:
-    del setuptools.command.sdist.sdist.make_release_tree
-except AttributeError:
-    pass
-
 from distutils.errors import CompileError
 from distutils.dist import Distribution
 
@@ -250,7 +242,7 @@ def make_release_tree(self, base_dir, files):
     # Go through all of the packages and figure out which ones we are
     # going to build/install.
     print_raw()
-    print_raw("Edit setup.cfg to change the build options; "
+    print_raw("Edit mplsetup.cfg to change the build options; "
               "suppress output with --quiet.")
     print_raw()
     print_raw("BUILDING MATPLOTLIB")
diff --git a/setupext.py b/setupext.py
@@ -177,17 +177,17 @@ def get_and_extract_tarball(urls, sha, dirname):
 LOCAL_QHULL_VERSION = '2020.2'
 
 
-# Matplotlib build options, which can be altered using setup.cfg
-setup_cfg = os.environ.get('MPLSETUPCFG') or 'setup.cfg'
+# Matplotlib build options, which can be altered using mplsetup.cfg
+mplsetup_cfg = os.environ.get('MPLSETUPCFG') or 'mplsetup.cfg'
 config = configparser.ConfigParser()
-if os.path.exists(setup_cfg):
-    config.read(setup_cfg)
+if os.path.exists(mplsetup_cfg):
+    config.read(mplsetup_cfg)
 options = {
     'backend': config.get('rc_options', 'backend', fallback=None),
     'system_freetype': config.getboolean(
         'libs', 'system_freetype', fallback=sys.platform.startswith('aix')),
-    'system_qhull': config.getboolean('libs', 'system_qhull',
-                                      fallback=False),
+    'system_qhull': config.getboolean(
+        'libs', 'system_qhull', fallback=False),
 }
 
 
@@ -323,7 +323,7 @@ class OptionalPackage(SetupPackage):
 
     def check(self):
         """
-        Check whether ``setup.cfg`` requests this package to be installed.
+        Check whether ``mplsetup.cfg`` requests this package to be installed.
 
         May be overridden by subclasses for additional checks.
         """
diff --git a/src/checkdep_freetype2.c b/src/checkdep_freetype2.c
@@ -1,7 +1,7 @@
 #ifdef __has_include
   #if !__has_include(<ft2build.h>)
     #error "FreeType version 2.3 or higher is required. \
-You may unset the system_freetype entry in setup.cfg to let Matplotlib download it."
+You may unset the system_freetype entry in mplsetup.cfg to let Matplotlib download it."
   #endif
 #endif
 
@@ -15,5 +15,5 @@ You may unset the system_freetype entry in setup.cfg to let Matplotlib download
   XSTR(FREETYPE_MAJOR) "." XSTR(FREETYPE_MINOR) "." XSTR(FREETYPE_PATCH) ".")
 #if FREETYPE_MAJOR << 16 + FREETYPE_MINOR << 8 + FREETYPE_PATCH < 0x020300
   #error "FreeType version 2.3 or higher is required. \
-You may unset the system_freetype entry in setup.cfg to let Matplotlib download it."
+You may unset the system_freetype entry in mplsetup.cfg to let Matplotlib download it."
 #endif
