ޠj' S r SSKJr SSKrSSKrSSKJrJr SSKJ r J
r
SSK J r SSK
Jr SSKJrJr SS KJr S
S KJr S
S KJr S
S
KJr S
SKJrJ r " S S\5 r " S S5 r \ \4r S S jr! " S S5 r" " S S\5 r\" \5 " S S5 5 r#\" \5 " S S5 5 r$S S jr% " S S 5 r&g)!z
Processors and tools specific to the `Twisted `_
networking engine.
See also :doc:`structlog's Twisted support `.
) annotationsN)CallableSequence)AnyTextIOlog)Failure) ILogObservertextFromEventDict) implementer )BoundLoggerBase)_BUILTIN_DEFAULT_PROCESSORS) JSONRenderer) EventDict
WrappedLoggerc 4 \ rS rSrSrSSS jjrSSS jjrSrg) BoundLogger z
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,
)
Nc * U R " SU40 UD6$ )z7
Process event and call ``log.msg()`` with the result.
msg_proxy_to_loggerselfeventkws K/var/www/html/gaurav/venv/lib/python3.13/site-packages/structlog/twisted.pyr BoundLogger.msg/ $$UE8R88 c * U R " SU40 UD6$ )z7
Process event and call ``log.err()`` with the result.
errr r s r r$ BoundLogger.err5 r! r" N)r z
str | Noner r returnr )__name__
__module__ __qualname____firstlineno____doc__r r$ __static_attributes__r& r" r r r s 9 9 9r" r c " \ rS rSrSrSS jrSrg)
LoggerFactory< z
Build a Twisted logger when an *instance* is called.
>>> from structlog import configure
>>> from structlog.twisted import LoggerFactory
>>> configure(logger_factory=LoggerFactory())
c [ $ )z
Positional arguments are silently ignored.
:rvalue: A new Twisted logger.
.. versionchanged:: 0.4.0
Added support for optional positional arguments.
r )r argss r __call__LoggerFactory.__call__E s
r" r& N)r3 r r( r r) r* r+ r, r- r4 r. r& r" r r0 r0 < s r" r0 c U R SS5 nU R SS5 nU R SS5 n[ U[ 5 ( a [ U[ 5 ( a [ S5 eU( a [ U[ 5 ( a [ S5 e[ U[ 5 ( d" [ U[ 5 ( a
U=( d SnUn[ U[ 5 ( a UnU( d# [
R " 5 S:w a
[ 5 n[ U[ 5 ( a [ U[ 5 ( d [ U5 nXU 4$ ) 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) eventDictr8 r9 r s r _extractStuffAndWhyrD T s ]]8T
*F == &D MM'4 (E&+&&:e[+I+INOO
5#&&<== fk * *z%/M/Mw% clln(:: &-((FG1L1L ""r" c 6 \ rS rSrSrSS jrS S jrS
S jrSrg) ReprWrappery z
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.
c Xl g r' string)r rJ s r __init__ReprWrapper.__init__ s r" c l [ XR 5 =( a U R UR :H $ )z%
Check for equality, just for tests.
)r< __class__rJ )r others r __eq__ReprWrapper.__eq__ s'
unn - M$++ 2M
r" c U R $ r' rI )r s r __repr__ReprWrapper.__repr__ s {{r" rI N)rJ r? r( None)rO objectr( bool)r( r? ) r) r* r+ r, r- rK rP rS r. r& r" r rF rF y s
r" rF c 2 \ rS rSrSr SS jrSrg)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.
c [ U5 u pEnUS:X a< XSS' [ U[ 5 ( a" UR SS9US' UR 5 OXSS' [ [ R " XX#5 5 4SS04$ )Nr$ r verbose)detail exception
_structlogT)rD r< r
getTraceback cleanFailurerF GenericJSONRendererr4 r loggernamerC r8 r9 s r r4 JSONRenderer.__call__ s #6i"@ i 5=!%g &'**)/)<)`_
.. versionadded:: 0.2.0
c Xl g r' _observer)r observers r rK JSONLogObserverWrapper.__init__ s !r" c SU; a: [ R " [ U5 UR S5 S.5 4US' SUS' U R U5 $ )Nr^ system)r r~ messageT)jsondumpsr getrz rr s r r4 JSONLogObserverWrapper.__call__ s[ y (
!2 %" #,--"9 $Ii '+Il #~~i((r" ry N)r{ r r( rU )rC r r( r? rt r& r" r rv rv s ")r" rv c F [ [ [ R 5 5 $ )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
)rv rg r@ stdoutr& r" r plainJSONStdOutLoggerr s , ""6szz"B CCr" c H \ rS rSrSr S SS jjr S S jrSrg)
EventAdapteri aB
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()``.
Nc 2 U=( d [ S U l g )N)r
_dictRenderer)r dictRenderers r rK EventAdapter.__init__/ s * L-H-Lr" c US:X a) [ U5 u pEnXSS' SUU R XU5 S.4$ U R XU5 $ )Nr$ r r& )r8 r9 )rD r rb s r r4 EventAdapter.__call__7 s` 5=
':)&D #F)!%g $ . .vY G
!!& ::r" )r r' )r z5Callable[[WrappedLogger, str, EventDict], str] | Noner( rU )rc r rd r? rC r r( r rt r& r" r r r sN *
M
BM
M;#;+.;;D; ;r" r )rC r r( ztuple[Any, Any, EventDict])r( rv )'r-
__future__r r r@ collections.abcr r typingr r twisted.pythonr twisted.python.failurer
twisted.python.logr r zope.interfacer
_baser _configr
processorsr ra r r r r0 rB r= rD rF rg rv r r r& r" r r s #
. * > & " 0 ; ,9/ 98 * g& "#J <-
& -
`
\ 2
\ ) ) )DD2-; -;r"