h h d Z ddlmZ ddlZddlZddlZddlZddlZddlmZ ddl m
Z
m Z m Z m
Z
mZ ddlmZ ddlmZ dd lmZmZ dd
lmZmZmZ dd lmZ dd lm Z dd
l m Z ddl m Z m Z m!Z!m"Z"m#Z# g dZ$ej% dd8dZ& e' Z( G d dej) Z* G d de Z+d9d Z, G d d Z- G d d! Z. G d" d# Z/d:d*Z0d:d+Z1d:d,Z2 ej3 d-dd.dd/d0d j4 5 Z6 G d1 d2 Z7d;d5Z8 G d6 d7ej9 Z:dS )`_.
See also :doc:`structlog's standard library support `.
) annotationsN)partial)AnyCallable
CollectionIterableSequence )_config)BoundLoggerBase) _find_first_app_frame_and_name
_format_stack)_LEVEL_TO_NAME_NAME_TO_LEVEL
add_log_level)merge_contextvars) DropEvent)StackInfoRenderer)Context EventDictExcInfo Processor
WrappedLogger) add_log_level_numberr add_logger_name
ExtraAdder BoundLoggerfilter_by_level
get_logger
LoggerFactory PositionalArgumentsFormatterProcessorFormatterrecreate_defaultsrender_to_log_kwargs) log_levelr%
int | NonereturnNonec < | #ddi}t j d dt j | d| t j t j t t t t j
d t j
d gt t dS )
ak
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.
Arguments:
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
NforceT %(message)s)formatstreamlevel)
processors
wrapper_classlogger_factory )
logging basicConfigsysstdoutr reset_defaults configurer r r _BUILTIN_DEFAULT_PROCESSORSr r )r% kws ]/var/www/html/web-builder-api.evdpl.com/venv/lib/python3.11/site-packages/structlog/stdlib.pyr# r# 1 s , t_
:
/ 3 / 3
"$
c e Zd ZdZ d d
d
Zd S )_FixedFindCallerLoggerzi
Change the behavior of `logging.Logger.findCaller` to cope with
*structlog*'s extra frames.
Fr
stack_infobool
stacklevelintr' tuple[str, int, str, str | None]c t dg \ }}|rt | 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.
r5 N)r
r f_code co_filenamef_linenoco_name)selfrA rC fnamesinfos r=
findCallerz!_FixedFindCallerLogger.findCallerh sI 1)==4$.8
a Dx#QZ1A5HHr> N)Fr
)rA rB rC rD r' rE )__name__
__module__ __qualname____doc__rO r4 r> r= r@ r@ b sC ;<
I
I
I
I
I
I
Ir> r@ c e Zd ZU dZded< dN fd ZdO fd
ZdO fd ZdN fd ZdPdQdZ dPdQdZ
dPdQdZ e Z dPdQdZ
dPdQdZ dPdQdZ dPdRdZeZ dPdS fd
ZedTd ZedUd ZedVd! ZedWd# ZedVd$ ZedUd% ZdXd'Z dYdZd+Z d[d\d6Z d]d8Z d^d;Z d^d<Z dWd=Z d]d>Z!dUd?Z"d_d@Z#d`dBZ$dadFZ%dbdGZ&dbdHZ'dbdIZ(dbdJZ)dbdKZ*e*Z+dbdLZ,dcdMZ- xZ.S )dr 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.
logging.Logger_logger
new_valuesr r' c 6 t j di |S )zS
Return a new logger with *new_values* added to the existing ones.
r4 )superbindrK rW __class__s r= rZ zBoundLogger.bind s! uww|))j)))r> keysstrc 0 t j | S )z
Return a new logger with *keys* removed from the context.
Raises:
KeyError: If the key is not part of the context.
)rY unbindrK r] r\ s r= r` zBoundLogger.unbind s uww~t$$r> c 0 t j | S )zs
Like :meth:`unbind`, but best effort: missing keys are ignored.
.. versionadded:: 18.2.0
)rY
try_unbindra s r= rc zBoundLogger.try_unbind s "uww!4((r> c 6 t j 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 re-used.
r4 )rY newr[ s r= re zBoundLogger.new s! uww{((Z(((r> Nevent
str | Noneargsr< c & | j d|g|R i |S )zP
Process event and call `logging.Logger.debug` with the result.
debug_proxy_to_loggerrK rf rh r< s r= rj zBoundLogger.debug ) %t$WeAdAAAbAAAr> c & | j d|g|R i |S )zO
Process event and call `logging.Logger.info` with the result.
infork rm s r= rp zBoundLogger.info s) %t$VU@T@@@R@@@r> c & | j d|g|R i |S )zR
Process event and call `logging.Logger.warning` with the result.
warningrk rm s r= rr zBoundLogger.warning s) %t$YCCCCCCCr> c & | j d|g|R i |S )zP
Process event and call `logging.Logger.error` with the result.
errorrk rm s r= rt zBoundLogger.error rn r> c & | j d|g|R i |S )zS
Process event and call `logging.Logger.critical` with the result.
criticalrk rm s r= rv zBoundLogger.critical s) %t$ZDDDDDDDr> c P | dd | j |g|R i |S )z~
Process event and call `logging.Logger.error` with the result,
after setting ``exc_info`` to `True`.
exc_infoT)
setdefaultrt rm s r= exceptionzBoundLogger.exception s:
j$'''tz%-$---"---r> r. rD c < | j t | |g|R i |S )zg
Process *event* and call the appropriate logging method depending on
*level*.
)rl r rK r. rf rh r< s r= logzBoundLogger.log s. %t$^E%:EODOOOBOOOr> method_name
event_argsevent_kwc J |r||d< t j |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_argsrf )rY rl )rK r~ rf r r r\ s r= rl z BoundLogger._proxy_to_logger s< 5*4H& ''uww' MM5MHMMMr> c | j j S )z5
Returns :attr:`logging.Logger.name`
)rV rM rK s r= rM zBoundLogger.name s
| r> c | j j S )z6
Returns :attr:`logging.Logger.level`
)rV r. r s r= r. zBoundLogger.level s
|!!r> c | j j S )z7
Returns :attr:`logging.Logger.parent`
)rV parentr s r= r zBoundLogger.parent
s
|""r> rB c | j j S )z:
Returns :attr:`logging.Logger.propagate`
)rV propagater s r= r zBoundLogger.propagate s
|%%r> c | j j S )z9
Returns :attr:`logging.Logger.handlers`
)rV handlersr s r= r zBoundLogger.handlers
|$$r> c | j j S )z9
Returns :attr:`logging.Logger.disabled`
)rV disabledr s r= r zBoundLogger.disabled r r> r( c : | j | dS )zR
Calls :meth:`logging.Logger.setLevel` with unmodified arguments.
N)rV setLevelrK r. s r= r zBoundLogger.setLevel& s
e$$$$$r> FrA rE c 8 | j | S )zT
Calls :meth:`logging.Logger.findCaller` with unmodified arguments.
)rA )rV rO )rK rA s r= rO zBoundLogger.findCaller, s |&&*&===r> rM fnlnomsgtuple[Any, ...]rx r funcextralogging.LogRecordc
H | j ||||||||| S )zT
Calls :meth:`logging.Logger.makeRecord` with unmodified arguments.
)r r )rV
makeRecord)
rK rM r. r r r rh rx r r s
r= r zBoundLogger.makeRecord4 s6 |&& %S#tXD '
r> recordc : | j | dS )zP
Calls :meth:`logging.Logger.handle` with unmodified arguments.
N)rV handlerK r s r= r zBoundLogger.handleG s
F#####r> hdlrlogging.Handlerc : | j | dS )zT
Calls :meth:`logging.Logger.addHandler` with unmodified arguments.
N)rV
addHandlerrK r s r= r zBoundLogger.addHandlerM s
%%%%%r> c : | j | dS )zW
Calls :meth:`logging.Logger.removeHandler` with unmodified arguments.
N)rV
removeHandlerr s r= r zBoundLogger.removeHandlerS s
""4(((((r> c 4 | j S )zw
Calls :meth:`logging.Logger.hasHandlers` with unmodified arguments.
Exists only in Python 3.
)rV hasHandlersr s r= r zBoundLogger.hasHandlersY s |'')))r> c : | j | dS )zV
Calls :meth:`logging.Logger.callHandlers` with unmodified arguments.
N)rV callHandlersr s r= r zBoundLogger.callHandlersa s
!!&)))))r> c 4 | j S )zc
Calls :meth:`logging.Logger.getEffectiveLevel` with unmodified
arguments.
)rV getEffectiveLevelr s r= r z BoundLogger.getEffectiveLevelg s
|--///r> c 6 | j | S )zV
Calls :meth:`logging.Logger.isEnabledFor` with unmodified arguments.
)rV isEnabledForr s r= r zBoundLogger.isEnabledForn s |((///r> suffixc 6 | j | S )zR
Calls :meth:`logging.Logger.getChild` with unmodified arguments.
)rV getChild)rK r s r= r zBoundLogger.getChildt s |$$V,,,r> methCallable[..., Any]dict[str, Any]c K t j t j dfd d{V dS )S
Merge contextvars and log using the sync logger in a thread pool.
Nc : fd S )Nc g R i S Nr4 rh rf r< r s r= zABoundLogger._dispatch_to_sync.... ! DD$<$<$<$<$<$< r> runrh ctxrf r< r s r= r z/BoundLogger._dispatch_to_sync.. & CGG < < < < < < <== r> ) contextvars copy_contextasyncioget_running_looprun_in_executorrK r rf rh r< r s ````@r= _dispatch_to_syncz BoundLogger._dispatch_to_sync{ s &((&((88 = = = = = = = =
r> c P K | | j ||| d{V dS )zq
Log using `debug()`, but asynchronously in a separate thread.
.. versionadded:: 23.1.0
N)r rj rm s r= adebugzBoundLogger.adebug < $$TZbAAAAAAAAAAAr> c P K | | j ||| d{V dS )zp
Log using `info()`, but asynchronously in a separate thread.
.. versionadded:: 23.1.0
N)r rp rm s r= ainfozBoundLogger.ainfo s< $$TYtR@@@@@@@@@@@r> c P K | | j ||| d{V dS )zs
Log using `warning()`, but asynchronously in a separate thread.
.. versionadded:: 23.1.0
N)r rr rm s r= awarningzBoundLogger.awarning s< $$T\5$CCCCCCCCCCCr> c P K | | j ||| d{V dS )zq
Log using `error()`, but asynchronously in a separate thread.
.. versionadded:: 23.1.0
N)r rt rm s r= aerrorzBoundLogger.aerror r r> c P K | | j ||| d{V dS )zt
Log using `critical()`, but asynchronously in a separate thread.
.. versionadded:: 23.1.0
N)r rv rm s r= acriticalzBoundLogger.acritical s< $$T]E4DDDDDDDDDDDr> c K | dd du r+| d t j |d< | | j ||| d{V dS )zu
Log using `exception()`, but asynchronously in a separate thread.
.. versionadded:: 23.1.0
rx Trz N)getr7 rx r rz rm s r=
aexceptionzBoundLogger.aexception su 66*d # #t + +{0C0C0K \^^BzN$$T^UD"EEEEEEEEEEEr> c l K | t | j | ||| d{V dS )zo
Log using `log()`, but asynchronously in a separate thread.
.. versionadded:: 23.1.0
N)r r r} r| s r= alogzBoundLogger.alog sF $$WTXu%=%=udBOOOOOOOOOOOr> )rW r r' r )r] r^ r' r r )rf rg rh r r< r r' r )
r. rD rf rg rh r r< r r' r )
r~ r^ rf rg r r^ r r r' r )r' r^ )r' rD )r' r )r' rB )r. rD r' r( )F)rA rB r' rE )NN)rM r^ r. rD r r^ r rD r r^ rh r rx r r rg r r r' r )r r r' r( )r r r' r( )r. rD r' rB )r r^ r' rU
r r rf r^ rh r r< r r' r( rf r^ rh r r< r r' r(
r. r rf r^ rh r r< r r' r( )/rP rQ rR rS __annotations__rZ r` rc re rj rp rr warnrt rv rz r} fatalrl propertyrM r. r r r r r rO r r r r r r r r r r r r r r r afatalr r
__classcell__r\ s @r= r r x s? & * * * * * * % % % % % %) ) ) ) ) )) ) ) ) ) )B B B B B A A A A A D D D D D DB B B B B E E E E E #' . . . . . /3P P P P P
E
!N N N N N N N, ! ! ! X! " " " X" # # # X# & & & X& % % % X% % % % X% % % % % "'> > > > >"
&$ $ $ $ & & & & ) ) ) ) * * * ** * * * 0 0 0 00 0 0 0 - - - -
"B B B BA A A AD D D DB B B BE E E E F F F F FP P P P P P P Pr> r rh r initial_valuesc $ 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 )rh r s r= r r s t 6~ 6 66r> c e Zd ZU dZdZded< ded< dZeZdddd,dZ e
d-d Z d.dZ d.dZ
d/dZd/dZd0d#Zd1d$Zd1d%Zd1d&ZeZd1d'Zd1d(ZeZd1d)Zd2d+ZdS )3AsyncBoundLoggera`
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.
)sync_bl_loopr r r _contextN)_sync_blr loggerrU r1 Iterable[Processor]contextr r r c |r|| _ || _ d S | ||| | _ t j | _ d S )N)r r1 r )r r _bound_logger_factoryr r )rK r r1 r r r s r= __init__zAsyncBoundLogger.__init__ sX #DL DJ F11j' 2
-//
r> r' c | j j S r )r r r s r= r zAsyncBoundLogger._context s
|$$r> rW c
T t d di | j j di || j S Nr4 )r r1 r r r )r r rZ r rK rW s r= rZ zAsyncBoundLogger.bind sA &T\&4444*
r> c
T t d di | j j di || j S r )r r re r r s r= re zAsyncBoundLogger.new' s? %T\%33
33*
r> r] r^ c N t d di | j j | | j S r )r r r` r rK r] s r= r` zAsyncBoundLogger.unbind1 s6 (T\($/*
r> c N t d di | j j | | j S r )r r rc r r s r= rc zAsyncBoundLogger.try_unbind; s6 ,T\,d3*
r> r r rf rh r r< r r( c K t j t j | j fd d{V dS )r c : fd S )Nc g R i S r r4 r s r= r zFAsyncBoundLogger._dispatch_to_sync....S r r> r r s r= r z4AsyncBoundLogger._dispatch_to_sync..S r r> N)r r r r r _executorr s ````@r= r z"AsyncBoundLogger._dispatch_to_syncE s &((&((88 N = = = = = = = =
r> c Z K | | j j ||| d {V d S r )r r rj rm s r= rj zAsyncBoundLogger.debugV = $$T\%7bIIIIIIIIIIIr> c Z K | | j j ||| d {V d S r )r r rp rm s r= rp zAsyncBoundLogger.infoY s= $$T\%6tRHHHHHHHHHHHr> c Z K | | j j ||| d {V d S r )r r rr rm s r= rr zAsyncBoundLogger.warning\ s= $$T\%95$KKKKKKKKKKKr> c Z K | | j j ||| d {V d S r )r r rt rm s r= rt zAsyncBoundLogger.errora r r> c Z K | | j j ||| d {V d S r )r r rv rm s r= rv zAsyncBoundLogger.criticald s= $$T\%:E4LLLLLLLLLLLr> c K | dd }|(| d t j }||d< | | j j ||| d {V d S )Nrx rz )popr r7 rx r r rz )rK rf rh r< eis r= rz zAsyncBoundLogger.exceptioni s| VVJ
%
%
:"&&--5 B:$$T\%;UD"MMMMMMMMMMMr> r. c v K | t | j j | ||| d {V d S r )r r r r} r| s r= r} zAsyncBoundLogger.logt s^ $$ DL$e , ,eT2
r> )
r rU r1 r r r r r r r )r' r )rW r r' r )r] r^ r' r r r r )rP rQ rR rS __slots__r r r r r r r rZ re r` rc r rj rp rr r rt rv r rz r} r4 r> r= r r s $ %I I ' 0 0 0 0 0 02 % % % X%
"J J J JI I I IL L L L DJ J J JM M M M
E N N N N
r> r c $ e Zd ZdZd d dZd
d
ZdS )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())
Arguments:
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*.
Nignore_frame_nameslist[str] | Nonec F || _ t j t d S r )_ignorer5 setLoggerClassr@ )rK r s r= r zLoggerFactory.__init__ s! ) 566666r> rh r r' rU 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 )r5 getLoggerr
r )rK rh _rM s r= __call__zLoggerFactory.__call__ sG .$T!W-- - 1 >>4 &&&r> r )r r
)rh r r' rU rP rQ rR rS r r r4 r> r= r r z sK (7 7 7 7 7' ' ' ' ' 'r> r c $ e Zd ZdZdddZddZdS )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.
Tremove_positional_argsrB r' r( c || _ d S r )r )rK r s r= r z%PositionalArgumentsFormatter.__init__ s &<###r> r r __r^
event_dictr c | d }|rNt | dk r+t |d t r|d r|d }|dxx |z cc< | j r||d= |S )Nr r
r rf )r len
isinstancedictr )rK r r r rh s r= r z%PositionalArgumentsFormatter.__call__ s ~~ /00 (4yyA~~*T!Wd";";~Q~Aw w 4 ' & .4+;,-r> N)T)r rB r' r( r r r r^ r r r' r r r4 r> r= r! r! sK &= = = = = r> r! r rU r~ r^ r r c T | 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~ r s r= r r s* * >+677
Or> 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 r s r= r r s $ "0 ! c ^ | d }| | j |d< n
|j |d< |S )z0
Add the logger name to the event dict.
_recordNr )r rM )r r~ r r s r= r r s; ^^I
&
&F
~ %{
8 %{
8 r> rM pathnamer r4 c X e Zd ZdZdZdddZddZedd Zedd Z dS )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.
Arguments:
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
)_copierNallowCollection[str] | Noner' r( c l | |#t j | j g | | _ d S | j | _ d S r ) functoolsr
_copy_allowedr% _copy_all)rK r& s r= r zExtraAdder.__init__3 s< D %,T-?5JJDLLL >DLLLr> r rU rM r^ r r c ` | d }|| || |S )Nr" )r r% )rK r rM r r s r= r zExtraAdder.__call__= s5 ,6>>)+D+D LLV , , ,r> r r c ` |j D ]\ }}|t vr|||< d S r )__dict__items_LOG_RECORD_KEYS)clsr r keyvalues r= r+ zExtraAdder._copy_allE sE !///11 ( (JC***"'
3 ( (r> Collection[str]c B |D ]}||j v r|j | ||< d S r )r. )r1 r& r r r2 s r= r* zExtraAdder._copy_allowedM s; 7 7Cfo%%"(/#"6
3 7 7r> r )r& r' r' r( )r rU rM r^ r r r' r )r r r r r' r( )r& r4 r r r r r' r( )
rP rQ rR rS r r r classmethodr+ r* r4 r> r= r r s ( I* * * * * ( ( ( [( 7 7 7 [7 7 7r> r r r c P d dfddD S )a
Render ``event_dict`` into keyword arguments for `logging.log`.
The ``event`` field is translated into ``msg`` 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``.
rf )r r c D i | ] }|v | | S r4 r ).0r< r s r=
z(render_to_log_kwargs..l s<
Z
r"" r> )rx rA
stackLevelr9 r r r s `r= r$ r$ Y sQ " ~~g&&
>
r> c p e Zd ZdZ d$d% fd
Zd& fd Zed'd Zed(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.
Arguments:
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.
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.
Nr4 F processorProcessor | Noner1 Sequence[Processor] | Noneforeign_pre_chain
keep_exc_inforB keep_stack_infor logging.Logger | Nonepass_foreign_argsrh r kwargsr' r( c 6 | dd }
t j |d|
i| |r|rd} t | | || j |f| _ n|r|| _ nd} t | || _ || _ || _ || _ || _
d S )Nfmtr+ zBThe `processor` and `processors` arguments are mutually exclusive.z2Either `processor` or `processors` must be passed.) r rY r TypeErrorremove_processors_metar1 rB rC rD r rF )
rK r? r1 rB rC rD r rF rh rG rI r r\ s
r= r zProcessorFormatter.__init__ s jj
..$2C26222 ! !VCC.. , # :I FDOO
! (DOOFCC.. !2 * . !2 r> r r r^ c t j |j }t |dt }t |dd }|t ur?|dk r9| j | j }|j }|j }||d< d|d< n| j }|j
}| |dd }| j r
|j
|d
< d |_
|j r
|j |d < |j r
|j |d
< | j sd|_ d|_ | j sd|_ | j pd D ]} |||| }| j D ]} |||| }||_ 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.
rV _name__structlog_sentinel__Nr" T_from_structlogF)rf r" rO r r4 rx rA )r5
makeLogRecordr. getattr _SENTINELr rM r copy levelnamelower
getMessagerF rh rx rA rC exc_textrD rB r1 rY r, )rK r r meth_nameedprocpr\ s r= r, zProcessorFormatter.format s &v77I66FG-EFF " "y4L'L'L{& I
""B "ByM$(B ! ![F (..00I **,,!#( B %
4(. $% FK
1!' :
5#)#4< %
'"&"&'
)$(! .4"
1
1T&)R00 * *A69b))BB
ww~~f%%%r> rU rM r r 2tuple[tuple[EventDict], dict[str, dict[str, Any]]]c |fd| |difS )a5
Wrap *logger*, *name*, and *event_dict*.
The result is later unpacked by `ProcessorFormatter` when
formatting log entries.
Use this static method as the renderer (i.e. final processor) if you
want to use `ProcessorFormatter` in your `logging` configuration.
r )rV rM r4 )r rM r s r= wrap_for_formatterz%ProcessorFormatter.wrap_for_formatter, s }wFT(J(J KKKr> r r r c |d= |d= |S )z
Remove ``_record`` and ``_from_structlog`` from *event_dict*.
These keys are added to the event dictionary, before
`ProcessorFormatter`'s *processors* are run.
.. versionadded:: 21.3.0
r" rO r4 r= s r= rK z)ProcessorFormatter.remove_processors_meta; s
y ! ( )r> )Nr4 NFFNF)r? r@ r1 rA rB rA rC rB rD rB r rE rF rB rh r rG r r' r( )r r r' r^ )r rU rM r^ r r r' r\ r )
rP rQ rR rS r r, staticmethodr^ rK r r s @r= r" r" t s Q Qj '+138< # %(,"' 3 3 3 3 3 3 3D@& @& @& @& @& @&D L L L \ L \ r> r" )r% r& r' r( )rh r r r r' r )r rU r~ r^ r r r' r )r rU r r^ r r r' r );rS
__future__r r r r) r5 r7 r typingr r r r r r _baser _framesr
r _log_levelsr r r r
exceptionsr r1 r r r r r r __all__NOTSETr# objectrR Loggerr@ r r r r r! r r r LogRecordr. r] r0 r r$ Formatterr" r4 r> r= rn s
# " " " " "
@ @ @ @ @ @ @ @ @ @ @ @ @ @ " " " " " " B B B B B B B B F F F F F F F F F F * * * * * * ! ! ! ! ! ! ) ) ) ) ) ) I I I I I I I I I I I I I I
29 + + + + + +\
FHH I I I I IW^ I I I,SP SP SP SP SP/ SP SP SPl
7
7
7
7 Y
Y
Y
Y
Y
Y
Y
Y
x.' .' .' .' .' .' .' .'b) ) ) ) ) ) ) )X 6 . %7$
Az1eR
4466
:7 :7 :7 :7 :7 :7 :7 :7z 6V V V V V* V V V V Vr>