o
ADik' @ s6 d Z ddlmZ ddlZddlZddlmZmZmZm Z ddl
m Z ddl m
Z
ddlmZmZ ddlmZ d d
lmZ d d lmZ d d lmZ d d
lmZmZ G dd deZ G dd dZ e e
fZ d$ddZ G dd dZ!G dd deZeeG d d d Z"eeG d d d Z#d%d d!Z$G d"d# d#Z%dS )&z
Processors and tools specific to the `Twisted `_
networking engine.
See also :doc:`structlog's Twisted support `.
) annotationsN)AnyCallableSequenceTextIOlog)Failure) ILogObservertextFromEventDict) implementer )BoundLoggerBase)_BUILTIN_DEFAULT_PROCESSORS) JSONRenderer) EventDict
WrappedLoggerc @ s( e Zd ZdZd d
dd Zd d
d
d ZdS ) BoundLoggera
Twisted-specific 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::
configure(
wrapper_class=structlog.twisted.BoundLogger,
)
Nevent
str | Nonekwr returnc K | j d|fi |S )zG
Process event and call ``log.msg()`` with the result.
msg_proxy_to_loggerselfr r r J/var/www/Datamplify/venv/lib/python3.10/site-packages/structlog/twisted.pyr . zBoundLogger.msgc K r )zG
Process event and call ``log.err()`` with the result.
errr r r r r r! 4 r zBoundLogger.errN)r r r r r r )__name__
__module__ __qualname____doc__r r! r r r r r s r c @ s e Zd ZdZd ddZdS )
LoggerFactoryz
Build a Twisted logger when an *instance* is called.
>>> from structlog import configure
>>> from structlog.twisted import LoggerFactory
>>> configure(logger_factory=LoggerFactory())
argsr r r c G s t S )z
Positional arguments are silently ignored.
:rvalue: A new Twisted logger.
.. versionchanged:: 0.4.0
Added support for optional positional arguments.
r )r r( r r r __call__D s zLoggerFactory.__call__N)r( r r r r# r$ r% r& r) r r r r r' ; s r' eventDictr r tuple[Any, Any, EventDict]c C s | dd}| dd}| dd}t|tr t|tr td|r+t|tr+tdt|ts;t|tr;|p8d}|}t|trB|}|sMt dkrMt }t|tr[t|ts[t|}||| fS ) z
Removes all possible *_why*s and *_stuff*s, analyzes exc_info and returns
a tuple of ``(_stuff, _why, eventDict)``.
**Modifies** *eventDict*!
_stuffN_whyr z3Both _stuff and event contain an Exception/Failure.z!Both `_why` and `event` supplied.error)NNN) pop
isinstance _FAIL_TYPES
ValueErrorstrsysexc_infor
BaseException)r+ r- r. r r r r _extractStuffAndWhyS s"
r8 c @ s. e Zd ZdZdddZdd d Zdd
dZdS ) ReprWrappera
Wrap a string and return it as the ``__repr__``.
This is needed for ``twisted.python.log.err`` that calls `repr` on
``_stuff``:
>>> repr("foo")
"'foo'"
>>> repr(ReprWrapper("foo"))
'foo'
Note the extra quotes in the unwrapped example.
stringr4 r Nonec C
|| _ d S r" r: )r r: r r r __init__
zReprWrapper.__init__otherobjectboolc C s t || jo | j|jkS )z5
Check for equality, just for tests.
)r1 __class__r: )r r@ r r r __eq__ s zReprWrapper.__eq__c C s | j S r" r= )r r r r __repr__ s zReprWrapper.__repr__N)r: r4 r r; )r@ rA r rB )r r4 )r# r$ r% r& r> rD rE r r r r r9 x s
r9 c @ s e Zd ZdZd
d
d Zd S )r a
Behaves like `structlog.processors.JSONRenderer` except that it formats
tracebacks and failures itself if called with ``err()``.
.. note::
This ultimately means that the messages get logged out using ``msg()``,
and *not* ``err()`` which renders failures in separate lines.
Therefore it will break your tests that contain assertions using
`flushLoggedErrors
`_.
*Not* an adapter like `EventAdapter` but a real formatter. Also does *not*
require to be adapted using it.
Use together with a `JSONLogObserverWrapper`-wrapped Twisted logger like
`plainJSONStdOutLogger` for pure-JSON logs.
loggerr namer4 r+ r r $tuple[Sequence[Any], dict[str, Any]]c C sh t |\}}}|dkr!||d< t|tr |jdd|d< | n||d< tt| |||fddifS )Nr! r verbose)detail exception
_structlogT)r8 r1 r getTraceback cleanFailurer9 GenericJSONRendererr) r rF rG r+ r- r. r r r r) s
zJSONRenderer.__call__N)rF r rG r4 r+ r r rH r* r r r r r s r c @ s$ e Zd ZdZd
ddZdd
d Zd S )PlainFileLogObserverz
Write only the plain message without timestamps or anything else.
Great to just print JSON to stdout where you catch it with something like
runit.
Args:
file: File to print to.
.. versionadded:: 0.2.0
filer r r; c C s |j | _|j| _d S r" )write_writeflush_flush)r rR r r r r> s z PlainFileLogObserver.__init__r+ r c C s | t|d | d S )N
)rT r rV r r+ r r r r) s z PlainFileLogObserver.__call__N)rR r r r; )r+ r r r; r# r$ r% r& r> r) r r r r rQ s
rQ c @ s$ e Zd ZdZdddZdd d Zd
S )JSONLogObserverWrappera
Wrap a log *observer* and render non-`JSONRenderer` entries to JSON.
Args:
observer (ILogObserver):
Twisted log observer to wrap. For example
:class:`PlainFileObserver` or Twisted's stock `FileLogObserver
`_
.. versionadded:: 0.2.0
observerr r r; c C r< r" ) _observer)r r[ r r r r> r? z JSONLogObserverWrapper.__init__r+ r r4 c C s: d|vrt t||ddf|d< d|d< | |S )NrL system)r r] messageT)jsondumpsr getr\ rX r r r r) s
z JSONLogObserverWrapper.__call__N)r[ r r r; )r+ r r r4 rY r r r r rZ s
rZ c C s t ttjS )a
Return a logger that writes only the message to stdout.
Transforms non-`JSONRenderer` messages to JSON.
Ideal for JSONifying log entries from Twisted plugins and libraries that
are outside of your control::
$ twistd -n --logger structlog.twisted.plainJSONStdOutLogger web
{"event": "Log opened.", "system": "-"}
{"event": "twistd 13.1.0 (python 2.7.3) starting up.", "system": "-"}
{"event": "reactor class: twisted...EPollReactor.", "system": "-"}
{"event": "Site starting on 8080", "system": "-"}
{"event": "Starting factory ", ...}
...
Composes `PlainFileLogObserver` and `JSONLogObserverWrapper` to a usable
logger.
.. versionadded:: 0.2.0
)rZ rQ r5 stdoutr r r r plainJSONStdOutLogger s rc c @ s( e Zd ZdZ ddddZdddZdS ) EventAdapterar
Adapt an ``event_dict`` to Twisted logging system.
Particularly, make a wrapped `twisted.python.log.err
`_
behave as expected.
Args:
dictRenderer:
Renderer that is used for the actual log message. Please note that
structlog comes with a dedicated `JSONRenderer`.
**Must** be the last processor in the chain and requires a *dictRenderer*
for the actual formatting as an constructor argument in order to be able to
fully support the original behaviors of ``log.msg()`` and ``log.err()``.
N dictRenderer5Callable[[WrappedLogger, str, EventDict], str] | Noner r; c C s |pt d | _d S )N)r
_dictRenderer)r re r r r r> . s zEventAdapter.__init__rF r rG r4 r+ r r c C sD |dkrt |\}}}||d< d|| |||dfS | |||S )Nr! r r )r- r. )r8 rh rP r r r r) 6 s zEventAdapter.__call__r" )re rf r r; )rF r rG r4 r+ r r r rY r r r r rd s
rd )r+ r r r, )r rZ )&r&
__future__r r_ r5 typingr r r r twisted.pythonr twisted.python.failurer twisted.python.logr
r zope.interfacer _baser _configr
processorsr rO r r r r' r7 r2 r8 r9 rQ rZ rc rd r r r r s2
% 0
"