Skip to content

Introduce HolidayBase methods for proper serialization #2333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arkid15r merged 4 commits into from
Mar 9, 2025
Merged

Introduce HolidayBase methods for proper serialization #2333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9b3eb72
Introduce HolidayBase methods for proper serialization
KJhellico Mar 6, 2025
9658a5f
Update test
KJhellico Mar 6, 2025
9ef839a
Fix key removing
KJhellico Mar 6, 2025
eaa6a31
Apply suggestions from code review
KJhellico Mar 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 43 additions & 28 deletions holidays/holiday_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,36 +365,11 @@ def __init__(
self.observed = observed
self.subdiv = subdiv
self.weekend_workdays = getattr(self, "weekend_workdays", set())

supported_languages = set(self.supported_languages)
if self._entity_code is not None:
fallback = language not in supported_languages
languages = [language] if language in supported_languages else None
locale_directory = str(Path(__file__).with_name("locale"))

# Add entity native content translations.
entity_translation = translation(
self._entity_code,
fallback=fallback,
languages=languages,
localedir=locale_directory,
)
# Add a fallback if entity has parent translations.
if parent_entity := self.parent_entity:
entity_translation.add_fallback(
translation(
parent_entity.country or parent_entity.market,
fallback=fallback,
languages=languages,
localedir=locale_directory,
)
)
self.tr = entity_translation.gettext
else:
self.tr = gettext

self.years = _normalize_arguments(int, years)

# Configure l10n related attributes.
self._init_translation()

# Populate holidays.
for year in self.years:
self._populate(year)
Expand Down Expand Up @@ -592,6 +567,12 @@ def __getitem__(self, key: DateLike) -> Any:

return dict.__getitem__(self, self.__keytransform__(key))

def __getstate__(self) -> dict[str, Any]:
"""Return the object's state for serialization."""
state = self.__dict__.copy()
state.pop("tr", None)
return state

def __keytransform__(self, key: DateLike) -> date:
"""Transforms the date from one of the following types:

Expand Down Expand Up @@ -699,6 +680,11 @@ def __setitem__(self, key: DateLike, value: str) -> None:

dict.__setitem__(self, self.__keytransform__(key), value)

def __setstate__(self, state: dict[str, Any]) -> None:
"""Restore the object's state after deserialization."""
self.__dict__.update(state)
self._init_translation()

def __str__(self) -> str:
if self:
return super().__str__()
Expand Down Expand Up @@ -750,6 +736,35 @@ def get_subdivision_aliases(cls) -> dict[str, list]:

return subdivision_aliases

def _init_translation(self) -> None:
"""Initialize translation function based on language settings."""
supported_languages = set(self.supported_languages)
if self._entity_code is not None:
fallback = self.language not in supported_languages
languages = [self.language] if self.language in supported_languages else None
locale_directory = str(Path(__file__).with_name("locale"))

# Add entity native content translations.
entity_translation = translation(
self._entity_code,
fallback=fallback,
languages=languages,
localedir=locale_directory,
)
# Add a fallback if entity has parent translations.
if parent_entity := self.parent_entity:
entity_translation.add_fallback(
translation(
parent_entity.country or parent_entity.market,
fallback=fallback,
languages=languages,
localedir=locale_directory,
)
)
self.tr = entity_translation.gettext
else:
self.tr = gettext

def _is_leap_year(self) -> bool:
"""
Returns True if the year is leap. Returns False otherwise.
Expand Down
10 changes: 10 additions & 0 deletions tests/test_holiday_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -867,6 +867,16 @@ def test_pickle(self):
self.assertEqual(loaded_holidays, self.hb)
self.assertIn(dt, self.hb)

def test_pickle_localized_entity(self):
for lang in ("uk", "en_US", None):
ua = UA(language=lang)
dt = "2021-01-01"
self.assertIn(dt, self.hb)

loaded_ua = pickle.loads(pickle.dumps(ua))
self.assertEqual(loaded_ua, ua)
self.assertIn(dt, loaded_ua)


class TestSpecialHolidays(unittest.TestCase):
def setUp(self):
Expand Down