Vh?dZddlmZddlmZddlmZddlmZmZm Z m Z m Z m Z ddl mZddlmZdd lmZmZdd lmZmZGd d e ZGd dZGddZGddZeZddZy)z Logger class. ) annotations)time) TracebackType)AnyCallableContextManagerOptionalProtocolcast) currentframe)Failure) ILogObserverLogTrace)InvalidLogLevelErrorLogLevelcFeZdZdZeddZeddZeddZy) Operationz An L{Operation} represents the success (or lack thereof) of code performed within the body of the L{Logger.failureHandler} context manager. cy)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. Nselfs F/home/dcms/DCMS/lib/python3.12/site-packages/twisted/logger/_logger.py succeededzOperation.succeededcy)zj Did the operation raise an exception? If so, this L{Failure} is that exception. Nrrs rfailurezOperation.failure#rrcy)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. Nrrs rfailedzOperation.failed*rrNreturnbool)r"Failure | None)__name__ __module__ __qualname____doc__propertyrrr rrrrrsC       rrcdeZdZUdZded<dZded<d dZed dZd d Z dd Z y) _FailCtxMgrFr#rNr$rc||_yN_failrfails r__init__z_FailCtxMgr.__init__7  rc|jduSr-rrs rr z_FailCtxMgr.failed:s||4''rc|Sr-rrs r __enter__z_FailCtxMgr.__enter__>s rc\|#t}||_|j|yd|_yNT)r rr/rrexc_type exc_value tracebackrs r__exit__z_FailCtxMgr.__exit__As5  iG"DL JJw "DNrr1zCallable[[Failure], None]r"Noner!)r"rr;ztype[BaseException] | Noner<zBaseException | Noner=zTracebackType | Noner"r#) r%r&r'r__annotations__rr2r)r r7r>rrrr+r+3s_It"G^"(( , ( (   rr+c4eZdZddZddZ ddZy)_FastFailCtxMgrc||_yr-r.r0s rr2z_FastFailCtxMgr.__init__Rr3rcyr-rrs rr7z_FastFailCtxMgr.__enter__Us rcL|"t}||_|j|yr9)r rr/r:s rr>z_FastFailCtxMgr.__exit__Xs'  iG"DL JJw rNr?)r"r@rA)r%r&r'r2r7r>rrrrDrDQs7  , ( (   rrDc*eZdZdZeddZ d ddZdddZddZ d ddZ de jf ddZ ddd Z ddd Zddd Zddd Zddd Z e jf ddZe jf ddZy)Loggera~ 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. cn tttdjdS#t$rYywxYw)z Derive a namespace from the module containing the caller's caller. @return: the fully qualified python name of a module. r%z )r strr f_globalsKeyErrorrrr_namespaceFromCallingContextz#Logger._namespaceFromCallingContextqs5 \!_66zBC C  s %( 44Ncr||j}||_||_|ddlm}||_y||_y)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)rO namespacesource_globalrQobserver)rrRrSrUrQs rr2zLogger.__init__}s=  99;I"   3*)rXr%rRrs r__repr__zLogger.__repr__s'4>>**+1T^^,>a@@rc p|tjvr(|jdtt |||y|}|j |||j |j|td|vr.tt|dj||jf|j|y)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().) invalidLevelloggerN) log_logger log_level log_namespace log_source log_formatlog_time log_trace) r iterconstantsrr rupdaterRrSrr rappendrU)rlevelformatkwargsevents remitz Logger.emits ..0 0 LLL,U34"    ..{{V   %  5- . 5 5tT]]6K L erc H| t}|j||fd|i|y)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} N log_failure)r rs)rrprrorqs rrzLogger.failures+d ?iG %?W??rc H|jtj|fi|y)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)rsrdebugrrprqs rrwz Logger.debug  (..&3F3rc H|jtj|fi|y)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)rsrinforxs rr{z Logger.info*  (--262rc H|jtj|fi|y)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)rsrwarnrxs rr~z Logger.warn9r|rc H|jtj|fi|y)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)rsrerrorrxs rrz Logger.errorHryrc H|jtj|fi|y)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)rsrcriticalrxs rrzLogger.criticalWs  (##V6v6rc ,tfdS)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. c.j|fiSr-r5)frprqrors rz(Logger.failuresHandled..s\T\\&!U%Mf%Mr)r+)rrprorqs````rfailuresHandledzLogger.failuresHandledfsTMNNrc(tfdS)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. c*j|Sr-r5)rror staticMessages rrz'Logger.failureHandler..smQ)Nr)rD)rrros```rfailureHandlerzLogger.failureHandlersVNOOr)r"rL)NNN)rR Optional[str]rSzOptional[object]rUzOptional['ILogObserver']r"r@r-)rZobjectr[zOptional[type]r"z'Logger')rorrprrqrr"r@) rprLrzOptional[Failure]rorrqrr"r@)rprrqrr"r@)rprLrorrqrr"zContextManager[Operation])rrLrorr"zContextManager[None])r%r&r'r( staticmethodrOr2r\rarsrrrrwr{r~rrrrrrrIrIfsQ  $(#'-1 % %!%+ %  %: @A8<%%'4%GM% %T&*"++ 5@5@#5@ 5@  5@  5@n 4 3 3 4 7 .6->->*O*O"**OJP*O "*O^#+++P+P+P  +PrrIcBtj||jS)z? Get a L{Logger} instance attached to the given class. )_logr\rX)objs r _loggerForrs <<S]] ++rN)rrr"rI)r( __future__rrtypesrtypingrrrr r r twisted.python.compatr twisted.python.failurer _interfacesrr_levelsrrrr+rDrIrrrrrrsd #JJ.*/3  <<*WPWPt x,r