Start eliminating obsolete and temporary rcParams key, numerix.npyma module

efiring · efiring · commit f0a001a4e77b · 2008-12-13T06:20:28.000Z
svn path=/trunk/matplotlib/; revision=6595
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,11 +1,15 @@
+2008-12-12 Preparations to eliminate maskedarray rcParams key: its
+           use will now generate a warning.  Similarly, importing
+           the obsolote numerix.npyma will generate a warning. - EF
+
 2008-12-12 Added support for the numpy.histogram() weights parameter
            to the axes hist() method. Docs taken from numpy - MM
 
 2008-12-12 Fixed warning in hist() with numpy 1.2 - MM
 
 2008-12-12 Removed external packages: configobj and enthought.traits
            which are only required by the experimental traited config
-           and are somewhat out of date. If needed, install them 
+           and are somewhat out of date. If needed, install them
            independently, see:
 
            http://code.enthought.com/projects/traits
diff --git a/lib/matplotlib/config/mplconfig.py b/lib/matplotlib/config/mplconfig.py
@@ -59,7 +59,6 @@ class MPLConfig(TConfig):
     timezone = T.Trait('UTC', pytz.all_timezones)
     datapath = T.Trait(cutils.get_data_path())
     numerix = T.Trait('numpy', 'numpy', 'numeric', 'numarray')
-    maskedarray = T.false
     units = T.false
 
     class backend(TConfig):
@@ -290,7 +289,6 @@ def __init__(self, tconfig):
         'backend' : (self.tconfig.backend, 'use'),
         'backend_fallback' : (self.tconfig.backend, 'fallback'),
         'numerix' : (self.tconfig, 'numerix'),
-        'maskedarray' : (self.tconfig, 'maskedarray'),
         'toolbar' : (self.tconfig, 'toolbar'),
         'datapath' : (self.tconfig, 'datapath'),
         'units' : (self.tconfig, 'units'),
diff --git a/lib/matplotlib/config/rcsetup.py b/lib/matplotlib/config/rcsetup.py
@@ -296,7 +296,6 @@ def __call__(self, s):
 defaultParams = {
     'backend'           : ['WXAgg', validate_backend],
     'numerix'           : ['numpy', validate_numerix],
-    'maskedarray'       : [False, validate_bool],
     'toolbar'           : ['toolbar2', validate_toolbar],
     'datapath'          : [None, validate_path_exists],   # handled by _get_data_path_cached
     'units'             : [False, validate_bool],
diff --git a/lib/matplotlib/numerix/__init__.py b/lib/matplotlib/numerix/__init__.py
@@ -20,7 +20,6 @@
 from matplotlib import rcParams, verbose
 
 which = None, None
-use_maskedarray = None
 
 # First, see if --numarray or --Numeric was specified on the command
 # line:
@@ -31,10 +30,6 @@
              "--NumPy", "--numpy", "--NUMPY", "--Numpy",
              ]:
         which = a[2:], "command line"
-    if a == "--maskedarray":
-        use_maskedarray = True
-    if a == "--ma":
-        use_maskedarray = False
 
 try: del a
 except NameError: pass
@@ -45,11 +40,6 @@
     except KeyError:
         pass
 
-if use_maskedarray is None:
-    try:
-        use_maskedarray = rcParams['maskedarray']
-    except KeyError:
-        use_maskedarray = False
 
 # If all the above fail, default to Numeric. Most likely not used.
 if which[0] is None:
diff --git a/lib/matplotlib/numerix/ma/__init__.py b/lib/matplotlib/numerix/ma/__init__.py
@@ -1,4 +1,4 @@
-from matplotlib.numerix import which, use_maskedarray
+from matplotlib.numerix import which
 
 if which[0] == "numarray":
     from numarray.ma import *
@@ -9,15 +9,10 @@
     nomask = None
     getmaskorNone = getmask
 elif which[0] == "numpy":
-    if use_maskedarray:
-        from maskedarray import *
-        print "using maskedarray"
-    else:
-        try:
-            from numpy.ma import *        # numpy 1.05 and later
-        except ImportError:
-            from numpy.core.ma import *   # earlier
-        #print "using ma"
+    try:
+        from numpy.ma import *        # numpy 1.05 and later
+    except ImportError:
+        from numpy.core.ma import *   # earlier
     def getmaskorNone(obj):
         _msk = getmask(obj)
         if _msk is nomask:
diff --git a/lib/matplotlib/numerix/npyma/__init__.py b/lib/matplotlib/numerix/npyma/__init__.py
@@ -1,11 +1,7 @@
-from matplotlib.numerix import use_maskedarray
+import warnings
 
-if use_maskedarray:
-    from maskedarray import *
-    print "using maskedarray"
-else:
-    try:
-        from numpy.ma import *        # numpy 1.05 and later
-    except ImportError:
-        from numpy.core.ma import *   # earlier
-    #print "using ma"
+warnings.warn("npyma is obsolete and will be removed", DeprecationWarning)
+try:
+    from numpy.ma import *        # numpy 1.05 and later
+except ImportError:
+    from numpy.core.ma import *   # earlier
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -118,6 +118,16 @@ def validate_autolayout(v):
     if v:
         warnings.warn("figure.autolayout is not currently supported")
 
+def validate_maskedarray(v):
+    # 2008/12/12: start warning; later, remove all traces of maskedarray
+    try:
+        if v == 'obsolete':
+            return v
+    except ValueError:
+        pass
+    warnings.warn('rcParams key "maskedarray" is obsolete and has no effect;\n'
+                  ' please delete it from your matplotlibrc file')
+
 class validate_nseq_float:
     def __init__(self, n):
         self.n = n
@@ -311,7 +321,7 @@ def __call__(self, s):
     'backend'           : ['Agg', validate_backend], # agg is certainly present
     'backend_fallback'  : [True, validate_bool], # agg is certainly present
     'numerix'           : ['numpy', validate_numerix],
-    'maskedarray'       : [False, validate_bool],
+    'maskedarray'       : ['obsolete', validate_maskedarray], #to be removed
     'toolbar'           : ['toolbar2', validate_toolbar],
     'datapath'          : [None, validate_path_exists],   # handled by _get_data_path_cached
     'units'             : [False, validate_bool],
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -35,9 +35,6 @@ backend      : %(backend)s
 # you if backend_fallback is True
 #backend_fallback: True
 numerix      : %(numerix)s  # numpy, Numeric or numarray
-#maskedarray : False       # True to use external maskedarray module
-                           # instead of numpy.ma; this is a temporary
-                           # setting for testing maskedarray.
 #interactive  : False      # see http://matplotlib.sourceforge.net/interactive.html
 #toolbar      : toolbar2   # None | classic | toolbar2
 #timezone     : UTC        # a pytz timezone string, eg US/Central or Europe/Paris
