Added:
* structlog.tracebacks.Stack now includes an exc_notes field reflecting
the notes attached to the exception. #684
Changed:
* structlog.stdlib.BoundLogger's binding-related methods now also return Self. #694
* structlog.processors.TimeStamper now produces internally timezone-aware
datetime objects. Default output hasn't changed, but you can now use %z in your fmt string. #709
Fixed:
* Expose structlog.dev.RichTracebackFormatter for imports. #699
* Expose structlog.processors.LogfmtRenderer for imports. #701
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-structlog?expand=0&rev=28
Added:
* Add structlog.stdlib.render_to_log_args_and_kwargs processor. Same
as structlog.stdlib.render_to_log_kwargs, but also allows to pass
positional arguments to logging. With it, you do not need to add
structlog.stdlib.PositionalArgumentsFormatter processor to format
positional arguments from structlog loggers. #668
* Native loggers now have is_enabled_for() and get_effective_level()
methods that mirror the behavior of the standard library's
logging.Logger.isEnabledFor() and logging.Logger.getEffectiveLevel(). #689
Changed:
* structlog.typing.BindableLogger protocol now returns Self instead
of BindableLogger. 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 adds structlog.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 key
exception: "MISSING" or lead to an error. Now, an invalid or missing exc_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 to error() or critical(). #677
* structlog.tracebacks.ExceptionDictTransformer now actually accepts None for locals_max_length
and locals_max_string. #675
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-structlog?expand=0&rev=26
- Update to 24.4.0:
* This is just a docs / PyPI README update. No code changes whatsoever.
- Update to 24.3.0:
* Restore feature parity between structlog.traceback.ExceptionDictTransformer
and Rich's traceback extractor #627
+ When displaying locals, use Rich for formatting if it is available.
+ When displaying locals, call repr() on strings, too (improves handling of
SecretStr implementations).
+ Add locals_max_length config option
+ Add locals_hide_sunder config option
+ Add locals_hide_dunder config option
+ Add suppress config option
* structlog.testing.capture_logs() now maps the exception log level to
error (as it's elsewhere) #628
OBS-URL: https://build.opensuse.org/request/show/1188962
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-structlog?expand=0&rev=24
* It is now possible to disable log level-padding in
`structlog.dev.LogLevelColumnFormatter` and
`structlog.dev.ConsoleRenderer`.
* The `structlog.processors.CallsiteParameterAdder` can now be
pickled.
* `structlog.processors.CallsiteParameterAdder` now also works
with `structlog.stdlib.BoundLogger`'s non-standard async
methods (`ainfo()`, and so forth)
* `structlog.processors.LogfmtRenderer` now escapes newlines.
* `structlog.processors.LogfmtRenderer` now escapes backslashes
and double quotes.
* `structlog.processors.CallsiteParameterAdder` has been
optimized to be about 2x faster.
* `structlog.stdlib.render_to_log_kwargs` now correctly passes
stacklevel as a kwarg to stdlib logging.
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-structlog?expand=0&rev=22
* The lazy logger proxy returned by `structlog.get_logger()`
now returns its initial values when asked for context.
* When asked for context before binding for the first time, it
returned an empty dictionary in 23.3.0.
* The displayed level name when using
`structlog.stdlib.BoundLogger.exception()` is `"error"`
instead of `"exception"`.
* Don't ignore the `width` argument of
`RichTracebackFormatter`.
* Implementing the output on top of the new columns API has
changed the default very slightly, but shouldn't be
noticeable.
* Async log methods (those starting with an `a`) now also
support the collection of callsite information using
`structlog.processors.CallsiteParameterAdder`.
* `structlog.stdlib.recreate_defaults()` now also adds
`structlog.stdlib.add_logger_name` to the processors.
* The return value from `get_logger()` (a
`BoundLoggerLazyProxy`) now passes `isinstance`-checks
against `structlog.typing.BindableLogger` on Python 3.12.
* `structlog.threadlocal.tmp_bind()` now also works with
`BoundLoggerLazyProxy` (in other words: before anything is
bound to a bound logger).
* stdlib: `ProcessorFormatter` can now be told to not render
the log record message using `getMessage` and just
`str(record.msg)` instead.
* stdlib: `structlog.stdlib.BoundLogger.exception()`'s handling
of`LogRecord.exc_info` is now set consistent with `logging`.
* Official support for Python 3.12.
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-structlog?expand=0&rev=18
- Update to 22.1.0:
Removed:
* Python 3.6 is not supported anymore.
* Pickling is now only possible with protocol version 3 and newer.
Deprecated:
* The entire structlog.threadlocal module is deprecated. Please use the
primitives from structlog.contextvars instead.
* If you're using the modern APIs (bind_threadlocal() / merge_threadlocal())
it's enough to replace them 1:1 with their contextvars counterparts. The old
approach around wrap_dict() has been discouraged for a while.
* Currently there are no concrete plans to remove the module, but no patches
against it will be accepted from now on. #409
Added:
* structlog.processors.StackInfoRenderer now has an additional_ignores
parameter that allows you to filter out your own logging layer. #396
* Added structlog.WriteLogger, a faster – but more low-level – alternative to
structlog.PrintLogger. It works the way PrintLogger used to work in previous
versions. #403#404
* structlog.make_filtering_bound_logger()-returned loggers now also have a
log() method to match the structlog.stdlib.BoundLogger signature closer. #413
* Added structured logging of tracebacks via the structlog.tracebacks module,
and most notably the structlog.tracebacks.ExceptionDictTransformer which can be
used with the new structlog.processors.ExceptionRenderer to render JSON
tracebacks. #407
* structlog.stdlib.recreate_defaults(log_level=logging.NOTSET) that recreates
structlog's defaults on top of standard library's logging. It optionally also
configures logging to log to standard out at the passed log level. #428
* structlog.processors.EventRenamer allows you to rename the hitherto
hard-coded event dict key event to something else. Optionally, you can rename
another key to event at the same time, too. So adding EventRenamer(to="msg",
OBS-URL: https://build.opensuse.org/request/show/990495
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-structlog?expand=0&rev=13
- Update to 21.5.0:
* Added the structlog.processors.LogfmtRenderer processor to render
log lines using the logfmt format. #376
* Added the structlog.stdlib.ExtraAdder processor that adds extra
attributes of logging.LogRecord objects to the event dictionary.
This processor can be used for adding data passed in the extra
parameter of the logging module's log methods to the event
dictionary. #209#377
* Added the structlog.processor.CallsiteParameterAdder processor that
adds parameters of the callsite that an event dictionary orginated
from to the event dictionary. This processor can be used to enrich
events dictionaries with information such as the function name,
line number and filename that an event dictionary orignated from. #380
- Update to 21.4.0:
* Fixed import when running in optimized mode (PYTHONOPTIMIZE=2
or python -OO). #373
* Added the structlog.threadlocal.bound_threadlocal and
structlog.contextvars.bound_contextvars decorator/context managers
to temporarily bind key/value pairs to a thread-local and context-local
context. #371
- Update to 21.3.0:
* structlog.dev.ConsoleRenderer now has sort_keys boolean parameter
that allows to disable the sorting of keys on output. #358
* structlog.processors.TimeStamper now works well with FreezeGun
even when it gets applied before the loggers are configured. #364
* structlog.stdlib.AsyncBoundLogger now determines the running loop
when logging, not on instantiation. That has a minor performance
impact, but makes it more robust when loops change
OBS-URL: https://build.opensuse.org/request/show/958252
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-structlog?expand=0&rev=12
- Update to 21.2.0:
Highlights:
* Support for for beautiful (and helpful!) exceptions by integrating
ConsoleRenderer with rich or better-exceptions.
* Helpers to access thread-local and context-local context.
* Deeper contextvars support.
Backward-incompatible changes:
* To implement pretty exceptions (see Changes below),
structlog.dev.ConsoleRenderer now formats exceptions itself.
Make sure to remove format_exc_info from your processor chain if you
configure structlog manually. This change is not really breaking
because the old use-case will keep working as before. However if
you pass pretty_exceptions=True (which is the default if either
rich or better-exceptions is installed), a warning will be raised
and the exception will be renderered without prettyfication.
Changes:
* structlog is now importable if sys.stdout is None (e.g. when
running using pythonw). #313
* structlog.threadlocal.get_threadlocal() and
structlog.contextvars.get_contextvars() can now be used to get a copy
of the current thread-local/context-local context that has been bound
using structlog.threadlocal.bind_threadlocal() and
structlog.contextvars.bind_contextvars(). #331#337
* structlog.threadlocal.get_merged_threadlocal(bl) and
structlog.contextvars.get_merged_contextvars(bl) do the same, but
also merge the context from a bound logger bl. Same pull requests as
previous change.
* structlog.contextvars.bind_contextvars() now returns a mapping of
keys to contextvars.Tokens, allowing you to reset values using the
new structlog.contextvars.reset_contextvars(). #339
OBS-URL: https://build.opensuse.org/request/show/925035
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-structlog?expand=0&rev=11
Backward-incompatible changes:
* Python 2.7 and 3.5 aren't supported anymore. The package meta
data should ensure that you keep getting 20.1.0 on those versions. #244
* structlog is now fully type-annotated. This won't break your
applications, but if you use Mypy, it will most likely break your CI.
Deprecations:
* Accessing the _context attribute of a bound logger is now deprecated.
Please use the new structlog.get_context().
Changes:
* structlog has now type hints for all of its APIs! Since structlog
is highly dynamic and configurable, this led to a few concessions
like a specialized structlog.stdlib.get_logger() whose only difference
to structlog.get_logger() is that it has the correct type hints.
We consider them provisional for the time being – i.e. the backward
compatibility does not apply to them in its full strength until we
feel we got it right. Please feel free to provide feedback! #223, #282
* Added structlog.make_filtering_logger that can be used like
configure(wrapper_class=make_filtering_bound_logger(logging.INFO)).
It creates a highly optimized bound logger whose inactive methods
only consist of a return None. This is now also the default logger.
* As a complement, structlog.stdlib.add_log_level() can now
additionally be imported as structlog.processors.add_log_level
since it just adds the method name to the event dict.
* structlog.processors.add_log_level() is now part of the default configuration.
* structlog.stdlib.ProcessorFormatter no longer uses exceptions for
control flow, allowing foreign_pre_chain processors to use
sys.exc_info() to access the real exception.
* Added structlog.BytesLogger to avoid unnecessary encoding round trips.
Concretely this is useful with orjson which returns bytes. #271
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-structlog?expand=0&rev=7
Backward-incompatible changes:
* Python 3.4 is not supported anymore. It has been unsupported by
the Python core team for a while now and its PyPI downloads are negligible.
It's very unlikely that structlog will break under 3.4 anytime soon,
but we don't test it anymore.
Changes:
* Full Python 3.8 support for structlog.stdlib.
* Added more pass-through properties to structlog.stdlib.BoundLogger.
To makes it easier to use it as a drop-in replacement for logging.Logger. #198
* structlog.stdlib.ProcessorFormatter now takes a logger object as an
optional keyword argument. This makes ProcessorFormatter work properly
with stuctlog.stdlib.filter_by_level(). #219
* structlog.dev.ConsoleRenderer now uses no colors by default, if
colorama is not available. #215
* structlog.dev.ConsoleRenderer now initializes colorama lazily, to
prevent accidental side-effects just by importing structlog. #210
* Added new processor structlog.dev.set_exc_info() that will set
exc_info=True if the method's name is exception and exc_info isn't
set at all. This is only necessary when the standard library integration
is not used. It fixes the problem that in the default configuration,
structlog.get_logger().exception("hi") in an except block would not print the
exception without passing exc_info=True to it explicitly. #130, #173, #200, #204
* A best effort has been made to make as much of structlog pickleable as possible
to make it friendlier with multiprocessing and similar libraries.
Some classes can only be pickled on Python 3 or using the dill library
though and that is very unlikely to change.
* So far, the configuration proxy, structlog.processor.TimeStamper,
structlog.BoundLogger, structlog.PrintLogger and structlog.dev.ConsoleRenderer
have been made pickelable. Please report if you need any another class fixed. #126
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-structlog?expand=0&rev=3
