From 660fbb19335f772cd5ed8215fd0e7c0969965919 Mon Sep 17 00:00:00 2001 From: ijmbarr Date: Sat, 10 Mar 2018 14:57:02 +0100 Subject: [PATCH 1/5] DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta --- pandas/core/indexes/accessors.py | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/pandas/core/indexes/accessors.py b/pandas/core/indexes/accessors.py index c5b300848876e..99be8c008e5dd 100644 --- a/pandas/core/indexes/accessors.py +++ b/pandas/core/indexes/accessors.py @@ -157,6 +157,30 @@ class TimedeltaProperties(Properties): """ def to_pytimedelta(self): + """ + Return an array of the Timedeltas in `datetime.timedelta` format with + the same length as the original Series. + + Returns + ------- + a : numpy.ndarray + 1D array containing data with `datetime.timedelta` type + + Examples + -------- + >>> s = pd.Series(pd.to_timedelta(np.arange(5), unit='d')) + >>> s + 0 0 days + 1 1 days + 2 2 days + 3 3 days + 4 4 days + dtype: timedelta64[ns] + >>> s.dt.to_pytimedelta() + array([datetime.timedelta(0), datetime.timedelta(1), + datetime.timedelta(2), datetime.timedelta(3), + datetime.timedelta(4)], dtype=object) + """ return self._get_values().to_pytimedelta() @property From 2aa395b26784ddc07a73bdf29774de47527b1c1d Mon Sep 17 00:00:00 2001 From: ijmbarr Date: Sat, 10 Mar 2018 15:46:21 +0100 Subject: [PATCH 2/5] DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta --- pandas/core/indexes/accessors.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/pandas/core/indexes/accessors.py b/pandas/core/indexes/accessors.py index 99be8c008e5dd..b581c101f6ccd 100644 --- a/pandas/core/indexes/accessors.py +++ b/pandas/core/indexes/accessors.py @@ -158,13 +158,15 @@ class TimedeltaProperties(Properties): def to_pytimedelta(self): """ + Return array of Timedeltas as `datetime.timedelta`. + Return an array of the Timedeltas in `datetime.timedelta` format with the same length as the original Series. Returns ------- a : numpy.ndarray - 1D array containing data with `datetime.timedelta` type + 1D array containing data with `datetime.timedelta` type. Examples -------- From 18d67b607fec051c5b5c87360ddcaed329945d6f Mon Sep 17 00:00:00 2001 From: ijmbarr Date: Sat, 10 Mar 2018 19:06:52 +0100 Subject: [PATCH 3/5] DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta --- pandas/core/indexes/accessors.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/pandas/core/indexes/accessors.py b/pandas/core/indexes/accessors.py index b581c101f6ccd..24d7ec4877cc8 100644 --- a/pandas/core/indexes/accessors.py +++ b/pandas/core/indexes/accessors.py @@ -160,7 +160,9 @@ def to_pytimedelta(self): """ Return array of Timedeltas as `datetime.timedelta`. - Return an array of the Timedeltas in `datetime.timedelta` format with + Python's standard `datetime` library uses a different representation to + what pandas for differences between times. This method converts a Series + of pandas Timedeltas to `datetime.timedelta` format with the same length as the original Series. Returns @@ -178,10 +180,15 @@ def to_pytimedelta(self): 3 3 days 4 4 days dtype: timedelta64[ns] + >>> s.dt.to_pytimedelta() array([datetime.timedelta(0), datetime.timedelta(1), datetime.timedelta(2), datetime.timedelta(3), datetime.timedelta(4)], dtype=object) + + See Also + -------- + datetime.timedelta """ return self._get_values().to_pytimedelta() From c490ef4442622439fdb9a65a6d5a902eb198c002 Mon Sep 17 00:00:00 2001 From: ijmbarr Date: Sat, 10 Mar 2018 19:09:35 +0100 Subject: [PATCH 4/5] DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta --- pandas/core/indexes/accessors.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pandas/core/indexes/accessors.py b/pandas/core/indexes/accessors.py index 24d7ec4877cc8..67913cba80007 100644 --- a/pandas/core/indexes/accessors.py +++ b/pandas/core/indexes/accessors.py @@ -161,8 +161,8 @@ def to_pytimedelta(self): Return array of Timedeltas as `datetime.timedelta`. Python's standard `datetime` library uses a different representation to - what pandas for differences between times. This method converts a Series - of pandas Timedeltas to `datetime.timedelta` format with + what pandas for differences between times. This method converts a + Series of pandas Timedeltas to `datetime.timedelta` format with the same length as the original Series. Returns From 48ca62c44def96b51014580fa6ae1809bb53f415 Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Sat, 17 Mar 2018 13:09:30 +0100 Subject: [PATCH 5/5] Update accessors.py --- pandas/core/indexes/accessors.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/pandas/core/indexes/accessors.py b/pandas/core/indexes/accessors.py index 67913cba80007..8e61edd6c4029 100644 --- a/pandas/core/indexes/accessors.py +++ b/pandas/core/indexes/accessors.py @@ -158,12 +158,12 @@ class TimedeltaProperties(Properties): def to_pytimedelta(self): """ - Return array of Timedeltas as `datetime.timedelta`. + Return an array of native `datetime.timedelta` objects. - Python's standard `datetime` library uses a different representation to - what pandas for differences between times. This method converts a - Series of pandas Timedeltas to `datetime.timedelta` format with - the same length as the original Series. + Python's standard `datetime` library uses a different representation + timedelta's. This method converts a Series of pandas Timedeltas + to `datetime.timedelta` format with the same length as the original + Series. Returns -------