polars.date_range#

polars.date_range(
start: date | datetime | IntoExprColumn,
end: date | datetime | IntoExprColumn,
interval: str | timedelta = '1d',
*,
closed: ClosedInterval = 'both',
time_unit: TimeUnit | None = None,
time_zone: str | None = None,
eager: Literal[False] = False,
name: str | None = None,
) → Expr[source]#
polars.date_range(
start: date | datetime | IntoExprColumn,
end: date | datetime | IntoExprColumn,
interval: str | timedelta = '1d',
*,
closed: ClosedInterval = 'both',
time_unit: TimeUnit | None = None,
time_zone: str | None = None,
eager: Literal[True],
name: str | None = None,
) → Series
polars.date_range(
start: date | datetime | IntoExprColumn,
end: date | datetime | IntoExprColumn,
interval: str | timedelta = '1d',
*,
closed: ClosedInterval = 'both',
time_unit: TimeUnit | None = None,
time_zone: str | None = None,
eager: bool,
name: str | None = None,
) → Series | Expr

Generate a date range.

Parameters:
start

Lower bound of the date range.

end

Upper bound of the date range.

interval

Interval of the range periods, specified as a Python timedelta object or using the Polars duration string language (see “Notes” section below).

closed{‘both’, ‘left’, ‘right’, ‘none’}

Define which sides of the range are closed (inclusive).

time_unit{None, ‘ns’, ‘us’, ‘ms’}

Time unit of the resulting Datetime data type. Only takes effect if the output column is of type Datetime.

time_zone

Time zone of the resulting Datetime data type. Only takes effect if the output column is of type Datetime.

eager

Evaluate immediately and return a Series. If set to False (default), return an expression instead.

name

Name of the output column.

Deprecated since version 0.18.0: This argument is deprecated. Use the alias method instead.

Returns:
Expr or Series

Column of data type Date or Datetime.

Notes

  1. If both start and end are passed as date types (not datetime), and the interval granularity is no finer than 1d, the returned range is also of type date. All other permutations return a datetime Series.

    Deprecated since version 0.19.3: In a future version of Polars, date_range will always return a Date. Please use datetime_range() if you want a Datetime instead.

  2. interval is created according to the following string language:

    • 1ns (1 nanosecond)

    • 1us (1 microsecond)

    • 1ms (1 millisecond)

    • 1s (1 second)

    • 1m (1 minute)

    • 1h (1 hour)

    • 1d (1 calendar day)

    • 1w (1 calendar week)

    • 1mo (1 calendar month)

    • 1q (1 calendar quarter)

    • 1y (1 calendar year)

    Or combine them: “3d12h4m25s” # 3 days, 12 hours, 4 minutes, and 25 seconds

    By “calendar day”, we mean the corresponding time on the next day (which may not be 24 hours, due to daylight savings). Similarly for “calendar week”, “calendar month”, “calendar quarter”, and “calendar year”.

Examples

Using Polars duration string to specify the interval:

>>> from datetime import date
>>> pl.date_range(date(2022, 1, 1), date(2022, 3, 1), "1mo", eager=True)
shape: (3,)
Series: 'date' [date]
[
    2022-01-01
    2022-02-01
    2022-03-01
]

Using timedelta object to specify the interval:

>>> from datetime import timedelta
>>> pl.date_range(
...     date(1985, 1, 1),
...     date(1985, 1, 10),
...     timedelta(days=2),
...     eager=True,
... )
shape: (5,)
Series: 'date' [date]
[
    1985-01-01
    1985-01-03
    1985-01-05
    1985-01-07
    1985-01-09
]