TST: Test to_native_types for Period/DatetimeIndex

Author: gfyoung

pandas/indexes/base.py

@@ -1820,7 +1820,26 @@ def _format_with_header(self, header, na_rep='NaN', **kwargs):
         return header + result
 
     def to_native_types(self, slicer=None, **kwargs):
-        """ slice and dice then format """
+        """
+        Format specified values of `self` and return them.
+
+        Parameters
+        ----------
+        slicer : int, array-like
+            An indexer into `self` that specifies which values
+            are used in the formatting process.
+        kwargs : dict
+            Options for specifying how the values should be formatted.
+            These options include the following:
+
+            1) na_rep : str
+                The value that serves as a placeholder for NULL values
+            2) quoting : bool or None
+                Whether or not there are quoted values in `self`
+            3) date_format : str
+                The format used to represent date-like values
+        """
+
         values = self
         if slicer is not None:
             values = values[slicer]

pandas/tests/indexes/datetimes/test_datetime.py

@@ -773,3 +773,43 @@ def test_slice_bounds_empty(self):
         left = empty_idx._maybe_cast_slice_bound('2015-01-02', 'left', 'loc')
         exp = Timestamp('2015-01-02 00:00:00')
         self.assertEqual(left, exp)
+
+    def test_to_native_types(self):
+        index = DatetimeIndex(freq='1D', periods=3, start='2017-01-01')
+
+        # First, with no arguments.
+        expected = np.array(['2017-01-01', '2017-01-02',
+                             '2017-01-03'], dtype=object)
+
+        result = index.to_native_types()
+        tm.assert_numpy_array_equal(result, expected)
+
+        # No NaN values, so na_rep has no effect
+        result = index.to_native_types(na_rep='pandas')
+        tm.assert_numpy_array_equal(result, expected)
+
+        # Make sure slicing works
+        expected = np.array(['2017-01-01', '2017-01-03'], dtype=object)
+
+        result = index.to_native_types([0, 2])
+        tm.assert_numpy_array_equal(result, expected)
+
+        # Make sure date formatting works
+        expected = np.array(['01-2017-01', '01-2017-02',
+                             '01-2017-03'], dtype=object)
+
+        result = index.to_native_types(date_format='%m-%Y-%d')
+        tm.assert_numpy_array_equal(result, expected)
+
+        # NULL object handling should work
+        index = DatetimeIndex(['2017-01-01', pd.NaT, '2017-01-03'])
+        expected = np.array(['2017-01-01', 'NaT', '2017-01-03'], dtype=object)
+
+        result = index.to_native_types()
+        tm.assert_numpy_array_equal(result, expected)
+
+        expected = np.array(['2017-01-01', 'pandas',
+                             '2017-01-03'], dtype=object)
+
+        result = index.to_native_types(na_rep='pandas')
+        tm.assert_numpy_array_equal(result, expected)

pandas/tests/indexes/period/test_period.py

@@ -774,3 +774,44 @@ def test_map(self):
         result = index.map(lambda x: x.ordinal)
         exp = Index([x.ordinal for x in index])
         tm.assert_index_equal(result, exp)
+
+    def test_to_native_types(self):
+        index = PeriodIndex(['2017-01-01', '2017-01-02',
+                             '2017-01-03'], freq='D')
+
+        # First, with no arguments.
+        expected = np.array(['2017-01-01', '2017-01-02',
+                             '2017-01-03'], dtype='<U10')
+
+        result = index.to_native_types()
+        tm.assert_numpy_array_equal(result, expected)
+
+        # No NaN values, so na_rep has no effect
+        result = index.to_native_types(na_rep='pandas')
+        tm.assert_numpy_array_equal(result, expected)
+
+        # Make sure slicing works
+        expected = np.array(['2017-01-01', '2017-01-03'], dtype='<U10')
+
+        result = index.to_native_types([0, 2])
+        tm.assert_numpy_array_equal(result, expected)
+
+        # Make sure date formatting works
+        expected = np.array(['01-2017-01', '01-2017-02',
+                             '01-2017-03'], dtype='<U10')
+
+        result = index.to_native_types(date_format='%m-%Y-%d')
+        tm.assert_numpy_array_equal(result, expected)
+
+        # NULL object handling should work
+        index = PeriodIndex(['2017-01-01', pd.NaT, '2017-01-03'], freq='D')
+        expected = np.array(['2017-01-01', 'NaT', '2017-01-03'], dtype=object)
+
+        result = index.to_native_types()
+        tm.assert_numpy_array_equal(result, expected)
+
+        expected = np.array(['2017-01-01', 'pandas',
+                             '2017-01-03'], dtype=object)
+
+        result = index.to_native_types(na_rep='pandas')
+        tm.assert_numpy_array_equal(result, expected)