Skip to content

Synchronize entity dynamic imports #1794

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 3 commits into from
May 22, 2024
Merged

Synchronize entity dynamic imports #1794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
061a0e9
Solves #1514 by synchronizing dynamic imports in ThreadPoolExecutor
Izzette May 16, 2024
0fbcbdd
Replace EntityLoader thread pool to use RLock
Izzette May 16, 2024
b747c69
Add comment describing RLock
Izzette May 22, 2024
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
1 change: 1 addition & 0 deletions AUTHORS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ Heikki Orsila
Henrik Sozzi
Hugh McNamara
Hugo van Kemenade
Isabelle COWAN-BERGMAN
Jacky Han
Jacob Punter
Jaemin Kim
Expand Down
11 changes: 10 additions & 1 deletion holidays/registry.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
# License: MIT (see LICENSE file)

import importlib
from threading import RLock
from typing import Any, Dict, Iterable, Optional, Tuple, Union

from holidays.holiday_base import HolidayBase
Expand Down Expand Up @@ -178,6 +179,11 @@
"ny_stock_exchange": ("NewYorkStockExchange", "NYSE", "XNYS"),
}

# A re-entrant lock. Once a thread has acquired a re-entrant lock,
# the same thread may acquire it again without blocking.
# https://docs.python.org/3/library/threading.html#rlock-objects
IMPORT_LOCK = RLock()

Comment thread
Izzette marked this conversation as resolved.

class EntityLoader:
"""Country and financial holidays entities lazy loader."""
Expand Down Expand Up @@ -223,7 +229,10 @@ def __str__(self) -> str:
def get_entity(self) -> Optional[HolidayBase]:
"""Return lazy-loaded entity."""
if self.entity is None:
self.entity = getattr(importlib.import_module(self.module_name), self.entity_name)
# Avoid deadlock due to importlib.import_module not being thread-safe by caching all
# the first imports in a dedicated thread.
with IMPORT_LOCK:
self.entity = getattr(importlib.import_module(self.module_name), self.entity_name)

return self.entity

Expand Down