MAINT: Move round_trip_pickle outside of TestCase

Author: gfyoung

pandas/tests/core/dtypes/test_dtypes.py

@@ -40,7 +40,7 @@ def f():
         self.assertNotEqual(np.str_, self.dtype)
 
     def test_pickle(self):
-        result = self.round_trip_pickle(self.dtype)
+        result = tm.round_trip_pickle(self.dtype)
         self.assertEqual(result, self.dtype)
 
 

pandas/tests/core/sparse/test_array.py

@@ -562,7 +562,7 @@ def _check_inplace_op(op):
 
     def test_pickle(self):
         def _check_roundtrip(obj):
-            unpickled = self.round_trip_pickle(obj)
+            unpickled = tm.round_trip_pickle(obj)
             tm.assert_sp_array_equal(unpickled, obj)
 
         _check_roundtrip(self.arr)

pandas/tests/core/sparse/test_frame.py

@@ -278,7 +278,7 @@ def test_array_interface(self):
     def test_pickle(self):
 
         def _test_roundtrip(frame, orig):
-            result = self.round_trip_pickle(frame)
+            result = tm.round_trip_pickle(frame)
             tm.assert_sp_frame_equal(frame, result)
             tm.assert_frame_equal(result.to_dense(), orig, check_dtype=False)
 

pandas/tests/core/sparse/test_series.py

@@ -390,7 +390,7 @@ def test_to_frame(self):
 
     def test_pickle(self):
         def _test_roundtrip(series):
-            unpickled = self.round_trip_pickle(series)
+            unpickled = tm.round_trip_pickle(series)
             tm.assert_sp_series_equal(series, unpickled)
             tm.assert_series_equal(series.to_dense(), unpickled.to_dense())
 

pandas/tests/frame/test_block_internals.py

@@ -350,18 +350,18 @@ def test_copy(self):
         self.assertIsNot(copy._data, self.mixed_frame._data)
 
     def test_pickle(self):
-        unpickled = self.round_trip_pickle(self.mixed_frame)
+        unpickled = tm.round_trip_pickle(self.mixed_frame)
         assert_frame_equal(self.mixed_frame, unpickled)
 
         # buglet
         self.mixed_frame._data.ndim
 
         # empty
-        unpickled = self.round_trip_pickle(self.empty)
+        unpickled = tm.round_trip_pickle(self.empty)
         repr(unpickled)
 
         # tz frame
-        unpickled = self.round_trip_pickle(self.tzframe)
+        unpickled = tm.round_trip_pickle(self.tzframe)
         assert_frame_equal(self.tzframe, unpickled)
 
     def test_consolidate_datetime64(self):

pandas/tests/frame/test_subclass.py

@@ -85,7 +85,7 @@ def test_dataframe_metadata(self):
         self.assertEqual(df.iloc[0:1, :].testattr, 'XXX')
 
         # GH10553
-        unpickled = self.round_trip_pickle(df)
+        unpickled = tm.round_trip_pickle(df)
         tm.assert_frame_equal(df, unpickled)
         self.assertEqual(df._metadata, unpickled._metadata)
         self.assertEqual(df.testattr, unpickled.testattr)

pandas/tests/indexes/common.py

@@ -28,7 +28,7 @@ def setup_indices(self):
             setattr(self, name, idx)
 
     def verify_pickle(self, index):
-        unpickled = self.round_trip_pickle(index)
+        unpickled = tm.round_trip_pickle(index)
         self.assertTrue(index.equals(unpickled))
 
     def test_pickle_compat_construction(self):

pandas/tests/indexes/datetimes/test_datetime.py

@@ -106,7 +106,7 @@ def test_roundtrip_pickle_with_tz(self):
         # GH 8367
         # round-trip of timezone
         index = date_range('20130101', periods=3, tz='US/Eastern', name='foo')
-        unpickled = self.round_trip_pickle(index)
+        unpickled = tm.round_trip_pickle(index)
         self.assert_index_equal(index, unpickled)
 
     def test_reindex_preserves_tz_if_target_is_empty_list_or_array(self):

pandas/tests/indexes/datetimes/test_ops.py

@@ -1121,7 +1121,7 @@ def test_comparison(self):
         self.assertFalse(comp[9])
 
     def test_pickle_unpickle(self):
-        unpickled = self.round_trip_pickle(self.rng)
+        unpickled = tm.round_trip_pickle(self.rng)
         self.assertIsNotNone(unpickled.offset)
 
     def test_copy(self):
@@ -1272,7 +1272,7 @@ def test_shift(self):
             self.assertEqual(shifted[0], rng[0] + CDay())
 
     def test_pickle_unpickle(self):
-        unpickled = self.round_trip_pickle(self.rng)
+        unpickled = tm.round_trip_pickle(self.rng)
         self.assertIsNotNone(unpickled.offset)
 
     def test_summary(self):

pandas/tests/indexes/period/test_period.py

@@ -58,7 +58,7 @@ def test_pickle_compat_construction(self):
     def test_pickle_round_trip(self):
         for freq in ['D', 'M', 'Y']:
             idx = PeriodIndex(['2016-05-16', 'NaT', NaT, np.NaN], freq='D')
-            result = self.round_trip_pickle(idx)
+            result = tm.round_trip_pickle(idx)
             tm.assert_index_equal(result, idx)
 
     def test_get_loc(self):
@@ -761,7 +761,7 @@ def test_append_concat(self):
     def test_pickle_freq(self):
         # GH2891
         prng = period_range('1/1/2011', '1/1/2012', freq='M')
-        new_prng = self.round_trip_pickle(prng)
+        new_prng = tm.round_trip_pickle(prng)
         self.assertEqual(new_prng.freq, offsets.MonthEnd())
         self.assertEqual(new_prng.freqstr, 'M')
 

pandas/tests/indexes/test_multi.py

@@ -1044,7 +1044,7 @@ def test_roundtrip_pickle_with_tz(self):
             [[1, 2], ['a', 'b'], date_range('20130101', periods=3,
                                             tz='US/Eastern')
              ], names=['one', 'two', 'three'])
-        unpickled = self.round_trip_pickle(index)
+        unpickled = tm.round_trip_pickle(index)
         self.assertTrue(index.equal_levels(unpickled))
 
     def test_from_tuples_index_values(self):

pandas/tests/indexes/timedeltas/test_timedelta.py

@@ -454,7 +454,7 @@ def test_pass_TimedeltaIndex_to_index(self):
     def test_pickle(self):
 
         rng = timedelta_range('1 days', periods=10)
-        rng_p = self.round_trip_pickle(rng)
+        rng_p = tm.round_trip_pickle(rng)
         tm.assert_index_equal(rng, rng_p)
 
     def test_hash_error(self):

pandas/tests/scalar/test_period.py

@@ -909,7 +909,7 @@ def test_multiples(self):
     def test_round_trip(self):
 
         p = Period('2000Q1')
-        new_p = self.round_trip_pickle(p)
+        new_p = tm.round_trip_pickle(p)
         self.assertEqual(new_p, p)
 
 

pandas/tests/scalar/test_timedelta.py

@@ -559,7 +559,7 @@ def test_overflow(self):
     def test_pickle(self):
 
         v = Timedelta('1 days 10:11:12.0123456')
-        v_p = self.round_trip_pickle(v)
+        v_p = tm.round_trip_pickle(v)
         self.assertEqual(v, v_p)
 
     def test_timedelta_hash_equality(self):

pandas/tests/series/test_io.py

@@ -134,7 +134,7 @@ def test_timeseries_periodindex(self):
         from pandas import period_range
         prng = period_range('1/1/2011', '1/1/2012', freq='M')
         ts = Series(np.random.randn(len(prng)), prng)
-        new_ts = self.round_trip_pickle(ts)
+        new_ts = tm.round_trip_pickle(ts)
         self.assertEqual(new_ts.index.freq, 'M')
 
     def test_pickle_preserve_name(self):

pandas/tests/series/test_timeseries.py

@@ -827,19 +827,19 @@ def test_asfreq_resample_set_correct_freq(self):
     def test_pickle(self):
 
         # GH4606
-        p = self.round_trip_pickle(NaT)
+        p = tm.round_trip_pickle(NaT)
         self.assertTrue(p is NaT)
 
         idx = pd.to_datetime(['2013-01-01', NaT, '2014-01-06'])
-        idx_p = self.round_trip_pickle(idx)
+        idx_p = tm.round_trip_pickle(idx)
         self.assertTrue(idx_p[0] == idx[0])
         self.assertTrue(idx_p[1] is NaT)
         self.assertTrue(idx_p[2] == idx[2])
 
         # GH11002
         # don't infer freq
         idx = date_range('1750-1-1', '2050-1-1', freq='7D')
-        idx_p = self.round_trip_pickle(idx)
+        idx_p = tm.round_trip_pickle(idx)
         tm.assert_index_equal(idx, idx_p)
 
     def test_setops_preserve_freq(self):

pandas/tests/test_multilevel.py

@@ -179,7 +179,7 @@ def _check_op(opname):
 
     def test_pickle(self):
         def _test_roundtrip(frame):
-            unpickled = self.round_trip_pickle(frame)
+            unpickled = tm.round_trip_pickle(frame)
             tm.assert_frame_equal(frame, unpickled)
 
         _test_roundtrip(self.frame)

pandas/tests/test_panel.py

@@ -43,7 +43,7 @@ class PanelTests(object):
 
     def test_pickle(self):
         with catch_warnings(record=True):
-            unpickled = self.round_trip_pickle(self.panel)
+            unpickled = tm.round_trip_pickle(self.panel)
             assert_frame_equal(unpickled['ItemA'], self.panel['ItemA'])
 
     def test_rank(self):

pandas/tests/tseries/test_offsets.py

@@ -1906,7 +1906,7 @@ def test_calendar(self):
 
     def test_roundtrip_pickle(self):
         def _check_roundtrip(obj):
-            unpickled = self.round_trip_pickle(obj)
+            unpickled = tm.round_trip_pickle(obj)
             self.assertEqual(unpickled, obj)
 
         _check_roundtrip(self.offset)
@@ -1967,7 +1967,7 @@ def test_offsets_compare_equal(self):
 
     def test_roundtrip_pickle(self):
         def _check_roundtrip(obj):
-            unpickled = self.round_trip_pickle(obj)
+            unpickled = tm.round_trip_pickle(obj)
             self.assertEqual(unpickled, obj)
 
         _check_roundtrip(self._object())

pandas/util/testing.py

@@ -92,9 +92,6 @@ def setUpClass(cls):
     def tearDownClass(cls):
         pass
 
-    def round_trip_pickle(self, obj, path=None):
-        return round_trip_pickle(obj, path=path)
-
     # https://docs.python.org/3/library/unittest.html#deprecated-aliases
     def assertEquals(self, *args, **kwargs):
         return deprecate('assertEquals',
@@ -126,6 +123,22 @@ def reset_display_options():
 
 
 def round_trip_pickle(obj, path=None):
+    """
+    Pickle an object and then read it again.
+
+    Parameters
+    ----------
+    obj : pandas object
+        The object to pickle and then re-read.
+    path : str, default None
+        The path where the pickled object is written and then read.
+
+    Returns
+    -------
+    round_trip_pickled_object : pandas object
+        The original object that was pickled and then re-read.
+    """
+
     if path is None:
         path = u('__%s__.pickle' % rands(10))
     with ensure_clean(path) as path: