Skip to content

Commit 9dc49d3

Browse files
ijmbarrjorisvandenbossche
authored andcommitted
DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta (#20142)
1 parent e902764 commit 9dc49d3

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

pandas/core/indexes/accessors.py

+33
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,39 @@ class TimedeltaProperties(Properties):
200200
"""
201201

202202
def to_pytimedelta(self):
203+
"""
204+
Return an array of native `datetime.timedelta` objects.
205+
206+
Python's standard `datetime` library uses a different representation
207+
timedelta's. This method converts a Series of pandas Timedeltas
208+
to `datetime.timedelta` format with the same length as the original
209+
Series.
210+
211+
Returns
212+
-------
213+
a : numpy.ndarray
214+
1D array containing data with `datetime.timedelta` type.
215+
216+
Examples
217+
--------
218+
>>> s = pd.Series(pd.to_timedelta(np.arange(5), unit='d'))
219+
>>> s
220+
0 0 days
221+
1 1 days
222+
2 2 days
223+
3 3 days
224+
4 4 days
225+
dtype: timedelta64[ns]
226+
227+
>>> s.dt.to_pytimedelta()
228+
array([datetime.timedelta(0), datetime.timedelta(1),
229+
datetime.timedelta(2), datetime.timedelta(3),
230+
datetime.timedelta(4)], dtype=object)
231+
232+
See Also
233+
--------
234+
datetime.timedelta
235+
"""
203236
return self._get_values().to_pytimedelta()
204237

205238
@property

0 commit comments

Comments
 (0)