/usr/lib/python3/dist-packages/structlog/twisted.py is in python3-structlog 15.2.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | # This file is dual licensed under the terms of the Apache License, Version
# 2.0, and the MIT License. See the LICENSE file in the root of this
# repository for complete details.
"""
Processors and tools specific to the `Twisted <https://twistedmatrix.com/>`_
networking engine.
See also :doc:`structlog's Twisted support <twisted>`.
"""
from __future__ import absolute_import, division, print_function
import json
import sys
from twisted.python import log
from twisted.python.failure import Failure
from twisted.python.log import ILogObserver, textFromEventDict
from zope.interface import implementer
from structlog._base import BoundLoggerBase
from structlog._compat import PY2, string_types
from structlog._utils import until_not_interrupted
from structlog.processors import (
# can't import processors module without risking circular imports
JSONRenderer as GenericJSONRenderer,
KeyValueRenderer,
)
class BoundLogger(BoundLoggerBase):
"""
Twisted-specific version of :class:`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,
)
"""
def msg(self, event=None, **kw):
"""
Process event and call ``log.msg()`` with the result.
"""
return self._proxy_to_logger('msg', event, **kw)
def err(self, event=None, **kw):
"""
Process event and call ``log.err()`` with the result.
"""
return self._proxy_to_logger('err', event, **kw)
class LoggerFactory(object):
"""
Build a Twisted logger when an *instance* is called.
>>> from structlog import configure
>>> from structlog.twisted import LoggerFactory
>>> configure(logger_factory=LoggerFactory())
"""
def __call__(self, *args):
"""
Positional arguments are silently ignored.
:rvalue: A new Twisted logger.
.. versionchanged:: 0.4.0
Added support for optional positional arguments.
"""
return log
_FAIL_TYPES = (BaseException, Failure)
def _extractStuffAndWhy(eventDict):
"""
Removes all possible *_why*s and *_stuff*s, analyzes exc_info and returns
a tuple of `(_stuff, _why, eventDict)`.
**Modifies** *eventDict*!
"""
_stuff = eventDict.pop('_stuff', None)
_why = eventDict.pop('_why', None)
event = eventDict.pop('event', None)
if (
isinstance(_stuff, _FAIL_TYPES) and
isinstance(event, _FAIL_TYPES)
):
raise ValueError('Both _stuff and event contain an Exception/Failure.')
# `log.err('event', _why='alsoEvent')` is ambiguous.
if _why and isinstance(event, string_types):
raise ValueError('Both `_why` and `event` supplied.')
# Two failures are ambiguous too.
if not isinstance(_stuff, _FAIL_TYPES) and isinstance(event, _FAIL_TYPES):
_why = _why or 'error'
_stuff = event
if isinstance(event, string_types):
_why = event
if not _stuff and sys.exc_info() != (None, None, None):
_stuff = Failure()
# Either we used the error ourselves or the user supplied one for
# formatting. Avoid log.err() to dump another traceback into the log.
if isinstance(_stuff, BaseException):
_stuff = Failure(_stuff)
if PY2: # pragma: nocover we don't care about the implicit else
sys.exc_clear()
return _stuff, _why, eventDict
class ReprWrapper(object):
"""
Wrap a string and return it as the __repr__.
This is needed for log.err() that calls repr() on _stuff:
>>> repr("foo")
"'foo'"
>>> repr(ReprWrapper("foo"))
'foo'
Note the extra quotes in the unwrapped example.
"""
def __init__(self, string):
self.string = string
def __eq__(self, other):
"""
Check for equality, actually just for tests.
"""
return isinstance(other, self.__class__) \
and self.string == other.string
def __repr__(self):
return self.string
class JSONRenderer(GenericJSONRenderer):
"""
Behaves like :class:`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 <https://twistedmatrix.com/documents/
current/api/twisted.trial.unittest.SynchronousTestCase.html
#flushLoggedErrors>`_.
*Not* an adapter like :class:`EventAdapter` but a real formatter. Nor does
it require to be adapted using it.
Use together with a :class:`JSONLogObserverWrapper`-wrapped Twisted logger
like :func:`plainJSONStdOutLogger` for pure-JSON logs.
"""
def __call__(self, logger, name, eventDict):
_stuff, _why, eventDict = _extractStuffAndWhy(eventDict)
if name == 'err':
eventDict['event'] = _why
if isinstance(_stuff, Failure):
eventDict['exception'] = _stuff.getTraceback(detail='verbose')
_stuff.cleanFailure()
else:
eventDict['event'] = _why
return ((ReprWrapper(
GenericJSONRenderer.__call__(self, logger, name, eventDict)
),), {'_structlog': True})
@implementer(ILogObserver)
class PlainFileLogObserver(object):
"""
Write only the the plain message without timestamps or anything else.
Great to just print JSON to stdout where you catch it with something like
runit.
:param file file: File to print to.
.. versionadded:: 0.2.0
"""
def __init__(self, file):
self._write = file.write
self._flush = file.flush
def __call__(self, eventDict):
until_not_interrupted(self._write, textFromEventDict(eventDict) + '\n')
until_not_interrupted(self._flush)
@implementer(ILogObserver)
class JSONLogObserverWrapper(object):
"""
Wrap a log *observer* and render non-:class:`JSONRenderer` entries to JSON.
:param ILogObserver observer: Twisted log observer to wrap. For example
:class:`PlainFileObserver` or Twisted's stock `FileLogObserver
<https://twistedmatrix.com/documents/current/api/twisted.python.log.
FileLogObserver.html>`_
.. versionadded:: 0.2.0
"""
def __init__(self, observer):
self._observer = observer
def __call__(self, eventDict):
if '_structlog' not in eventDict:
eventDict['message'] = (json.dumps({
'event': textFromEventDict(eventDict),
'system': eventDict.get('system'),
}),)
eventDict['_structlog'] = True
return self._observer(eventDict)
def plainJSONStdOutLogger():
"""
Return a logger that writes only the message to stdout.
Transforms non-:class:`~structlog.twisted.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 <twisted.web.server.Site ...>", ...}
...
Composes :class:`PlainFileLogObserver` and :class:`JSONLogObserverWrapper`
to a usable logger.
.. versionadded:: 0.2.0
"""
return JSONLogObserverWrapper(PlainFileLogObserver(sys.stdout))
class EventAdapter(object):
"""
Adapt an ``event_dict`` to Twisted logging system.
Particularly, make a wrapped `twisted.python.log.err
<https://twistedmatrix.com/documents/current/
api/twisted.python.log.html#err>`_ behave as expected.
:param callable dictRenderer: Renderer that is used for the actual
log message. Please note that structlog comes with a dedicated
:class:`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()``.
"""
def __init__(self, dictRenderer=None):
"""
:param dictRenderer: A processor used to format the log message.
"""
self._dictRenderer = dictRenderer or KeyValueRenderer()
def __call__(self, logger, name, eventDict):
if name == 'err':
# This aspires to handle the following cases correctly:
# - log.err(failure, _why='event', **kw)
# - log.err('event', **kw)
# - log.err(_stuff=failure, _why='event', **kw)
_stuff, _why, eventDict = _extractStuffAndWhy(eventDict)
eventDict['event'] = _why
return ((), {
'_stuff': _stuff,
'_why': self._dictRenderer(logger, name, eventDict),
})
else:
return self._dictRenderer(logger, name, eventDict)
|