BUG: small API change in Series.clip arg order, enable np.clip to be used also, GH #272

Author: wesm

RELEASE.rst

@@ -55,6 +55,9 @@ feedback on the library.
   - Deprecated `nanRep` argument in various `to_string` and `to_csv` functions
     in favor of `na_rep`. Will be removed in 0.6 (GH #275)
   - Renamed `delimiter` to `sep` in `DataFrame.from_csv` for consistency
+  - Changed order of `Series.clip` arguments to match those of `numpy.clip` and
+    added (unimplemented) `out` argument so `numpy.clip` can be called on a
+    Series (GH #272)
   - Series functions renamed (and thus deprecated) in 0.4 series have been
     removed:
 

pandas/core/series.py

@@ -967,7 +967,7 @@ def autocorr(self):
         """
         return self.corr(self.shift(1))
 
-    def clip(self, upper=None, lower=None):
+    def clip(self, lower=None, upper=None, out=None):
         """
         Trim values at input threshold(s)
 
@@ -980,6 +980,9 @@ def clip(self, upper=None, lower=None):
         -------
         clipped : Series
         """
+        if out is not None:  # pragma: no cover
+            raise Exception('out argument is not supported yet')
+
         result = self
         if lower is not None:
             result = result.clip_lower(lower)

pandas/tests/test_series.py

@@ -843,6 +843,11 @@ def test_clip(self):
         self.assertEqual(self.ts.clip(lower=val).min(), val)
         self.assertEqual(self.ts.clip(upper=val).max(), val)
 
+        result = self.ts.clip(-0.5, 0.5)
+        expected = np.clip(self.ts, -0.5, 0.5)
+        assert_series_equal(result, expected)
+        self.assert_(isinstance(expected, Series))
+
     def test_valid(self):
         ts = self.ts.copy()
         ts[::2] = np.NaN