TimeStamper now returns UTC timezone for custom format string.

[m-endra]

Summary

This change reverts the ability to display a UTC timestamp with a custom strftime format string in TimeStamper. Previously, the local time zone was used regardless of utc=True flag for TimeStamper. The output for utc=False remains unchanged, and timezone is correctly displayed with %z and %Z.

from structlog.processors import TimeStamper
ts = TimeStamper(fmt="%Y-%m-%d %H:%M:%S %z %Z")
print(ts(None, None, {}))

# BEFORE
{'timestamp': '2025-03-18 10:24:40 +0100 CET'}
# AFTER
{'timestamp': '2025-03-18 09:23:36 +0000 UTC'}

Due to limitations in freezegun, the tests don't simulate execution is different timezones. Maybe a switch to time-machine can fix that.

Feel free to remove comments and descriptions in changelog.

Pull Request Check List

• Do not open pull requests from your main branch – use a separate branch!
  • There's a ton of footguns waiting if you don't heed this warning. You can still go back to your project, create a branch from your main branch, push it, and open the pull request from the new branch.
  • This is not a pre-requisite for your pull request to be accepted, but you have been warned.
• Added tests for changed code.
  • The CI fails with less than 100% coverage.
• New APIs are added to our typing tests in api.py.
• Updated documentation for changed code.
  • New functions/classes have to be added to docs/api.rst by hand.
  • Changed/added classes/methods/functions have appropriate versionadded, versionchanged, or deprecated directives.
    • The next version is the second number in the current release + 1. The first number represents the current year. So if the current version on PyPI is 23.1.0, the next version is gonna be 23.2.0. If the next version is the first in the new year, it'll be 24.1.0.
• Documentation in .rst and .md files is written using semantic newlines.
• Changes (and possible deprecations) are documented in the changelog.
• Consider granting push permissions to the PR branch, so maintainers can fix minor issues themselves without pestering you.

[hynek]

Is this true @adamchainz? 😇

[hynek]

hilariously, I just ran into this bug myself.

thanks, will release asap!

[m-endra]

Haha, good to hear it's not only me seeing that ;)