feat: add caching for timezone offsets, significantly speeds up import (#1250)

* feat: add caching for timezone offsets, significantly speeds up import

this is different from pr #1181. it builds a cache at install time which
can be distributed.

closes #533

* Upgrade the minimum version of regex

---------

Co-authored-by: Adrián Chaves <[email protected]>

Author: tobymao

CONTRIBUTING.rst

@@ -179,3 +179,16 @@ Whenever the content of
 the corresponding documentation table::
 
     dateparser_scripts/update_supported_languages_and_locales.py
+
+
+Updating the Timezone Cache
+----------------------------------------------------
+
+Whenever the content of
+``dateparser/timezones.py`` is modified you need to rebuild the timezone cache.
+
+Run this command:
+``BUILD_TZ_CACHE=1 python -c "import dateparser"``
+
+which should update
+``dateparser/data/dateparser_tz_cache.pkl``

MANIFEST.in

@@ -3,6 +3,7 @@ include CONTRIBUTING.rst
 include HISTORY.rst
 include LICENSE
 include README.rst
+include dateparser/data/dateparser_tz_cache.pkl
 include dateparser_data/settings.py
 include requirements.txt
 

dateparser/data/dateparser_tz_cache.pkl

@@ -1,4 +1,8 @@
+import os
+import pickle
+import zlib
 from datetime import datetime, timedelta, timezone, tzinfo
+from pathlib import Path
 
 import regex as re
 
@@ -84,8 +88,47 @@ def get_local_tz_offset():
     return offset
 
 
-_search_regex_parts = []
-_tz_offsets = list(build_tz_offsets(_search_regex_parts))
-_search_regex = re.compile("|".join(_search_regex_parts))
-_search_regex_ignorecase = re.compile("|".join(_search_regex_parts), re.IGNORECASE)
 local_tz_offset = get_local_tz_offset()
+
+_tz_offsets = None
+_search_regex = None
+_search_regex_ignorecase = None
+
+
+def _load_offsets(cache_path, current_hash):
+    global _tz_offsets, _search_regex, _search_regex_ignorecase
+
+    try:
+        with open(cache_path, mode="rb") as file:
+            (
+                serialized_hash,
+                _tz_offsets,
+                _search_regex,
+                _search_regex_ignorecase,
+            ) = pickle.load(file)
+            if current_hash is None or current_hash == serialized_hash:
+                return
+    except (FileNotFoundError, ValueError, TypeError):
+        pass
+
+    _search_regex_parts = []
+    _tz_offsets = list(build_tz_offsets(_search_regex_parts))
+    _search_regex = re.compile("|".join(_search_regex_parts))
+    _search_regex_ignorecase = re.compile("|".join(_search_regex_parts), re.IGNORECASE)
+
+    with open(cache_path, mode="wb") as file:
+        pickle.dump(
+            (current_hash, _tz_offsets, _search_regex, _search_regex_ignorecase),
+            file,
+            protocol=5,
+        )
+
+
+CACHE_PATH = Path(__file__).parent.joinpath("data", "dateparser_tz_cache.pkl")
+
+if "BUILD_TZ_CACHE" in os.environ:
+    current_hash = zlib.crc32(str(timezone_info_list).encode("utf-8"))
+else:
+    current_hash = None
+
+_load_offsets(CACHE_PATH, current_hash)

dateparser/timezone_parser.py

@@ -31,7 +31,7 @@
     install_requires=[
         "python-dateutil>=2.7.0",
         "pytz>=2024.2",
-        "regex>=2015.06.24,!=2019.02.19,!=2021.8.27",
+        "regex>=2024.9.11",
         "tzlocal>=0.2",
     ],
     entry_points={

setup.py

@@ -27,7 +27,7 @@ deps =
     {[testenv]deps}
     python-dateutil==2.7.0
     pytz==2024.2
-    regex==2015.06.24
+    regex==2024.9.11
     tzlocal==0.2
 
 [testenv:min-all]