Added machinery for the mpl_baseline package

SidharthBansal · SidharthBansal · commit f3664a1f3fc8 · 2020-08-23T19:13:35.000+05:30
diff --git a/.flake8 b/.flake8
@@ -64,6 +64,7 @@ per-file-ignores =
     lib/matplotlib/pylab.py: F401, F403
     lib/matplotlib/pyplot.py: F401, F811
     lib/matplotlib/style/__init__.py: F401
+    lib/matplotlib/tests/__init__.py: F401
     lib/matplotlib/testing/conftest.py: F401
     lib/matplotlib/tests/conftest.py: F401
     lib/matplotlib/tests/test_backend_qt.py: F401
@@ -81,6 +82,7 @@ per-file-ignores =
     lib/mpl_toolkits/axisartist/axes_rgb.py: F401
     lib/mpl_toolkits/axisartist/axislines.py: F401
     lib/mpl_toolkits/mplot3d/__init__.py: F401
+    lib/mpl_toolkits/tests/__init__.py: F401
     lib/mpl_toolkits/tests/conftest.py: F401
     lib/pylab.py: F401, F403
 
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -21,3 +21,4 @@ recursive-include tutorials *
 include versioneer.py
 include lib/matplotlib/_version.py
 include tests.py
+prune sub-wheels
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -85,6 +85,7 @@ steps:
 
 - bash: |
     python -m pip install --upgrade pip
+    python -m pip install --upgrade setuptools
     python -m pip install -r requirements/testing/travis_all.txt -r requirements/testing/travis_extra.txt ||
       [[ "$PYTHON_VERSION" = 'Pre' ]]
   displayName: 'Install dependencies with pip'
diff --git a/doc/devel/testing.rst b/doc/devel/testing.rst
@@ -145,12 +145,12 @@ tests it::
        ax.plot(range(10), linestyle=(0, (3, 3)), lw=5)
 
 The first time this test is run, there will be no baseline image to compare
-against, so the test will fail.  Copy the output images (in this case
-:file:`result_images/test_lines/test_line_dashes.png`) to the correct
-subdirectory of :file:`baseline_images` tree in the source directory (in this
-case :file:`lib/matplotlib/tests/baseline_images/test_lines`).  Put this new
-file under source code revision control (with ``git add``).  When rerunning
-the tests, they should now pass.
+against, so the test will fail.  The baseline images for the :file:`lib/matplotlib` directory can be generated by using
+`python3 -mpytest lib/matplotlib --matplotlib_baseline_image_generation`. Similarly, the baseline images for the
+:file: `lib/mpl_toolkits` directory can be generated by using `python3 -mpytest lib/mpl_toolkits --matplotlib_baseline`
+`_image_generation`. This will create baseline images in the respective `baseline_images` directory for the matplotlib
+and mpl_toolkits folder. When rerunning the tests with the `matplotlib_baseline_image_generation` flag,
+test will pass.
 
 Baseline images take a lot of space in the Matplotlib repository.
 An alternative approach for image comparison tests is to use the
diff --git a/lib/matplotlib/testing/decorators.py b/lib/matplotlib/testing/decorators.py
@@ -483,7 +483,25 @@ def _image_directories(func):
     doesn't exist.
     """
     module_path = Path(sys.modules[func.__module__].__file__)
-    baseline_dir = module_path.parent / "baseline_images" / module_path.stem
+    if func.__module__.startswith("matplotlib."):
+        try:
+            import matplotlib_baseline_images
+        except:
+            raise ImportError("Not able to import matplotlib_baseline_images")
+        baseline_dir = (Path(matplotlib_baseline_images.__file__).parent /
+                            module_path.stem)
+    elif func.__module__.startswith("mpl_toolkits."):
+        try:
+            import mpl_toolkits_baseline_images
+        except:
+            raise ImportError("Not able to import "
+                              "mpl_toolkits_baseline_images")
+        baseline_dir = (Path(mpl_toolkits_baseline_images.__file__).parent /
+                            module_path.stem)
+    else:
+        baseline_dir = (module_path.parent /
+                            "baseline_images" /
+                            module_path.stem)
     result_dir = Path().resolve() / "result_images" / module_path.stem
     result_dir.mkdir(parents=True, exist_ok=True)
     return baseline_dir, result_dir
diff --git a/lib/matplotlib/tests/__init__.py b/lib/matplotlib/tests/__init__.py
@@ -1,10 +1,9 @@
-from pathlib import Path
-
-
-# Check that the test directories exist.
-if not (Path(__file__).parent / 'baseline_images').exists():
-    raise IOError(
+# Check for the matplotlib_baseline_images.
+try:
+    import matplotlib_baseline_images
+except:
+    raise ImportError(
         'The baseline image directory does not exist. '
         'This is most likely because the test data is not installed. '
-        'You may need to install matplotlib from source to get the '
+        'You may need to install matplotlib_baseline_images to get the '
         'test data.')
diff --git a/lib/mpl_toolkits/tests/__init__.py b/lib/mpl_toolkits/tests/__init__.py
@@ -1,10 +1,9 @@
-from pathlib import Path
-
-
-# Check that the test directories exist
-if not (Path(__file__).parent / "baseline_images").exists():
-    raise IOError(
+# Check for the mpl_toolkits_baseline_images.
+try:
+    import mpl_toolkits_baseline_images
+except:
+    raise ImportError(
         'The baseline image directory does not exist. '
         'This is most likely because the test data is not installed. '
-        'You may need to install matplotlib from source to get the '
+        'You may need to install mpl_toolkits_baseline_images to get the '
         'test data.')
diff --git a/requirements/testing/travis_all.txt b/requirements/testing/travis_all.txt
@@ -9,3 +9,4 @@ pytest-timeout
 pytest-xdist
 python-dateutil
 tornado
+-e sub-wheels/matplotlib-baseline-images
diff --git a/setup.cfg.template b/setup.cfg.template
@@ -14,9 +14,8 @@
 
 [packages]
 # There are a number of data subpackages from Matplotlib that are
-# considered optional. All except 'tests' data (meaning the baseline
-# image files) are installed by default, but that can be changed here.
-#tests = False
+# considered optional. Sample data are installed by default, but that can be
+# changed here.
 #sample_data = True
 
 [gui_support]
diff --git a/setup.py b/setup.py
@@ -59,7 +59,6 @@
     setupext.Platform(),
     setupext.FreeType(),
     setupext.SampleData(),
-    setupext.Tests(),
     setupext.BackendMacOSX(),
     ]
 
diff --git a/setupext.py b/setupext.py
@@ -452,24 +452,6 @@ def get_package_data(self):
         }
 
 
-class Tests(OptionalPackage):
-    name = "tests"
-    default_config = False
-
-    def get_package_data(self):
-        return {
-            'matplotlib': [
-                *_pkg_data_helper('matplotlib', 'tests/baseline_images'),
-                *_pkg_data_helper('matplotlib', 'tests/tinypages'),
-                'tests/cmr10.pfb',
-                'tests/mpltest.ttf',
-            ],
-            'mpl_toolkits': [
-                *_pkg_data_helper('mpl_toolkits', 'tests/baseline_images'),
-            ]
-        }
-
-
 def add_numpy_flags(ext):
     import numpy as np
     ext.include_dirs.append(np.get_include())
diff --git a/sub-wheels/matplotlib-baseline-images/LICENSE b/sub-wheels/matplotlib-baseline-images/LICENSE
@@ -0,0 +1,49 @@
+License agreement for matplotlib versions 1.3.0 and later
+=========================================================
+
+1. This LICENSE AGREEMENT is between the Matplotlib Development Team
+("MDT"), and the Individual or Organization ("Licensee") accessing and
+otherwise using matplotlib software in source or binary form and its
+associated documentation.
+
+2. Subject to the terms and conditions of this License Agreement, MDT
+hereby grants Licensee a nonexclusive, royalty-free, world-wide license
+to reproduce, analyze, test, perform and/or display publicly, prepare
+derivative works, distribute, and otherwise use matplotlib
+alone or in any derivative version, provided, however, that MDT's
+License Agreement and MDT's notice of copyright, i.e., "Copyright (c)
+2012- Matplotlib Development Team; All Rights Reserved" are retained in
+matplotlib  alone or in any derivative version prepared by
+Licensee.
+
+3. In the event Licensee prepares a derivative work that is based on or
+incorporates matplotlib or any part thereof, and wants to
+make the derivative work available to others as provided herein, then
+Licensee hereby agrees to include in any such work a brief summary of
+the changes made to matplotlib .
+
+4. MDT is making matplotlib available to Licensee on an "AS
+IS" basis.  MDT MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
+IMPLIED.  BY WAY OF EXAMPLE, BUT NOT LIMITATION, MDT MAKES NO AND
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF MATPLOTLIB
+WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.
+
+5. MDT SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF MATPLOTLIB
+ FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR
+LOSS AS A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING
+MATPLOTLIB , OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF
+THE POSSIBILITY THEREOF.
+
+6. This License Agreement will automatically terminate upon a material
+breach of its terms and conditions.
+
+7. Nothing in this License Agreement shall be deemed to create any
+relationship of agency, partnership, or joint venture between MDT and
+Licensee.  This License Agreement does not grant permission to use MDT
+trademarks or trade name in a trademark sense to endorse or promote
+products or services of Licensee, or any third party.
+
+8. By copying, installing or otherwise using matplotlib ,
+Licensee agrees to be bound by the terms and conditions of this License
+Agreement.
diff --git a/sub-wheels/matplotlib-baseline-images/README.rst b/sub-wheels/matplotlib-baseline-images/README.rst
@@ -0,0 +1,4 @@
+Matplotlib-baseline-images is a data package containing matplotlib baseline
+images and matplotlib toolkit baseline images. Baseline images were earlier
+installed with the matplotlib. Now they are separately installed with the main
+matplotlib package.
diff --git a/sub-wheels/matplotlib-baseline-images/lib/matplotlib_baseline_images/__init__.py b/sub-wheels/matplotlib-baseline-images/lib/matplotlib_baseline_images/__init__.py
diff --git a/sub-wheels/matplotlib-baseline-images/lib/mpl_toolkits_baseline_images/__init__.py b/sub-wheels/matplotlib-baseline-images/lib/mpl_toolkits_baseline_images/__init__.py
diff --git a/sub-wheels/matplotlib-baseline-images/setup.py b/sub-wheels/matplotlib-baseline-images/setup.py
@@ -0,0 +1,21 @@
+from setuptools import setup, find_packages
+import sys
+import subprocess
+
+# The version number of the matplotlib_baseline_images should be same as that
+# of matplotlib package. Checking the matplotlib version number needs cwd as
+# the grandparent directory without changing the directory in the
+# sub-wheels/matplotlib-baseline-images/setup.py.
+__version__ = subprocess.check_output(
+    [sys.executable, "setup.py", "--version"], cwd="../..",
+    universal_newlines=True).rstrip("\n")
+
+setup(
+    name="matplotlib-baseline-images",
+    version=__version__,
+    description="Package contains mpl baseline images and mpl toolkit images",
+    package_dir={"": "lib"},
+    packages=find_packages("lib"),
+    include_package_data=True,
+#    install_requires=["matplotlib=={}".format(__version__)],
+)
diff --git a/tools/triage_tests.py b/tools/triage_tests.py
@@ -37,12 +37,15 @@
 # order to find the source, we need to search for a match in one of
 # these two places.
 
-BASELINE_IMAGES = [
-    Path('lib/matplotlib/tests/baseline_images'),
-    Path('lib/mpl_toolkits/tests/baseline_images'),
-]
-
-
+try:
+    import matplotlib_baseline_images
+    import mpl_toolkits_baseline_images
+    BASELINE_IMAGES = [
+        (Path(matplotlib_baseline_images.__file__).parent),
+        (Path(mpl_toolkits_baseline_images.__file__).parent),
+    ]
+except:
+    raise ImportError("Not able to import baseline images packages")
 # Non-png image extensions
 
 exts = ['pdf', 'svg']

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,6 @@`
`59`	`59`	`setupext.Platform(),`
`60`	`60`	`setupext.FreeType(),`
`61`	`61`	`setupext.SampleData(),`
`62`		`- setupext.Tests(),`
`63`	`62`	`setupext.BackendMacOSX(),`
`64`	`63`	`]`
`65`	`64`