""" Tests for offsets.CustomBusinessHour """ from __future__ import annotations from datetime import ( datetime, time as dt_time, ) import numpy as np import pytest from pandas._libs.tslibs import Timestamp from pandas._libs.tslibs.offsets import ( BusinessHour, CustomBusinessHour, Nano, ) from pandas.tests.tseries.offsets.common import assert_offset_equal from pandas.tseries.holiday import USFederalHolidayCalendar holidays = ["2014-06-27", datetime(2014, 6, 30), np.datetime64("2014-07-02")] @pytest.fixture def dt(): return datetime(2014, 7, 1, 10, 00) @pytest.fixture def _offset(): return CustomBusinessHour # 2014 Calendar to check custom holidays # Sun Mon Tue Wed Thu Fri Sat # 6/22 23 24 25 26 27 28 # 29 30 7/1 2 3 4 5 # 6 7 8 9 10 11 12 @pytest.fixture def offset1(): return CustomBusinessHour(weekmask="Tue Wed Thu Fri") @pytest.fixture def offset2(): return CustomBusinessHour(holidays=holidays) class TestCustomBusinessHour: def test_constructor_errors(self): msg = "time data must be specified only with hour and minute" with pytest.raises(ValueError, match=msg): CustomBusinessHour(start=dt_time(11, 0, 5)) msg = "time data must match '%H:%M' format" with pytest.raises(ValueError, match=msg): CustomBusinessHour(start="AAA") msg = "time data must match '%H:%M' format" with pytest.raises(ValueError, match=msg): CustomBusinessHour(start="14:00:05") def test_different_normalize_equals(self, _offset): # GH#21404 changed __eq__ to return False when `normalize` does not match offset = _offset() offset2 = _offset(normalize=True) assert offset != offset2 def test_repr(self, offset1, offset2): assert repr(offset1) == "" assert repr(offset2) == "" def test_with_offset(self, dt): expected = Timestamp("2014-07-01 13:00") assert dt + CustomBusinessHour() * 3 == expected assert dt + CustomBusinessHour(n=3) == expected def test_eq(self, offset1, offset2): for offset in [offset1, offset2]: assert offset == offset assert CustomBusinessHour() != CustomBusinessHour(-1) assert CustomBusinessHour(start="09:00") == CustomBusinessHour() assert CustomBusinessHour(start="09:00") != CustomBusinessHour(start="09:01") assert CustomBusinessHour(start="09:00", end="17:00") != CustomBusinessHour( start="17:00", end="09:01" ) assert CustomBusinessHour(weekmask="Tue Wed Thu Fri") != CustomBusinessHour( weekmask="Mon Tue Wed Thu Fri" ) assert CustomBusinessHour(holidays=["2014-06-27"]) != CustomBusinessHour( holidays=["2014-06-28"] ) def test_hash(self, offset1, offset2): assert hash(offset1) == hash(offset1) assert hash(offset2) == hash(offset2) def test_add_dateime(self, dt, offset1, offset2): assert offset1 + dt == datetime(2014, 7, 1, 11) assert offset2 + dt == datetime(2014, 7, 1, 11) def testRollback1(self, dt, offset1, offset2): assert offset1.rollback(dt) == dt assert offset2.rollback(dt) == dt d = datetime(2014, 7, 1, 0) # 2014/07/01 is Tuesday, 06/30 is Monday(holiday) assert offset1.rollback(d) == datetime(2014, 6, 27, 17) # 2014/6/30 and 2014/6/27 are holidays assert offset2.rollback(d) == datetime(2014, 6, 26, 17) def testRollback2(self, _offset): assert _offset(-3).rollback(datetime(2014, 7, 5, 15, 0)) == datetime( 2014, 7, 4, 17, 0 ) def testRollforward1(self, dt, offset1, offset2): assert offset1.rollforward(dt) == dt assert offset2.rollforward(dt) == dt d = datetime(2014, 7, 1, 0) assert offset1.rollforward(d) == datetime(2014, 7, 1, 9) assert offset2.rollforward(d) == datetime(2014, 7, 1, 9) def testRollforward2(self, _offset): assert _offset(-3).rollforward(datetime(2014, 7, 5, 16, 0)) == datetime( 2014, 7, 7, 9 ) def test_roll_date_object(self): offset = BusinessHour() dt = datetime(2014, 7, 6, 15, 0) result = offset.rollback(dt) assert result == datetime(2014, 7, 4, 17) result = offset.rollforward(dt) assert result == datetime(2014, 7, 7, 9) normalize_cases = [ ( CustomBusinessHour(normalize=True, holidays=holidays), { datetime(2014, 7, 1, 8): datetime(2014, 7, 1), datetime(2014, 7, 1, 17): datetime(2014, 7, 3), datetime(2014, 7, 1, 16): datetime(2014, 7, 3), datetime(2014, 7, 1, 23): datetime(2014, 7, 3), datetime(2014, 7, 1, 0): datetime(2014, 7, 1), datetime(2014, 7, 4, 15): datetime(2014, 7, 4), datetime(2014, 7, 4, 15, 59): datetime(2014, 7, 4), datetime(2014, 7, 4, 16, 30): datetime(2014, 7, 7), datetime(2014, 7, 5, 23): datetime(2014, 7, 7), datetime(2014, 7, 6, 10): datetime(2014, 7, 7), }, ), ( CustomBusinessHour(-1, normalize=True, holidays=holidays), { datetime(2014, 7, 1, 8): datetime(2014, 6, 26), datetime(2014, 7, 1, 17): datetime(2014, 7, 1), datetime(2014, 7, 1, 16): datetime(2014, 7, 1), datetime(2014, 7, 1, 10): datetime(2014, 6, 26), datetime(2014, 7, 1, 0): datetime(2014, 6, 26), datetime(2014, 7, 7, 10): datetime(2014, 7, 4), datetime(2014, 7, 7, 10, 1): datetime(2014, 7, 7), datetime(2014, 7, 5, 23): datetime(2014, 7, 4), datetime(2014, 7, 6, 10): datetime(2014, 7, 4), }, ), ( CustomBusinessHour( 1, normalize=True, start="17:00", end="04:00", holidays=holidays ), { datetime(2014, 7, 1, 8): datetime(2014, 7, 1), datetime(2014, 7, 1, 17): datetime(2014, 7, 1), datetime(2014, 7, 1, 23): datetime(2014, 7, 2), datetime(2014, 7, 2, 2): datetime(2014, 7, 2), datetime(2014, 7, 2, 3): datetime(2014, 7, 3), datetime(2014, 7, 4, 23): datetime(2014, 7, 5), datetime(2014, 7, 5, 2): datetime(2014, 7, 5), datetime(2014, 7, 7, 2): datetime(2014, 7, 7), datetime(2014, 7, 7, 17): datetime(2014, 7, 7), }, ), ] @pytest.mark.parametrize("norm_cases", normalize_cases) def test_normalize(self, norm_cases): offset, cases = norm_cases for dt, expected in cases.items(): assert offset._apply(dt) == expected @pytest.mark.parametrize( "dt, expected", [ [datetime(2014, 7, 1, 9), False], [datetime(2014, 7, 1, 10), True], [datetime(2014, 7, 1, 15), True], [datetime(2014, 7, 1, 15, 1), False], [datetime(2014, 7, 5, 12), False], [datetime(2014, 7, 6, 12), False], ], ) def test_is_on_offset(self, dt, expected): offset = CustomBusinessHour(start="10:00", end="15:00", holidays=holidays) assert offset.is_on_offset(dt) == expected apply_cases = [ ( CustomBusinessHour(holidays=holidays), { datetime(2014, 7, 1, 11): datetime(2014, 7, 1, 12), datetime(2014, 7, 1, 13): datetime(2014, 7, 1, 14), datetime(2014, 7, 1, 15): datetime(2014, 7, 1, 16), datetime(2014, 7, 1, 19): datetime(2014, 7, 3, 10), datetime(2014, 7, 1, 16): datetime(2014, 7, 3, 9), datetime(2014, 7, 1, 16, 30, 15): datetime(2014, 7, 3, 9, 30, 15), datetime(2014, 7, 1, 17): datetime(2014, 7, 3, 10), datetime(2014, 7, 2, 11): datetime(2014, 7, 3, 10), # out of business hours datetime(2014, 7, 2, 8): datetime(2014, 7, 3, 10), datetime(2014, 7, 2, 19): datetime(2014, 7, 3, 10), datetime(2014, 7, 2, 23): datetime(2014, 7, 3, 10), datetime(2014, 7, 3, 0): datetime(2014, 7, 3, 10), # saturday datetime(2014, 7, 5, 15): datetime(2014, 7, 7, 10), datetime(2014, 7, 4, 17): datetime(2014, 7, 7, 10), datetime(2014, 7, 4, 16, 30): datetime(2014, 7, 7, 9, 30), datetime(2014, 7, 4, 16, 30, 30): datetime(2014, 7, 7, 9, 30, 30), }, ), ( CustomBusinessHour(4, holidays=holidays), { datetime(2014, 7, 1, 11): datetime(2014, 7, 1, 15), datetime(2014, 7, 1, 13): datetime(2014, 7, 3, 9), datetime(2014, 7, 1, 15): datetime(2014, 7, 3, 11), datetime(2014, 7, 1, 16): datetime(2014, 7, 3, 12), datetime(2014, 7, 1, 17): datetime(2014, 7, 3, 13), datetime(2014, 7, 2, 11): datetime(2014, 7, 3, 13), datetime(2014, 7, 2, 8): datetime(2014, 7, 3, 13), datetime(2014, 7, 2, 19): datetime(2014, 7, 3, 13), datetime(2014, 7, 2, 23): datetime(2014, 7, 3, 13), datetime(2014, 7, 3, 0): datetime(2014, 7, 3, 13), datetime(2014, 7, 5, 15): datetime(2014, 7, 7, 13), datetime(2014, 7, 4, 17): datetime(2014, 7, 7, 13), datetime(2014, 7, 4, 16, 30): datetime(2014, 7, 7, 12, 30), datetime(2014, 7, 4, 16, 30, 30): datetime(2014, 7, 7, 12, 30, 30), }, ), ] @pytest.mark.parametrize("apply_case", apply_cases) def test_apply(self, apply_case): offset, cases = apply_case for base, expected in cases.items(): assert_offset_equal(offset, base, expected) nano_cases = [ ( CustomBusinessHour(holidays=holidays), { Timestamp("2014-07-01 15:00") + Nano(5): Timestamp("2014-07-01 16:00") + Nano(5), Timestamp("2014-07-01 16:00") + Nano(5): Timestamp("2014-07-03 09:00") + Nano(5), Timestamp("2014-07-01 16:00") - Nano(5): Timestamp("2014-07-01 17:00") - Nano(5), }, ), ( CustomBusinessHour(-1, holidays=holidays), { Timestamp("2014-07-01 15:00") + Nano(5): Timestamp("2014-07-01 14:00") + Nano(5), Timestamp("2014-07-01 10:00") + Nano(5): Timestamp("2014-07-01 09:00") + Nano(5), Timestamp("2014-07-01 10:00") - Nano(5): Timestamp("2014-06-26 17:00") - Nano(5), }, ), ] @pytest.mark.parametrize("nano_case", nano_cases) def test_apply_nanoseconds(self, nano_case): offset, cases = nano_case for base, expected in cases.items(): assert_offset_equal(offset, base, expected) def test_us_federal_holiday_with_datetime(self): # GH 16867 bhour_us = CustomBusinessHour(calendar=USFederalHolidayCalendar()) t0 = datetime(2014, 1, 17, 15) result = t0 + bhour_us * 8 expected = Timestamp("2014-01-21 15:00:00") assert result == expected @pytest.mark.parametrize( "weekmask, expected_time, mult", [ ["Mon Tue Wed Thu Fri Sat", "2018-11-10 09:00:00", 10], ["Tue Wed Thu Fri Sat", "2018-11-13 08:00:00", 18], ], ) def test_custom_businesshour_weekmask_and_holidays(weekmask, expected_time, mult): # GH 23542 holidays = ["2018-11-09"] bh = CustomBusinessHour( start="08:00", end="17:00", weekmask=weekmask, holidays=holidays ) result = Timestamp("2018-11-08 08:00") + mult * bh expected = Timestamp(expected_time) assert result == expected