Fix datetime.datetime.utcnow() deprecation warning (#4158)

* Do not use `utcnow`

* Avoid manual `datetime` patching

* Fix unit tests

* Use freezegun for tests

* Revert "Do not use `utcnow`"

This reverts commit f47b4f2.

* Reapply "Do not use `utcnow`"

This reverts commit 46aa296.

* Switch to `time-machine`

* Use function-level mocks

* Mock things exactly

* Pass around entire `datetime` object, not just years

Author: puddly

requirements_test.txt

@@ -15,3 +15,4 @@ pytest-asyncio
 pytest>=7.1.3
 zigpy>=0.80.0
 ruff==0.9.4 # Keep this in sync with .pre-commit-config.yaml
+time-machine<3,>=2

tests/common.py

@@ -1,7 +1,6 @@
 """Quirks common helpers."""
 
 import asyncio
-import datetime
 
 ZCL_IAS_MOTION_COMMAND = b"\t!\x00\x01\x00\x00\x00\x00\x00"
 ZCL_OCC_ATTR_RPT_OCC = b"\x18d\n\x00\x00\x18\x01"
@@ -25,22 +24,6 @@ def cluster_command(self, tsn, command_id, args):
         self.cluster_commands.append((tsn, command_id, args))
 
 
-class MockDatetime(datetime.datetime):
-    """Override for datetime functions."""
-
-    @classmethod
-    def now(cls):
-        """Return testvalue."""
-
-        return cls(1970, 1, 1, 1, 0, 0)
-
-    @classmethod
-    def utcnow(cls):
-        """Return testvalue."""
-
-        return cls(1970, 1, 1, 2, 0, 0)
-
-
 async def wait_for_zigpy_tasks() -> None:
     """Wait for all running zigpy tasks to finish."""
     tasks = []

tests/test_tuya.py

@@ -5,8 +5,10 @@
 import struct
 from typing import Final
 from unittest import mock
+from zoneinfo import ZoneInfo
 
 import pytest
+import time_machine
 from zigpy.device import Device
 from zigpy.profiles import zha
 from zigpy.quirks import CustomDevice, get_device
@@ -16,7 +18,7 @@
 from zigpy.zcl.clusters.security import IasZone, ZoneStatus
 from zigpy.zcl.foundation import ZCLAttributeDef
 
-from tests.common import ClusterListener, MockDatetime, wait_for_zigpy_tasks
+from tests.common import ClusterListener, wait_for_zigpy_tasks
 import zhaquirks
 from zhaquirks.const import (
     DEVICE_TYPE,
@@ -723,6 +725,7 @@ async def async_success(*args, **kwargs):
         assert status == foundation.Status.UNSUP_CLUSTER_COMMAND
 
 
+@time_machine.travel(datetime.datetime(1970, 1, 1, 1, 0, tzinfo=ZoneInfo("Etc/GMT+1")))
 @pytest.mark.parametrize("quirk", (zhaquirks.tuya.ts0601_trv.MoesHY368_Type1,))
 async def test_moes(zigpy_device_from_quirk, quirk):
     """Test thermostatic valve outgoing commands."""
@@ -1312,9 +1315,6 @@ async def async_success(*args, **kwargs):
         _, status = await onoff_cluster.command(0x0009)
         assert status == foundation.Status.UNSUP_CLUSTER_COMMAND
 
-        origdatetime = datetime.datetime
-        datetime.datetime = MockDatetime
-
         hdr, args = tuya_cluster.deserialize(ZCL_TUYA_SET_TIME_REQUEST)
         tuya_cluster.handle_message(hdr, args)
         await wait_for_zigpy_tasks()
@@ -1329,7 +1329,6 @@ async def async_success(*args, **kwargs):
             ask_for_ack=None,
             priority=None,
         )
-        datetime.datetime = origdatetime
 
 
 @pytest.mark.parametrize("quirk", (zhaquirks.tuya.ts0601_electric_heating.MoesBHT,))

tests/test_tuya_builder.py

@@ -2,16 +2,18 @@
 
 import datetime
 from unittest import mock
+from zoneinfo import ZoneInfo
 
 import pytest
+import time_machine
 from zigpy.quirks.registry import DeviceRegistry
 from zigpy.quirks.v2 import CustomDeviceV2
 import zigpy.types as t
 from zigpy.zcl import foundation
 from zigpy.zcl.clusters.general import Basic
 from zigpy.zcl.clusters.homeautomation import ElectricalMeasurement
 
-from tests.common import ClusterListener, MockDatetime, wait_for_zigpy_tasks
+from tests.common import ClusterListener, wait_for_zigpy_tasks
 import zhaquirks
 from zhaquirks.const import BatterySize
 from zhaquirks.tuya import (
@@ -407,6 +409,7 @@ async def test_tuya_spell(device_mock, read_attr_spell, data_query_spell):
         request_mock.reset_mock()
 
 
+@time_machine.travel(datetime.datetime(1970, 1, 1, 1, 0, tzinfo=ZoneInfo("Etc/GMT+1")))
 async def test_tuya_mcu_set_time(device_mock):
     """Test TuyaQuirkBuilder replacement cluster, set_time requests (0x24) messages for MCU devices."""
 
@@ -430,10 +433,6 @@ async def test_tuya_mcu_set_time(device_mock):
         TUYA_SET_TIME
     ].is_manufacturer_specific
 
-    # Mock datetime
-    origdatetime = datetime.datetime
-    datetime.datetime = MockDatetime
-
     # simulate a SET_TIME message
     hdr, args = ep.tuya_manufacturer.deserialize(ZCL_TUYA_SET_TIME)
     assert hdr.command_id == TUYA_SET_TIME
@@ -450,8 +449,6 @@ async def test_tuya_mcu_set_time(device_mock):
         assert not res_hdr[0].manufacturer
         assert not res_hdr[0].frame_control.is_manufacturer_specific
 
-    datetime.datetime = origdatetime  # restore datetime
-
 
 @pytest.mark.parametrize(
     "force",

tests/test_tuya_mcu.py

@@ -2,11 +2,13 @@
 
 import datetime
 from unittest import mock
+from zoneinfo import ZoneInfo
 
 import pytest
+import time_machine
 from zigpy.zcl import foundation
 
-from tests.common import ClusterListener, MockDatetime
+from tests.common import ClusterListener
 import zhaquirks
 from zhaquirks.tuya import TUYA_MCU_VERSION_RSP, TUYA_SET_TIME, TuyaDPType
 from zhaquirks.tuya.mcu import (
@@ -175,6 +177,7 @@ async def test_tuya_version(zigpy_device_from_quirk, quirk):
     assert succ["mcu_version"] == "2.0.2"
 
 
+@time_machine.travel(datetime.datetime(1970, 1, 1, 1, 0, tzinfo=ZoneInfo("Etc/GMT+1")))
 @pytest.mark.parametrize(
     "quirk", (zhaquirks.tuya.ts0601_dimmer.TuyaDoubleSwitchDimmer,)
 )
@@ -186,10 +189,6 @@ async def test_tuya_mcu_set_time(zigpy_device_from_quirk, quirk):
     tuya_cluster = tuya_device.endpoints[1].tuya_manufacturer
     cluster_listener = ClusterListener(tuya_cluster)
 
-    # Mock datetime
-    origdatetime = datetime.datetime
-    datetime.datetime = MockDatetime
-
     # simulate a SET_TIME message
     hdr, args = tuya_cluster.deserialize(ZCL_TUYA_SET_TIME)
     assert hdr.command_id == TUYA_SET_TIME
@@ -206,9 +205,6 @@ async def test_tuya_mcu_set_time(zigpy_device_from_quirk, quirk):
             TUYA_SET_TIME, [0, 0, 28, 32, 0, 0, 14, 16], expect_reply=False
         )
 
-    # restore datetime
-    datetime.datetime = origdatetime  # restore datetime
-
 
 @pytest.mark.parametrize(
     "quirk", (zhaquirks.tuya.ts0601_dimmer.TuyaDoubleSwitchDimmer,)

tests/test_tuya_valve.py

@@ -1,10 +1,10 @@
 """Tests for Tuya quirks."""
 
-from datetime import datetime, timezone
+from datetime import datetime
 from unittest import mock
-from unittest.mock import patch
 
 import pytest
+import time_machine
 from zigpy.quirks.v2 import EntityMetadata
 from zigpy.zcl import ClusterType, foundation
 
@@ -182,16 +182,7 @@ async def test_giex_functions():
     assert zhaquirks.tuya.tuya_valve.giex_string_to_td("12:01:05,3") == 43265
     assert zhaquirks.tuya.tuya_valve.giex_string_to_dt("--:--:--") is None
 
-    class MockDatetime:
-        def now(self, tz: timezone):
-            """Mock now."""
-            return datetime(2024, 10, 2, 12, 10, 23, tzinfo=tz)
-
-        def strptime(self, v: str, fmt: str):
-            """Mock strptime."""
-            return datetime.strptime(v, fmt)
-
-    with patch("zhaquirks.tuya.tuya_valve.datetime", MockDatetime()):
+    with time_machine.travel("2024-10-02 12:10:23 +0100"):
         assert zhaquirks.tuya.tuya_valve.giex_string_to_dt(
             "20:12:01"
         ) == datetime.fromisoformat("2024-10-02T20:12:01+04:00")

zhaquirks/tuya/__init__.py

@@ -366,8 +366,8 @@ class TuyaManufCluster(CustomCluster):
     name = "Tuya Manufacturer Specicific"
     cluster_id = TUYA_CLUSTER_ID
     ep_attribute = "tuya_manufacturer"
-    set_time_offset = 0
-    set_time_local_offset = None
+    set_time_offset: datetime.datetime | None = None
+    set_time_local_offset: datetime.datetime | None = None
 
     # remove manufacturer id for cluster, important for `TUYA_SET_DATA` commands
     manufacturer_id_override: t.uint16_t = foundation.ZCLHeader.NO_MANUFACTURER_ID
@@ -450,7 +450,7 @@ def handle_cluster_request(
     ) -> None:
         """Handle time request."""
 
-        if hdr.command_id != 0x0024 or self.set_time_offset == 0:
+        if hdr.command_id != 0x0024 or self.set_time_offset is None:
             return super().handle_cluster_request(
                 hdr, args, dst_addressing=dst_addressing
             )
@@ -466,20 +466,15 @@ def handle_cluster_request(
             self.cluster_id,
             hdr.command_id,
         )
+
+        assert self.set_time_local_offset is not None
+
         payload = TuyaTimePayload()
         utc_timestamp = int(
-            (
-                datetime.datetime.utcnow()  # noqa: DTZ003
-                - datetime.datetime(self.set_time_offset, 1, 1)
-            ).total_seconds()
+            (datetime.datetime.now(datetime.UTC) - self.set_time_offset).total_seconds()
         )
         local_timestamp = int(
-            (
-                datetime.datetime.now()
-                - datetime.datetime(
-                    self.set_time_local_offset or self.set_time_offset, 1, 1
-                )
-            ).total_seconds()
+            (datetime.datetime.now() - self.set_time_local_offset).total_seconds()
         )
         payload.extend(utc_timestamp.to_bytes(4, "big", signed=False))
         payload.extend(local_timestamp.to_bytes(4, "big", signed=False))

zhaquirks/tuya/mcu/__init__.py

@@ -152,8 +152,8 @@ class TuyaConnectionStatus(t.Struct):
 class TuyaMCUCluster(TuyaAttributesCluster, TuyaNewManufCluster):
     """Manufacturer specific cluster for sending Tuya MCU commands."""
 
-    set_time_offset = 1970  # MCU timestamp from 1/1/1970
-    set_time_local_offset = None
+    set_time_offset = datetime.datetime(1970, 1, 1, tzinfo=datetime.UTC)
+    set_time_local_offset = datetime.datetime(1970, 1, 1)
 
     # TODO: Backwards compatibility, remove
     MCUVersion = MCUVersion
@@ -311,16 +311,12 @@ def handle_set_time_request(self, payload: t.uint16_t) -> foundation.Status:
         self.debug("handle_set_time_request payload: %s", payload)
         payload_rsp = TuyaTimePayload()
 
-        utc_now = datetime.datetime.utcnow()  # noqa: DTZ003
-        now = datetime.datetime.now()
-
-        offset_time = datetime.datetime(self.set_time_offset, 1, 1)
-        offset_time_local = datetime.datetime(
-            self.set_time_local_offset or self.set_time_offset, 1, 1
+        utc_timestamp = int(
+            (datetime.datetime.now(datetime.UTC) - self.set_time_offset).total_seconds()
+        )
+        local_timestamp = int(
+            (datetime.datetime.now() - self.set_time_local_offset).total_seconds()
         )
-
-        utc_timestamp = int((utc_now - offset_time).total_seconds())
-        local_timestamp = int((now - offset_time_local).total_seconds())
 
         payload_rsp.extend(utc_timestamp.to_bytes(4, "big", signed=False))
         payload_rsp.extend(local_timestamp.to_bytes(4, "big", signed=False))

zhaquirks/tuya/ts0601_haozee.py

@@ -1,5 +1,6 @@
 """Map from manufacturer to standard clusters for thermostatic valves."""
 
+import datetime
 from typing import Final
 
 import zigpy.profiles.zha
@@ -79,8 +80,8 @@ class HY08WEManufCluster(TuyaManufClusterAttributes):
     """Manufacturer Specific Cluster of some thermostatic valves."""
 
     # Important! This device uses offset from 2000 year for UTC time and offset from 1970 for local time
-    set_time_offset = 2000
-    set_time_local_offset = 1970
+    set_time_offset = datetime.datetime(2000, 1, 1, tzinfo=datetime.UTC)
+    set_time_local_offset = datetime.datetime(1970, 1, 1)
 
     class AttributeDefs(TuyaManufClusterAttributes.AttributeDefs):
         """Attribute definitions."""

zhaquirks/tuya/ts0601_trv.py

@@ -1,5 +1,6 @@
 """Map from manufacturer to standard clusters for thermostatic valves."""
 
+import datetime
 import logging
 from typing import Final, Optional, Union
 
@@ -54,7 +55,8 @@
 class SiterwellManufCluster(TuyaManufClusterAttributes):
     """Manufacturer Specific Cluster of some thermostatic valves."""
 
-    set_time_offset = 1970
+    set_time_offset = datetime.datetime(1970, 1, 1, tzinfo=datetime.UTC)
+    set_time_local_offset = datetime.datetime(1970, 1, 1)
 
     class AttributeDefs(TuyaManufClusterAttributes.AttributeDefs):
         """Attribute definitions."""
@@ -216,7 +218,8 @@ class data144(t.FixedList, item_type=t.uint8_t, length=18):
 class MoesManufCluster(TuyaManufClusterAttributes):
     """Manufacturer Specific Cluster of some thermostatic valves."""
 
-    set_time_offset = 1970
+    set_time_offset = datetime.datetime(1970, 1, 1, tzinfo=datetime.UTC)
+    set_time_local_offset = datetime.datetime(1970, 1, 1)
 
     class AttributeDefs(TuyaManufClusterAttributes.AttributeDefs):
         """Attribute definitions."""