-
Notifications
You must be signed in to change notification settings - Fork 488
/
Copy pathtest_holiday_base.py
1190 lines (960 loc) · 45.8 KB
/
test_holiday_base.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
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
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# holidays
# --------
# A fast, efficient Python library for generating country, province and state
# specific sets of holidays on the fly. It aims to make determining whether a
# specific date is a holiday as fast and flexible as possible.
#
# Authors: Vacanza Team and individual contributors (see AUTHORS file)
# dr-prodigy <dr.prodigy.github@gmail.com> (c) 2017-2023
# ryanss <ryanssdev@icloud.com> (c) 2014-2017
# Website: https://github.com/vacanza/holidays
# License: MIT (see LICENSE file)
import pickle
import unittest
from datetime import date, datetime
from datetime import timedelta as td
from holidays.calendars.gregorian import JAN, FEB, OCT, DEC, MON, TUE, SAT, SUN
from holidays.constants import HOLIDAY_NAME_DELIMITER, OPTIONAL, PUBLIC, SCHOOL
from holidays.groups.christian import ChristianHolidays
from holidays.groups.custom import StaticHolidays
from holidays.holiday_base import HolidayBase
class EntityStubStaticHolidays:
special_public_holidays = {
1111: (JAN, 1, "Test holiday"),
2222: (FEB, 2, "Test holiday"),
3333: ((FEB, 2, "Test holiday")),
4444: (),
1991: (
(JAN, 7, JAN, 12),
(JAN, 8, JAN, 13, 1991),
),
2024: (FEB, 19, FEB, 24),
}
substituted_date_format = "%d/%m/%Y"
substituted_label = "From %s"
class EntityStub(HolidayBase):
def _add_observed(self, dt: date, before: bool = True, after: bool = True) -> None:
if not self.observed:
return None
if self._is_saturday(dt) and before:
self._add_holiday("%s (observed)" % self[dt], dt + td(days=-1))
elif self._is_sunday(dt) and after:
self._add_holiday("%s (observed)" % self[dt], dt + td(days=+1))
def _populate(self, year: int) -> None:
super()._populate(year)
name = "New Year's Day"
self._add_observed(self._add_holiday_jan_1(name), before=False)
if self.observed and self._is_friday(DEC, 31):
self._add_holiday_dec_31("%s (observed)" % name)
self._add_observed(self._add_holiday_jun_19("Juneteenth National Independence Day"))
self._add_observed(self._add_holiday_jul_4("Independence Day"))
self._add_holiday_4th_thu_of_nov("Thanksgiving")
self._add_observed(self._add_holiday_dec_25("Christmas Day"))
class CountryStub1(EntityStub, StaticHolidays):
country = "CS1"
subdivisions = ("Subdiv 1", "Subdiv 2", "3")
subdivisions_aliases = {
"S1": "Subdiv 1",
"S2": "Subdiv 2",
"S3": "3",
"S_1": "Subdiv 1",
"S_2": "Subdiv 2",
"S_3": "3",
}
supported_categories = (PUBLIC, SCHOOL)
def __init__(self, *args, **kwargs) -> None:
StaticHolidays.__init__(self, cls=EntityStubStaticHolidays)
super().__init__(*args, **kwargs)
def _populate_subdiv_subdiv_1_public_holidays(self):
self._add_holiday_aug_10("Subdiv 1 Custom Holiday")
def _populate_subdiv_subdiv_2_public_holidays(self):
self._add_holiday_aug_10("Subdiv 2 Custom Holiday")
class CountryStub2(EntityStub):
country = "CS2"
subdivisions = ("Subdiv-3", "Subdiv-4")
def _populate(self, year: int) -> None:
super()._populate(year)
self._add_holiday_mar_1("Custom March 1st Holiday")
class CountryStub3(HolidayBase):
country = "CS3"
def _populate(self, year: int) -> None:
super()._populate(year)
self._add_holiday_may_1("Custom May 1st Holiday")
self._add_holiday_may_2("Custom May 2nd Holiday")
class CountryStub4(HolidayBase):
country = "CS4"
supported_categories = ("CUSTOM_1", "CUSTOM_2")
class CountryStub5(HolidayBase, ChristianHolidays):
country = "CS5"
def __init__(self, *args, **kwargs) -> None:
ChristianHolidays.__init__(self)
super().__init__(*args, **kwargs)
class CountryStub6(EntityStub, StaticHolidays):
country = "CS6"
def __init__(self, *args, **kwargs) -> None:
StaticHolidays.__init__(self, cls=EntityStubStaticHolidays)
super().__init__(*args, **kwargs)
def _populate_public_holidays(self) -> None:
self._add_holiday_may_1("Labor Day")
self._add_holiday_may_2("Labor Day Two")
class MarketStub1(EntityStub):
market = "MS1"
class MarketStub2(EntityStub):
market = "MS2"
class TestArgs(unittest.TestCase):
def test_categories(self):
self.assertEqual({PUBLIC}, CountryStub1(categories=PUBLIC).categories)
self.assertEqual({PUBLIC, SCHOOL}, CountryStub1(categories=(PUBLIC, SCHOOL)).categories)
self.assertRaises(ValueError, lambda: CountryStub1(categories=OPTIONAL))
self.assertRaises(ValueError, lambda: CountryStub1(categories="UNSUPPORTED"))
self.assertRaises(ValueError, lambda: CountryStub1(categories=("HOME", "UNSUPPORTED")))
self.assertRaises(ValueError, lambda: CountryStub4())
def test_country(self):
self.assertEqual(CountryStub1().country, "CS1")
def test_expand(self):
hb = CountryStub1(years=(2013, 2015), expand=False)
self.assertFalse(hb.expand)
self.assertSetEqual(hb.years, {2013, 2015})
self.assertNotIn("2014-01-01", hb)
self.assertSetEqual(hb.years, {2013, 2015})
def test_observed(self):
hb = CountryStub1(observed=False)
self.assertFalse(hb.observed)
self.assertIn("2000-01-01", hb)
self.assertNotIn("1999-12-31", hb)
self.assertIn("2012-01-01", hb)
self.assertNotIn("2012-01-02", hb)
hb.observed = True
self.assertIn("2000-01-01", hb)
self.assertIn("1999-12-31", hb)
self.assertIn("2012-01-01", hb)
self.assertIn("2012-01-02", hb)
hb.observed = False
self.assertIn("2000-01-01", hb)
self.assertNotIn("1999-12-31", hb)
self.assertIn("2012-01-01", hb)
self.assertNotIn("2012-01-02", hb)
def test_subdivision(self):
self.assertEqual(CountryStub1(subdiv="Subdiv 1").subdiv, "Subdiv 1")
self.assertEqual(CountryStub1(subdiv=3).subdiv, "3")
def test_subdivisions_aliases(self):
subdivisions_aliases = {
"subdiv_1": ("S1", "S_1"),
"subdiv_2": ("S2", "S_2"),
"3": ("S3", "S_3"),
}
for subdiv, aliases in subdivisions_aliases.items():
for alias in aliases:
self.assertEqual(subdiv, CountryStub1(subdiv=alias)._normalized_subdiv)
self.assertEqual(
CountryStub1.get_subdivision_aliases(),
{
"Subdiv 1": ["S1", "S_1"],
"Subdiv 2": ["S2", "S_2"],
"3": ["S3", "S_3"],
},
)
def test_years(self):
hb = HolidayBase()
self.assertSetEqual(hb.years, set())
self.assertNotIn("2014-01-02", hb)
self.assertSetEqual(hb.years, {2014})
self.assertNotIn("2013-01-02", hb)
self.assertNotIn("2014-01-02", hb)
self.assertNotIn("2015-01-02", hb)
self.assertSetEqual(hb.years, {2013, 2014, 2015})
self.assertSetEqual(
HolidayBase(years=range(2010, 2016)).years, {2010, 2011, 2012, 2013, 2014, 2015}
)
self.assertSetEqual(HolidayBase(years=(2013, 2015, 2015)).years, {2013, 2015})
self.assertSetEqual(HolidayBase(years=(2013.0, 2015.0, 2015.0)).years, {2013, 2015})
self.assertSetEqual(HolidayBase(years=2015).years, {2015})
self.assertSetEqual(HolidayBase(years=2015.0).years, {2015})
class TestCategories(unittest.TestCase):
class CustomCategoryClass(HolidayBase):
country = "CCC"
default_category = "CC"
subdivisions = ("SD_1", "SD_2")
supported_categories = ("CC", "CC_1", "CC_2")
def _populate_cc_holidays(self):
self._add_holiday_may_15("CC Holiday")
def _populate_cc_1_holidays(self):
self._add_holiday_may_16("CC1 Holiday")
def _populate_cc_2_holidays(self):
self._add_holiday_jun_15("CC2 Holiday")
def _populate_subdiv_sd_1_cc_holidays(self):
self._add_holiday_jul_1("SD_1 CC Holiday")
def _populate_subdiv_sd_1_cc_1_holidays(self):
self._add_holiday_jul_1("SD_1 CC_1 Holiday")
def _populate_subdiv_sd_2_cc_holidays(self):
self._add_holiday_aug_1("SD_2 CC Holiday")
def test_default_category(self):
ccc = TestCategories.CustomCategoryClass(years=2024)
self.assertEqual(ccc.categories, {TestCategories.CustomCategoryClass.default_category})
for name in ("CC Holiday",):
self.assertTrue(ccc.get_named(name, lookup="exact"))
for name in ("CC1 Holiday", "CC2 Holiday", "SD_1 CC_1 Holiday", "SD_2 CC Holiday"):
self.assertFalse(ccc.get_named(name, lookup="exact"))
# Default category with subdiv.
ccc_sd2 = TestCategories.CustomCategoryClass(years=2024, subdiv="SD_2")
self.assertEqual(ccc_sd2.categories, {TestCategories.CustomCategoryClass.default_category})
for name in ("CC Holiday", "SD_2 CC Holiday"):
self.assertTrue(ccc_sd2.get_named(name, lookup="exact"), name)
for name in ("CC1 Holiday", "CC2 Holiday", "SD_1 CC_1 Holiday"):
self.assertFalse(ccc_sd2.get_named(name, lookup="exact"), name)
def test_no_default_category(self):
TestCategories.CustomCategoryClass.default_category = None
self.assertRaises(ValueError, lambda: TestCategories.CustomCategoryClass(years=2024))
self.assertRaises(
ValueError, lambda: TestCategories.CustomCategoryClass(years=2024, subdiv="SD_1")
)
# Explicitly set category.
ccc = TestCategories.CustomCategoryClass(years=2024, categories="CC")
self.assertEqual(ccc.categories, {"CC"})
self.assertIn("2024-05-15", ccc)
def test_non_default_categories(self):
for categories in (
{"CC_1": ("2024-05-16",)},
{"CC_2": ("2024-06-15",)},
):
for category in categories:
ccc = TestCategories.CustomCategoryClass(years=2024, categories=category)
self.assertEqual(ccc.categories, set(categories), category)
for dt in categories[category]:
self.assertIn(dt, ccc)
class TestDeprecationWarnings(unittest.TestCase):
def test_prov_deprecation(self):
with self.assertWarns(Warning):
CountryStub1(prov="Subdiv 1")
def test_state_deprecation(self):
with self.assertWarns(Warning):
CountryStub1(state="Subdiv 1")
class TestEqualityInequality(unittest.TestCase):
def test_eq(self):
hb_1 = CountryStub1()
hb_2 = CountryStub2()
hb_3 = CountryStub1(subdiv="Subdiv 1")
self.assertEqual(hb_1, hb_1)
self.assertEqual(hb_2, hb_2)
self.assertEqual(hb_3, hb_3)
hb_4 = CountryStub1(years=2014)
hb_5 = CountryStub1(years=2014)
self.assertEqual(hb_4, hb_5)
self.assertEqual(hb_5, hb_4)
hb_6 = CountryStub2(years=(2014, 2015))
hb_7 = CountryStub2(years=(2014, 2015))
self.assertEqual(hb_6, hb_7)
self.assertEqual(hb_7, hb_6)
hb_8 = CountryStub3(language="fr")
hb_9 = CountryStub3(language="fr")
self.assertEqual(hb_8, hb_9)
self.assertEqual(hb_9, hb_8)
# Use assertFalse instead of assertNotEqual as we want to check "==" explicitly.
self.assertFalse(hb_1 == {})
self.assertFalse(hb_2 == {})
self.assertFalse(hb_3 == {})
self.assertFalse(hb_1 == hb_2)
self.assertFalse(hb_2 == hb_1)
self.assertFalse(hb_1 == hb_3)
self.assertFalse(hb_3 == hb_1)
self.assertFalse(hb_2 == hb_3)
self.assertFalse(hb_3 == hb_2)
def test_ne(self):
hb_1 = CountryStub1()
hb_2 = CountryStub2()
hb_3 = CountryStub1(subdiv="Subdiv 1")
self.assertNotEqual(hb_1, {})
self.assertNotEqual(hb_2, {})
self.assertNotEqual(hb_3, {})
self.assertNotEqual(hb_1, hb_2)
self.assertNotEqual(hb_2, hb_1)
self.assertNotEqual(hb_1, hb_3)
self.assertNotEqual(hb_3, hb_1)
self.assertNotEqual(hb_2, hb_3)
self.assertNotEqual(hb_3, hb_2)
hb_4 = CountryStub1(years=2014)
hb_5 = CountryStub2(years=2015)
self.assertNotEqual(hb_1, hb_4)
self.assertNotEqual(hb_4, hb_1)
self.assertNotEqual(hb_2, hb_5)
self.assertNotEqual(hb_5, hb_2)
self.assertNotEqual(hb_4, hb_5)
self.assertNotEqual(hb_5, hb_4)
hb_6 = CountryStub1(years=2014, subdiv="Subdiv 1")
hb_7 = CountryStub1(years=2014, subdiv="Subdiv 2")
self.assertNotEqual(hb_6, hb_7)
self.assertNotEqual(hb_7, hb_6)
hb_8 = CountryStub1(years=2014)
hb_9 = CountryStub1(years=2014, language="fr")
self.assertNotEqual(hb_8, hb_9)
self.assertNotEqual(hb_9, hb_8)
# Use assertFalse instead of assertEqual in order to check "!=" explicitly.
self.assertFalse(hb_1 != hb_1)
self.assertFalse(hb_2 != hb_2)
self.assertFalse(hb_3 != hb_3)
class TestGetList(unittest.TestCase):
def test_get_list_multiple_countries(self):
hb_country_1 = CountryStub1(years=2021)
hb_country_2 = CountryStub1(years=2021)
hb_country_1._add_holiday_dec_20("Custom Holiday 1")
hb_country_2._add_holiday_dec_20("Custom Holiday 2")
self.assertEqual(hb_country_1["2021-12-20"], "Custom Holiday 1")
self.assertEqual(hb_country_2["2021-12-20"], "Custom Holiday 2")
self.assertListEqual(hb_country_1.get_list("2021-12-20"), ["Custom Holiday 1"])
self.assertListEqual(hb_country_2.get_list("2021-12-20"), ["Custom Holiday 2"])
hb_combined = hb_country_1 + hb_country_2
self.assertEqual(hb_combined["2021-12-20"], "Custom Holiday 1; Custom Holiday 2")
self.assertListEqual(
hb_combined.get_list("2021-12-20"), ["Custom Holiday 1", "Custom Holiday 2"]
)
def test_get_list_multiple_subdivisions(self):
hb_subdiv_1 = CountryStub1(subdiv="Subdiv 1", years=2021)
hb_subdiv_2 = CountryStub1(subdiv="Subdiv 2", years=2021)
self.assertEqual(hb_subdiv_1["2021-08-10"], "Subdiv 1 Custom Holiday")
self.assertEqual(hb_subdiv_2["2021-08-10"], "Subdiv 2 Custom Holiday")
self.assertListEqual(hb_subdiv_1.get_list("2021-08-10"), ["Subdiv 1 Custom Holiday"])
self.assertListEqual(hb_subdiv_2.get_list("2021-08-10"), ["Subdiv 2 Custom Holiday"])
hb_combined = hb_subdiv_1 + hb_subdiv_2
self.assertEqual(
hb_combined["2021-08-10"], "Subdiv 1 Custom Holiday; Subdiv 2 Custom Holiday"
)
self.assertListEqual(
hb_combined.get_list("2021-08-10"),
["Subdiv 1 Custom Holiday", "Subdiv 2 Custom Holiday"],
)
class TestGetNamed(unittest.TestCase):
def test_contains(self):
hb = CountryStub1(years=2022)
for name in ("New", "Year"):
self.assertListEqual(hb.get_named(name, lookup="contains"), [date(2022, 1, 1)])
self.assertListEqual(
hb.get_named("Independence Day", lookup="contains"),
[date(2022, 6, 19), date(2022, 6, 20), date(2022, 7, 4)],
)
self.assertListEqual(hb.get_named("independence day", lookup="contains"), [])
self.assertListEqual(hb.get_named("Thanksgiving", lookup="contains"), [date(2022, 11, 24)])
self.assertListEqual(hb.get_named("Thanksgivi", lookup="contains"), [date(2022, 11, 24)])
self.assertListEqual(hb.get_named("thanks", lookup="contains"), [])
self.assertSetEqual(hb.years, {2022})
hb = CountryStub1(observed=False, years=2022)
self.assertListEqual(
hb.get_named("Independence Day", lookup="contains"),
[date(2022, 6, 19), date(2022, 7, 4)],
)
self.assertListEqual(hb.get_named("independence day", lookup="contains"), [])
self.assertSetEqual(hb.years, {2022})
def test_exact(self):
hb = CountryStub1(years=2022)
for name in ("New", "Day"):
self.assertListEqual(hb.get_named(name, lookup="exact"), [])
self.assertListEqual(hb.get_named("Independence Day", lookup="exact"), [date(2022, 7, 4)])
self.assertListEqual(hb.get_named("Thanksgiving", lookup="exact"), [date(2022, 11, 24)])
self.assertListEqual(hb.get_named("thanksgiving", lookup="exact"), [])
self.assertSetEqual(hb.years, {2022})
hb = CountryStub1(observed=False, years=2022)
self.assertListEqual(hb.get_named("Independence Day", lookup="exact"), [date(2022, 7, 4)])
self.assertSetEqual(hb.years, {2022})
def test_icontains(self):
hb = CountryStub1(years=2022)
for name in ("Thanksgiving", "thanksgiving", "Thanksgivi"):
self.assertListEqual(hb.get_named(name, lookup="icontains"), [date(2022, 11, 24)])
self.assertListEqual(
hb.get_named("Independence Day", lookup="icontains"),
[date(2022, 6, 19), date(2022, 6, 20), date(2022, 7, 4)],
)
self.assertSetEqual(hb.years, {2022})
hb = CountryStub1(observed=False, years=2022)
self.assertListEqual(
hb.get_named("Independence Day", lookup="icontains"),
[date(2022, 6, 19), date(2022, 7, 4)],
)
self.assertSetEqual(hb.years, {2022})
def test_iexact(self):
hb = CountryStub1(years=2022)
for name in ("new year's day", "New Year's Day"):
self.assertListEqual(hb.get_named(name, lookup="iexact"), [date(2022, 1, 1)])
for name in ("New Year Day", "New Year", "year", "NEW Year"):
self.assertListEqual(hb.get_named(name, lookup="iexact"), [])
self.assertListEqual(hb.get_named("independence day", lookup="iexact"), [date(2022, 7, 4)])
self.assertListEqual(hb.get_named("thanksgiving", lookup="iexact"), [date(2022, 11, 24)])
self.assertListEqual(hb.get_named("Thanksgivin", lookup="iexact"), [])
self.assertSetEqual(hb.years, {2022})
hb = CountryStub1(observed=False, years=2022)
self.assertListEqual(hb.get_named("independence day", lookup="iexact"), [date(2022, 7, 4)])
self.assertSetEqual(hb.years, {2022})
def test_invalid(self):
hb = CountryStub1(years=2022)
self.assertRaises(
AttributeError, lambda: hb.get_named("Independence Day", lookup="invalid")
)
def test_istartswith(self):
hb = CountryStub1(years=2022)
for name in ("new year's", "New Year's", "New Year's day"):
self.assertListEqual(hb.get_named(name, lookup="istartswith"), [date(2022, 1, 1)])
for name in ("New Year Day", "New Year holiday", "New Year's Day Holiday", "year"):
self.assertListEqual(hb.get_named(name, lookup="istartswith"), [])
self.assertListEqual(
hb.get_named("independence day", lookup="istartswith"), [date(2022, 7, 4)]
)
self.assertSetEqual(hb.years, {2022})
hb = CountryStub1(observed=False, years=2022)
self.assertListEqual(
hb.get_named("independence day", lookup="istartswith"), [date(2022, 7, 4)]
)
self.assertSetEqual(hb.years, {2022})
def test_startswith(self):
hb = CountryStub1(years=2022)
for name in ("New Year's", "New Year"):
self.assertListEqual(hb.get_named(name, lookup="startswith"), [date(2022, 1, 1)])
for name in ("New Year Day", "New Year Holiday", "New Year's Day Holiday", "year"):
self.assertListEqual(hb.get_named(name, lookup="startswith"), [])
self.assertListEqual(
hb.get_named("Independence Day", lookup="startswith"), [date(2022, 7, 4)]
)
self.assertListEqual(
hb.get_named("Christmas", lookup="startswith"),
[date(2022, 12, 25), date(2022, 12, 26)],
)
self.assertSetEqual(hb.years, {2022})
hb = CountryStub1(observed=False, years=2022)
self.assertListEqual(
hb.get_named("Independence Day", lookup="startswith"), [date(2022, 7, 4)]
)
self.assertListEqual(hb.get_named("Christmas", lookup="startswith"), [date(2022, 12, 25)])
self.assertSetEqual(hb.years, {2022})
class TestHelperMethods(unittest.TestCase):
def setUp(self):
self.hb = CountryStub1()
def test_add_holiday(self):
self.hb._populate(2023)
self.hb._add_holiday("Test 1", date(2023, JAN, 5))
self.hb._add_holiday("Test 2", (JAN, 6))
self.hb._add_holiday_jan_7("Test 3")
self.assertIn("2023-01-05", self.hb)
self.assertIn("2023-01-06", self.hb)
self.assertIn("2023-01-07", self.hb)
for args in (
(date(2020, JAN, 5),),
(JAN, 5, "Test 1", True),
("Test", "Test"),
):
self.assertRaises(TypeError, lambda: self.hb._add_holiday(*args))
def test_is_leap_year(self):
self.hb._populate(1999)
self.assertFalse(self.hb._is_leap_year())
self.hb._populate(2000)
self.assertTrue(self.hb._is_leap_year())
self.hb._populate(2004)
self.assertTrue(self.hb._is_leap_year())
self.hb._populate(2200)
self.assertFalse(self.hb._is_leap_year())
def test_is_weekend(self):
self.hb._populate(2022)
dts = (date(2022, 10, 3), date(2022, 10, 4), (OCT, 3), (OCT, 4))
self.hb.weekend = {MON, TUE}
for dt in dts:
self.assertTrue(self.hb._is_weekend(dt))
self.hb.weekend = {}
for dt in dts:
self.assertFalse(self.hb._is_weekend(dt))
self.hb.weekend = {SAT, SUN}
for dt in (date(2022, 10, 1), date(2022, 10, 2)):
self.assertTrue(self.hb._is_weekend(dt))
for dt in ((OCT, 1), (OCT, 2)):
self.assertTrue(self.hb._is_weekend(dt))
self.assertTrue(self.hb._is_weekend(*dt))
for dt in (date(2022, 10, 3), date(2022, 10, 4)):
self.assertFalse(self.hb._is_weekend(dt))
for dt in ((OCT, 3), (OCT, 4)):
self.assertFalse(self.hb._is_weekend(dt))
self.assertFalse(self.hb._is_weekend(*dt))
class TestHolidaySum(unittest.TestCase):
def setUp(self) -> None:
self.hb_1 = CountryStub1(years=2014)
self.hb_2 = CountryStub2(years=2015)
self.hb_3 = CountryStub3()
self.hb_combined = self.hb_1 + self.hb_2 + self.hb_3
def assertAdded(self): # noqa: N802
self.assertNotIn("2014-03-01", self.hb_1)
self.assertNotIn("2014-05-01", self.hb_1)
self.assertNotIn("2014-05-02", self.hb_1)
self.assertIn("2014-03-01", self.hb_2)
self.assertIn("2014-05-01", self.hb_3)
self.assertIn("2014-05-02", self.hb_3)
self.assertIn("2014-07-04", self.hb_1)
self.assertIn("2014-07-04", self.hb_1 + self.hb_2)
self.assertIn("2014-07-04", self.hb_2 + self.hb_1)
self.assertIn("2015-07-04", self.hb_1 + self.hb_2)
self.assertIn("2015-07-04", self.hb_2 + self.hb_1)
self.assertIn("2000-03-01", self.hb_combined)
self.assertIn("2000-05-01", self.hb_combined)
self.assertIn("2000-05-02", self.hb_combined)
self.assertIn("2000-07-04", self.hb_combined)
self.assertIn("2000-07-04", self.hb_combined)
def test_add_country(self):
self.assertAdded()
self.hb_combined = CountryStub1(years=2014)
self.hb_combined += CountryStub2(years=2015)
self.hb_combined += CountryStub3()
self.assertAdded()
self.hb_combined = (
self.hb_1
+ (self.hb_2 + self.hb_3)
+ self.hb_1
+ (self.hb_3 + self.hb_2 + CountryStub2(subdiv="Subdiv-4"))
)
self.assertAdded()
self.hb_combined = CountryStub1(years=2014, subdiv="Subdiv 1")
self.hb_combined += CountryStub1(years=2014, subdiv="Subdiv 2")
self.assertEqual(
self.hb_combined["2014-08-10"], "Subdiv 1 Custom Holiday; Subdiv 2 Custom Holiday"
)
self.assertRaises(TypeError, lambda: self.hb_1 + {})
def test_add_financial(self):
hb_1 = MarketStub1(years=2013)
hb_2 = MarketStub2(years=(2014, 2015))
hb_combined = hb_1 + hb_2
self.assertIn("2013-01-01", hb_1)
self.assertIn("2014-01-01", hb_2)
self.assertIn("2015-01-01", hb_2)
self.assertIn("2013-01-01", hb_combined)
self.assertIn("2014-01-01", hb_combined)
self.assertIn("2015-01-01", hb_combined)
self.assertListEqual(hb_combined.market, ["MS1", "MS2"])
def test_args(self):
self.hb_1 = CountryStub1(years=2014, subdiv="Subdiv 1")
self.hb_2 = CountryStub2(years=2015, subdiv="Subdiv-3")
self.assertListEqual(self.hb_combined.country, ["CS1", "CS2", "CS3"])
self.assertListEqual((self.hb_1 + self.hb_2).subdiv, ["Subdiv 1", "Subdiv-3"])
self.assertListEqual((self.hb_2 + self.hb_1).subdiv, ["Subdiv-3", "Subdiv 1"])
self.assertEqual((self.hb_1 + self.hb_3).subdiv, "Subdiv 1")
self.assertTrue((self.hb_2 + self.hb_3).expand)
self.assertSetEqual((self.hb_2 + self.hb_3).years, {2014, 2015})
self.assertSetEqual((self.hb_3 + self.hb_2).years, {2014, 2015})
self.hb_combined = sum(CountryStub1(subdiv=subdiv) for subdiv in CountryStub1.subdivisions)
self.assertEqual(self.hb_combined.country, CountryStub1.country)
self.assertEqual(self.hb_combined.subdiv, list(CountryStub1.subdivisions))
class TestInheritance(unittest.TestCase):
def setUp(self):
self.hb = CountryStub1()
def test_custom_holidays(self):
class CustomHolidays(CountryStub1):
def _populate(self, year):
super()._populate(year)
self._add_holiday_jul_13("Ninja Turtle's Day")
self._add_holiday_dec_31("New Year's Eve")
del self[date(year, JAN, 1)]
hb = CustomHolidays(years=(2014, 2020))
self.assertIn("2014-01-01", self.hb)
self.assertNotIn("2014-01-01", hb)
self.assertIn("2014-12-31", hb)
self.assertNotIn("2014-12-31", self.hb)
self.assertIn("2020-01-01", self.hb)
self.assertNotIn("2020-01-01", hb)
self.assertIn("2020-12-31", hb)
self.assertNotIn("2020-12-31", self.hb)
self.assertNotIn("2014-07-13", self.hb)
self.assertIn("2014-07-13", hb)
self.assertNotIn("2020-07-13", self.hb)
self.assertIn("2020-07-13", hb)
class TestKeyTransforms(unittest.TestCase):
def setUp(self):
self.hb = CountryStub1()
def test_date(self):
dt = date(2014, 1, 1)
self.assertIn(dt, self.hb)
self.assertEqual(self.hb[dt], "New Year's Day")
dt = date(2014, 1, 3)
self.hb[dt] = "Fake Holiday"
self.assertIn(dt, self.hb)
self.assertEqual(self.hb.pop(dt), "Fake Holiday")
self.assertNotIn(dt, self.hb)
def test_date_subclass(self):
class CustomDateType(date):
pass
self.assertTrue(issubclass(CustomDateType, date))
self.assertIn(CustomDateType(2014, 1, 1), self.hb)
self.assertNotIn(CustomDateType(2014, 1, 3), self.hb)
def test_datetime(self):
self.assertIn(datetime(2014, 1, 1, 13, 45), self.hb)
self.assertEqual(self.hb[datetime(2014, 1, 1, 13, 45)], "New Year's Day")
self.hb[datetime(2014, 1, 3, 1, 1)] = "Fake Holiday"
self.assertIn(datetime(2014, 1, 3, 2, 2), self.hb)
self.assertEqual(self.hb.pop(datetime(2014, 1, 3, 4, 4)), "Fake Holiday")
self.assertNotIn(datetime(2014, 1, 3, 2, 2), self.hb)
def test_exception(self):
self.assertRaises((TypeError, ValueError), lambda: "abc" in self.hb)
self.assertRaises((TypeError, ValueError), lambda: self.hb.get("abc123"))
self.assertRaises(TypeError, lambda: self.hb.get({"123"}))
self.assertRaises((TypeError, ValueError), self.hb.__setitem__, "abc", "Test")
self.assertRaises((TypeError, ValueError), lambda: {} in self.hb)
def test_string(self):
self.assertIn("2014-01-01", self.hb)
self.assertEqual(self.hb["2014-01-01"], "New Year's Day")
self.assertIn("01/01/2014", self.hb)
self.assertEqual(self.hb["01/01/2014"], "New Year's Day")
self.hb["01/03/2014"] = "Fake Holiday"
self.assertIn("01/03/2014", self.hb)
self.assertNotIn("03/01/2014", self.hb)
self.assertIn("2014-01-03", self.hb)
self.assertNotIn("2014-03-01", self.hb)
self.assertEqual(self.hb.pop("01/03/2014"), "Fake Holiday")
def test_timestamp(self):
self.assertIn(1388552400, self.hb)
self.assertEqual(self.hb[1388552400], "New Year's Day")
self.assertIn(1388552400.01, self.hb)
self.assertEqual(self.hb[1388552400.01], "New Year's Day")
self.hb[1388725200] = "Fake Holiday"
self.assertIn(1388725201, self.hb)
self.assertEqual(self.hb.pop(1388725202), "Fake Holiday")
self.assertNotIn(1388725201, self.hb)
class TestPop(unittest.TestCase):
def setUp(self):
self.hb = CountryStub1()
def test_exception(self):
self.assertRaises(KeyError, lambda: self.hb.pop("2014-01-02"))
self.hb.pop("2014-01-01")
self.assertRaises(KeyError, lambda: self.hb.pop("2014-01-01"))
def test_success(self):
self.assertFalse(self.hb.pop("2014-01-02", False))
self.assertTrue(self.hb.pop("2014-01-02", True))
self.assertIn("2014-01-01", self.hb)
self.assertEqual(self.hb.pop("2014-01-01"), "New Year's Day")
self.assertNotIn("2014-01-01", self.hb)
class TestPopNamed(unittest.TestCase):
def setUp(self):
self.hb = CountryStub1()
def test_exception(self):
self.assertRaises(KeyError, lambda: self.hb.pop_named("New Year's Dayz"))
self.assertIn("2014-01-01", self.hb)
self.hb.pop_named("New Year's Day")
self.assertRaises(KeyError, lambda: self.hb.pop_named("New Year's Day"))
def test_single(self):
self.assertIn("2014-01-01", self.hb)
for dt in self.hb.pop_named("New Year's Day"):
self.assertNotIn(dt, self.hb)
def test_multiple(self):
dt = date(2022, 2, 22)
holiday_name_1 = "Holiday Name 1"
holiday_name_2 = "Holiday Name 2"
holiday_name_3 = "Holiday Name 3"
combined_name = HOLIDAY_NAME_DELIMITER.join(
(holiday_name_1, holiday_name_2, holiday_name_3)
)
self.hb[dt] = holiday_name_1
self.hb[dt] = holiday_name_2
self.hb[dt] = holiday_name_3
self.assertEqual(self.hb[dt], combined_name)
# Pop the entire date by multiple holidays exact name.
self.hb.pop_named(combined_name)
self.assertNotIn(dt, self.hb)
# Pop only one holiday by a single name.
self.hb[dt] = holiday_name_1
self.hb[dt] = holiday_name_2
self.hb[dt] = holiday_name_3
# 3 holidays names.
self.assertEqual(self.hb[dt], combined_name)
self.hb.pop_named(holiday_name_1)
# 2 holiday names.
self.assertEqual(
self.hb[dt], HOLIDAY_NAME_DELIMITER.join((holiday_name_2, holiday_name_3))
)
self.hb.pop_named(holiday_name_3)
# 1 holiday name.
self.assertEqual(self.hb[dt], holiday_name_2)
self.hb.pop_named(holiday_name_2)
# 0 holiday names.
self.assertNotIn(dt, self.hb)
def test_partial(self):
self.assertIn("2014-01-01", self.hb)
for dt in self.hb.pop_named("N"):
self.assertNotIn(dt, self.hb)
self.assertRaises(KeyError, lambda: self.hb.pop_named("New Year"))
class TestRepr(unittest.TestCase):
def test_base(self):
self.assertEqual(repr(HolidayBase()), "holidays.HolidayBase()")
def test_country(self):
self.assertEqual(repr(CountryStub1()), "holidays.country_holidays('CS1')")
self.assertEqual(
repr(CountryStub1(subdiv="Subdiv 1")),
"holidays.country_holidays('CS1', subdiv='Subdiv 1')",
)
def test_market(self):
self.assertEqual(repr(MarketStub1()), "holidays.financial_holidays('MS1')")
class TestSerialization(unittest.TestCase):
def setUp(self):
self.hb = CountryStub1()
def test_pickle(self):
dt = "2020-01-01"
self.assertIn(dt, self.hb)
loaded_holidays = pickle.loads(pickle.dumps(self.hb))
self.assertEqual(loaded_holidays, self.hb)
self.assertIn(dt, self.hb)
class TestSpecialHolidays(unittest.TestCase):
def setUp(self):
self.hb = CountryStub1()
def test_populate_special_holidays(self):
self.assertSetEqual(self.hb.years, set())
self.hb._populate(1111)
self.assertSetEqual(self.hb.years, {1111})
self.assertIn("1111-01-01", self.hb)
self.assertIn("2222-02-02", self.hb)
self.assertIn("3333-02-02", self.hb)
self.assertSetEqual(self.hb.years, {1111, 2222, 3333})
class TestStandardMethods(unittest.TestCase):
def setUp(self):
self.hb = CountryStub1()
def test_append(self):
self.hb.append([date(2015, 4, 1), "2015-04-03"])
self.hb.append(date(2015, 4, 6))
self.hb.append("2015-04-07")
for dt in (
"2015-01-01",
"2015-04-01",
"2015-04-03",
"2015-04-06",
"2015-04-07",
"2015-12-25",
):
self.assertIn(dt, self.hb)
for dt in (
"2015-04-04",
"2015-04-05",
"2015-04-02",
):
self.assertNotIn(dt, self.hb)
def test_bool(self):
self.assertFalse(self.hb)
self.assertEqual(bool(self.hb), False)
self.assertEqual(len(self.hb), 0)
self.assertIn("2014-01-01", self.hb)
self.assertTrue(self.hb)
self.assertEqual(bool(self.hb), True)
self.assertNotEqual(len(self.hb), 0)
def test_contains(self):
self.assertIn("2014-01-01", self.hb)
self.assertNotIn("2014-01-03", self.hb)
def test_copy(self):
hb = CountryStub1()
self.assertEqual(hb, hb.copy())
hb_fr = CountryStub1(language="fr")
hb_xx = CountryStub1(language="xx")
self.assertNotEqual(hb, hb_fr)
self.assertNotEqual(hb.copy(), hb_fr.copy())
self.assertNotEqual(hb, hb_xx)
self.assertNotEqual(hb.copy(), hb_xx.copy())
def test_get(self):
self.assertEqual(self.hb.get("2014-01-01"), "New Year's Day")
self.assertIsNone(self.hb.get("2014-01-03"))
self.assertFalse(self.hb.get("2014-01-03", False))
self.assertTrue(self.hb.get("2014-01-03", True))
def test_getattr(self):
self.hb._populate(2023)
name = "Test"
self.assertEqual(self.hb._add_holiday_3rd_mon_of_jun(name), date(2023, 6, 19))
self.assertEqual(self.hb._add_holiday_4th_fri_of_aug(name), date(2023, 8, 25))
self.assertEqual(self.hb._add_holiday_1st_wed_of_aug(name), date(2023, 8, 2))
self.assertEqual(self.hb._add_holiday_1st_mon_before_may_24(name), date(2023, 5, 22))
self.assertEqual(self.hb._add_holiday_1st_sun_from_aug_31(name), date(2023, 9, 3))
h_chr = CountryStub5()
h_chr._populate(2023)
self.assertEqual(h_chr._add_holiday_8_days_past_easter(name), date(2023, 4, 17))
self.assertEqual(h_chr._add_holiday_5_days_prior_easter(name), date(2023, 4, 4))
self.assertRaises(ValueError, lambda: self.hb._add_holiday_5th_fri_of_aug(name))
self.assertRaises(AttributeError, lambda: self.hb._add_holiday_4th_nam_of_aug(name))
self.assertRaises(AttributeError, lambda: self.hb._add_holiday_nam_12(name))
self.assertRaises(AttributeError, lambda: self.hb._add_holiday_1st_fri_before_nam_29(name))
self.assertRaises(AttributeError, lambda: self.hb._add_holiday_1st_fri_random_jan_29(name))
self.assertRaises(AttributeError, lambda: h_chr._add_holiday_18_days_past_eastr(name))
self.assertRaises(AttributeError, lambda: self.hb._add_holiday_fe_15(name))
self.assertRaises(AttributeError, lambda: self.hb._add_holiday_2_may_15(name))
self.assertRaises(AttributeError, lambda: self.hb._add_holiday_3th_su_of_aug(name))
self.assertRaises(
AttributeError, lambda: self.hb._add_holiday_2_days_past_1st_sat_of_ap(name)
)
self.assertRaises(AttributeError, lambda: self.hb._add_holiday_1st_sat_from_fe_10(name))
def test_getitem(self):
self.assertEqual(self.hb["2014-01-01"], "New Year's Day")
self.assertEqual(self.hb.get("2014-01-01"), "New Year's Day")
self.assertIsNone(self.hb.get("2014-01-03"))
self.assertRaises(KeyError, lambda: self.hb["2014-01-03"])
self.assertListEqual(self.hb["2013-12-31":"2014-01-02"], [date(2014, 1, 1)])
self.assertListEqual(
self.hb["2013-12-24":"2014-01-02"], [date(2013, 12, 25), date(2014, 1, 1)]
)
self.assertListEqual(self.hb["2013-12-25":"2014-01-02":3], [date(2013, 12, 25)])
self.assertListEqual(
self.hb["2013-12-25":"2014-01-02":7], [date(2013, 12, 25), date(2014, 1, 1)]
)
self.assertListEqual(self.hb["2014-01-02":"2013-12-30"], [date(2014, 1, 1)])
self.assertListEqual(self.hb["2014-01-02":"2013-12-25"], [date(2014, 1, 1)])
self.assertListEqual(
self.hb["2014-01-02":"2013-12-24"], [date(2014, 1, 1), date(2013, 12, 25)]
)
self.assertListEqual(self.hb["2014-01-01":"2013-12-24":3], [date(2014, 1, 1)])
self.assertListEqual(
self.hb["2014-01-01":"2013-12-24":7],
[date(2014, 1, 1), date(2013, 12, 25)],
)
self.assertListEqual(self.hb["2013-12-31":"2014-01-02":-3], [])
self.assertListEqual(self.hb["2014-01-01" : "2013-12-24" : td(days=3)], [date(2014, 1, 1)])
self.assertListEqual(
self.hb["2014-01-01" : "2013-12-24" : td(days=7)],
[date(2014, 1, 1), date(2013, 12, 25)],
)