# 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 (c) 2017-2023 # ryanss (c) 2014-2017 # Website: https://github.com/vacanza/holidays # License: MIT (see LICENSE file) import unittest import warnings from collections import defaultdict from datetime import date from pathlib import Path from unittest import mock import pytest import holidays from holidays.utils import ( CountryHoliday, country_holidays, financial_holidays, list_localized_countries, list_localized_financial, list_supported_countries, list_supported_financial, ) from tests.common import PYTHON_LATEST_SUPPORTED_VERSION, PYTHON_VERSION class TestCountryHolidays(unittest.TestCase): def setUp(self): self.holidays = country_holidays("US") def test_country(self): self.assertEqual(self.holidays.country, "US") def test_country_single_year(self): test_holidays = country_holidays("US", years=2021) self.assertEqual(test_holidays.years, {2021}) def test_country_multiple_years(self): test_holidays = country_holidays("US", years=(2015, 2021)) self.assertEqual(test_holidays.years, {2015, 2021}) def test_country_range_years(self): test_holidays = country_holidays("US", years=range(2010, 2015)) self.assertEqual(test_holidays.years, set(range(2010, 2015))) def test_country_subdivision(self): test_holidays = country_holidays("US", subdiv="NY") self.assertEqual(test_holidays.subdiv, "NY") def test_invalid_country_raises_not_implemented(self): with self.assertRaises(NotImplementedError): country_holidays("XXXX") def test_invalid_country_subdivision_raises_not_implemented(self): with self.assertRaises(NotImplementedError): country_holidays("US", subdiv="XXXX") def test_country_holiday_class_deprecation(self): with self.assertWarns(DeprecationWarning) as ctx: CountryHoliday("IT") self.assertIn("CountryHoliday is deprecated", str(ctx.warning)) class TestFinancialHolidays(unittest.TestCase): def setUp(self): self.holidays = financial_holidays("XNYS") def test_market(self): self.assertEqual(self.holidays.market, "XNYS") def test_market_single_year(self): test_holidays = financial_holidays("XNYS", years=2021) self.assertEqual(test_holidays.years, {2021}) def test_market_multiple_years(self): test_holidays = financial_holidays("XNYS", years=(2015, 2021)) self.assertEqual(test_holidays.years, {2015, 2021}) def test_market_range_years(self): test_holidays = financial_holidays("XNYS", years=range(2010, 2015)) self.assertEqual(test_holidays.years, set(range(2010, 2015))) def test_invalid_market_raises_not_implemented(self): with self.assertRaises(NotImplementedError): financial_holidays("XXXX") def test_invalid_market_subdivision_raises_not_implemented(self): with self.assertRaises(NotImplementedError): financial_holidays("XNYS", subdiv="XXXX") class TestAllInSameYear(unittest.TestCase): """Ensure only holidays in the year(s) requested are returned.""" years = set(range(1950, 2051)) def _check_holidays_years(self, entity_func, entity_list): """ Only holidays in the year(s) requested should be returned. This ensures that we avoid triggering a "RuntimeError: dictionary changed size during iteration" error. This is logic test and not a code compatibility test, so for expediency we only run it once on the latest Python version. """ warnings.simplefilter("ignore") for entity in entity_list: with self.subTest(entity=entity): # Check each year individually for year in self.years: for dt in entity_func(entity, years=year): self.assertEqual(dt.year, year) self.assertIsInstance(dt, date) # Check full range at once all_holidays = entity_func(entity, years=self.years) self.assertEqual(all_holidays.years, self.years) @pytest.mark.skipif( PYTHON_VERSION != PYTHON_LATEST_SUPPORTED_VERSION, reason="Run once on the latest Python version only", ) @mock.patch("pathlib.Path.rglob", return_value=()) def test_all_countries(self, _unused_mock): self._check_holidays_years(country_holidays, list_supported_countries()) @pytest.mark.skipif( PYTHON_VERSION != PYTHON_LATEST_SUPPORTED_VERSION, reason="Run once on the latest Python version only", ) @mock.patch("pathlib.Path.rglob", return_value=()) def test_all_financial(self, _unused_mock): self._check_holidays_years(financial_holidays, list_supported_financial()) class TestListLocalizedEntities(unittest.TestCase): def assertLocalizedEntities(self, localized_entities, supported_entities): # noqa: N802 tests_dir = Path(__file__).parent locale_dir = tests_dir.parent / "holidays" / "locale" # Collect `` part from # holidays/locale//LC_MESSAGES/.mo. entity_to_languages = defaultdict(list) for path in locale_dir.rglob("*.mo"): entity_to_languages[path.stem].append(path.parts[-3]) for entity_code in supported_entities.keys(): actual_languages = sorted(entity_to_languages.get(entity_code, [])) expected_languages = localized_entities.get(entity_code, []) self.assertEqual( actual_languages, expected_languages, f"The supported languages for {entity_code} don't match its actual languages: " f"{set(actual_languages).difference(set(expected_languages))}", ) entity = getattr(holidays, entity_code) self.assertEqual( list(entity.supported_languages), expected_languages, f"The supported languages for {entity_code} don't match " "its `supported_languages`.", ) if expected_languages: self.assertIn( entity.default_language, expected_languages, "The `default_language` must be listed in " f"`supported_languages` for {entity_code}", ) def test_localized_countries(self): self.assertLocalizedEntities( list_localized_countries(), list_supported_countries(include_aliases=False) ) def test_localized_financial(self): self.assertLocalizedEntities( list_localized_financial(), list_supported_financial(include_aliases=False) ) class TestListSupportedEntities(unittest.TestCase): def test_list_supported_countries(self): supported_countries = list_supported_countries(include_aliases=False) for country in ("AR", "IM", "ZA"): self.assertIn(country, supported_countries) us_subdivisions = supported_countries["US"] self.assertIn("CA", us_subdivisions) self.assertIsInstance(us_subdivisions, list) countries_count = sum( 1 for path in Path("holidays/countries").glob("*.py") if path.stem != "__init__" ) self.assertEqual(countries_count, len(supported_countries)) def test_list_supported_financial(self): supported_financial = list_supported_financial(include_aliases=False) for market in ("BVMF", "IFEU", "XECB", "XNYS"): self.assertIn(market, supported_financial) xnys_subdivisions = supported_financial.get("XNYS", []) self.assertIsInstance(xnys_subdivisions, list) financial_count = sum( 1 for path in Path("holidays/financial").glob("*.py") if path.stem != "__init__" ) self.assertEqual(financial_count, len(supported_financial))