Retrieves the year for a datetime column.
Returns:
| Name | Type | Description |
Expression | Expression | a Int32 expression with just the year extracted from a datetime column |
Examples:
1
2
3
4
5
6
7
8
9
10
11
12
13 | >>> import datetime
>>> import daft
>>> from daft.functions import year
>>> df = daft.from_pydict(
... {
... "datetime": [
... datetime.datetime(2024, 7, 3, 0, 0, 0),
... datetime.datetime(2023, 7, 4, 0, 0, 0),
... datetime.datetime(2022, 7, 5, 0, 0, 0),
... ],
... }
... )
>>> df.with_column("year", year(df["datetime"])).collect()
|
╭─────────────────────┬───────╮
│ datetime ┆ year │
│ --- ┆ --- │
│ Timestamp[us] ┆ Int32 │
╞═════════════════════╪═══════╡
│ 2024-07-03 00:00:00 ┆ 2024 │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌┤
│ 2023-07-04 00:00:00 ┆ 2023 │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌┤
│ 2022-07-05 00:00:00 ┆ 2022 │
╰─────────────────────┴───────╯
(Showing first 3 of 3 rows)
Source code in daft/functions/datetime.py
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503 | def year(expr: Expression) -> Expression:
"""Retrieves the year for a datetime column.
Returns:
Expression: a Int32 expression with just the year extracted from a datetime column
Examples:
>>> import datetime
>>> import daft
>>> from daft.functions import year
>>> df = daft.from_pydict(
... {
... "datetime": [
... datetime.datetime(2024, 7, 3, 0, 0, 0),
... datetime.datetime(2023, 7, 4, 0, 0, 0),
... datetime.datetime(2022, 7, 5, 0, 0, 0),
... ],
... }
... )
>>> df.with_column("year", year(df["datetime"])).collect()
╭─────────────────────┬───────╮
│ datetime ┆ year │
│ --- ┆ --- │
│ Timestamp[us] ┆ Int32 │
╞═════════════════════╪═══════╡
│ 2024-07-03 00:00:00 ┆ 2024 │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌┤
│ 2023-07-04 00:00:00 ┆ 2023 │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌┤
│ 2022-07-05 00:00:00 ┆ 2022 │
╰─────────────────────┴───────╯
<BLANKLINE>
(Showing first 3 of 3 rows)
"""
return Expression._call_builtin_scalar_fn("year", expr)
|