Highlights
Lots of updates to exception handling that I hope will stabilize a bit now.
Full changelog below!
Special Thanks
This release would not be possible without my generous sponsors! Thank you to all of you making sustainable maintenance possible! If you would like to join them, go to https://github.com/sponsors/hynek and check out the sweet perks!
Above and Beyond
Variomedia AG (@variomedia), Tidelift (@tidelift), Klaviyo (@klaviyo), FilePreviews (@filepreviews), Privacy Solutions GmbH (@privacy-solutions), Gedankenspieler (@Gedankenspieler), Daniel Fortunov (@asqui), Kevin P. Fleming (@kpfleming), and Polar (@polarsource).
Maintenance Sustainers
Buttondown (@buttondown), Christopher Dignam (@chdsbd), Stefan Hagen (@sthagen), Magnus Watn (@magnuswatn), David Cramer (@dcramer), Jesse Snyder (@jessesnyder), Rivo Laks (@rivol), Chris Withers (@cjw296), Mike Fiedler (@miketheman), Duncan Hill (@cricalix), Colin Marquardt (@cmarqu), Pieter Swinkels (@swinkels), Nick Libertini (@libertininick), Moving Content AG (@moving-content), ProteinQure (@ProteinQure), The Westervelt Company (@westerveltco), Sławomir Ehlert (@slafs), Mostafa Khalil (@khadrawy), Filip Mularczyk (@mukiblejlok), Thomas Klinger (@thmsklngr), Andreas Poehlmann (@ap--), August Bigelow (@atbigelow), Carlton Gibson (@carltongibson), and Roboflow (@roboflow).
Not to forget 11 more amazing humans who chose to be generous but anonymous!
Full Changelog
Added
-
Add
structlog.stdlib.render_to_log_args_and_kwargs
processor. Same asstructlog.stdlib.render_to_log_kwargs
, but also allows to pass positional arguments tologging
. With it, you do not need to addstructlog.stdlib.PositionalArgumentsFormatter
processor to format positional arguments from structlog loggers. #668 -
Native loggers now have
is_enabled_for()
andget_effective_level()
methods that mirror the behavior of the standard library'slogging.Logger.isEnabledFor()
andlogging.Logger.getEffectiveLevel()
. #689
Changed
-
structlog.typing.BindableLogger
protocol now returnsSelf
instead ofBindableLogger
. This adds a dependency on typing-extensions for Pythons older than 3.11. #642 #659 -
structlog.dev.ConsoleRenderer
will quote string value with special characters. #647 -
structlog.stdlib.recreate_defaults()
now also addsstructlog.stdlib.PositionalArgumentsFormatter
. In default native mode, this is done by the loggers at the edge. -
structlog.make_filtering_bound_logger()
now also accepts a string for min_level.
Fixed
-
Fix handling calls to
{logger}.exception()
outside of exception blocks. Depending on the structlog configuration, this either resulted in an event dict keyexception: "MISSING"
or lead to an error. Now, an invalid or missingexc_info
will just be ignored. This means, that calling{logger}.exception()
outside of an exception block is basically the same as calling{logger}.error()
. #634 #680 -
Instantiating
structlog.dev.ConsoleRenderer
does not mutate the passed styles dict anymore. #669 -
The native
FilteringBoundLogger.fatal()
method now maps to the critical level, as it does in the standard library. Note that the level is discouraged to use there, so we recommend to stick toerror()
orcritical()
. #677 -
structlog.tracebacks.ExceptionDictTransformer
now actually acceptsNone
forlocals_max_length
andlocals_max_string
. #675
This release contains contributions from @aThorp96, @brcsw, @denis-savran, @emmanuel-ferdman, @hynek, @kain88-de, @Sh4pe, @sscherfke, @Tinche, @trim21, and @yaelmi3.
Artifact Attestations
You can verify this release's artifact attestions using GitHub's CLI tool by downloading the sdist and wheel from PyPI and running:
$ gh attestation verify --owner hynek structlog-25.1.0.tar.gz
and
$ gh attestation verify --owner hynek structlog-25.1.0-py3-none-any.whl