Added type hints for the public functions

regebro · Oct 9, 2023 · 660c499 · 660c499
1 parent bfb32da
commit 660c499
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/tzlocal/unix.py b/tzlocal/unix.py
@@ -202,7 +202,7 @@ def _get_localzone(_root="/"):
     return tz
 
 
-def get_localzone_name():
+def get_localzone_name() -> str:
     """Get the computers configured local timezone name, if any."""
     global _cache_tz_name
     if _cache_tz_name is None:
@@ -211,7 +211,7 @@ def get_localzone_name():
     return _cache_tz_name
 
 
-def get_localzone():
+def get_localzone() -> zoneinfo.ZoneInfo:
     """Get the computers configured local timezone, if any."""
 
     global _cache_tz
@@ -221,7 +221,7 @@ def get_localzone():
     return _cache_tz
 
 
-def reload_localzone():
+def reload_localzone() -> zoneinfo.ZoneInfo:
     """Reload the cached localzone. You need to call this if the timezone has changed."""
     global _cache_tz_name
     global _cache_tz

diff --git a/tzlocal/win32.py b/tzlocal/win32.py
@@ -112,7 +112,7 @@ def _get_localzone_name():
     return timezone
 
 
-def get_localzone_name():
+def get_localzone_name() -> str:
     """Get the zoneinfo timezone name that matches the Windows-configured timezone."""
     global _cache_tz_name
     if _cache_tz_name is None:
@@ -121,7 +121,7 @@ def get_localzone_name():
     return _cache_tz_name
 
 
-def get_localzone():
+def get_localzone() -> zoneinfo.ZoneInfo:
     """Returns the zoneinfo-based tzinfo object that matches the Windows-configured timezone."""
 
     global _cache_tz
@@ -137,7 +137,7 @@ def get_localzone():
     return _cache_tz
 
 
-def reload_localzone():
+def reload_localzone() -> zoneinfo.ZoneInfo:
     """Reload the cached localzone. You need to call this if the timezone has changed."""
     global _cache_tz
     global _cache_tz_name