|
| 1 | +from __future__ import annotations |
| 2 | + |
| 3 | +from datetime import date, datetime, time |
| 4 | +from typing import TYPE_CHECKING |
| 5 | +from zoneinfo import ZoneInfo |
| 6 | + |
| 7 | +import pytest |
| 8 | + |
| 9 | +import polars as pl |
| 10 | +from polars.exceptions import ComputeError, InvalidOperationError |
| 11 | +from polars.testing import assert_frame_equal |
| 12 | + |
| 13 | +if TYPE_CHECKING: |
| 14 | + from polars._typing import TimeUnit |
| 15 | + |
| 16 | + |
| 17 | +@pytest.mark.parametrize( |
| 18 | + ("dt", "expected"), |
| 19 | + [ |
| 20 | + (datetime(2022, 3, 15, 3), datetime(2022, 3, 1, 3)), |
| 21 | + (datetime(2022, 3, 15, 3, 2, 1, 123000), datetime(2022, 3, 1, 3, 2, 1, 123000)), |
| 22 | + (datetime(2022, 3, 15), datetime(2022, 3, 1)), |
| 23 | + (datetime(2022, 3, 1), datetime(2022, 3, 1)), |
| 24 | + ], |
| 25 | +) |
| 26 | +@pytest.mark.parametrize( |
| 27 | + ("tzinfo", "time_zone"), |
| 28 | + [ |
| 29 | + (None, None), |
| 30 | + (ZoneInfo("Asia/Kathmandu"), "Asia/Kathmandu"), |
| 31 | + ], |
| 32 | +) |
| 33 | +@pytest.mark.parametrize("time_unit", ["ms", "us", "ns"]) |
| 34 | +def test_month_start_datetime( |
| 35 | + dt: datetime, |
| 36 | + expected: datetime, |
| 37 | + time_unit: TimeUnit, |
| 38 | + tzinfo: ZoneInfo | None, |
| 39 | + time_zone: str | None, |
| 40 | +) -> None: |
| 41 | + ser = pl.Series([dt]).dt.replace_time_zone(time_zone).dt.cast_time_unit(time_unit) |
| 42 | + result = ser.dt.month_start().item() |
| 43 | + assert result == expected.replace(tzinfo=tzinfo) |
| 44 | + |
| 45 | + |
| 46 | +@pytest.mark.parametrize( |
| 47 | + ("dt", "expected"), |
| 48 | + [ |
| 49 | + (date(2022, 3, 15), date(2022, 3, 1)), |
| 50 | + (date(2022, 3, 31), date(2022, 3, 1)), |
| 51 | + ], |
| 52 | +) |
| 53 | +def test_month_start_date(dt: date, expected: date) -> None: |
| 54 | + ser = pl.Series([dt]) |
| 55 | + result = ser.dt.month_start().item() |
| 56 | + assert result == expected |
| 57 | + |
| 58 | + |
| 59 | +@pytest.mark.parametrize( |
| 60 | + ("dt", "expected"), |
| 61 | + [ |
| 62 | + (datetime(2022, 3, 15, 3), datetime(2022, 3, 31, 3)), |
| 63 | + ( |
| 64 | + datetime(2022, 3, 15, 3, 2, 1, 123000), |
| 65 | + datetime(2022, 3, 31, 3, 2, 1, 123000), |
| 66 | + ), |
| 67 | + (datetime(2022, 3, 15), datetime(2022, 3, 31)), |
| 68 | + (datetime(2022, 3, 31), datetime(2022, 3, 31)), |
| 69 | + ], |
| 70 | +) |
| 71 | +@pytest.mark.parametrize( |
| 72 | + ("tzinfo", "time_zone"), |
| 73 | + [ |
| 74 | + (None, None), |
| 75 | + (ZoneInfo("Asia/Kathmandu"), "Asia/Kathmandu"), |
| 76 | + ], |
| 77 | +) |
| 78 | +@pytest.mark.parametrize("time_unit", ["ms", "us", "ns"]) |
| 79 | +def test_month_end_datetime( |
| 80 | + dt: datetime, |
| 81 | + expected: datetime, |
| 82 | + time_unit: TimeUnit, |
| 83 | + tzinfo: ZoneInfo | None, |
| 84 | + time_zone: str | None, |
| 85 | +) -> None: |
| 86 | + ser = pl.Series([dt]).dt.replace_time_zone(time_zone).dt.cast_time_unit(time_unit) |
| 87 | + result = ser.dt.month_end().item() |
| 88 | + assert result == expected.replace(tzinfo=tzinfo) |
| 89 | + |
| 90 | + |
| 91 | +@pytest.mark.parametrize( |
| 92 | + ("dt", "expected"), |
| 93 | + [ |
| 94 | + (date(2022, 3, 15), date(2022, 3, 31)), |
| 95 | + (date(2022, 3, 31), date(2022, 3, 31)), |
| 96 | + ], |
| 97 | +) |
| 98 | +def test_month_end_date(dt: date, expected: date) -> None: |
| 99 | + ser = pl.Series([dt]) |
| 100 | + result = ser.dt.month_end().item() |
| 101 | + assert result == expected |
| 102 | + |
| 103 | + |
| 104 | +def test_month_start_end_invalid() -> None: |
| 105 | + ser = pl.Series([time(1, 2, 3)]) |
| 106 | + with pytest.raises( |
| 107 | + InvalidOperationError, |
| 108 | + match=r"`month_start` operation not supported for dtype `time` \(expected: date/datetime\)", |
| 109 | + ): |
| 110 | + ser.dt.month_start() |
| 111 | + with pytest.raises( |
| 112 | + InvalidOperationError, |
| 113 | + match=r"`month_end` operation not supported for dtype `time` \(expected: date/datetime\)", |
| 114 | + ): |
| 115 | + ser.dt.month_end() |
| 116 | + |
| 117 | + |
| 118 | +def test_month_end_ambiguous_start_24646() -> None: |
| 119 | + dt = datetime(1987, 3, 3, 2, 45, 00, tzinfo=ZoneInfo("Pacific/Chatham")) |
| 120 | + with pytest.raises(ComputeError, match="is ambiguous"): |
| 121 | + pl.DataFrame({"a": [dt]}).select(pl.col("a").dt.month_start()) |
| 122 | + result = pl.DataFrame({"a": [dt]}).select(pl.col("a").dt.month_end()) |
| 123 | + expected = pl.DataFrame({"a": [datetime(1987, 3, 31, 2, 45)]}).with_columns( |
| 124 | + pl.col("a").dt.replace_time_zone("Pacific/Chatham") |
| 125 | + ) |
| 126 | + assert_frame_equal(result, expected) |
| 127 | + |
| 128 | + |
| 129 | +def test_month_end_non_existent_start_24646() -> None: |
| 130 | + # 2015-03-01 00:30 in America/Havana |
| 131 | + dt = datetime(1990, 4, 2, 0, 30, tzinfo=ZoneInfo("America/Havana")) |
| 132 | + with pytest.raises(ComputeError, match="is non-existent"): |
| 133 | + pl.DataFrame({"a": [dt]}).select(pl.col("a").dt.month_start()) |
| 134 | + result = pl.DataFrame({"a": [dt]}).select(pl.col("a").dt.month_end()) |
| 135 | + expected = pl.DataFrame( |
| 136 | + {"a": [datetime(1990, 4, 30, 0, 30, tzinfo=ZoneInfo("America/Havana"))]} |
| 137 | + ) |
| 138 | + assert_frame_equal(result, expected) |
0 commit comments