Skip to content

Commit f194271

Browse files
committed
docs/stdlib: be direct w/ advising against AsyncBoundLogger
1 parent 72943b3 commit f194271

1 file changed

Lines changed: 3 additions & 8 deletions

File tree

‎src/structlog/stdlib.py‎

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -537,14 +537,9 @@ class AsyncBoundLogger:
537537
"""
538538
Wraps a `BoundLogger` & exposes its logging methods as ``async`` versions.
539539
540-
Instead of blocking the program, they are run asynchronously in a thread
541-
pool executor.
542-
543-
This means more computational overhead per log call. But it also means that
544-
the processor chain (e.g. JSON serialization) and I/O won't block your
545-
whole application.
546-
547-
Only available for Python 3.7 and later.
540+
This approach has turned out to be a mistake and the class has been
541+
deprecated in 23.1.0. Use the regular `BoundLogger` with its a-prefixed
542+
methods instead.
548543
549544
.. versionadded:: 20.2.0
550545
.. versionchanged:: 20.2.0 fix _dispatch_to_sync contextvars usage

0 commit comments

Comments
 (0)