Skip to content

Commit 82999c8

Browse files
authored
DOC: Added an example for each series.dt field accessor (#33259)
1 parent 8a8544f commit 82999c8

File tree

1 file changed

+128
-0
lines changed

1 file changed

+128
-0
lines changed

pandas/core/arrays/datetimes.py

+128
Original file line numberDiff line numberDiff line change
@@ -1239,55 +1239,183 @@ def date(self):
12391239
"Y",
12401240
"""
12411241
The year of the datetime.
1242+
1243+
Examples
1244+
--------
1245+
>>> datetime_series = pd.Series(
1246+
... pd.date_range("2000-01-01", periods=3, freq="Y")
1247+
... )
1248+
>>> datetime_series
1249+
0 2000-12-31
1250+
1 2001-12-31
1251+
2 2002-12-31
1252+
dtype: datetime64[ns]
1253+
>>> datetime_series.dt.year
1254+
0 2000
1255+
1 2001
1256+
2 2002
1257+
dtype: int64
12421258
""",
12431259
)
12441260
month = _field_accessor(
12451261
"month",
12461262
"M",
12471263
"""
12481264
The month as January=1, December=12.
1265+
1266+
Examples
1267+
--------
1268+
>>> datetime_series = pd.Series(
1269+
... pd.date_range("2000-01-01", periods=3, freq="M")
1270+
... )
1271+
>>> datetime_series
1272+
0 2000-01-31
1273+
1 2000-02-29
1274+
2 2000-03-31
1275+
dtype: datetime64[ns]
1276+
>>> datetime_series.dt.month
1277+
0 1
1278+
1 2
1279+
2 3
1280+
dtype: int64
12491281
""",
12501282
)
12511283
day = _field_accessor(
12521284
"day",
12531285
"D",
12541286
"""
12551287
The day of the datetime.
1288+
1289+
Examples
1290+
--------
1291+
>>> datetime_series = pd.Series(
1292+
... pd.date_range("2000-01-01", periods=3, freq="D")
1293+
... )
1294+
>>> datetime_series
1295+
0 2000-01-01
1296+
1 2000-01-02
1297+
2 2000-01-03
1298+
dtype: datetime64[ns]
1299+
>>> datetime_series.dt.day
1300+
0 1
1301+
1 2
1302+
2 3
1303+
dtype: int64
12561304
""",
12571305
)
12581306
hour = _field_accessor(
12591307
"hour",
12601308
"h",
12611309
"""
12621310
The hours of the datetime.
1311+
1312+
Examples
1313+
--------
1314+
>>> datetime_series = pd.Series(
1315+
... pd.date_range("2000-01-01", periods=3, freq="h")
1316+
... )
1317+
>>> datetime_series
1318+
0 2000-01-01 00:00:00
1319+
1 2000-01-01 01:00:00
1320+
2 2000-01-01 02:00:00
1321+
dtype: datetime64[ns]
1322+
>>> datetime_series.dt.hour
1323+
0 0
1324+
1 1
1325+
2 2
1326+
dtype: int64
12631327
""",
12641328
)
12651329
minute = _field_accessor(
12661330
"minute",
12671331
"m",
12681332
"""
12691333
The minutes of the datetime.
1334+
1335+
Examples
1336+
--------
1337+
>>> datetime_series = pd.Series(
1338+
... pd.date_range("2000-01-01", periods=3, freq="T")
1339+
... )
1340+
>>> datetime_series
1341+
0 2000-01-01 00:00:00
1342+
1 2000-01-01 00:01:00
1343+
2 2000-01-01 00:02:00
1344+
dtype: datetime64[ns]
1345+
>>> datetime_series.dt.minute
1346+
0 0
1347+
1 1
1348+
2 2
1349+
dtype: int64
12701350
""",
12711351
)
12721352
second = _field_accessor(
12731353
"second",
12741354
"s",
12751355
"""
12761356
The seconds of the datetime.
1357+
1358+
Examples
1359+
--------
1360+
>>> datetime_series = pd.Series(
1361+
... pd.date_range("2000-01-01", periods=3, freq="s")
1362+
... )
1363+
>>> datetime_series
1364+
0 2000-01-01 00:00:00
1365+
1 2000-01-01 00:00:01
1366+
2 2000-01-01 00:00:02
1367+
dtype: datetime64[ns]
1368+
>>> datetime_series.dt.second
1369+
0 0
1370+
1 1
1371+
2 2
1372+
dtype: int64
12771373
""",
12781374
)
12791375
microsecond = _field_accessor(
12801376
"microsecond",
12811377
"us",
12821378
"""
12831379
The microseconds of the datetime.
1380+
1381+
Examples
1382+
--------
1383+
>>> datetime_series = pd.Series(
1384+
... pd.date_range("2000-01-01", periods=3, freq="us")
1385+
... )
1386+
>>> datetime_series
1387+
0 2000-01-01 00:00:00.000000
1388+
1 2000-01-01 00:00:00.000001
1389+
2 2000-01-01 00:00:00.000002
1390+
dtype: datetime64[ns]
1391+
>>> datetime_series.dt.microsecond
1392+
0 0
1393+
1 1
1394+
2 2
1395+
dtype: int64
12841396
""",
12851397
)
12861398
nanosecond = _field_accessor(
12871399
"nanosecond",
12881400
"ns",
12891401
"""
12901402
The nanoseconds of the datetime.
1403+
1404+
Examples
1405+
--------
1406+
>>> datetime_series = pd.Series(
1407+
... pd.date_range("2000-01-01", periods=3, freq="ns")
1408+
... )
1409+
>>> datetime_series
1410+
0 2000-01-01 00:00:00.000000000
1411+
1 2000-01-01 00:00:00.000000001
1412+
2 2000-01-01 00:00:00.000000002
1413+
dtype: datetime64[ns]
1414+
>>> datetime_series.dt.nanosecond
1415+
0 0
1416+
1 1
1417+
2 2
1418+
dtype: int64
12911419
""",
12921420
)
12931421
weekofyear = _field_accessor(

0 commit comments

Comments
 (0)