TST: test deprecated mode names give identical result

update doctests to reflect new order of modes list

make test_dwt_coeff_len result not depend on order of the modes in list

remove doctest that is a duplication of test_dwt_coeff_len unittest

Author: grlee77

doc/source/regression/dwt-idwt.rst

@@ -74,10 +74,7 @@ extension mode (please refer to the PyWavelets' documentation for the
 :ref:`extension modes <Modes>` available:
 
     >>> pywt.Modes.modes
-    ['zero', 'constant', 'symmetric', 'reflect', 'periodic', 'smooth', 'periodization']
-
-    >>> [int(pywt.dwt_coeff_len(len(x), w.dec_len, mode)) for mode in pywt.Modes.modes]
-    [6, 6, 6, 6, 6, 6, 4]
+    ['zero', 'constant', 'symmetric', 'periodic', 'smooth', 'periodization', 'reflect']
 
 As you see in the above example, the :ref:`periodization <Modes.periodization>`
 (periodization) mode is slightly different from the others. It's aim when

doc/source/regression/modes.rst

@@ -19,7 +19,7 @@ Import :mod:`pywt` first
 List of available signal extension :ref:`modes <Modes>`:
 
     >>> print(pywt.Modes.modes)
-    ['zero', 'constant', 'symmetric', 'reflect', 'periodic', 'smooth', 'periodization']
+    ['zero', 'constant', 'symmetric', 'periodic', 'smooth', 'periodization', 'reflect']
 
 
 Invalid mode name should rise a :exc:`ValueError`:

pywt/tests/test_deprecations.py

@@ -1,4 +1,7 @@
-from numpy.testing import assert_warns
+import warnings
+
+import numpy as np
+from numpy.testing import assert_warns, run_module_suite, assert_array_equal
 
 import pywt
 
@@ -74,3 +77,22 @@ def use_MODES_new():
         return getattr(pywt.MODES, 'symmetric')
 
     assert_warns(DeprecationWarning, use_MODES_new)
+
+
+def test_mode_equivalence():
+    old_new = [('zpd', 'zero'),
+               ('cpd', 'constant'),
+               ('sym', 'symmetric'),
+               ('ppd', 'periodic'),
+               ('sp1', 'smooth'),
+               ('per', 'periodization')]
+    x = np.arange(8.)
+    with warnings.catch_warnings():
+        warnings.simplefilter('ignore', DeprecationWarning)
+        for old, new in old_new:
+            assert_array_equal(pywt.dwt(x, 'db2', mode=old),
+                               pywt.dwt(x, 'db2', mode=new))
+
+
+if __name__ == '__main__':
+    run_module_suite()

pywt/tests/test_dwt_idwt.py

@@ -97,10 +97,14 @@ def test_dwt_coeff_len():
     w = pywt.Wavelet('sym3')
     ln_modes = [pywt.dwt_coeff_len(len(x), w.dec_len, mode) for mode in
                 pywt.Modes.modes]
-    assert_allclose(ln_modes, [6, 6, 6, 6, 6, 6, 4])
+
+    expected_result = [6, ] * len(pywt.Modes.modes)
+    expected_result[pywt.Modes.modes.index('periodization')] = 4
+
+    assert_allclose(ln_modes, expected_result)
     ln_modes = [pywt.dwt_coeff_len(len(x), w, mode) for mode in
                 pywt.Modes.modes]
-    assert_allclose(ln_modes, [6, 6, 6, 6, 6, 6, 4])
+    assert_allclose(ln_modes, expected_result)
 
 
 def test_idwt_none_input():

pywt/tests/test_modes.py

@@ -9,8 +9,8 @@
 
 
 def test_available_modes():
-    modes = ['zero', 'constant', 'symmetric', 'reflect',
-             'periodic', 'smooth', 'periodization']
+    modes = ['zero', 'constant', 'symmetric', 'periodic', 'smooth',
+             'periodization', 'reflect']
     assert_equal(pywt.Modes.modes, modes)
     assert_equal(pywt.Modes.from_object('constant'), 2)