Merge branch 'mnt/matplotlib' into 'master'

Mnt/matplotlib

See merge request fsl/fsleyes/props!48

.ci/build_doc.sh

@@ -2,6 +2,7 @@
 
 set -e
 
+pip install -r requirements.txt
 pip install -r requirements-dev.txt
 python setup.py doc
 mkdir -p public

CHANGELOG.rst

@@ -2,7 +2,19 @@ This document contains the ``fsleyes-props`` release history in reverse
 chronological order.
 
 
-1.7.2 (Saturday March 26th 2021)
+
+1.7.3 (Wednesday April 21st 2021)
+---------------------------------
+
+
+Changed
+^^^^^^^
+
+* Fixed deprecated usage of the ``matplotilb.cm.cmap_d`` colour map
+  dictionary.
+
+
+1.7.2 (Saturday March 27th 2021)
 --------------------------------
 
 

README.rst

@@ -69,6 +69,9 @@ Dependencies for running the tests and building documentation are listed in the
 Documentation
 -------------
 
+The ``fsleyes-props`` API documentation is hosted at
+https://open.win.ox.ac.uk/pages/fsl/fsleyes/props/.
+
 ``fsleyes-props`` is documented using `sphinx
 <http://http://sphinx-doc.org/>`_. You can build the API documentation by
 running::

doc/conf.py

@@ -33,6 +33,7 @@ date = datetime.date.today()
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
     'sphinx.ext.autosummary',
     'sphinx.ext.mathjax',
 #     'sphinxcontrib.restbuilder',

fsleyes_props/cli.py

@@ -193,8 +193,11 @@ import logging
 import sys
 import argparse
 
-from . import properties       as props
-from . import properties_types as ptypes
+import matplotlib.pyplot as plt
+import matplotlib.cm     as mplcm
+
+import fsleyes_props.properties       as props
+import fsleyes_props.properties_types as ptypes
 
 
 log = logging.getLogger(__name__)
@@ -205,7 +208,6 @@ class SkipArgument(Exception):
     by :func:`applyArguments` and :func:`generateArguments` to indicate
     that the arguemnt should be skipped (i.e. not applied, or not generated).
     """
-    pass
 
 
 def _String(parser,
@@ -480,24 +482,21 @@ def _ColourMap(parser,
     def parse(cmapName):
         try:
 
-            import matplotlib.cm as mplcm
-
-            cmapKeys   = list(mplcm.cmap_d.keys())
-            cmapNames  = [mplcm.cmap_d[k].name for k in cmapKeys]
+            cmapKeys   = plt.colormaps()
+            cmapNames  = [mplcm.get_cmap(cm).name for cm in cmapKeys]
 
             lCmapNames = [s.lower() for s in cmapNames]
             lCmapKeys  = [s.lower() for s in cmapKeys]
+            cmapName   = cmapName.lower()
 
-            cmapName = cmapName.lower()
-
-            try:    idx = lCmapKeys .index(cmapName)
-            except: idx = lCmapNames.index(cmapName)
+            try:               idx = lCmapKeys .index(cmapName)
+            except ValueError: idx = lCmapNames.index(cmapName)
 
             cmapName = cmapKeys[idx]
 
             return mplcm.get_cmap(cmapName)
 
-        except:
+        except Exception:
             raise argparse.ArgumentTypeError(
                 'Unknown colour map: {}'.format(cmapName))
 

fsleyes_props/properties_types.py

@@ -33,8 +33,8 @@ added as attributes of a :class:`.HasProperties` class definition.
 
 import os.path as op
 
-from collections import abc
-
+import matplotlib.pyplot as plt
+import matplotlib.cm     as mplcm
 import matplotlib.colors as mplcolors
 import numpy             as np
 
@@ -892,7 +892,6 @@ class ColourMap(props.PropertyBase):
         matplotlib :class:`.Colormap` instance.
         """
 
-        import matplotlib.colors as mplcolors
         if not isinstance(value, mplcolors.Colormap):
             raise ValueError('Colour map value is not a '
                              'matplotlib.colors.Colormap instance')
@@ -909,26 +908,19 @@ class ColourMap(props.PropertyBase):
 
         if isinstance(value, str):
 
-            import matplotlib.cm as mplcm
-
-            # Case insensitive match
-            cmapKeys   = list(mplcm.cmap_d.keys())
-            cmapNames  = [cm.name for cm in mplcm.cmap_d.values()]
+            # Case insensitive match against either
+            # the registered colourmap key, or the
+            # colourmap name
+            cmapKeys   = plt.colormaps()
+            cmapNames  = [mplcm.get_cmap(cm).name for cm in cmapKeys]
 
             lCmapNames = [s.lower() for s in cmapNames]
             lCmapKeys  = [s.lower() for s in cmapKeys]
+            value      = value.lower()
+            idx        = None
 
-            value = value.lower()
-
-            try:
-                idx = lCmapKeys .index(value)
-            except ValueError:
-                idx = None
-
-            try:
-                idx = lCmapNames.index(value)
-            except ValueError:
-                idx = None
+            try:               idx = lCmapKeys .index(value)
+            except ValueError: idx = lCmapNames.index(value)
 
             if idx is None:
                 raise ValueError('Unknown colour map ({}) - valid choices '