from great_tables import vals
vals.fmt_date(["2025-01-01", "2025-01-02"], date_style="month_day_year")['January 1, 2025', 'January 2, 2025']vals.fmt_date()
Format values as dates.
Usage
vals.fmt_date(
x,
date_style="iso",
pattern="{x}",
locale=None,
)Format input values to date values using one of 41 preset date styles. Input can be in the form of date type or as a ISO-8601 string (in the form of YYYY-MM-DD HH:MM:SS or YYYY-MM-DD).
Parameters
x: X-
A list of values to be formatted.
date_style: DateStyle = "iso"-
The date style to use. By default this is the short name
"iso"which corresponds to ISO 8601 date formatting. There are 41 date styles in total. pattern: str = "{x}"-
A formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the
{x}(which can be used multiple times, if needed) and all other characters will be interpreted as string literals. locale: str | None = None-
An optional locale identifier that can be used for formatting values according the locale’s rules. Examples include
"en"for English (United States) and"fr"for French (France).
Formatting With The date_style Argument
We need to supply a preset date style to the date_style argument. The date styles are numerous and can handle localization to any supported locale. Those termed flexible adapt their output to any locale= provided, following the locale’s conventions for the order of the fields, the punctuation, and which fields are abbreviated. The following table provides a listing of all date styles and their output values (corresponding to an input date of 2000-02-29).
| Date Style | Output | Notes | |
|---|---|---|---|
| 1 | "iso" |
"2000-02-29" |
ISO 8601 |
| 2 | "wday_month_day_year" |
"Tuesday, February 29, 2000" |
|
| 3 | "wd_m_day_year" |
"Tue, Feb 29, 2000" |
|
| 4 | "wday_day_month_year" |
"Tuesday 29 February 2000" |
|
| 5 | "month_day_year" |
"February 29, 2000" |
|
| 6 | "m_day_year" |
"Feb 29, 2000" |
|
| 7 | "day_m_year" |
"29 Feb 2000" |
|
| 8 | "day_month_year" |
"29 February 2000" |
|
| 9 | "day_month" |
"29 February" |
|
| 10 | "day_m" |
"29 Feb" |
|
| 11 | "year" |
"2000" |
|
| 12 | "month" |
"February" |
|
| 13 | "day" |
"29" |
|
| 14 | "year.mn.day" |
"2000/02/29" |
|
| 15 | "y.mn.day" |
"00/02/29" |
|
| 16 | "year_week" |
"2000-W09" |
ISO 8601 |
| 17 | "year_quarter" |
"2000-Q1" |
|
| 18 | "yMd" |
"2/29/2000" |
flexible |
| 19 | "yMEd" |
"Tue, 2/29/2000" |
flexible |
| 20 | "yMMM" |
"Feb 2000" |
flexible |
| 21 | "yMMMM" |
"February 2000" |
flexible |
| 22 | "yMMMd" |
"Feb 29, 2000" |
flexible |
| 23 | "yMMMEd" |
"Tue, Feb 29, 2000" |
flexible |
| 24 | "GyMd" |
"2/29/2000 AD" |
flexible |
| 25 | "GyMMMd" |
"Feb 29, 2000 AD" |
flexible |
| 26 | "GyMMMEd" |
"Tue, Feb 29, 2000 AD" |
flexible |
| 27 | "yM" |
"2/2000" |
flexible |
| 28 | "Md" |
"2/29" |
flexible |
| 29 | "MEd" |
"Tue, 2/29" |
flexible |
| 30 | "MMMd" |
"Feb 29" |
flexible |
| 31 | "MMMEd" |
"Tue, Feb 29" |
flexible |
| 32 | "MMMMd" |
"February 29" |
flexible |
| 33 | "GyMMM" |
"Feb 2000 AD" |
flexible |
| 34 | "yQQQ" |
"Q1 2000" |
flexible |
| 35 | "yQQQQ" |
"1st quarter 2000" |
flexible |
| 36 | "Gy" |
"2000 AD" |
flexible |
| 37 | "y" |
"2000" |
flexible |
| 38 | "M" |
"2" |
flexible |
| 39 | "MMM" |
"Feb" |
flexible |
| 40 | "d" |
"29" |
flexible |
| 41 | "Ed" |
"29 Tue" |
flexible |
The names of the flexible date styles are CLDR skeletons, where each letter stands for a field: G is the era, y the year, Q the quarter, M the month, d the day of the month, and E the day of the week. A longer run of Q, M, or E gives a longer form of that field.
Returns
list[str]- A list of formatted values is returned.