BLD: Switch to static linking by default on windows

Author: Kojoley

.appveyor.yml

@@ -76,16 +76,6 @@ install:
     curl -sL https://github.com/python/cpython/pull/1224.patch |
     patch -fsup 1 -d %CONDA_PREFIX% ) || cmd /c "exit /b 0"
 
-  # Let the install prefer the static builds of the libs
-  - set LIBRARY_LIB=%CONDA_PREFIX%\Library\lib
-  - mkdir lib || cmd /c "exit /b 0"
-  - copy /y %LIBRARY_LIB%\zlibstatic.lib lib\zlib.lib
-  - copy /y %LIBRARY_LIB%\libpng16_static.lib lib\libpng16.lib
-  # These z.lib / png.lib are not static versions but files which end up as
-  # dependencies to the dll file. This is fine for the conda build, but not here
-  # and for the wheels
-  - del %LIBRARY_LIB%\png.lib
-  - del %LIBRARY_LIB%\z.lib
   # enables the local freetype build
   - set MPLLOCALFREETYPE=1
   # Show the installed packages + versions
@@ -97,9 +87,9 @@ test_script:
   - pip install -ve .
   # these should show no z, png, or freetype dll...
   - set "DUMPBIN=%VS140COMNTOOLS%\..\..\VC\bin\dumpbin.exe"
-  - '"%DUMPBIN%" /DEPENDENTS lib\matplotlib\ft2font*.pyd | findstr freetype.*.dll && exit /b 1 || exit /b 0'
-  - '"%DUMPBIN%" /DEPENDENTS lib\matplotlib\_png*.pyd | findstr z.*.dll && exit /b 1 || exit /b 0'
-  - '"%DUMPBIN%" /DEPENDENTS lib\matplotlib\_png*.pyd | findstr png.*.dll && exit /b 1 || exit /b 0'
+  - 'if x%MPLSTATICBUILD% == xTrue "%DUMPBIN%" /DEPENDENTS lib\matplotlib\ft2font*.pyd | findstr freetype.*.dll && exit /b 1 || exit /b 0'
+  - 'if x%MPLSTATICBUILD% == xTrue "%DUMPBIN%" /DEPENDENTS lib\matplotlib\_png*.pyd | findstr z.*.dll && exit /b 1 || exit /b 0'
+  - 'if x%MPLSTATICBUILD% == xTrue "%DUMPBIN%" /DEPENDENTS lib\matplotlib\_png*.pyd | findstr png.*.dll && exit /b 1 || exit /b 0'
 
   # this are optional dependencies so that we don't skip so many tests...
   - if x%TEST_ALL% == xyes conda install -q ffmpeg inkscape miktex pillow
@@ -116,6 +106,7 @@ test_script:
 after_test:
   # After the tests were a success, build wheels with the static libs
   # Hide the output, the copied files really clutter the build log...
+  - set MPLSTATICBUILD=True
   - 'python setup.py bdist_wheel > NUL:'
   - dir dist\
   - echo finished...

INSTALL.rst

@@ -307,11 +307,10 @@ the list of conda packages.
 
   conda create -n "matplotlib_build" python=3.7 numpy python-dateutil pyparsing tornado cycler tk libpng zlib freetype msinttypes
   conda activate matplotlib_build
+  # force the build against static libpng and zlib libraries
+  set MPLSTATICBUILD=True
+  python setup.py bdist_wheel
 
-For building, call the script ``build_alllocal.cmd`` in the root folder of the
-repository::
-
-  build_alllocal.cmd
 
 Conda packages
 ^^^^^^^^^^^^^^

build_alllocal.cmd

@@ -22,9 +22,12 @@ steps:
 
   - script: |
       nuget install libpng-msvc14-x64 -ExcludeVersion -OutputDirectory "$(build.BinariesDirectory)"
-      echo ##vso[task.setvariable variable=CL]/I$(build.BinariesDirectory)\libpng-msvc14-x64\build\native\include
-      echo ##vso[task.setvariable variable=LINK]/LIBPATH:$(build.BinariesDirectory)\libpng-msvc14-x64\build\native\lib_release
+      nuget install zlib-msvc14-x64 -ExcludeVersion -OutputDirectory "$(build.BinariesDirectory)"
       echo ##vso[task.prependpath]$(build.BinariesDirectory)\libpng-msvc14-x64\build\native\bin_release
+      echo ##vso[task.prependpath]$(build.BinariesDirectory)\zlib-msvc14-x64\build\native\bin_release
+      echo ##vso[task.setvariable variable=CL]/I$(build.BinariesDirectory)\libpng-msvc14-x64\build\native\include /I$(build.BinariesDirectory)\zlib-msvc14-x64\build\native\include
+      echo ##vso[task.setvariable variable=LINK]/LIBPATH:$(build.BinariesDirectory)\libpng-msvc14-x64\build\native\lib_release /LIBPATH:$(build.BinariesDirectory)\zlib-msvc14-x64\build\native\lib_release
+
     displayName: 'Install dependencies with nuget'
 
 - ${{ if eq(parameters.installer, 'brew') }}:

ci/azure-pipelines-steps.yml

@@ -61,3 +61,8 @@
 # modules.  The default is determined by fallback.
 #
 #backend = Agg
+
+[build]
+# Build options
+# If we should try to use static libraries on Windows
+#staticbuild = True

setup.cfg.template

@@ -151,6 +151,7 @@ def write_cache(local_fn, data):
 # matplotlib build options, which can be altered using setup.cfg
 options = {
     'backend': None,
+    'staticbuild': False,
     }
 
 
@@ -164,12 +165,18 @@ def write_cache(local_fn, data):
 
     if config.has_option('test', 'local_freetype'):
         options['local_freetype'] = config.getboolean("test", "local_freetype")
+
+    if config.has_option('build', 'staticbuild'):
+        options['staticbuild'] = config.getboolean("build", "staticbuild")
 else:
     config = None
 
 lft = bool(os.environ.get('MPLLOCALFREETYPE', False))
 options['local_freetype'] = lft or options.get('local_freetype', False)
 
+staticbuild = bool(os.environ.get('MPLSTATICBUILD', os.name == 'nt'))
+options['staticbuild'] = staticbuild or options.get('staticbuild', False)
+
 
 if '-q' in sys.argv or '--quiet' in sys.argv:
     def print_raw(*args, **kwargs): pass  # Suppress our own output.
@@ -195,6 +202,23 @@ def get_buffer_hash(fd):
     return hasher.hexdigest()
 
 
+def deplib(libname):
+    if sys.platform != 'win32':
+        return libname
+
+    known_libs = {
+        # TODO: support versioned libpng on build system rewrite
+        'libpng16': ('libpng16', '_static'),
+        'z': ('zlib', 'static'),
+    }
+
+    libname, static_postfix = known_libs[libname]
+    if options['staticbuild']:
+        libname += static_postfix
+
+    return libname
+
+
 @functools.lru_cache(1)  # We only need to compute this once.
 def get_pkg_config():
     """
@@ -501,7 +525,7 @@ def add_flags(self, ext):
                 ext, 'freetype2',
                 atleast_version='9.11.3',
                 alt_exec=['freetype-config'],
-                default_libraries=['freetype', 'z'])
+                default_libraries=['freetype', deplib('z')])
             ext.define_macros.append(('FREETYPE_BUILD_TYPE', 'system'))
 
     def do_custom_build(self):
@@ -635,7 +659,7 @@ def get_extension(self):
             default_libraries=(
                 ['png', 'z'] if os.name == 'posix' else
                 # libpng upstream names their lib libpng16.lib, not png.lib.
-                ['libpng16'] if os.name == 'nt' else
+                [deplib('libpng16'), deplib('z')] if os.name == 'nt' else
                 []
             ))
         add_numpy_flags(ext)