Skip to content

Commit c529f21

Browse files
committed
Merge branch 'docstring_series_to_pydatetime' of https://github.com/priya-gitTest/pandas into docstring_series_to_pydatetime
2 parents afa6c42 + 35ce553 commit c529f21

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

pandas/core/indexes/accessors.py

+37
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,43 @@ class DatetimeProperties(Properties):
126126
"""
127127

128128
def to_pydatetime(self):
129+
"""
130+
Return an ndarray of native Python datetime objects.
131+
132+
Timezone information is retained if present.
133+
134+
Returns
135+
-------
136+
numpy.ndarray
137+
object dtype array containing native Python datetime objects.
138+
139+
Examples
140+
--------
141+
This method is available on both Series with datetime values, under the
142+
``.dt`` accessor, and directly on DatetimeIndex.
143+
144+
**Series**
145+
146+
>>> s = pd.Series(pd.date_range('20180310', periods=2))
147+
>>> s.head()
148+
0 2018-03-10
149+
1 2018-03-11
150+
dtype: datetime64[ns]
151+
152+
>>> s.dt.to_pydatetime()
153+
array([datetime.datetime(2018, 3, 10, 0, 0),
154+
datetime.datetime(2018, 3, 11, 0, 0)], dtype=object)
155+
156+
**DatetimeIndex**
157+
>>> idx = pd.date_range("2018-03-10", periods=2)
158+
>>> idx # doctest: +NORMALIZE_WHITESPACE
159+
DatetimeIndex(['2018-03-10', '2018-03-11'],
160+
dtype='datetime64[ns]', freq='D')
161+
162+
>>> idx.to_pydatetime()
163+
array([datetime.datetime(2018, 3, 10, 0, 0),
164+
datetime.datetime(2018, 3, 11, 0, 0)], dtype=object)
165+
"""
129166
return self._get_values().to_pydatetime()
130167

131168
@property

0 commit comments

Comments
 (0)