Modify the way the local TZ is detected (#100)

Author: seapagan

.pre-commit-config.yaml

@@ -36,6 +36,7 @@ repos:
         additional_dependencies:
           - "types-python-dateutil"
           - "types-redis"
+          - "types-tzlocal"
 
   - repo: https://github.com/python-poetry/poetry
     rev: "1.8.0"

TODO.md

@@ -22,3 +22,8 @@ These below are from Issues or PRs in the original repository.
   the test logic not production code.
 - catch invalid cache type exceptions and raise a more informative error
   message.
+- configure the log time display format in the `Cache` class. Make it
+  totally configurable through an optional parameter and/or detect and use the
+  preferred local time format.
+- catch invalid cache type exceptions and just return a normal response
+  instead of raising Internal Server (500) error

fastapi_redis_cache/client.py

@@ -12,7 +12,8 @@
     Optional,
     Union,
 )
-from zoneinfo import ZoneInfo
+
+import tzlocal
 
 from fastapi_redis_cache.enums import RedisEvent, RedisStatus
 from fastapi_redis_cache.key_gen import get_cache_key
@@ -261,5 +262,5 @@ def get_etag(cached_data: Union[str, bytes, dict[str, Any]]) -> str:
     @staticmethod
     def get_log_time() -> str:
         """Get a timestamp to include with a log message."""
-        local_tz = ZoneInfo("localtime")
+        local_tz = tzlocal.get_localzone()
         return datetime.now(local_tz).strftime(LOG_TIMESTAMP)

poetry.lock

@@ -35,6 +35,7 @@ python = "^3.9"
 pydantic = "^2.7.1"
 redis = "^5.0.4"
 fastapi = { extras = ["all"], version = ">=0.110.2,<0.112.0" }
+tzlocal = "^5.2"
 
 [tool.poetry.group.dev.dependencies]
 # linting etc
@@ -78,6 +79,7 @@ pygments = "^2.17.2"
 # needed for mupy typing
 types-python-dateutil = "^2.9.0.20240316"
 types-redis = "^4.6.0.20240425"
+types-tzlocal = "^5.1.0.1"
 
 
 [build-system]

pyproject.toml

@@ -1,42 +1,42 @@
-annotated-types==0.6.0 ; python_version >= "3.9" and python_version < "4.0"
-anyio==4.3.0 ; python_version >= "3.9" and python_version < "4.0"
+annotated-types==0.7.0 ; python_version >= "3.9" and python_version < "4.0"
+anyio==4.4.0 ; python_version >= "3.9" and python_version < "4.0"
 application-properties==0.8.2 ; python_version >= "3.9" and python_version < "4.0"
 async-timeout==4.0.3 ; python_version >= "3.9" and python_full_version < "3.11.3"
 babel==2.15.0 ; python_version >= "3.9" and python_version < "4.0"
-certifi==2024.2.2 ; python_version >= "3.9" and python_version < "4.0"
+certifi==2024.6.2 ; python_version >= "3.9" and python_version < "4.0"
 cffi==1.16.0 ; python_version >= "3.9" and python_version < "4.0"
 cfgv==3.4.0 ; python_version >= "3.9" and python_version < "4.0"
 charset-normalizer==3.3.2 ; python_version >= "3.9" and python_version < "4.0"
 click==8.1.7 ; python_version >= "3.9" and python_version < "4.0"
 colorama==0.4.6 ; python_version >= "3.9" and python_version < "4.0"
 columnar==1.4.1 ; python_version >= "3.9" and python_version < "4.0"
-coverage[toml]==7.4.4 ; python_version >= "3.9" and python_version < "4.0"
-cryptography==42.0.5 ; python_version >= "3.9" and python_version < "4.0"
+coverage[toml]==7.5.3 ; python_version >= "3.9" and python_version < "4.0"
+cryptography==42.0.8 ; python_version >= "3.9" and python_version < "4.0"
 csscompressor==0.9.5 ; python_version >= "3.9" and python_version < "4.0"
 deprecated==1.2.14 ; python_version >= "3.9" and python_version < "4.0"
 distlib==0.3.8 ; python_version >= "3.9" and python_version < "4.0"
 dnspython==2.6.1 ; python_version >= "3.9" and python_version < "4.0"
-email-validator==2.1.1 ; python_version >= "3.9" and python_version < "4.0"
-exceptiongroup==1.2.0 ; python_version >= "3.9" and python_version < "3.11"
-faker==25.8.0 ; python_version >= "3.9" and python_version < "4.0"
+email-validator==2.2.0 ; python_version >= "3.9" and python_version < "4.0"
+exceptiongroup==1.2.1 ; python_version >= "3.9" and python_version < "3.11"
+faker==25.9.1 ; python_version >= "3.9" and python_version < "4.0"
 fakeredis==2.23.2 ; python_version >= "3.9" and python_version < "4.0"
 fastapi-cli==0.0.4 ; python_version >= "3.9" and python_version < "4.0"
 fastapi[all]==0.111.0 ; python_version >= "3.9" and python_version < "4.0"
-filelock==3.13.1 ; python_version >= "3.9" and python_version < "4.0"
+filelock==3.15.3 ; python_version >= "3.9" and python_version < "4.0"
 ghp-import==2.1.0 ; python_version >= "3.9" and python_version < "4.0"
 gitdb==4.0.11 ; python_version >= "3.9" and python_version < "4.0"
-github-changelog-md==0.9.3 ; python_version >= "3.9" and python_version < "4.0"
+github-changelog-md==0.9.4 ; python_version >= "3.9" and python_version < "4.0"
 gitpython==3.1.43 ; python_version >= "3.9" and python_version < "4.0"
 h11==0.14.0 ; python_version >= "3.9" and python_version < "4.0"
 htmlmin2==0.1.13 ; python_version >= "3.9" and python_version < "4.0"
-httpcore==1.0.4 ; python_version >= "3.9" and python_version < "4.0"
+httpcore==1.0.5 ; python_version >= "3.9" and python_version < "4.0"
 httptools==0.6.1 ; python_version >= "3.9" and python_version < "4.0"
 httpx==0.27.0 ; python_version >= "3.9" and python_version < "4.0"
-identify==2.5.35 ; python_version >= "3.9" and python_version < "4.0"
+identify==2.5.36 ; python_version >= "3.9" and python_version < "4.0"
 idna==3.7 ; python_version >= "3.9" and python_version < "4.0"
-importlib-metadata==7.0.2 ; python_version >= "3.9" and python_version < "3.10"
+importlib-metadata==7.2.0 ; python_version >= "3.9" and python_version < "3.10"
 iniconfig==2.0.0 ; python_version >= "3.9" and python_version < "4.0"
-itsdangerous==2.1.2 ; python_version >= "3.9" and python_version < "4.0"
+itsdangerous==2.2.0 ; python_version >= "3.9" and python_version < "4.0"
 jinja2==3.1.4 ; python_version >= "3.9" and python_version < "4.0"
 jsmin==3.0.1 ; python_version >= "3.9" and python_version < "4.0"
 markdown-it-py==3.0.0 ; python_version >= "3.9" and python_version < "4.0"
@@ -56,23 +56,23 @@ mkdocstrings==0.25.1 ; python_version >= "3.9" and python_version < "4.0"
 mock==5.1.0 ; python_version >= "3.9" and python_version < "4.0"
 mypy-extensions==1.0.0 ; python_version >= "3.9" and python_version < "4.0"
 mypy==1.10.0 ; python_version >= "3.9" and python_version < "4.0"
-nodeenv==1.8.0 ; python_version >= "3.9" and python_version < "4.0"
-orjson==3.9.15 ; python_version >= "3.9" and python_version < "4.0"
-packaging==24.0 ; python_version >= "3.9" and python_version < "4.0"
+nodeenv==1.9.1 ; python_version >= "3.9" and python_version < "4.0"
+orjson==3.10.5 ; python_version >= "3.9" and python_version < "4.0"
+packaging==24.1 ; python_version >= "3.9" and python_version < "4.0"
 paginate==0.5.6 ; python_version >= "3.9" and python_version < "4.0"
 pastel==0.2.1 ; python_version >= "3.9" and python_version < "4.0"
 pathspec==0.12.1 ; python_version >= "3.9" and python_version < "4.0"
-platformdirs==4.2.0 ; python_version >= "3.9" and python_version < "4.0"
+platformdirs==4.2.2 ; python_version >= "3.9" and python_version < "4.0"
 pluggy==1.5.0 ; python_version >= "3.9" and python_version < "4.0"
 poethepoet==0.26.1 ; python_version >= "3.9" and python_version < "4.0"
 pre-commit==3.7.1 ; python_version >= "3.9" and python_version < "4.0"
-pycparser==2.21 ; python_version >= "3.9" and python_version < "4.0"
+pycparser==2.22 ; python_version >= "3.9" and python_version < "4.0"
 pydantic-core==2.18.4 ; python_version >= "3.9" and python_version < "4.0"
-pydantic-extra-types==2.6.0 ; python_version >= "3.9" and python_version < "4.0"
-pydantic-settings==2.2.1 ; python_version >= "3.9" and python_version < "4.0"
+pydantic-extra-types==2.8.2 ; python_version >= "3.9" and python_version < "4.0"
+pydantic-settings==2.3.3 ; python_version >= "3.9" and python_version < "4.0"
 pydantic==2.7.4 ; python_version >= "3.9" and python_version < "4.0"
 pyfakefs==5.5.0 ; python_version >= "3.9" and python_version < "4.0"
-pygithub==2.2.0 ; python_version >= "3.9" and python_version < "4.0"
+pygithub==2.3.0 ; python_version >= "3.9" and python_version < "4.0"
 pygments==2.18.0 ; python_version >= "3.9" and python_version < "4.0"
 pyjwt[crypto]==2.8.0 ; python_version >= "3.9" and python_version < "4.0"
 pymarkdownlnt==0.9.20 ; python_version >= "3.9" and python_version < "4.0"
@@ -98,9 +98,8 @@ redis==5.0.6 ; python_version >= "3.9" and python_version < "4.0"
 regex==2024.5.15 ; python_version >= "3.9" and python_version < "4.0"
 requests==2.32.3 ; python_version >= "3.9" and python_version < "4.0"
 rich==13.7.1 ; python_version >= "3.9" and python_version < "4.0"
-rtoml==0.9.0 ; python_version >= "3.9" and python_version < "4.0"
-ruff==0.4.9 ; python_version >= "3.9" and python_version < "4.0"
-setuptools==69.2.0 ; python_version >= "3.9" and python_version < "4.0"
+rtoml==0.10.0 ; python_version >= "3.9" and python_version < "4.0"
+ruff==0.4.10 ; python_version >= "3.9" and python_version < "4.0"
 shellingham==1.5.4 ; python_version >= "3.9" and python_version < "4.0"
 simple-toml-settings==0.6.1 ; python_version >= "3.9" and python_version < "4.0"
 six==1.16.0 ; python_version >= "3.9" and python_version < "4.0"
@@ -112,18 +111,24 @@ termcolor==2.4.0 ; python_version >= "3.9" and python_version < "4.0"
 tomli==2.0.1 ; python_version >= "3.9" and python_version < "4.0"
 toolz==0.12.1 ; python_version >= "3.9" and python_version < "4.0"
 typer==0.12.3 ; python_version >= "3.9" and python_version < "4.0"
-types-pyopenssl==24.0.0.20240311 ; python_version >= "3.9" and python_version < "4.0"
+types-cffi==1.16.0.20240331 ; python_version >= "3.9" and python_version < "4.0"
+types-pyopenssl==24.1.0.20240425 ; python_version >= "3.9" and python_version < "4.0"
 types-python-dateutil==2.9.0.20240316 ; python_version >= "3.9" and python_version < "4.0"
+types-pytz==2024.1.0.20240417 ; python_version >= "3.9" and python_version < "4.0"
 types-redis==4.6.0.20240425 ; python_version >= "3.9" and python_version < "4.0"
-typing-extensions==4.10.0 ; python_version >= "3.9" and python_version < "4.0"
-ujson==5.9.0 ; python_version >= "3.9" and python_version < "4.0"
+types-setuptools==70.0.0.20240524 ; python_version >= "3.9" and python_version < "4.0"
+types-tzlocal==5.1.0.1 ; python_version >= "3.9" and python_version < "4.0"
+typing-extensions==4.12.2 ; python_version >= "3.9" and python_version < "4.0"
+tzdata==2024.1 ; python_version >= "3.9" and python_version < "4.0" and platform_system == "Windows"
+tzlocal==5.2 ; python_version >= "3.9" and python_version < "4.0"
+ujson==5.10.0 ; python_version >= "3.9" and python_version < "4.0"
 urllib3==2.2.2 ; python_version >= "3.9" and python_version < "4.0"
-uvicorn[standard]==0.28.0 ; python_version >= "3.9" and python_version < "4.0"
+uvicorn[standard]==0.30.1 ; python_version >= "3.9" and python_version < "4.0"
 uvloop==0.19.0 ; (sys_platform != "win32" and sys_platform != "cygwin") and platform_python_implementation != "PyPy" and python_version >= "3.9" and python_version < "4.0"
-virtualenv==20.25.1 ; python_version >= "3.9" and python_version < "4.0"
-watchdog==4.0.0 ; python_version >= "3.9" and python_version < "4.0"
-watchfiles==0.21.0 ; python_version >= "3.9" and python_version < "4.0"
+virtualenv==20.26.2 ; python_version >= "3.9" and python_version < "4.0"
+watchdog==4.0.1 ; python_version >= "3.9" and python_version < "4.0"
+watchfiles==0.22.0 ; python_version >= "3.9" and python_version < "4.0"
 wcwidth==0.2.13 ; python_version >= "3.9" and python_version < "4.0"
 websockets==12.0 ; python_version >= "3.9" and python_version < "4.0"
 wrapt==1.16.0 ; python_version >= "3.9" and python_version < "4.0"
-zipp==3.18.1 ; python_version >= "3.9" and python_version < "3.10"
+zipp==3.19.2 ; python_version >= "3.9" and python_version < "3.10"

requirements-dev.txt

@@ -1,28 +1,28 @@
-annotated-types==0.6.0 ; python_version >= "3.9" and python_version < "4.0"
-anyio==4.3.0 ; python_version >= "3.9" and python_version < "4.0"
+annotated-types==0.7.0 ; python_version >= "3.9" and python_version < "4.0"
+anyio==4.4.0 ; python_version >= "3.9" and python_version < "4.0"
 async-timeout==4.0.3 ; python_version >= "3.9" and python_full_version < "3.11.3"
-certifi==2024.2.2 ; python_version >= "3.9" and python_version < "4.0"
+certifi==2024.6.2 ; python_version >= "3.9" and python_version < "4.0"
 click==8.1.7 ; python_version >= "3.9" and python_version < "4.0"
 colorama==0.4.6 ; python_version >= "3.9" and python_version < "4.0" and (sys_platform == "win32" or platform_system == "Windows")
 dnspython==2.6.1 ; python_version >= "3.9" and python_version < "4.0"
-email-validator==2.1.1 ; python_version >= "3.9" and python_version < "4.0"
-exceptiongroup==1.2.0 ; python_version >= "3.9" and python_version < "3.11"
+email-validator==2.2.0 ; python_version >= "3.9" and python_version < "4.0"
+exceptiongroup==1.2.1 ; python_version >= "3.9" and python_version < "3.11"
 fastapi-cli==0.0.4 ; python_version >= "3.9" and python_version < "4.0"
 fastapi[all]==0.111.0 ; python_version >= "3.9" and python_version < "4.0"
 h11==0.14.0 ; python_version >= "3.9" and python_version < "4.0"
-httpcore==1.0.4 ; python_version >= "3.9" and python_version < "4.0"
+httpcore==1.0.5 ; python_version >= "3.9" and python_version < "4.0"
 httptools==0.6.1 ; python_version >= "3.9" and python_version < "4.0"
 httpx==0.27.0 ; python_version >= "3.9" and python_version < "4.0"
 idna==3.7 ; python_version >= "3.9" and python_version < "4.0"
-itsdangerous==2.1.2 ; python_version >= "3.9" and python_version < "4.0"
+itsdangerous==2.2.0 ; python_version >= "3.9" and python_version < "4.0"
 jinja2==3.1.4 ; python_version >= "3.9" and python_version < "4.0"
 markdown-it-py==3.0.0 ; python_version >= "3.9" and python_version < "4.0"
 markupsafe==2.1.5 ; python_version >= "3.9" and python_version < "4.0"
 mdurl==0.1.2 ; python_version >= "3.9" and python_version < "4.0"
-orjson==3.9.15 ; python_version >= "3.9" and python_version < "4.0"
+orjson==3.10.5 ; python_version >= "3.9" and python_version < "4.0"
 pydantic-core==2.18.4 ; python_version >= "3.9" and python_version < "4.0"
-pydantic-extra-types==2.6.0 ; python_version >= "3.9" and python_version < "4.0"
-pydantic-settings==2.2.1 ; python_version >= "3.9" and python_version < "4.0"
+pydantic-extra-types==2.8.2 ; python_version >= "3.9" and python_version < "4.0"
+pydantic-settings==2.3.3 ; python_version >= "3.9" and python_version < "4.0"
 pydantic==2.7.4 ; python_version >= "3.9" and python_version < "4.0"
 pygments==2.18.0 ; python_version >= "3.9" and python_version < "4.0"
 python-dotenv==1.0.1 ; python_version >= "3.9" and python_version < "4.0"
@@ -34,9 +34,11 @@ shellingham==1.5.4 ; python_version >= "3.9" and python_version < "4.0"
 sniffio==1.3.1 ; python_version >= "3.9" and python_version < "4.0"
 starlette==0.37.2 ; python_version >= "3.9" and python_version < "4.0"
 typer==0.12.3 ; python_version >= "3.9" and python_version < "4.0"
-typing-extensions==4.10.0 ; python_version >= "3.9" and python_version < "4.0"
-ujson==5.9.0 ; python_version >= "3.9" and python_version < "4.0"
-uvicorn[standard]==0.28.0 ; python_version >= "3.9" and python_version < "4.0"
+typing-extensions==4.12.2 ; python_version >= "3.9" and python_version < "4.0"
+tzdata==2024.1 ; python_version >= "3.9" and python_version < "4.0" and platform_system == "Windows"
+tzlocal==5.2 ; python_version >= "3.9" and python_version < "4.0"
+ujson==5.10.0 ; python_version >= "3.9" and python_version < "4.0"
+uvicorn[standard]==0.30.1 ; python_version >= "3.9" and python_version < "4.0"
 uvloop==0.19.0 ; (sys_platform != "win32" and sys_platform != "cygwin") and platform_python_implementation != "PyPy" and python_version >= "3.9" and python_version < "4.0"
-watchfiles==0.21.0 ; python_version >= "3.9" and python_version < "4.0"
+watchfiles==0.22.0 ; python_version >= "3.9" and python_version < "4.0"
 websockets==12.0 ; python_version >= "3.9" and python_version < "4.0"