Skip to content

daft.functions.quarter#

quarter #

quarter(expr: Expression) -> Expression

Retrieves the quarter for a datetime column.

Returns:

Name Type Description
Expression Expression

a UInt32 expression with just the quarter 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 quarter
>>> df = daft.from_pydict(
...     {
...         "datetime": [
...             datetime.datetime(2024, 1, 1, 0, 0, 0),
...             datetime.datetime(2023, 7, 4, 0, 0, 0),
...             datetime.datetime(2022, 12, 5, 0, 0, 0),
...         ],
...     }
... )
>>> df.with_column("quarter", quarter(df["datetime"])).collect()
╭─────────────────────┬─────────╮
│ datetime            ┆ quarter │
│ ---                 ┆ ---     │
│ Timestamp[us]       ┆ UInt32  │
╞═════════════════════╪═════════╡
│ 2024-01-01 00:00:00 ┆ 1       │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┤
│ 2023-07-04 00:00:00 ┆ 3       │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┤
│ 2022-12-05 00:00:00 ┆ 4       │
╰─────────────────────┴─────────╯
(Showing first 3 of 3 rows)
Source code in daft/functions/datetime.py
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
def quarter(expr: Expression) -> Expression:
    """Retrieves the quarter for a datetime column.

    Returns:
        Expression: a UInt32 expression with just the quarter extracted from a datetime column

    Examples:
        >>> import datetime
        >>> import daft
        >>> from daft.functions import quarter
        >>> df = daft.from_pydict(
        ...     {
        ...         "datetime": [
        ...             datetime.datetime(2024, 1, 1, 0, 0, 0),
        ...             datetime.datetime(2023, 7, 4, 0, 0, 0),
        ...             datetime.datetime(2022, 12, 5, 0, 0, 0),
        ...         ],
        ...     }
        ... )
        >>> df.with_column("quarter", quarter(df["datetime"])).collect()
        ╭─────────────────────┬─────────╮
        │ datetime            ┆ quarter │
        │ ---                 ┆ ---     │
        │ Timestamp[us]       ┆ UInt32  │
        ╞═════════════════════╪═════════╡
        │ 2024-01-01 00:00:00 ┆ 1       │
        ├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┤
        │ 2023-07-04 00:00:00 ┆ 3       │
        ├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┤
        │ 2022-12-05 00:00:00 ┆ 4       │
        ╰─────────────────────┴─────────╯
        <BLANKLINE>
        (Showing first 3 of 3 rows)

    """
    return Expression._call_builtin_scalar_fn("quarter", expr)