File: asian_generator.py

package info (click to toggle)
python-holidays 0.78-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 54,836 kB
  • sloc: python: 106,063; javascript: 85; makefile: 59
file content (431 lines) | stat: -rw-r--r-- 12,940 bytes parent folder | download
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
#!/usr/bin/env python3


#  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 CONTRIBUTORS 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)

from datetime import date
from datetime import timedelta as td
from functools import lru_cache
from pathlib import Path


class _Lunisolar:
    def __init__(self) -> None:
        """
        This class generates Gregorian dates for Chinese lunisolar calendar
        based holidays.

        See `Wikipedia
        <https://en.wikipedia.org/wiki/Chinese_New_Year#Dates_in_Chinese_\
        lunisolar_calendar>`__

        Sources:
        http://putidea.blogspot.com/2010/10/python.html
        https://github.com/BohanZhang/python-MagicLamp/blob/master/bin/utils/lunar_calendar.py
        """

        # A binary representation starting from year 1901 of the number of
        # days per year, and the number of days from the 1st to the 13th to
        # store the monthly (including the month of the month). 1 means that
        # the month is 30 days. 0 means the month is 29 days.
        # The 12th to 15th digits indicate the month of the next month.
        # If it is 0x0F, it means that there is no leap month.
        self.G_LUNAR_MONTH_DAYS = (
            0xF0EA4,
            0xF1D4A,
            0x52C94,
            0xF0C96,
            0xF1536,
            0x42AAC,
            0xF0AD4,
            0xF16B2,
            0x22EA4,
            0xF0EA4,  # 1910
            0x6364A,
            0xF164A,
            0xF1496,
            0x52556,
            0xF155A,
            0xF0AD4,
            0x216D2,
            0xF1B52,
            0x73B24,
            0xF1B24,  # 1920
            0xF1A4A,
            0x5349A,
            0xF14AC,
            0xF056C,
            0x42B6A,
            0xF0DA8,
            0xF1D52,
            0x23D24,
            0xF1D24,
            0x61A4C,  # 1930
            0xF0A56,
            0xF14AE,
            0x5256C,
            0xF16B4,
            0xF0DA8,
            0x31D92,
            0xF0E92,
            0x72D26,
            0xF1526,
            0xF0A56,  # 1940
            0x614B6,
            0xF155A,
            0xF0AD4,
            0x436AA,
            0xF1748,
            0xF1692,
            0x23526,
            0xF152A,
            0x72A5A,
            0xF0A6C,  # 1950
            0xF155A,
            0x52B54,
            0xF0B64,
            0xF1B4A,
            0x33A94,
            0xF1A94,
            0x8152A,
            0xF152E,
            0xF0AAC,
            0x6156A,  # 1960
            0xF15AA,
            0xF0DA4,
            0x41D4A,
            0xF1D4A,
            0xF0C94,
            0x3192E,
            0xF1536,
            0x72AB4,
            0xF0AD4,
            0xF16D2,  # 1970
            0x52EA4,
            0xF16A4,
            0xF164A,
            0x42C96,
            0xF1496,
            0x82956,
            0xF055A,
            0xF0ADA,
            0x616D2,
            0xF1B52,  # 1980
            0xF1B24,
            0x43A4A,
            0xF1A4A,
            0xA349A,
            0xF14AC,
            0xF056C,
            0x60B6A,
            0xF0DAA,
            0xF1D52,
            0x53D24,  # 1990
            0xF1D24,
            0xF1A4C,
            0x314AC,
            0xF14AE,
            0x829AC,
            0xF06B4,
            0xF0DAA,
            0x52D92,
            0xF0E92,
            0xF0D26,  # 2000
            0x42A56,
            0xF0A56,
            0xF14B6,
            0x22AB4,
            0xF0AD4,
            0x736AA,
            0xF1748,
            0xF1692,
            0x53526,
            0xF152A,  # 2010
            0xF0A5A,
            0x4155A,
            0xF156A,
            0x92B54,
            0xF0BA4,
            0xF1B4A,
            0x63A94,
            0xF1A94,
            0xF192A,
            0x42A5C,  # 2020
            0xF0AAC,
            0xF156A,
            0x22B64,
            0xF0DA4,
            0x61D4A,
            0xF0E4A,
            0xF0C96,
            0x5192E,
            0xF1956,
            0xF0AB4,  # 2030
            0x315AC,
            0xF16D2,
            0xB2EA4,
            0xF16A4,
            0xF164A,
            0x63496,
            0xF1496,
            0xF0956,
            0x50AB6,
            0xF0B5A,  # 2040
            0xF16D4,
            0x236A4,
            0xF1B24,
            0x73A4A,
            0xF1A4A,
            0xF14AA,
            0x5295A,
            0xF096C,
            0xF0B6A,
            0x31B54,  # 2050
            0xF1D92,
            0x83D24,
            0xF1D24,
            0xF1A4C,
            0x614AC,
            0xF14AE,
            0xF09AC,
            0x40DAA,
            0xF0EAA,
            0xF0E92,  # 2060
            0x31D26,
            0xF0D26,
            0x72A56,
            0xF0A56,
            0xF14B6,
            0x52AB4,
            0xF0AD4,
            0xF16CA,
            0x42E94,
            0xF1694,  # 2070
            0x8352A,
            0xF152A,
            0xF0A5A,
            0x6155A,
            0xF156A,
            0xF0B54,
            0x4174A,
            0xF1B4A,
            0xF1A94,
            0x3392A,  # 2080
            0xF192C,
            0x7329C,
            0xF0AAC,
            0xF156A,
            0x52B64,
            0xF0DA4,
            0xF1D4A,
            0x41C94,
            0xF0D16,
            0x8192E,  # 2090
            0xF0956,
            0xF0AB6,
            0x615AC,
            0xF16D4,
            0xF0EA4,
            0x42E4A,
            0xF164A,
            0xF1516,
            0x22936,
            0xF0956,  # 2100
        )
        # Define range of years covered
        self.START_YEAR = 1901
        self.END_YEAR = 2100
        # The Gregorian date for the 1st day of the 1st month of 1900 year is 1901/2/19
        self.LUNAR_START_DATE = ((1901, 1, 1),)
        self.SOLAR_START_DATE = date(1901, 2, 19)
        # The Gregorian date for the 29th day of 12th month of 2100 year is 2101/1/28
        self.LUNAR_END_DATE = (2100, 12, 29)
        self.SOLAR_END_DATE = date(2101, 1, 28)

    @lru_cache
    def _get_leap_month(self, lunar_year: int) -> int:
        """
        Return the number of the leap month if one exists in the year,
        otherwise 15.
        """
        return (self.G_LUNAR_MONTH_DAYS[lunar_year - self.START_YEAR] >> 16) & 0x0F

    def _lunar_month_days(self, lunar_year: int, lunar_month: int) -> int:
        """
        Return the number of days in a lunar month.
        """
        return 29 + ((self.G_LUNAR_MONTH_DAYS[lunar_year - self.START_YEAR] >> lunar_month) & 0x01)

    def _lunar_year_days(self, year: int) -> int:
        """
        Return the number of days in a lunar year.
        """
        days = 0
        months_day = self.G_LUNAR_MONTH_DAYS[year - self.START_YEAR]
        for i in range(1, 13 if self._get_leap_month(year) == 0x0F else 14):
            day = 29 + ((months_day >> i) & 0x01)
            days += day
        return days

    @lru_cache
    def _span_days(self, year: int) -> int:
        """
        Return the number of days elapsed since self.SOLAR_START_DATE to the
        beginning of the year.
        """
        return sum(self._lunar_year_days(y) for y in range(self.START_YEAR, year))

    def lunar_to_gre(self, year: int, month: int, day: int, leap: bool = True) -> date:
        """
        Return the Gregorian date of a Chinese lunar day and month in a
        given Gregorian year.
        """
        leap_month = self._get_leap_month(year) if leap else 15
        span_days = sum(
            self._lunar_month_days(year, m) for m in range(1, month + (month > leap_month))
        )
        span_days += self._span_days(year) + day - 1
        return self.SOLAR_START_DATE + td(days=span_days)

    def vesak_date(self, year: int) -> date:
        """
        Return the estimated Gregorian date of Vesak for Thailand, Laos,
        Singapore and Indonesia, corresponding to 15th day of 4th month
        of the Chinese lunar calendar. See `Wikipedia
        <https://en.wikipedia.org/wiki/Vesak#Dates_of_observance>`__.
        """
        return self.lunar_to_gre(year, 4, 15)

    def vesak_may_date(self, year: int) -> date:
        """
        Return the estimated Gregorian date of Vesak for Sri Lanka, Nepal,
        India, Bangladesh and Malaysia, corresponding to the day of the
        first full moon in May in the Gregorian calendar. See `Wikipedia
        <https://en.wikipedia.org/wiki/Vesak#Dates_of_observance>`__.
        """
        dt = self.lunar_to_gre(year, 3, 15, leap=False)
        return dt if dt.month == 5 else self.lunar_to_gre(year, 4, 15, leap=False)

    def s_diwali_date(self, year: int) -> date:
        """
        Return the estimated Gregorian date of Southern India (Tamil)
        Diwali. Defined as the date of Amāvásyā (new moon) of Kārttikai, which
        corresponds with the months of November or December in the Gregorian
        calendar. See `Wikipedia <https://en.wikipedia.org/wiki/Diwali>`__.
        """
        return self.lunar_to_gre(year, 10, 1) + td(days=-2)

    def thaipusam_date(self, year: int) -> date:
        """
        Return the estimated Gregorian date of Thaipusam (Tamil). Defined as
        the date of the full moon in the Tamil month of Thai, which
        corresponds with the months of January or February in the Gregorian
        calendar. See `Wikipedia <https://en.wikipedia.org/wiki/Thaipusam>`__.
        """
        leap_month = self._get_leap_month(year)
        return self.lunar_to_gre(year, 1 if leap_month <= 6 else 2, 1) + td(days=-15)


CLASS_NAME = "_{cal_name}Lunisolar"
OUT_FILE_NAME = "{cal_name}_dates.py"

CLASS_TEMPLATE = """class {class_name}:
{holiday_data}"""

HOLIDAY_ARRAY_TEMPLATE = """    {hol_name}_DATES = {{
{year_dates}
    }}
"""

YEAR_TEMPLATE = "        {year}: ({date}),"

BUDDHIST, CHINESE, HINDU = range(3)
CALENDARS = {
    BUDDHIST: "Buddhist",
    CHINESE: "Chinese",
    HINDU: "Hindu",
}

# Timezones:
# UTC+7: VN
# UTC+8: BN, CN, HK, ID, MO, MY, PH, SG, TW
# UTC+9: KR

ASIAN_HOLIDAYS = (
    # CN, HK, ID, KR, MY, PH, SG, TW, VN
    (1, 1, "LUNAR_NEW_YEAR", CHINESE),  # Lunar New Year
    # VN
    (3, 10, "HUNG_KINGS", CHINESE),  # Kings' Commemoration Day
    # HK, KR
    (4, 8, "BUDDHA_BIRTHDAY", CHINESE),  # Buddha's Birthday
    # ID, SG
    (4, 15, "VESAK", BUDDHIST),  # Vesak
    # CN, HK, TW
    (5, 5, "DRAGON_BOAT", CHINESE),  # Dragon Boat Festival
    # CN, HK, KR, TW
    (8, 15, "MID_AUTUMN", CHINESE),  # Mid-Autumn Festival
    # HK
    (9, 9, "DOUBLE_NINTH", CHINESE),  # Double Ninth Festival
    # MY
    (0, 0, "VESAK_MAY", BUDDHIST),  # Vesak (May)
    # MY, SG
    (0, 0, "DIWALI", HINDU),  # Diwali
    # MY
    (0, 0, "THAIPUSAM", HINDU),  # Thaipusam
)


def generate_data():
    cnls = _Lunisolar()

    g_year_min, g_year_max = (1901, 2100)
    dates = {}
    for g_year in range(g_year_min, g_year_max + 1):
        for h_month, h_day, hol_name, _ in ASIAN_HOLIDAYS:
            if h_month == 0:
                continue
            g_date = cnls.lunar_to_gre(g_year, h_month, h_day)
            if year_dates := dates.get(g_year):
                year_dates[hol_name] = g_date
            else:
                dates[g_year] = {hol_name: g_date}
        dates[g_year]["DIWALI"] = cnls.s_diwali_date(g_year)
        dates[g_year]["THAIPUSAM"] = cnls.thaipusam_date(g_year)
        dates[g_year]["VESAK_MAY"] = cnls.vesak_may_date(g_year)

    for calendar in CALENDARS:
        holiday_names = sorted(d[2] for d in ASIAN_HOLIDAYS if d[3] == calendar)
        holiday_data = []
        for hol_name in holiday_names:
            year_dates = []
            for year in range(g_year_min, g_year_max + 1):
                d = dates[year].get(hol_name)
                date_str = f"{d.strftime('%b').upper()}, {d.day}"
                year_dates.append(YEAR_TEMPLATE.format(year=year, date=date_str))
            year_dates_str = "\n".join(year_dates)
            holiday_data.append(
                HOLIDAY_ARRAY_TEMPLATE.format(hol_name=hol_name, year_dates=year_dates_str)
            )
        holiday_data_str = "\n".join(holiday_data)
        cal_name = CALENDARS[calendar]
        class_str = CLASS_TEMPLATE.format(
            class_name=CLASS_NAME.format(cal_name=cal_name),
            holiday_data=holiday_data_str,
        )

        path = Path("holidays/calendars") / OUT_FILE_NAME.format(cal_name=cal_name.lower())
        path.write_text(class_str, encoding="UTF-8")


if __name__ == "__main__":
    generate_data()