U Acj?@sdZddlmZddlmZddlmZddlmZmZm Z m Z m Z m Z ddl mZddlmZdd lmZmZdd lmZmZGd d d e ZGd ddZGdddZGdddZeZdddddZdS)z Logger class. ) annotations)time) TracebackType)AnyCallableContextManagerOptionalProtocolcast) currentframe)Failure) ILogObserverLogTrace)InvalidLogLevelErrorLogLevelc@sFeZdZdZeddddZeddddZeddd d Zd S) Operationz An L{Operation} represents the success (or lack thereof) of code performed within the body of the L{Logger.failureHandler} context manager. boolreturncCsdS)z Did the operation succeed? C{True} iff the code completed without raising an exception; C{False} while the code is running and C{False} if it raises an exception. Nselfrr:/tmp/pip-unpacked-wheel-nrvc_22y/twisted/logger/_logger.py succeededszOperation.succeededFailure | NonecCsdS)zj Did the operation raise an exception? If so, this L{Failure} is that exception. Nrrrrrfailure#szOperation.failurecCsdS)z Did the operation fail? C{True} iff the code raised an exception; C{False} while the code is running and C{False} if it completed without error. Nrrrrrfailed*szOperation.failedN)__name__ __module__ __qualname____doc__propertyrrrrrrrrsrc@sjeZdZUdZded<dZded<ddd d d Zedd d dZdd ddZ dddddddZ dS) _FailCtxMgrFrrNrrCallable[[Failure], None]NonefailrcCs ||_dSN_failrr'rrr__init__7sz_FailCtxMgr.__init__rcCs |jdk Sr(rrrrrr:sz_FailCtxMgr.failedrcCs|Sr(rrrrr __enter__>sz_FailCtxMgr.__enter__type[BaseException] | NoneBaseException | NoneTracebackType | Noneexc_type exc_value tracebackrcCs*|dk r t}||_||nd|_dSNT)r rr*rrr3r4r5rrrr__exit__As  z_FailCtxMgr.__exit__) rrr r__annotations__rr,r"rr.r8rrrrr#3s   r#c@s>eZdZdddddZddddZd d d d d ddZdS)_FastFailCtxMgrr$r%r&cCs ||_dSr(r)r+rrrr,Rsz_FastFailCtxMgr.__init__rcCsdSr(rrrrrr.Usz_FastFailCtxMgr.__enter__r/r0r1rr2cCs"|dk rt}||_||dSr6)r rr*r7rrrr8Xs  z_FastFailCtxMgr.__exit__N)rrr r,r.r8rrrrr:Qsr:c@s$eZdZdZeddddZd1ddd d d d d Zd2ddddddZddddZd3dddd dddZ de j fddddd dddZ d4ddd ddd Z d5ddd dd!d"Zd6ddd dd#d$Zd7ddd dd%d&Zd8ddd dd'd(Z e j fdddd)d*d+d,Ze j fddd-d.d/d0ZdS)9Loggera~ A L{Logger} emits log messages to an observer. You should instantiate it as a class or module attribute, as documented in L{this module's documentation }. @ivar namespace: the namespace for this logger @ivar source: The object which is emitting events via this logger @ivar observer: The observer that this logger will send events to. strrcCs2ztttdjdWStk r,YdSXdS)z Derive a namespace from the module containing the caller's caller. @return: the fully qualified python name of a module. rz N)r r<r f_globalsKeyErrorrrrr_namespaceFromCallingContextqsz#Logger._namespaceFromCallingContextNz Optional[str]zOptional[object]zOptional['ILogObserver']r%) namespacesourceobserverrcCsB|dkr|}||_||_|dkr8ddlm}||_n||_dS)a3 @param namespace: The namespace for this logger. Uses a dotted notation, as used by python modules. If not L{None}, then the name of the module of the caller is used. @param source: The object which is emitting events via this logger; this is automatically set on instances of a class if this L{Logger} is an attribute of that class. @param observer: The observer that this logger will send events to. If L{None}, use the L{global log publisher }. Nr )globalLogPublisher)r@rArBZ_globalrDrC)rrArBrCrDrrrr,}s zLogger.__init__objectzOptional[type]z'Logger')instanceownerrcCs>|dk s t|dkr|}n|}|jd|j|jg||jdS)a When used as a descriptor, i.e.:: # File: athing.py class Something: log = Logger() def hello(self): self.log.info("Hello") a L{Logger}'s namespace will be set to the name of the class it is declared on. In the above example, the namespace would be C{athing.Something}. Additionally, its source will be set to the actual object referring to the L{Logger}. In the above example, C{Something.log.source} would be C{Something}, and C{Something().log.source} would be an instance of C{Something}. N.)rC)AssertionError __class__joinrrrC)rrFrGrBrrr__get__s zLogger.__get__cCsd|jjd|jdS)N< >)rJrrArrrr__repr__szLogger.__repr__r)levelformatkwargsrcKsz|tkr*|jdtt|||ddS|}|j|||j|j|tdd|krlt t |d ||j f| |dS)a Emit a log event to all log observers at the given level. @param level: a L{LogLevel} @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param kwargs: additional key/value pairs to include in the event. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. z:Got invalid log level {invalidLevel!r} in {logger}.emit().)Z invalidLevelloggerN)Z log_loggerZ log_levelZ log_namespaceZ log_sourceZ log_formatZlog_timeZ log_trace) rZ iterconstantsrr rupdaterArBrr rappendrC)rrQrRrSeventrrremits(   z Logger.emitzOptional[Failure])rRrrQrSrcKs*|dkrt}|j||fd|i|dS)am Log a failure and emit a traceback. For example:: try: frob(knob) except Exception: log.failure("While frobbing {knob}", knob=knob) or:: d = deferredFrob(knob) d.addErrback(lambda f: log.failure("While frobbing {knob}", f, knob=knob)) This method is meant to capture unexpected exceptions in code; an exception that is caught and handled somehow should be logged, if appropriate, via L{Logger.error} instead. If some unknown exception occurs and your code doesn't know how to handle it, as in the above example, then this method provides a means to describe the failure. This is done at L{LogLevel.critical} by default, since no corrective guidance can be offered to an user/administrator, and the impact of the condition is unknown. @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param failure: a L{Failure} to log. If L{None}, a L{Failure} is created from the exception in flight. @param level: a L{LogLevel} to use. @param kwargs: additional key/value pairs to include in the event. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. @see: L{Logger.failureHandler} @see: L{Logger.failuresHandled} NZ log_failure)r rX)rrRrrQrSrrrrs2zLogger.failure)rRrSrcKs|jtj|f|dS)a Emit a log event at log level L{LogLevel.debug}. @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param kwargs: additional key/value pairs to include in the event. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. N)rXrdebugrrRrSrrrrYs z Logger.debugcKs|jtj|f|dS)a Emit a log event at log level L{LogLevel.info}. @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param kwargs: additional key/value pairs to include in the event. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. N)rXrinforZrrrr[*s z Logger.infocKs|jtj|f|dS)a Emit a log event at log level L{LogLevel.warn}. @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param kwargs: additional key/value pairs to include in the event. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. N)rXrwarnrZrrrr\9s z Logger.warncKs|jtj|f|dS)a Emit a log event at log level L{LogLevel.error}. @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param kwargs: additional key/value pairs to include in the event. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. N)rXrerrorrZrrrr]Hs z Logger.errorcKs|jtj|f|dS)a Emit a log event at log level L{LogLevel.critical}. @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param kwargs: additional key/value pairs to include in the event. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. N)rXrcriticalrZrrrr^Ws zLogger.criticalzContextManager[Operation])rRrQrSrc stfddS)a/ Run some application code, logging a failure and emitting a traceback in the event that any of it fails, but continuing on. For example:: log = Logger(...) def frameworkCode() -> None: with log.failuresHandled("While frobbing {knob}:", knob=knob) as op: frob(knob) if op.succeeded: log.info("frobbed {knob} successfully", knob=knob) This method is meant to capture unexpected exceptions from application code; an exception that is caught and handled somehow should be logged, if appropriate, via L{Logger.error} instead. If some unknown exception occurs and your code doesn't know how to handle it, as in the above example, then this method provides a means to describe the failure. This is done at L{LogLevel.critical} by default, since no corrective guidance can be offered to an user/administrator, and the impact of the condition is unknown. @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param level: a L{LogLevel} to use. @param kwargs: additional key/value pairs to include in the event, if it is emitted. Note that values which are later mutated may result in non-deterministic behavior from observers that schedule work for later execution. @see: L{Logger.failure} @see: L{Logger.failureHandler} @return: A context manager which yields an L{Operation} which will have either its C{succeeded} or C{failed} attribute set to C{True} upon completion of the code within the code within the C{with} block. csj|fSr(r-frRrSrQrrrz(Logger.failuresHandled..)r#)rrRrQrSrrarfailuresHandledfs*zLogger.failuresHandledzContextManager[None]) staticMessagerQrcstfddS)a For performance-sensitive frameworks that needs to handle potential failures from frequently-called application code, and do not need to include detailed structured information about the failure nor inspect the result of the operation, this method returns a context manager that will log exceptions and continue, that can be shared across multiple invocations. It should be instantiated at module scope to avoid additional object creations. For example:: log = Logger(...) ignoringFrobErrors = log.failureHandler("while frobbing:") def hotLoop() -> None: with ignoringFrobErrors: frob() This method is meant to capture unexpected exceptions from application code; an exception that is caught and handled somehow should be logged, if appropriate, via L{Logger.error} instead. If some unknown exception occurs and your code doesn't know how to handle it, as in the above example, then this method provides a means to describe the failure in nerd-speak. This is done at L{LogLevel.critical} by default, since no corrective guidance can be offered to an user/administrator, and the impact of the condition is unknown. @param format: a message format using new-style (PEP 3101) formatting. The logging event (which is a L{dict}) is used to render this format string. @param level: a L{LogLevel} to use. @see: L{Logger.failure} @return: A context manager which does not return a value, but will always exit from exceptions. cs|Sr(r-r_rQrrerrrbrcz'Logger.failureHandler..)r:)rrerQrrfrfailureHandlers+zLogger.failureHandler)NNN)N)N)N)N)N)N)N)rrr r! staticmethodr@r,rLrPrXrr^rrYr[r\r]rdrgrrrrr;fs.   *7/r;rE)objrcCst||jS)z? Get a L{Logger} instance attached to the given class. )_logrLrJ)rirrr _loggerForsrkN)r! __future__rrtypesrtypingrrrrr r Ztwisted.python.compatr Ztwisted.python.failurer Z _interfacesrrZ_levelsrrrr#r:r;rjrkrrrrs       \