o bb. @sdZddlmZddlmZddlmZmZm Z mZm Z m Z m Z ddl mZddlmZddlmZddlmZd d lmZmZd d lmZd Zd edefddZd ededefddZedfde ede ededefddZ e fd edee egefde efddZ!GdddeZ"dedeeefdefd d!Z#d edefd"d#Z$d$edefd%d&Z%d edefd'd(Z&d)d)d)e fd ed*e'd+e'd,e'deegefdef d-d.Z(d/S)0z& Tools for formatting logging events. )Mapping)datetime)AnyCallableIteratorrOptionalUnioncast) NamedConstant)FixedOffsetTimeZone)Failure) safe_repr) aFormatter flatFormat)LogEventz%Y-%m-%dT%H:%M:%S%zeventreturncCst|ddddS)aa Formats an event as text, using the format in C{event["log_format"]}. This implementation should never raise an exception; if the formatting cannot be done, the returned string will describe the event generically so that a useful message is emitted regardless. @param event: A logging event. @return: A formatted string. F)includeTracebackincludeTimestamp includeSystem) eventAsText)rr8/usr/lib/python3/dist-packages/twisted/logger/_format.py formatEvents  rerrorcCsVzdj||dWSty*t}ddd|D}djt|||dYSw)z Formats an event as text that describes the event generically and a formatting error. @param event: A logging event. @param error: The formatting error. @return: A formatted string. z)Unable to format event {event!r}: {error})rrz, css*|]\}}dt|t|fVqdS)z = N)joinr ).0keyvaluerrr Bs  z+formatUnformattableEvent..zrMESSAGE LOST: unformattable object logged: {error} Recoverable data: {text} Exception during formatting: {failure})rfailuretext)format BaseExceptionr ritemsr )rrr!r"rrrformatUnformattableEvent,s    r&-when timeFormatdefaultcCs8|dus|dur |St|}t||}t||S)a Format a timestamp as text. Example:: >>> from time import time >>> from twisted.logger import formatTime >>> >>> t = time() >>> formatTime(t) u'2013-10-22T14:19:11-0700' >>> formatTime(t, timeFormat="%Y/%W") # Year and week number u'2013/42' >>> @param when: A timestamp. @param timeFormat: A time format. @param default: Text to return if C{when} or C{timeFormat} is L{None}. @return: A formatted time. N)r fromLocalTimeStampDateTime fromtimestampstrstrftime)r(r)r*tzrrrr formatTimePs   r1cCs(t||d}|s dS|dd}|dS)a& Format an event as a line of human-readable text for, e.g. traditional log file output. The output format is C{"{timeStamp} [{system}] {event}\n"}, where: - C{timeStamp} is computed by calling the given C{formatTime} callable on the event's C{"log_time"} value - C{system} is the event's C{"log_system"} value, if set, otherwise, the C{"log_namespace"} and C{"log_level"}, joined by a C{"#"}. Each defaults to C{"-"} is not set. - C{event} is the event, as formatted by L{formatEvent}. Example:: >>> from time import time >>> from twisted.logger import formatEventAsClassicLogText >>> from twisted.logger import LogLevel >>> >>> formatEventAsClassicLogText(dict()) # No format, returns None >>> formatEventAsClassicLogText(dict(log_format="Hello!")) u'- [-#-] Hello!\n' >>> formatEventAsClassicLogText(dict( ... log_format="Hello!", ... log_time=time(), ... log_namespace="my_namespace", ... log_level=LogLevel.info, ... )) u'2013-10-22T17:30:02-0700 [my_namespace#info] Hello!\n' >>> formatEventAsClassicLogText(dict( ... log_format="Hello!", ... log_time=time(), ... log_system="my_system", ... )) u'2013-11-11T17:22:06-0800 [my_system] Hello!\n' >>> @param event: an event. @param formatTime: A time formatter @return: A formatted event, or L{None} if no output is appropriate. )r1N z )rreplace)rr1 eventTextrrrformatEventAsClassicLogTextrs / r5c@sXeZdZdZdeeefddfddZdefddZ de fd d Z d edefd d Z dS) CallMappingz Read-only mapping that turns a C{()}-suffix in key names into an invocation of the key rather than a lookup of the key. Implementation support for L{formatWithCall}. submappingrNcCs ||_dS)zo @param submapping: Another read-only mapping which will be used to look up items. N) _submapping)selfr7rrr__init__s zCallMapping.__init__cC t|jSN)iterr8r9rrr__iter__ zCallMapping.__iter__cCr;r<)lenr8r>rrr__len__r@zCallMapping.__len__rcCs6|d}|r |ddn|}|j|}|r|}|S)z| Look up an item in the submapping for this L{CallMapping}, calling it if C{key} ends with C{"()"}. z()N)endswithr8)r9rcallitrealKeyrrrr __getitem__s  zCallMapping.__getitem__) __name__ __module__ __qualname____doc__rr.rr:rr?intrBrGrrrrr6s r6 formatStringmappingcCstt|dt|S)a Format a string like L{str.format}, but: - taking only a name mapping; no positional arguments - with the additional syntax that an empty set of parentheses correspond to a formatting item that should be called, and its result C{str}'d, rather than calling C{str} on the element directly as normal. For example:: >>> formatWithCall("{string}, {function()}.", ... dict(string="just a string", ... function=lambda: "a function")) 'just a string, a function.' @param formatString: A PEP-3101 format string. @param mapping: A L{dict}-like object to format. @return: The string with formatted values interpolated. r)r.rvformatr6)rMrNrrrformatWithCallsrPc Csz=d|vr t|WStttttf|dd}|dur WdSt|tr&nt|tr1|d}nt d|t ||WSt yT}z t ||WYd}~Sd}~ww)ae Formats an event as a string, using the format in C{event["log_format"]}. This implementation should never raise an exception; if the formatting cannot be done, the returned string will describe the event generically so that a useful message is emitted regardless. @param event: A logging event. @return: A formatted string. log_flattened log_formatNzutf-8zLog format must be str, not ) rr rrr.bytesget isinstancedecode TypeErrorrPr$r&)rr#errr _formatEvents       rZr!c CsBz|}W|Sty }z dt|}WYd}~|Sd}~ww)a^ Format a failure traceback, assuming UTF-8 and using a replacement strategy for errors. Every effort is made to provide a usable traceback, but should not that not be possible, a message and the captured exception are logged. @param failure: The failure to retrieve a traceback from. @return: The formatted traceback. z((UNABLE TO OBTAIN TRACEBACK FROM EVENT):N) getTracebackr$r.)r! tracebackrYrrr_formatTracebacks r]cCsttt|dd}|dur4ttt|dd}|dur!d}n|j}djtt|dd|d}|Szt|}W|StyGd}Y|Sw) a Format the system specified in the event in the "log_system" key if set, otherwise the C{"log_namespace"} and C{"log_level"}, joined by a C{"#"}. Each defaults to C{"-"} is not set. If formatting fails completely, "UNFORMATTABLE" is returned. @param event: The event containing the system specification. @return: A formatted string representing the "log_system" key. log_systemN log_levelr'z{namespace}#{level} log_namespace) namespacelevel UNFORMATTABLE)r rr.rUr namer# Exception)rsystemrb levelNamerrr _formatSystems$    rhTrrrc Cst|}|rd|vr|d}t|}d||f}|s|Sd}|r1d|tt|dddg}d} |r@ddt|ddg} d j|| |d S) ah Format an event as text. Optionally, attach timestamp, traceback, and system information. The full output format is: C{"{timeStamp} [{system}] {event}\n{traceback}\n"} where: - C{timeStamp} is the event's C{"log_time"} value formatted with the provided C{formatTime} callable. - C{system} is the event's C{"log_system"} value, if set, otherwise, the C{"log_namespace"} and C{"log_level"}, joined by a C{"#"}. Each defaults to C{"-"} is not set. - C{event} is the event, as formatted by L{formatEvent}. - C{traceback} is the traceback if the event contains a C{"log_failure"} key. In the event the original traceback cannot be formatted, a message indicating the failure will be substituted. If the event cannot be formatted, and no traceback exists, an empty string is returned, even if includeSystem or includeTimestamp are true. @param event: A logging event. @param includeTraceback: If true and a C{"log_failure"} key exists, append a traceback. @param includeTimestamp: If true include a formatted timestamp before the event. @param includeSystem: If true, include the event's C{"log_system"} value. @param formatTime: A time formatter @return: A formatted string with specified options. @since: Twisted 18.9.0 log_failurer2rSlog_timeN []z{timeStamp}{system}{eventText}) timeStamprfr4)rZr]rr floatrUrhr#) rrrrr1r4fr\rnrfrrrr7s$*  rN))rKcollections.abcr MappingABCrr,typingrrrrrr constantlyr twisted.python._tzhelperr twisted.python.failurer twisted.python.reflectr _flattenrr _interfacesrtimeFormatRFC3339r.rr$r&ror1r5r6rPrZr]rhboolrrrrrsl  $     & # 6""!