Remove timezonefinder dependency and automatic timezone lookup

Co-authored-by: llucax <1031485+llucax@users.noreply.github.com>

Author: Copilot

pyproject.toml

@@ -42,7 +42,6 @@ dependencies = [
   "frequenz-client-common >= 0.3.2, < 0.4.0",
   "grpcio >= 1.63.0, < 2",
   "protobuf >= 5.26.1, < 7",
-  "timezonefinder >= 6.2.0, < 7",
   "typing-extensions >= 4.13.0, < 5",
 ]
 dynamic = ["version"]

src/frequenz/client/microgrid/_metadata.py

@@ -7,9 +7,6 @@
 from zoneinfo import ZoneInfo
 
 from frequenz.client.common.microgrid import MicrogridId
-from timezonefinder import TimezoneFinder
-
-_timezone_finder = TimezoneFinder()
 
 
 @dataclass(frozen=True, kw_only=True)
@@ -25,22 +22,9 @@ class Location:
     timezone: ZoneInfo | None = None
     """The timezone of the microgrid.
 
-    If not passed during construction (or `None` is passed), and there is a `longitude`
-    and `latitude`, then the timezone wil be looked up in a database based on the
-    coordinates. This lookup could fail, in which case the timezone will still be
-    `None`.
+    If not provided during construction, the timezone will remain `None`.
     """
 
-    def __post_init__(self) -> None:
-        """Initialize the timezone of the microgrid."""
-        if self.latitude is None or self.longitude is None or self.timezone is not None:
-            return
-
-        timezone = _timezone_finder.timezone_at(lat=self.latitude, lng=self.longitude)
-        if timezone:
-            # The dataclass is frozen, so it needs to use __setattr__ to set the timezone.
-            object.__setattr__(self, "timezone", ZoneInfo(key=timezone))
-
 
 @dataclass(frozen=True, kw_only=True)
 class Metadata:

tests/test_metadata.py

@@ -3,8 +3,6 @@
 
 """Tests for the microgrid metadata types."""
 
-from collections.abc import Iterator
-from unittest.mock import MagicMock, patch
 from zoneinfo import ZoneInfo
 
 import pytest
@@ -13,15 +11,6 @@
 from frequenz.client.microgrid import Location, Metadata
 
 
-@pytest.fixture
-def timezone_finder() -> Iterator[MagicMock]:
-    """Return a mock timezone finder."""
-    with patch(
-        "frequenz.client.microgrid._metadata._timezone_finder", autospec=True
-    ) as mock_timezone_finder:
-        yield mock_timezone_finder
-
-
 @pytest.mark.parametrize(
     "latitude, longitude, timezone",
     [
@@ -32,40 +21,29 @@ def timezone_finder() -> Iterator[MagicMock]:
         (52.52, None, ZoneInfo(key="UTC")),
         (None, 13.405, ZoneInfo(key="UTC")),
         (52.52, 13.405, ZoneInfo(key="UTC")),
+        (52.52, 13.405, None),
     ],
     ids=str,
 )
-def test_location_timezone_not_looked_up_if_not_possible_or_necessary(
-    timezone_finder: MagicMock,
+def test_location_timezone_behavior(
     latitude: float | None,
     longitude: float | None,
     timezone: ZoneInfo | None,
 ) -> None:
-    """Test the location timezone is not looked up if is not necessary or possible."""
-    timezone_finder.timezone_at.return_value = "Europe/Berlin"
-
+    """Test the location timezone behavior with different inputs."""
     location = Location(latitude=latitude, longitude=longitude, timezone=timezone)
 
     assert location.latitude == latitude
     assert location.longitude == longitude
     assert location.timezone == timezone
-    timezone_finder.timezone_at.assert_not_called()
 
 
-@pytest.mark.parametrize("timezone", [None, "Europe/Berlin"], ids=str)
-def test_location_timezone_lookup(
-    timezone_finder: MagicMock, timezone: str | None
-) -> None:
-    """Test the location timezone is looked up if not provided and there is enough info."""
-    timezone_finder.timezone_at.return_value = timezone
-
+def test_location_timezone_remains_none_when_not_provided() -> None:
+    """Test that timezone remains None when not explicitly provided, even with lat/lng."""
     location = Location(latitude=52.52, longitude=13.405)
-
-    if timezone is None:
-        assert location.timezone is None
-    else:
-        assert location.timezone == ZoneInfo(key=timezone)
-    timezone_finder.timezone_at.assert_called_once_with(lat=52.52, lng=13.405)
+    
+    # Timezone should remain None since automatic lookup is no longer performed
+    assert location.timezone is None
 
 
 def test_metadata_initialization() -> None:
@@ -81,11 +59,12 @@ def test_metadata_initialization() -> None:
     assert metadata.microgrid_id == microgrid_id
     assert metadata.location is None
 
-    # Test with only location
+    # Test with only location - timezone should be None even with lat/lng
     location = Location(latitude=52.52, longitude=13.405)
     metadata = Metadata(location=location)
     assert metadata.microgrid_id is None
     assert metadata.location == location
+    assert metadata.location.timezone is None
 
     # Test with both parameters
     metadata = Metadata(microgrid_id=microgrid_id, location=location)