Merge pull request #347 from 15r10nk/fix-timezone

fix: datetime with timezone

Author: 15r10nk

changelog.d/20260217_081345_15r10nk-git_fix_timezone.md

@@ -0,0 +1,42 @@
+<!--
+A new scriv changelog fragment.
+
+Uncomment the section that is right (remove the HTML comment wrapper).
+For top level release notes, leave all the headers commented out.
+-->
+
+<!--
+### Removed
+
+- A bullet item for the Removed category.
+
+-->
+<!--
+### Added
+
+- A bullet item for the Added category.
+
+-->
+<!--
+### Changed
+
+- A bullet item for the Changed category.
+
+-->
+<!--
+### Deprecated
+
+- A bullet item for the Deprecated category.
+
+-->
+
+### Fixed
+
+- Fixed handling of `datetime` and `time` objects with timezone information. The `tzinfo` parameter is now properly included in snapshots, and `timezone.utc` is represented with the correct import (`from datetime import timezone`).
+
+<!--
+### Security
+
+- A bullet item for the Security category.
+
+-->

src/inline_snapshot/plugin/_default_plugin.py

@@ -76,6 +76,21 @@ def builtin_function_handler(self, value, builder: Builder):
         if isinstance(value, BuiltinFunctionType):
             return builder.create_code(value.__name__)
 
+    @customize
+    def timezone_handler(self, value, builder: Builder):
+        if isinstance(value, datetime.timezone):
+            # Handle timezone.utc specially - it's a constant, not a constructor call
+            if value == datetime.timezone.utc:
+                return builder.create_code(
+                    "timezone.utc",
+                    imports=[ImportFrom("datetime", "timezone")],
+                )
+
+            # For other timezone objects, use the constructor
+            offset = value.utcoffset(None)
+            tzname = value.tzname(None)
+            return builder.create_call(datetime.timezone, [offset, tzname])
+
     @customize
     def datetime_handler(self, value, builder: Builder):
 
@@ -88,6 +103,7 @@ def datetime_handler(self, value, builder: Builder):
                     "minute": builder.with_default(value.minute, 0),
                     "second": builder.with_default(value.second, 0),
                     "microsecond": builder.with_default(value.microsecond, 0),
+                    "tzinfo": builder.with_default(value.tzinfo, None),
                 },
             )
 
@@ -105,6 +121,7 @@ def datetime_handler(self, value, builder: Builder):
                     "minute": builder.with_default(value.minute, 0),
                     "second": builder.with_default(value.second, 0),
                     "microsecond": builder.with_default(value.microsecond, 0),
+                    "tzinfo": builder.with_default(value.tzinfo, None),
                 },
             )
 

tests/test_datetime_timezone.py

@@ -0,0 +1,142 @@
+from inline_snapshot import snapshot
+from inline_snapshot.testing import Example
+
+
+def test_datetime_with_timezone():
+    Example(
+        {
+            "test_something.py": """\
+from datetime import datetime, timezone
+from inline_snapshot import snapshot
+
+
+def test_datetime():
+    dt = datetime(2026, 2, 16, 5, 0, tzinfo=timezone.utc)
+    assert dt == snapshot()
+""",
+        }
+    ).run_inline(
+        ["--inline-snapshot=create"],
+        changed_files=snapshot(
+            {
+                "test_something.py": """\
+from datetime import datetime, timezone
+from inline_snapshot import snapshot
+
+
+def test_datetime():
+    dt = datetime(2026, 2, 16, 5, 0, tzinfo=timezone.utc)
+    assert dt == snapshot(datetime(2026, 2, 16, hour=5, tzinfo=timezone.utc))
+"""
+            }
+        ),
+    ).run_inline()
+
+
+def test_time_with_timezone():
+    Example(
+        {
+            "test_something.py": """\
+from datetime import time, timezone
+from inline_snapshot import snapshot
+
+
+def test_time():
+    t = time(12, 30, tzinfo=timezone.utc)
+    assert t == snapshot()
+""",
+        }
+    ).run_inline(
+        ["--inline-snapshot=create"],
+        changed_files=snapshot(
+            {
+                "test_something.py": """\
+from datetime import time, timezone
+from inline_snapshot import snapshot
+
+
+def test_time():
+    t = time(12, 30, tzinfo=timezone.utc)
+    assert t == snapshot(time(hour=12, minute=30, tzinfo=timezone.utc))
+"""
+            }
+        ),
+    ).run_inline()
+
+
+def test_custom_timezone_with_offset_only():
+    Example(
+        {
+            "test_something.py": """\
+from datetime import datetime, timedelta, timezone
+from inline_snapshot import snapshot
+
+
+def test_custom_tz():
+    tz = timezone(timedelta(hours=5))
+    dt = datetime(2026, 2, 16, 5, 0, tzinfo=tz)
+    assert dt == snapshot()
+""",
+        }
+    ).run_inline(
+        ["--inline-snapshot=create"],
+        changed_files=snapshot(
+            {
+                "test_something.py": """\
+from datetime import datetime, timedelta, timezone
+from inline_snapshot import snapshot
+
+
+def test_custom_tz():
+    tz = timezone(timedelta(hours=5))
+    dt = datetime(2026, 2, 16, 5, 0, tzinfo=tz)
+    assert dt == snapshot(
+        datetime(
+            2026, 2, 16, hour=5, tzinfo=timezone(timedelta(seconds=18000), "UTC+05:00")
+        )
+    )
+"""
+            }
+        ),
+    ).run_inline()
+
+
+def test_custom_timezone_with_name():
+    Example(
+        {
+            "test_something.py": """\
+from datetime import datetime, timedelta, timezone
+from inline_snapshot import snapshot
+
+
+def test_custom_tz_named():
+    tz = timezone(timedelta(hours=-5), "EST")
+    dt = datetime(2026, 2, 16, 5, 0, tzinfo=tz)
+    assert dt == snapshot()
+""",
+        }
+    ).run_inline(
+        ["--inline-snapshot=create"],
+        changed_files=snapshot(
+            {
+                "test_something.py": """\
+from datetime import datetime, timedelta, timezone
+from inline_snapshot import snapshot
+
+
+def test_custom_tz_named():
+    tz = timezone(timedelta(hours=-5), "EST")
+    dt = datetime(2026, 2, 16, 5, 0, tzinfo=tz)
+    assert dt == snapshot(
+        datetime(
+            2026,
+            2,
+            16,
+            hour=5,
+            tzinfo=timezone(timedelta(days=-1, seconds=68400), "EST"),
+        )
+    )
+"""
+            }
+        ),
+    ).run_inline()