Merge pull request #1581 from vacanza/beta

v0.38
vacanza · Dec 4, 2023 · cae4372 · cae4372
2 parents 185e12f + d13d0ef
commit cae4372
Show file tree

Hide file tree

Showing 681 changed files with 640,517 additions and 46,235 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -34,9 +34,8 @@ Your PR description goes here.
 -->
 
 - [ ] I've followed the [contributing guidelines][contributing-guidelines]
-- [ ] I've added references to all holidays information sources used in this PR
-- [ ] The code style looks good: `make pre-commit` command generates no changes
-- [ ] All tests pass locally: `make test`, `make tox` (we strongly encourage adding tests to your code)
+- [ ] I've run `make pre-commit`, it didn't generate any changes
+- [ ] I've run `make test`, all tests passed locally
 
 <!--
   Thanks again for your contribution!

diff --git a/.gitignore b/.gitignore
@@ -9,13 +9,14 @@
 *.DS_Store
 *.egg-info
 *.mo
-*.pot
 *.pyc
 build/*
 coverage.lcov
 dist/
 docs/build
-holidays/locale/pot
+docs/source/_autosummary
+holidays/locale/pot/*.pot
+!holidays/locale/pot/UA.pot
 MANIFEST
 Pipfile
 venv/
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -6,11 +6,17 @@ repos:
       - id: check-builtin-literals
       - id: check-yaml
       - id: end-of-file-fixer
+        exclude_types:
+          - rst
       - id: fix-encoding-pragma
-        args: [--remove]
+        args:
+          - --remove
       - id: mixed-line-ending
-        args: [--fix=lf]
+        args:
+          - --fix=lf
       - id: trailing-whitespace
+        exclude_types:
+          - rst
 
   - repo: https://github.com/python/black
     rev: 23.11.0
@@ -35,14 +41,14 @@ repos:
         exclude: ^(docs)
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.7.0
+    rev: v1.7.1
     hooks:
       - id: mypy
         additional_dependencies: [types-all]
         args:
           - --ignore-missing-imports
-          - --show-error-codes
           - --implicit-optional
+          - --show-error-codes
 
   - repo: https://github.com/pre-commit/pygrep-hooks
     rev: v1.10.0
@@ -53,10 +59,12 @@ repos:
     rev: v6.2.0
     hooks:
       - id: rstcheck
-        additional_dependencies: [rstcheck, sphinx]
+        additional_dependencies:
+          - rstcheck
+          - sphinx
 
   - repo: https://github.com/tox-dev/tox-ini-fmt
-    rev: "1.3.1"
+    rev: '1.3.1'
     hooks:
       - id: tox-ini-fmt
 

diff --git a/CHANGES b/CHANGES
@@ -1,3 +1,20 @@
+Version 0.38
+============
+
+Released December 4, 2023
+
+- Add categories and subdivisions support to special observed holidays (#1561 by @KJhellico)
+- Add categories and subdivisions support to substituted holidays (#1558 by @KJhellico)
+- Update Czechia holidays: add sk localization (#1568 by @jose1711, @arkid15r)
+- Update PR template and contributing guidelines (#1574 by @arkid15r)
+- Update documentation: add supported entities section (#1564 by @arkid15r)
+- Update snapshot generator: group holidays by subdiv (#1578 by @KJhellico)
+- Update test coverage to 100% (#1573 by @arkid15r)
+- Add supported categories validation (#1576 by @arkid15r)
+- Merge substituted holidays with special holidays (#1580 by @KJhellico)
+- Migrate South Korea holidays to ObservedHolidayBase (#1560 by @KJhellico)
+- Prepare project for Weblate integration [UA] (#1565 by @arkid15r)
+
 Version 0.37
 ============
 

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -16,10 +16,11 @@ Basics
 
 When contributing with fixes and new features, please start forking/branching
 from the `beta branch`_ to work on the latest code and reduce merging issues.
-
-Contributed PRs_ are required to include valid test coverage **(the goal is
-100% coverage)** in order to be merged. Please don't hesitate to ask for
-help if you'read struggling with tests.
+If you add/change holiday official dates or names you must include references to
+all sources (government sites, archived web pages, wiki pages, etc) you've used
+while working on this PR. Contributed PRs_ are required to include valid test
+coverage in order to be merged. Please don't hesitate to ask for help if you
+need one with the tests.
 
 Thanks a lot for your support.
 
@@ -77,7 +78,7 @@ Use pytest directly if you need ``-s`` option:
 
 
 Localization
---------------------------
+------------
 .. _ISO 639-1 codes: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
 
 In order to add or update existing holiday names translation you'll need to

diff --git a/Makefile b/Makefile
@@ -22,6 +22,7 @@ clean:
 	find . -name *.pyc -delete
 	rm -rf .mypy_cache/*
 	rm -rf .pytest_cache/*
+	rm -rf docs/build/*
 
 coverage:
 	pytest --cov=. --cov-config=pyproject.toml --cov-report term-missing --dist loadscope --no-cov-on-fail --numprocesses auto

diff --git a/README.rst b/README.rst
@@ -365,7 +365,7 @@ The list of supported countries, their subdivisions, supported languages and cat
    * - Czechia
      - CZ
      -
-     - **cs**, en_US, uk
+     - **cs**, en_US, sk, uk
      -
    * - Denmark
      - DK

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -189,7 +189,7 @@
     "undoc-members": True,
     # 'private-members': False,  # default
     # 'special-members': False,  # default
-    "inherited-members": True,
+    "inherited-members": False,  # Disabled due to performance concerns.
     "show-inheritance": True,
     # 'ignore-module-all': False,  # default
     # 'imported-members': False, # default

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -18,6 +18,7 @@
    examples
    contributing
    api
+   Supported Entities <modules>
    changelog
    genindex
 

diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -0,0 +1,9 @@
+Supported Entities
+==================
+
+.. autosummary::
+   :toctree: _autosummary
+   :recursive:
+
+   holidays.countries
+   holidays.financial
diff --git a/holidays/__init__.py b/holidays/__init__.py
@@ -16,7 +16,7 @@
 from holidays.registry import EntityLoader
 from holidays.utils import *
 
-__version__ = "0.37"
+__version__ = "0.38"
 
 
 EntityLoader.load("countries", globals())

diff --git a/holidays/calendars/__init__.py b/holidays/calendars/__init__.py
@@ -11,12 +11,12 @@
 
 # flake8: noqa: F401
 
-from holidays.calendars.buddhist import _CustomBuddhistHolidays, _BuddhistLunisolar
-from holidays.calendars.chinese import _CustomChineseHolidays, _ChineseLunisolar
+from holidays.calendars.buddhist import _BuddhistLunisolar, _CustomBuddhistHolidays
+from holidays.calendars.chinese import _ChineseLunisolar, _CustomChineseHolidays
 from holidays.calendars.custom import _CustomCalendar
 from holidays.calendars.gregorian import GREGORIAN_CALENDAR
 from holidays.calendars.hebrew import _HebrewLunisolar
-from holidays.calendars.hindu import _HinduLunisolar, _CustomHinduHolidays
+from holidays.calendars.hindu import _CustomHinduHolidays, _HinduLunisolar
 from holidays.calendars.islamic import _CustomIslamicHolidays, _IslamicLunar
 from holidays.calendars.julian import JULIAN_CALENDAR
 from holidays.calendars.julian_revised import JULIAN_REVISED_CALENDAR

diff --git a/holidays/constants.py b/holidays/constants.py
@@ -51,19 +51,3 @@
 HEBREW = "hebrew"
 HINDU = "hindu"
 ISLAMIC = "islamic"
-
-ALL_CATEGORIES = {
-    ARMED_FORCES,
-    BANK,
-    CHINESE,
-    CHRISTIAN,
-    GOVERNMENT,
-    HALF_DAY,
-    HEBREW,
-    HINDU,
-    ISLAMIC,
-    OPTIONAL,
-    PUBLIC,
-    SCHOOL,
-    WORKDAY,
-}
diff --git a/holidays/countries/algeria.py b/holidays/countries/algeria.py
@@ -11,7 +11,7 @@
 
 from gettext import gettext as tr
 
-from holidays.groups import IslamicHolidays, InternationalHolidays
+from holidays.groups import InternationalHolidays, IslamicHolidays
 from holidays.holiday_base import HolidayBase
 
 

diff --git a/holidays/countries/angola.py b/holidays/countries/angola.py
@@ -26,18 +26,18 @@
 class Angola(ObservedHolidayBase, ChristianHolidays, InternationalHolidays, StaticHolidays):
     """
     References:
-    - https://en.wikipedia.org/wiki/Public_holidays_in_Angola
-    - http://www.siac.gv.ao/downloads/181029-Lei-Feriados.pdf
-    - [Decree #5/75] https://www.lexlink.eu/FileGet.aspx?FileId=3023486
-    - [Decree #92/80] https://www.lexlink.eu/FileGet.aspx?FileId=3023473
-    - [Decree #7/92] https://www.lexlink.eu/FileGet.aspx?FileId=3023485
-    - [Law #16/96] https://www.lexlink.eu/FileGet.aspx?FileId=3037036
-    - [Law #1/01] https://www.lexlink.eu/FileGet.aspx?FileId=3029035
-    - [Law #7/03] https://www.lexlink.eu/FileGet.aspx?FileId=3002131
-    - [Law #10/11] https://equadros.gov.ao/documents/40468/0/lei_10_11-1+%281%29.pdf
-    - [Law #11/18] https://equadros.gov.ao/documents/40468/0/Lei_no_11-18+%281%29.pdf
-    - https://www.officeholidays.com/countries/angola/
-    - https://www.timeanddate.com/holidays/angola/
+        - https://en.wikipedia.org/wiki/Public_holidays_in_Angola
+        - http://www.siac.gv.ao/downloads/181029-Lei-Feriados.pdf
+        - `Decree #5/75 <https://www.lexlink.eu/FileGet.aspx?FileId=3023486>`_
+        - [Decree #92/80] https://www.lexlink.eu/FileGet.aspx?FileId=3023473
+        - [Decree #7/92] https://www.lexlink.eu/FileGet.aspx?FileId=3023485
+        - [Law #16/96] https://www.lexlink.eu/FileGet.aspx?FileId=3037036
+        - [Law #1/01] https://www.lexlink.eu/FileGet.aspx?FileId=3029035
+        - [Law #7/03] https://www.lexlink.eu/FileGet.aspx?FileId=3002131
+        - [Law #10/11] https://equadros.gov.ao/documents/40468/0/lei_10_11-1+%281%29.pdf
+        - [Law #11/18] https://equadros.gov.ao/documents/40468/0/Lei_no_11-18+%281%29.pdf
+        - https://www.officeholidays.com/countries/angola/
+        - https://www.timeanddate.com/holidays/angola/
     """
 
     country = "AO"

diff --git a/holidays/countries/aruba.py b/holidays/countries/aruba.py
@@ -20,12 +20,12 @@
 
 class Aruba(HolidayBase, ChristianHolidays, InternationalHolidays):
     """
-    https://www.government.aw/information-public-services/hiring-people_47940/item/holidays_43823.html  # noqa: E501
-    https://www.overheid.aw/informatie-dienstverlening/ondernemen-en-werken-subthemas_46970/item/feestdagen_37375.html  # noqa: E501
-    https://www.gobierno.aw/informacion-tocante-servicio/haci-negoshi-y-traha-sub-topics_47789/item/dia-di-fiesta_41242.html  # noqa: E501
+    https://www.government.aw/information-public-services/hiring-people_47940/item/holidays_43823.html
+    https://www.overheid.aw/informatie-dienstverlening/ondernemen-en-werken-subthemas_46970/item/feestdagen_37375.html
+    https://www.gobierno.aw/informacion-tocante-servicio/haci-negoshi-y-traha-sub-topics_47789/item/dia-di-fiesta_41242.html
     https://www.visitaruba.com/about-aruba/national-holidays-and-celebrations/
     https://www.arubatoday.com/we-celebrate-our-national-hero-betico-croes/
-    https://www.caribbeannewsglobal.com/carnival-monday-remains-a-festive-day-in-aruba/  # noqa: E501
+    https://www.caribbeannewsglobal.com/carnival-monday-remains-a-festive-day-in-aruba/
     https://www.aruba.com/us/calendar/national-anthem-and-flag-day
     """
 

diff --git a/holidays/countries/austria.py b/holidays/countries/austria.py
@@ -19,7 +19,7 @@
 class Austria(HolidayBase, ChristianHolidays, InternationalHolidays):
     country = "AT"
     default_language = "de"
-    supported_categories = {BANK, PUBLIC}
+    supported_categories = (BANK, PUBLIC)
     supported_languages = ("de", "en_US", "uk")
     subdivisions = ("1", "2", "3", "4", "5", "6", "7", "8", "9")
 

diff --git a/holidays/countries/bangladesh.py b/holidays/countries/bangladesh.py
@@ -16,8 +16,9 @@
 
 class Bangladesh(HolidayBase, InternationalHolidays):
     """
-    https://mopa.gov.bd/sites/default/files/files/mopa.gov.bd/public_holiday/61c35b73_e335_462a_9bcf_4695b23b6d82/reg4-2019-212.PDF
-    https://en.wikipedia.org/wiki/Public_holidays_in_Bangladesh
+    References:
+        - https://mopa.gov.bd/sites/default/files/files/mopa.gov.bd/public_holiday/61c35b73_e335_462a_9bcf_4695b23b6d82/reg4-2019-212.PDF  # noqa: E501
+        - https://en.wikipedia.org/wiki/Public_holidays_in_Bangladesh
     """
 
     country = "BD"