"he d Z ddlmZ ddlZddlZddlZddlZddlZddlZddlm Z ddl
m Z m Z m
Z
mZmZmZmZ ej$ dk\ rddl
mZ nddlmZ dd lmZ dd
lmZ dd lmZmZ dd l m Z m Z m Z dd
lm Z m!Z! ddl"m#Z# ddl$m%Z% ddl
m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+ g dZ,ejZ dd-dZ. e/ Z0 G d dejb Z2 G d de Z3d.dZ4 G d d Z5 G d d Z6 G d d Z7 d/d Z8 d/d Z9 d/d!Z: ejv d"dd#dd$d%d jx j{ Z> G d& d' Z?d(Z@ d0d)ZA d1d*ZB G d+ d,ej ZDy)2z
Processors and helpers specific to the :mod:`logging` module from the `Python
standard library `_.
See also :doc:`structlog's standard library support `.
) annotationsN)partial)AnyCallable
CollectionDictIterableSequencecast) )Self )_config)BoundLoggerBase) _find_first_app_frame_and_name
_format_stack)
LEVEL_TO_NAME
NAME_TO_LEVEL
add_log_level)_ASYNC_CALLING_STACKmerge_contextvars) DropEvent)StackInfoRenderer)Context EventDictExcInfo ProcessorProcessorReturnValue
WrappedLogger)
BoundLogger
ExtraAdder
LoggerFactory PositionalArgumentsFormatterProcessorFormatterr add_log_level_numberadd_logger_namefilter_by_level
get_loggerrecreate_defaults render_to_log_args_and_kwargsrender_to_log_kwargs) log_levelc
X | +ddi}t j d dt j | d| t j
t j t t t t t t j d t j d gt t y)
a
Recreate defaults on top of standard library's logging.
The output looks the same, but goes through `logging`.
As with vanilla defaults, the backwards-compatibility guarantees don't
apply to the settings applied here.
Args:
log_level:
If `None`, don't configure standard library logging **at all**.
Otherwise configure it to log to `sys.stdout` at *log_level*
(``logging.NOTSET`` being the default).
If you need more control over `logging`, pass `None` here and
configure it yourself.
.. versionadded:: 22.1.0
.. versionchanged:: 23.3.0 Added `add_logger_name`.
.. versionchanged:: 25.1.0 Added `PositionalArgumentsFormatter`.
NforceT %(message)s)formatstreamlevel)
processors
wrapper_classlogger_factory )logging basicConfigsysstdoutr reset_defaults configurer$ r r r' r _BUILTIN_DEFAULT_PROCESSORSr! r# )r- kws M/var/www/html/sandstorm/venv/lib/python3.12/site-packages/structlog/stdlib.pyr* r* A s . t_
::
( * / / 3 / / 3
"$ c & e Zd ZdZ d ddZy)_FixedFindCallerLoggerzi
Change the behavior of `logging.Logger.findCaller` to cope with
*structlog*'s extra frames.
c t dg \ }}|r t | nd}|j j |j |j j
|fS )z
Finds the first caller frame outside of structlog so that the caller
info is populated for wrapping stdlib.
This logger gets set as the default one when using LoggerFactory.
r: N)r r f_code co_filenamef_linenoco_name)self
stack_info
stacklevelfnamesinfos rB
findCallerz!_FixedFindCallerLogger.findCaller{ sI 1)=4$.
a Dxx##QZZ1A1A5HHrC N)Fr )rL boolrM intreturn tuple[str, int, str, str | None])__name__
__module__ __qualname____doc__rQ r9 rC rB rE rE u s- ;<
I
I47
I )
IrC rE c X e Zd ZU dZded< d+ fd Zd, fd Zd, fd Zd+ fd Zd-d.dZ d-d.d Z
d-d.d
Z e Z d-d.d Z
d-d.d Zd-d.d
Z d- d.dZ d- d/dZ d- d0 fd
Zed1d Zed2d Zed3d Zed4d Zed3d Zed2d Zd5dZ d6 d7dZ d8 d9dZ d:dZ d;dZ d;d Z d4d Z d:d Z!d2d Z"dd"Z%d?d#Z&d?d$Z'd?d%Z(d?d&Z)d?d'Z*d?d(Z+d?d)Z, d@d*Z- xZ.S )Ar! a
Python Standard Library version of `structlog.BoundLogger`.
Works exactly like the generic one except that it takes advantage of
knowing the logging methods in advance.
Use it like::
structlog.configure(
wrapper_class=structlog.stdlib.BoundLogger,
)
It also contains a bunch of properties that pass-through to the wrapped
`logging.Logger` which should make it work as a drop-in replacement.
.. versionadded:: 23.1.0
Async variants `alog()`, `adebug()`, `ainfo()`, and so forth.
.. versionchanged:: 24.2.0
Callsite parameters are now also collected by
`structlog.processors.CallsiteParameterAdder` for async log methods.
logging.Logger_loggerc " t | di |S )zS
Return a new logger with *new_values* added to the existing ones.
r9 )superbindrK
new_values __class__s rB r_ zBoundLogger.bind s w|)j))rC c t | | S )z
Return a new logger with *keys* removed from the context.
Raises:
KeyError: If the key is not part of the context.
)r^ unbindrK keysrb s rB rd zBoundLogger.unbind s w~t$$rC c t | | S )zs
Like :meth:`unbind`, but best effort: missing keys are ignored.
.. versionadded:: 18.2.0
)r^
try_unbindre s rB rh zBoundLogger.try_unbind s w!4((rC c " t | di |S )z
Clear context and binds *initial_values* using `bind`.
Only necessary with dict implementations that keep global state like
those wrapped by `structlog.threadlocal.wrap_dict` when threads
are reused.
r9 )r^ newr` s rB rj zBoundLogger.new s w{(Z((rC c 0 | j d|g|i |S )zP
Process event and call `logging.Logger.debug` with the result.
debug_proxy_to_loggerrK eventargsrA s rB rl zBoundLogger.debug # %t$$WeAdAbAArC c 0 | j d|g|i |S )zO
Process event and call `logging.Logger.info` with the result.
inform ro s rB rt zBoundLogger.info s# %t$$VU@T@R@@rC c 0 | j d|g|i |S )zR
Process event and call `logging.Logger.warning` with the result.
warningrm ro s rB rv zBoundLogger.warning s# %t$$YCCCCrC c 0 | j d|g|i |S )zP
Process event and call `logging.Logger.error` with the result.
errorrm ro s rB rx zBoundLogger.error rr rC c 0 | j d|g|i |S zS
Process event and call `logging.Logger.critical` with the result.
criticalrm ro s rB r{ zBoundLogger.critical # %t$$ZDDDDrC c 0 | j d|g|i |S rz rm ro s rB fatalzBoundLogger.fatal r| rC c T |j dd | j d|g|i |S )z
Process event and call `logging.Logger.exception` with the result,
after setting ``exc_info`` to `True` if it's not already set.
exc_infoT exception)
setdefaultrn ro s rB r zBoundLogger.exception s1
j$'$t$$[%E$E"EErC c > | j t | |g|i |S )zg
Process *event* and call the appropriate logging method depending on
*level*.
)rn r rK r3 rp rq rA s rB logzBoundLogger.log s( %t$$]5%95N4N2NNrC c 6 |r||d< t | |fd|i|S )a
Propagate a method call to the wrapped logger.
This is the same as the superclass implementation, except that
it also preserves positional arguments in the ``event_dict`` so
that the stdlib's support for format strings can be used.
positional_argsrp )r^ rn )rK method_namerp
event_argsevent_kwrb s rB rn z BoundLogger._proxy_to_logger s- *4H& 'w' M5MHMMrC c . | j j S )z5
Returns :attr:`logging.Logger.name`
)r\ rO rK s rB rO zBoundLogger.name s
|| rC c . | j j S )z6
Returns :attr:`logging.Logger.level`
)r\ r3 r s rB r3 zBoundLogger.level s
||!!!rC c . | j j S )z7
Returns :attr:`logging.Logger.parent`
)r\ parentr s rB r zBoundLogger.parent# s
||"""rC c . | j j S )z:
Returns :attr:`logging.Logger.propagate`
)r\ propagater s rB r zBoundLogger.propagate* s
||%%%rC c . | j j S )z9
Returns :attr:`logging.Logger.handlers`
)r\ handlersr s rB r zBoundLogger.handlers1
||$$$rC c . | j j S )z9
Returns :attr:`logging.Logger.disabled`
)r\ disabledr s rB r zBoundLogger.disabled8 r rC c : | j j | y)zR
Calls :meth:`logging.Logger.setLevel` with unmodified arguments.
N)r\ setLevelrK r3 s rB r zBoundLogger.setLevel? s
e$rC c : | j j | S )zT
Calls :meth:`logging.Logger.findCaller` with unmodified arguments.
)rL )r\ rQ )rK rL s rB rQ zBoundLogger.findCallerE s ||&&*&==rC c
J | j j ||||||||| S )zT
Calls :meth:`logging.Logger.makeRecord` with unmodified arguments.
)funcextra)r\
makeRecord)
rK rO r3 fnlnomsgrq r r r s
rB r zBoundLogger.makeRecordM s3 ||&& %S#tXD '
rC c : | j j | y)zP
Calls :meth:`logging.Logger.handle` with unmodified arguments.
N)r\ handlerK records rB r zBoundLogger.handle` s
F#rC c : | j j | y)zT
Calls :meth:`logging.Logger.addHandler` with unmodified arguments.
N)r\
addHandlerrK hdlrs rB r zBoundLogger.addHandlerf s
%rC c : | j j | y)zW
Calls :meth:`logging.Logger.removeHandler` with unmodified arguments.
N)r\
removeHandlerr s rB r zBoundLogger.removeHandlerl s
""4(rC c 6 | j j S )zw
Calls :meth:`logging.Logger.hasHandlers` with unmodified arguments.
Exists only in Python 3.
)r\ hasHandlersr s rB r zBoundLogger.hasHandlersr s ||''))rC c : | j j | y)zV
Calls :meth:`logging.Logger.callHandlers` with unmodified arguments.
N)r\ callHandlersr s rB r zBoundLogger.callHandlersz s
!!&)rC c 6 | j j S )zc
Calls :meth:`logging.Logger.getEffectiveLevel` with unmodified
arguments.
)r\ getEffectiveLevelr s rB r z BoundLogger.getEffectiveLevel s
||--//rC c 8 | j j | S )zV
Calls :meth:`logging.Logger.isEnabledFor` with unmodified arguments.
)r\ isEnabledForr s rB r zBoundLogger.isEnabledFor s ||((//rC c 8 | j j | S )zR
Calls :meth:`logging.Logger.getChild` with unmodified arguments.
)r\ getChild)rK suffixs rB r zBoundLogger.getChild s ||$$V,,rC c ~ K t j t j j j }t j t j j dfd d{ t j | y7 # t j | w xY ww)S
Merge contextvars and log using the sync logger in a thread pool.
Nc 2 j fd S )Nc g i S Nr9 rq rp rA meths rB zABoundLogger._dispatch_to_sync.... U(@T(@R(@ rC runrq ctxrp rA r s rB r z/BoundLogger._dispatch_to_sync.. @A rC ) r setr< _getframef_back contextvars copy_contextasyncioget_running_looprun_in_executorresetrK r rp rq rA scs_tokenr s ```` @rB _dispatch_to_syncz BoundLogger._dispatch_to_sync s ),,S]]_-C-C-J-JK &&( 2**,<<A
! & &y 1
! & &y 1s0 AB=.B# B!B# B=!B# #B::B=c \ K | j | j ||| d{ y7 w)zq
Log using `debug()`, but asynchronously in a separate thread.
.. versionadded:: 23.1.0
N)r rl ro s rB adebugzBoundLogger.adebug & $$TZZbAAA ",*,c \ K | j | j ||| d{ y7 w)zp
Log using `info()`, but asynchronously in a separate thread.
.. versionadded:: 23.1.0
N)r rt ro s rB ainfozBoundLogger.ainfo s& $$TYYtR@@@r c \ K | j | j ||| d{ y7 w)zs
Log using `warning()`, but asynchronously in a separate thread.
.. versionadded:: 23.1.0
N)r rv ro s rB awarningzBoundLogger.awarning s& $$T\\5$CCCr c \ K | j | j ||| d{ y7 w)zq
Log using `error()`, but asynchronously in a separate thread.
.. versionadded:: 23.1.0
N)r rx ro s rB aerrorzBoundLogger.aerror r r c \ K | j | j ||| d{ y7 wzt
Log using `critical()`, but asynchronously in a separate thread.
.. versionadded:: 23.1.0
Nr r{ ro s rB acriticalzBoundLogger.acritical & $$T]]E4DDDr c \ K | j | j ||| d{ y7 wr r ro s rB afatalzBoundLogger.afatal r r c K |j dd du r(|j d t j |d< | j | j ||| d{ y7 w)zu
Log using `exception()`, but asynchronously in a separate thread.
.. versionadded:: 23.1.0
r Tr N)getr< r r r ro s rB
aexceptionzBoundLogger.aexception sV 66*d #t +{0C0K \\^BzN$$T^^UD"EEEs A A( A&!A(c p K | j t | j | ||| d{ y7 w)zo
Log using `log()`, but asynchronously in a separate thread.
.. versionadded:: 23.1.0
N)r r r r s rB alogzBoundLogger.alog s- $$WTXXu%=udBOOO ,646)ra r rT r )rf strrT r r )rp
str | Nonerq r rA r rT r )
r3 rS rp r rq r rA r rT r )
r r rp r r r r r rT r )rT r )rT rS )rT r )rT rR )r3 rS rT None)F)rL rR rT rU )NN)rO r r3 rS r r r rS r r rq tuple[Any, ...]r r r r r r rT logging.LogRecord)r r rT r )r zlogging.HandlerrT r )r3 rS rT rR )r r rT r[
r zCallable[..., Any]rp r rq r rA zdict[str, Any]rT r rp r rq r rA r rT r
r3 r rp r rq r rA r rT r )/rV rW rX rY __annotations__r_ rd rh rj rl rt rv warnrx r{ r~ r r rn propertyrO r3 r r r r r rQ r r r r r r r r r r r r r r r r r r
__classcell__rb s @rB r! r! s . * %))B A D DB E E #'F F/2F:=F F /3OO!+O;>OFIO O !NN N N
N
N, ! ! " " # # & & % % % % % "'> > )>"
&$ & ) ** 00 -2 2 2 2
2
2*BADBEE FPP!$P-0P8;P
PrC r! c , t j | i |S )a/
Only calls `structlog.get_logger`, but has the correct type hints.
.. warning::
Does **not** check whether -- or ensure that -- you've configured
*structlog* for standard library :mod:`logging`!
See :doc:`standard-library` for details.
.. versionadded:: 20.2.0
)r r) )rq initial_valuess rB r) r) s t 6~ 66rC c e Zd ZU dZdZded< ded< dZeZddd dd Z e
dd
Z dd Z dd Z
d d
Zd dZ d dZd dZd dZd dZd dZd dZd dZd dZd dZd dZy) AsyncBoundLoggera
Wraps a `BoundLogger` & exposes its logging methods as ``async`` versions.
Instead of blocking the program, they are run asynchronously in a thread
pool executor.
This means more computational overhead per log call. But it also means that
the processor chain (e.g. JSON serialization) and I/O won't block your
whole application.
Only available for Python 3.7 and later.
.. versionadded:: 20.2.0
.. versionchanged:: 20.2.0 fix _dispatch_to_sync contextvars usage
.. deprecated:: 23.1.0
Use the regular `BoundLogger` with its a-prefixed methods instead.
.. versionchanged:: 23.3.0
Callsite parameters are now also collected for async log methods.
)_loopsync_blr! r r _contextN)_sync_blr c |r|| _ || _ y | j ||| | _ t j | _ y )N)loggerr6 context)r r _bound_logger_factoryr r )rK r r6 r r r s rB __init__zAsyncBoundLogger.__init__# sH #DL DJ 11j' 2
--/
rC c . | j j S r )r r r s rB r zAsyncBoundLogger._context< s ||$$$rC c
j t d di | j j di || j S Nr9 )r r6 r r r )r r r_ r rK ra s rB r_ zAsyncBoundLogger.bind@ s8 &T\\&&44**
rC c
j t d di | j j di || j S r )r r rj r r s rB rj zAsyncBoundLogger.newL s6 %T\\%%3
3**
rC c d t d di | j j | | j S r )r r rd r rK rf s rB rd zAsyncBoundLogger.unbindV s3 (T\\(($/**
rC c d t d di | j j | | j S r )r r rh r r s rB rh zAsyncBoundLogger.try_unbind` s3 ,T\\,,d3**
rC c K t j t j j j }t j t j j | j fd d{ t j | y7 # t j | w xY ww)r c 2 j fd S )Nc g i S r r9 r s rB r zFAsyncBoundLogger._dispatch_to_sync....z r rC r r s rB r z4AsyncBoundLogger._dispatch_to_sync..z r rC N) r r r< r r r r r r r _executorr r s ```` @rB r z"AsyncBoundLogger._dispatch_to_syncj s ),,S]]_-C-C-J-JK &&( 2**,<<A
! & &y 1
! & &y 1s0 AC8B- B+B- C+B- -CCc p K | j | j j ||| d { y 7 wr )r r rl ro s rB rl zAsyncBoundLogger.debug * $$T\\%7%7bIIIr c p K | j | j j ||| d { y 7 wr )r r rt ro s rB rt zAsyncBoundLogger.info s* $$T\\%6%6tRHHHr c p K | j | j j ||| d { y 7 wr r r rv ro s rB rv zAsyncBoundLogger.warning * $$T\\%9%95$KKKr c p K | j | j j ||| d { y 7 wr r ro s rB r zAsyncBoundLogger.warn r r c p K | j | j j ||| d { y 7 wr )r r rx ro s rB rx zAsyncBoundLogger.error r r c p K | j | j j ||| d { y 7 wr r r r{ ro s rB r{ zAsyncBoundLogger.critical * $$T\\%:%:E4LLLr c p K | j | j j ||| d { y 7 wr r ro s rB r~ zAsyncBoundLogger.fatal r r c K |j dd }|%|j d t j }||d< | j | j
j ||| d { y 7 w)Nr r )popr r< r r r r )rK rp rq rA eis rB r zAsyncBoundLogger.exception sc VVJ
%
:"&&-5 B:$$T\\%;%;UD"MMMs A*A4,A2-A4c K | j t | j j | ||| d { y 7 wr )r r r r r s rB r zAsyncBoundLogger.log s8 $$ DLL$$e ,eT2
s 6A >A )
r r[ r6 zIterable[Processor]r r r r r r )rT r )ra r rT r )rf r rT r r r r )rV rW rX rY __slots__r r
r! r r r r r_ rj rd rh r rl rt rv r rx r{ r~ r r r9 rC rB r r s ( %I I ' 0 0 (0 0 0 02 % %
2 2 2 2
2
2*JILLJMM N
rC r c " e Zd ZdZdddZddZy)r# a
Build a standard library logger when an *instance* is called.
Sets a custom logger using :func:`logging.setLoggerClass` so variables in
log format are expanded properly.
>>> from structlog import configure
>>> from structlog.stdlib import LoggerFactory
>>> configure(logger_factory=LoggerFactory())
Args:
ignore_frame_names:
When guessing the name of a logger, skip frames whose names *start*
with one of these. For example, in pyramid applications you'll
want to set it to ``["venusian", "pyramid.config"]``. This argument
is called *additional_ignores* in other APIs throughout
*structlog*.
Nc D || _ t j t y r )_ignorer: setLoggerClassrE )rK ignore_frame_namess rB r zLoggerFactory.__init__ s ) 56rC c |rt j |d S t | j \ }}t j | S )aM
Deduce the caller's module name and create a stdlib logger.
If an optional argument is passed, it will be used as the logger name
instead of guesswork. This optional argument would be passed from the
:func:`structlog.get_logger` call. For example
``structlog.get_logger("foo")`` would cause this method to be called
with ``"foo"`` as its first positional argument.
.. versionchanged:: 0.4.0
Added support for optional positional arguments. Using the first
one for naming the constructed logger.
r )r: getLoggerr r! )rK rq _rO s rB __call__zLoggerFactory.__call__ sA $$T!W- - 1 >4 &&rC r )r# zlist[str] | None)rq r rT r[ rV rW rX rY r r' r9 rC rB r# r# s &7'rC r# c 2 e Zd ZdZdddZ ddZy)r$ aN
Apply stdlib-like string formatting to the ``event`` key.
If the ``positional_args`` key in the event dict is set, it must
contain a tuple that is used for formatting (using the ``%s`` string
formatting operator) of the value from the ``event`` key. This works
in the same way as the stdlib handles arguments to the various log
methods: if the tuple contains only a single `dict` argument it is
used for keyword placeholders in the ``event`` string, otherwise it
will be used for positional placeholders.
``positional_args`` is populated by `structlog.stdlib.BoundLogger` or
can be set manually.
The *remove_positional_args* flag can be set to `False` to keep the
``positional_args`` key in the event dict; by default it will be
removed from the event dict after formatting a message.
c || _ y r )remove_positional_args)rK r+ s rB r z%PositionalArgumentsFormatter.__init__ s
&<#rC c |j d }|r8t | dk( r t |d t r
|d r|d }|dxx |z cc< | j r||d= |S )Nr r r rp )r len
isinstancedictr+ )rK r& __
event_dictrq s rB r' z%PositionalArgumentsFormatter.__call__ sl ~~ /0 4yA~*T!Wd";QAw w 4 ' & &4+;,-rC N)T)r+ rR rT r r& r r0 r r1 r rT r r( r9 rC rB r$ r$ s1 &= $'5> rC r$ c B | j t | r|S t )aA
Check whether logging is configured to accept messages from this log level.
Should be the first processor if stdlib's filtering by level is used so
possibly expensive processors like exception formatters are avoided in the
first place.
>>> import logging
>>> from structlog.stdlib import filter_by_level
>>> logging.basicConfig(level=logging.WARN)
>>> logger = logging.getLogger()
>>> filter_by_level(logger, 'warn', {})
{}
>>> filter_by_level(logger, 'debug', {})
Traceback (most recent call last):
...
DropEvent
)r r r r r r1 s rB r( r( s" * =56
OrC c t | |d< |S )a
Add the log level number to the event dict.
Log level numbers map to the log level names. The Python stdlib uses them
for filtering logic. This adds the same numbers so users can leverage
similar filtering. Compare::
level in ("warning", "error", "critical")
level_number >= 30
The mapping of names to numbers is in
``structlog.stdlib._log_levels._NAME_TO_LEVEL``.
.. versionadded:: 18.2.0
level_number)r r4 s rB r& r& s $ "/{!;J~ rC c l |j d }|| j |d< |S |j |d< |S )z0
Add the logger name to the event dict.
_recordr )r rO )r r r1 r s rB r' r' 3 sC ^^I
&F
~ %{{
8 &{{
8 rC rO pathnamer r9 c v e Zd ZdZdZdd dZ d
dZe d d Ze d d Z y)
r" a
Add 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.
Args:
allow:
An optional collection of attributes that, if present in
`logging.LogRecord` objects, will be copied to event dictionaries.
If ``allow`` is None all attributes of `logging.LogRecord` objects
that do not exist on a standard `logging.LogRecord` object will be
copied to event dictionaries.
.. versionadded:: 21.5.0
)_copierNc ~ | |(t j | j g | | _ y | j | _ y r ) functoolsr
_copy_allowedr; _copy_all)rK allows rB r zExtraAdder.__init__\ s6 %,,T-?-?5JDL >>DLrC c P |j d }|| j || |S )Nr8 )r r; )rK r rO r1 r s rB r' zExtraAdder.__call__f s, ,6>>)+D LLV ,rC c d |j j D ] \ }}|t vs|||< y r )__dict__items_LOG_RECORD_KEYS)clsr1 r keyvalues rB r? zExtraAdder._copy_alln s6 !////1 (JC**"'
3 (rC c T |D ]# }||j v s|j | ||< % y r )rC )rF r@ r1 r rG s rB r> zExtraAdder._copy_allowedv s1 7Cfoo%"(//#"6
3 7rC r )r@ zCollection[str] | NonerT r )r r[ rO r r1 r rT r )r1 r r r rT r )r@ zCollection[str]r1 r r r rT r )
rV rW rX rY r r r' classmethodr? r> r9 rC rB r" r" F s & I*$,/=F ("(,=(
( ( 7 7 7 " 7
7 7rC r" )r rL rM c |j d g|j dd }t D ci c] }||v r||j | }}|r||d< ||fS c c}w )a-
Render ``event_dict`` into positional and keyword arguments for
`logging.Logger` logging methods.
See `logging.Logger.debug` method for keyword arguments reference.
The ``event`` field is passed in the first positional argument, positional
arguments from ``positional_args`` field are passed in subsequent positional
arguments, keyword arguments are extracted from the *event_dict* and the
rest of the *event_dict* is added as ``extra``.
This allows you to defer formatting to `logging`.
.. versionadded:: 25.1.0
rp r r9 r r LOG_KWARG_NAMES)r& r0 r1 rq
kwarg_namekwargss rB r+ r+ sx "
NN7 # Ljnn5F&K LD * # JNN:..F
$w <s Ac |j d |dt D ci c] }||v r||j | c}S c c}w )a
Render ``event_dict`` into keyword arguments for `logging.Logger` logging
methods.
See `logging.Logger.debug` method for keyword arguments reference.
The ``event`` field is translated into ``msg``, keyword arguments are
extracted from the *event_dict* and the rest of the *event_dict* is added as
``extra``.
This allows you to defer formatting to `logging`.
.. versionadded:: 17.1.0
.. versionchanged:: 22.1.0
``exc_info``, ``stack_info``, and ``stacklevel`` are passed as proper
kwargs and not put into ``extra``.
.. versionchanged:: 24.2.0
``stackLevel`` corrected to ``stacklevel``.
rp )r r rL )r& r0 r1 rA s rB r, r, sU , ~~g&
&
Z
r" "
s =c e Zd ZdZ d d fd
Zd fd Ze d d Ze d
d Z xZ S ) r% a
Call *structlog* processors on `logging.LogRecord`\s.
This is an implementation of a `logging.Formatter` that can be used to
format log entries from both *structlog* and `logging`.
Its static method `wrap_for_formatter` must be the final processor in
*structlog*'s processor chain.
Please refer to :ref:`processor-formatter` for examples.
Args:
foreign_pre_chain:
If not `None`, it is used as a processor chain that is applied to
**non**-*structlog* log entries before the event dictionary is
passed to *processors*. (default: `None`)
processors:
A chain of *structlog* processors that is used to process **all**
log entries. The last one must render to a `str` which then gets
passed on to `logging` for output.
Compared to *structlog*'s regular processor chains, there's a few
differences:
- The event dictionary contains two additional keys:
#. ``_record``: a `logging.LogRecord` that either was created
using `logging` APIs, **or** is a wrapped *structlog* log
entry created by `wrap_for_formatter`.
#. ``_from_structlog``: a `bool` that indicates whether or not
``_record`` was created by a *structlog* logger.
Since you most likely don't want ``_record`` and
``_from_structlog`` in your log files, we've added the static
method `remove_processors_meta` to ``ProcessorFormatter`` that
you can add just before your renderer.
- Since this is a `logging` *formatter*, raising
`structlog.DropEvent` will crash your application.
keep_exc_info:
``exc_info`` on `logging.LogRecord`\ s is added to the
``event_dict`` and removed afterwards. Set this to ``True`` to keep
it on the `logging.LogRecord`. (default: False)
keep_stack_info:
Same as *keep_exc_info* except for ``stack_info``. (default: False)
logger:
Logger which we want to push through the *structlog* processor
chain. This parameter is necessary for some of the processors like
`filter_by_level`. (default: None)
pass_foreign_args:
If True, pass a foreign log record's ``args`` attribute to the
``event_dict`` under ``positional_args`` key. (default: False)
processor:
A single *structlog* processor used for rendering the event
dictionary before passing it off to `logging`. Must return a `str`.
The event dictionary does **not** contain ``_record`` and
``_from_structlog``.
This parameter exists for historic reasons. Please use *processors*
instead.
use_get_message:
If True, use ``record.getMessage`` to get a fully rendered log
message, otherwise use ``str(record.msg)``. (default: True)
Raises:
TypeError: If both or neither *processor* and *processors* are passed.
.. versionadded:: 17.1.0
.. versionadded:: 17.2.0 *keep_exc_info* and *keep_stack_info*
.. versionadded:: 19.2.0 *logger*
.. versionadded:: 19.2.0 *pass_foreign_args*
.. versionadded:: 21.3.0 *processors*
.. deprecated:: 21.3.0
*processor* (singular) in favor of *processors* (plural). Removal is not
planned.
.. versionadded:: 23.3.0 *use_get_message*
c |
j dd } t
| | d| i|
|r|r
d} t | | || j |f| _ n|r|| _ n
d} t | || _ || _ || _ || _ || _
|| _ y )Nfmtr0 zBThe `processor` and `processors` arguments are mutually exclusive.z2Either `processor` or `processors` must be passed.) r r^ r TypeErrorremove_processors_metar6 foreign_pre_chain
keep_exc_infokeep_stack_infor pass_foreign_argsuse_get_message)rK processorr6 rV rW rX r rY rZ rq rO rS r rb s rB r zProcessorFormatter.__init__ s jj
.
$2C262
C. # : :I FDO
(DOFCC. !2 * . !2 . rC c t j |j }t |dt }t |dd }|t urw|dk7 rr| j
| j
}t
t |j }t
t t t f |j j }||d< d|d< n| j
}|j j }| j r|j! nt |j |dd }| j" r|j$ |d
< d |_ |j& r|j& |d < |j( r|j( |d
< | j* xs d D ] }t
t, |||| } | j. sd|_ d|_ | j2 sd|_ | j4 D ] } |||t
t, | } t7 |t sIt9 j: d| j4 d dt= | dt> d t
t | }||_ t@ | | S )z
Extract *structlog*'s `event_dict` from ``record.msg`` and format it.
*record* has been patched by `wrap_for_formatter` first though, so the
type isn't quite right.
r\ _name__structlog_sentinel__Nr8 T_from_structlogF)rp r8 r_ r r9 r rL zNThe last processor in ProcessorFormatter.processors must return a string, but r5 z returned a z instead.r )categoryrM )"r:
makeLogRecordrC getattr _SENTINELr r r r] r r r copy levelnamelowerrZ
getMessagerY rq r rL rV r rW exc_textrX r6 r. warningsr typeRuntimeWarningr^ r1 )rK r r meth_nameedprocprb s rB r1 zProcessorFormatter.formatA s. &&v7I6FG-EF "y4L'L{{& S&,,/I
d38nfjj1668B "ByM$(B ![[F ((..0I ++ %%' VZZ !#(B %%(. $% FK !' : #)#4#4< ..4"
B)T&)R%@A
B !! "FO "FO## $F ;A69d9b&9:B ; "c" MM((,(;'r s
#
L L L w & " B D D @ ! ) " 29 .b
H IW^^ I,cP/ cPL
7 a
a
H-' -'`) )X ),:C6 ),:C. ), :C %7$$
Az1eR
(446
97 97x ; ,5+< ,5 @o** orC