U

�
bW�@s�dZd
dl
Z
d
dlZd
dlZd
dlmZmZ
d
dlmZ
d
dlm	Z	m
Z
mZmZm
Z

d
dlmZ
d
dlmZmZmZmZmZmZmZmZ
d
dlm Z 
d
d	l!m"Z#
d
d
l$m%Z%m&Z&m'Z'm(Z(
d
dl)m*Z*
ee+e	fZ,Gdd
�d
�Z-Gdd�de�Z.e%�/e-ddi
�
dd�Z0dd�Z1dEdd�
Z2e2Z3Gdd�d�ZGdd�d�Ze*e�

de4�k�
r�dd�Z5eeeed�Z6e5e6j7�
d d!��
Z7e5e6j8�
d"d#��
Z8e5e6j9�
d$d%��
Z9e5e6j:�
d&d'��
Z:e+ee+e	fe+d(�d)d*�Z;e,ee+d+�d,d-�Z<Gd.d/�d/e�Z=Gd0d1�d1e=�Z>Gd2d3�d3e=�Z?Gd4d5�d5�Z@d6d7�ZAdFd9d:�
ZBGd;d<�d<�ZCd=d>�ZDd?e4�k�r�ee�ejEeFe
jGd@d�dA�aHee�ejIeFe
jJd@d�dA�ZKGdBdC�dCe=�ZLdDe4�k�r�eL�ZMdS)Gz%
Logging and metrics infrastructure.
�N)�ABC�abstractmethod)
�datetime)�Any�BinaryIO�Dict�Optional�cast)
�	Interface)�LegacyLogObserverWrapper�Logger�LoggingFile�LogLevel�LogPublisher�STDLibLogObserver�globalLogBeginner�globalLogPublisher)
�LogBeginner)
�publishToNewObserver)�context�failure�reflect�util)
�synchronizec
@seZ
dZd
ZdS)�ILogContextz�
    Actually, this interface is just a synonym for the dictionary interface,
    but it serves as a key for the default information in a log.

    I do not inherit from C{Interface} because the world is a cruel place.
    N)�__name__�
__module__�__qualname__�__doc__�rr�4/usr/lib/python3/dist-packages/twisted/python/log.pyr%s
rc@s eZ
dZd
Zedd�dd�ZdS)�ILogObserverz�
    An observer which can do something with log events.

    Given that most log observers are actually bound methods, it's okay to not
    explicitly declare provision of this interface.
    N��	eventDict�returnc


Csd
S)a6
        Log an event.

        @param eventDict: A dictionary with arbitrary keys.  However, these
            keys are often available:
              - C{message}: A C{tuple} of C{str} containing messages to be
                logged.
              - C{system}: A C{str} which indicates the "system" which is
                generating this event.
              - C{isError}: A C{bool} indicating whether this event represents
                an error.
              - C{failure}: A L{failure.Failure} instance
              - C{why}: Used as header of the traceback in case of errors.
              - C{format}: A string format used in place of C{message} to
                customize the event.  The intent is for the observer to format
                a message by doing something like C{format % eventDict}.
        Nr)
r#rrr �__call__6s
zILogObserver.__call__)rrrr�	EventDictr%rrrr r!.s
r!�system�
-cOs0t�
t�
��}|�|�

tjt|i
|
f|�|�
S�
N)r�getr�copy�update�call)�ctx�func�args�kwZnewCtxrrr �callWithContextMs



r2cOs�z|��}Wn6t
k
r"


�Yn"tk
rB


d
}t|d�

YnXztd|i
|
f|�|�
WSt
k
rr


�Yntk
r�


t|d�

YnXdS)z�
    Utility method which wraps a function in a try:/except:, logs a failure if
    one occurs, and uses the system's logPrefix.
    z(buggy logPrefix method))
r'r'N)�	logPrefix�KeyboardInterrupt�
BaseException�errr2)�loggerr/r0r1Zlprrr �callWithLoggerSs











r8cKsz|d
krt�
�}t|tj
�r4tf||
dd�|��

nBt|t�r\tft�
|�
|
dd�|��

ntt|�
f
|
dd�|��

d
S)a
    Write a failure to the log.

    The C{_stuff} and C{_why} parameters use an underscore prefix to lessen
    the chance of colliding with a keyword argument the application wishes
    to pass.  It is intended that they be supplied with arguments passed
    positionally, not by keyword.

    @param _stuff: The failure to log.  If C{_stuff} is L{None} a new
        L{Failure} will be created from the current exception state.  If
        C{_stuff} is an C{Exception} instance it will be wrapped in a
        L{Failure}.
    @type _stuff: L{None}, C{Exception}, or L{Failure}.

    @param _why: The source of this failure.  This will be logged along with
        C{_stuff} and should describe the context in which the failure
        occurred.
    @type _why: C{str}
    N�
)r�why�isError)r:r;)r�Failure�
isinstance�msg�	Exception�repr)Z_stuffZ_whyr1rrr r6gs





r6c@seZ
dZd
Zdd�ZdS)rzM
    This represents a class which may 'own' a log. Used by subclassing.
    c


Csd
S)z�
        Override this method to insert custom logging behavior.  Its
        return value will be inserted in front of every line.  It may
        be called more times than the number of output lines.
        r(r�
�selfrrr r3�szLogger.logPrefixN)rrrrr3rrrr r�s
rc@s\eZ
dZd
Zdg
Zdddefdd�
Zedd��
Zdd	�Z	d
d�Z
dd
�Zdd�Zdd�Z
dS)rz5
    Class for singleton log message publishing.
    r>NcCs�|dkrt�}|
dkr|}
|
dkr(t�}
|
|_
||_g|_|dkrht�}|�|
�

t|ttt��t	t
�}||_||_|j
|_|jj
|_
dSr))�NewPublisher�_observerPublisher�_publishPublisher�_legacyObservers�addObserverrr	r�NullFile�sys�warnings�_logBeginner�_warningsModule�showwarning�_oldshowwarning)rB�observerPublisher�publishPublisher�logBeginner�warningsModuleZbeginnerPublisherrrr �__init__�s,













�


zLogPublisher.__init__c

Csd
d�|jD�
S)z�
        Property returning all observers registered on this L{LogPublisher}.

        @return: observers previously added with L{LogPublisher.addObserver}
        @rtype: L{list} of L{callable}
        c
Ssg|]
}
|
j�qSr)
�legacyObserver)�.0�
xrrr �
<listcomp>�sz*LogPublisher.observers.<locals>.<listcomp>)
rFrArrr �	observers�szLogPublisher.observerscCs*t|
�
}|j
�|�

|j�|g
d
|�
dS)a&

        Begin logging to the L{LogBeginner} associated with this
        L{LogPublisher}.

        @param other: the observer to log to.
        @type other: L{LogBeginner}

        @param setStdout: if true, send standard I/O to the observer as well.
        @type setStdout: L{bool}
        TN)rrF�appendrK�beginLoggingTo)rB�other�	setStdout�wrappedrrr �
_startLogging�s

zLogPublisher._startLoggingc

Cs|jj
|j
kr|j|j_
d
S)z�
        Clean-up hook for fixing potentially global state.  Only for testing of
        this module itself.  If you want less global state, use the new
        warnings system in L{twisted.logger}.
        N)rLrMrNrArrr �_stopLogging�s
zLogPublisher._stopLoggingcCs$t|
�
}|j
�|�

|j�|�

d
S)z�
        Add a new observer.

        @type other: Provider of L{ILogObserver}
        @param other: A callable object that will be called with each new log
            message (a dict).
        N)rrFrYrDrG)rBr[r]rrr rG�s

zLogPublisher.addObservercCs6|jD]*}|j
|
kr|j�|�

|j�|�


q2qd
S)z%
        Remove an observer.
        N)rFrT�removerD�removeObserver)rBr[�observerrrr ra�s






zLogPublisher.removeObserverc
OsXtt
t�t�
pi���}|�|�

|
|d
<t��|d<d|krFd|d<t|j	|t
�
dS)ac
        Log a new message.

        The message should be a native string, i.e. bytes on Python 2 and
        Unicode on Python 3. For compatibility with both use the native string
        syntax, for example::

            >>> log.msg('Hello, world.')

        You MUST avoid passing in Unicode on Python 2, and the form::

            >>> log.msg('Hello ', 'world.')

        This form only works (sometimes) by accident.

        Keyword arguments will be converted into items in the event
        dict that is passed to L{ILogObserver} implementations.
        Each implementation, in turn, can define keys that are used
        by it specifically, in addition to common keys listed at
        L{ILogObserver.__call__}.

        For example, to set the C{system} parameter while logging
        a message::

        >>> log.msg('Started', system='Foo')

        �message�timer;r
N)r	r&rr*rr+r,rd�_publishNewrE�textFromEventDict)rBrcr1ZactualEventDictrrr r>�s





zLogPublisher.msg)rrrrZsynchronizedrJrS�propertyrXr^r_rGrar>rrrr r�s



�


		
r�theLogPublisherc
s�f
d
d�}
|
S)a�

        A decorator that returns its argument rather than the thing it is
        decorating.

        This allows the documentation generator to see an alias for a method or
        constant as an object with a docstring and thereby document it and
        allow references to it statically.

        @param something: An object to create an alias for.
        @type something: L{object}

        @return: a 1-argument callable that returns C{something}
        @rtype: L{object}
        c


s�Sr)r)
ZthingWithADocstring�
�	somethingrr �decorate,
s
z_actually.<locals>.decorater)rjrkrrir �	_actually
srl)rOrPrQc


Csd
S)z�
        Add a log observer to the global publisher.

        @see: L{LogPublisher.addObserver}

        @param observer: a log observer
        @type observer: L{callable}
        Nr�
rbrrr rG7
srGc


Csd
S)z�
        Remove a log observer from the global publisher.

        @see: L{LogPublisher.removeObserver}

        @param observer: a log observer previously added with L{addObserver}
        @type observer: L{callable}
        Nrrmrrr raB
srac
Osd
S)a?

        Publish a message to the global log publisher.

        @see: L{LogPublisher.msg}

        @param message: the log message
        @type message: C{tuple} of L{str} (native string)

        @param event: fields for the log event
        @type event: L{dict} mapping L{str} (native string) to L{object}
        Nr)rc�eventrrr r>M
sr>c
Csd
S)zw
        Publish a Python warning through the global log publisher.

        @see: L{LogPublisher.showwarning}
        Nrrrrr rM[
srM)�	fmtString�fmtDictr$cCs�z||
}Wnvtk
r"


�Ynbt
k
r�


zd
||
f}Wn<t
k
r|


zd|f
}Wnt
k
rv


d}YnXYnXYnX|S)a�

    Try to format a string, swallowing all errors to always return a string.

    @note: For backward-compatibility reasons, this function ensures that it
        returns a native string, meaning L{bytes} in Python 2 and L{str} in
        Python 3.

    @param fmtString: a C{%}-format string
    @param fmtDict: string formatting arguments for C{fmtString}

    @return: A native string, formatted from C{fmtString} and C{fmtDict}.
    zDInvalid format string or unformattable object in log message: %r, %sz=UNFORMATTABLE OBJECT WRITTEN TO LOG with fmt %r, MESSAGE LOSTzJPATHOLOGICAL ERROR IN BOTH FORMAT STRING AND MESSAGE DETAILS, MESSAGE LOST)r4r5)rorp�textrrr �_safeFormatd
s(





��

���rrr"c

Cs�|d
}
|
s�|dr�d|kr�tt
|�d�
�}|r<t�|�
}nd}zttj|d���}Wn.tk
r�
}
zdt
|�
}W5d}~XYnX|d|}q�d	|kr�t	|d	|�}q�dSnd
�
ttj|
��
}|S)a
    Extract text from an event dict passed to a log observer. If it cannot
    handle the dict, it returns None.

    The possible keys of eventDict are:
     - C{message}: by default, it holds the final text. It's required, but can
       be empty if either C{isError} or C{format} is provided (the first
       having the priority).
     - C{isError}: boolean indicating the nature of the event.
     - C{failure}: L{failure.Failure} instance, required if the event is an
       error.
     - C{why}: if defined, used as header of the traceback in case of errors.
     - C{format}: string format used in place of C{message} to customize
       the event. It uses all keys present in C{eventDict} to format
       the text.
    Other keys will be used when applying the C{format}, or ignored.
    rcr;rr:zUnhandled Errorz(unable to obtain traceback): N�

�format�
 )r	�strr*r�safe_strrr<�getTracebackr?rr�join�map)r#Zedmr:�	traceback�
erqrrr rf�
s"












rfc@s@eZ
dZd
Zeedd�dd��
Zdd�
dd�Zdd�
d	d
�ZdS)�_GlobalStartStopObserverzB
    Mix-in for global log observers that can start and stop.
    Nr"c
Csd
S)zR
        Emit the given log event.

        @param eventDict: a log event
        Nr�rBr#rrr �emit�
sz_GlobalStartStopObserver.emit)
r$c

Cst|j
�

d
S)z-
        Start observing log events.
        N)rGrrArrr �start�
sz_GlobalStartStopObserver.startc

Cst|j
�

d
S)z,
        Stop observing log events.
        N)rarrArrr �stop�
sz_GlobalStartStopObserver.stop)	rrrrrr&rr�r�rrrr r}�
s


r}c@sJeZ
dZUd
ZdZeeed<dd�Zdd�Z	dd	�Z
edd
�dd�ZdS)
�FileLogObserverz�
    Log observer that writes to a file-like object.

    @type timeFormat: C{str} or L{None}
    @ivar timeFormat: If not L{None}, the format string passed to strftime().
    N�
timeFormatcCs|
j|_|
j
|_
dSr))�write�flush)rB�
frrr rS�
s
zFileLogObserver.__init__cCs$t�
|
�
t�|
�
}|jd
|jS)a*

        Return the current local timezone offset from UTC.

        @type when: C{int}
        @param when: POSIX (ie, UTC) timestamp for which to find the offset.

        @rtype: C{int}
        @return: The number of seconds offset from UTC.  West is positive,
        east is negative.
        i�Q
)r�utcfromtimestamp�
fromtimestamp�days�seconds)rB�when�offsetrrr �getTimezoneOffset�
s
z!FileLogObserver.getTimezoneOffsetc
Cs�|jd
k	rt
�|
�
�|j�
S|�|
�
}t
�|
|�
}
tt|dd�
�
}tt|dd�
�
}|dkrld}nd}d|
j|
j	|
j
|
j|
j|
j
|||f	S)a
        Format the given UTC value as a string representing that time in the
        local timezone.

        By default it's formatted as an ISO8601-like string (ISO8601 date and
        ISO8601 time separated by a space). It can be customized using the
        C{timeFormat} attribute, which will be used as input for the underlying
        L{datetime.datetime.strftime} call.

        @type when: C{int}
        @param when: POSIX (ie, UTC) timestamp for which to find the offset.

        @rtype: C{str}
        N�<r
r(�
+z%%d-%02d-%02d %02d:%02d:%02d%s%02d%02d)r�rr��strftimer�r��abs�int�year�month�day�hour�minute�second)rBr�ZtzOffsetZtzHourZtzMinZtzSignrrr �
formatTime�
s(
















�zFileLogObserver.formatTimer"cCsht|
�
}|d
krd
S|�
|
d�
}|
d|�dd�d�}td|�}t�|j|d|�
t�|j�

d
S)	z|
        Format the given log event as text and write it to the output file.

        @param eventDict: a log event
        Nrdr'rsz
	)r'rqz[%(system)s] %(text)s
ru)rfr��replacerrr�untilConcludesr�r�)rBr#rqZtimeStrrpZmsgStrrrr rs





zFileLogObserver.emit)
rrrrr�rrv�__annotations__rSr�r�r&rrrrr r��
s

&r�c@s*eZ
dZd
Zd	dd�
Zedd�dd�ZdS)
�PythonLoggingObserveraL

    Output twisted messages to Python standard library L{logging} module.

    WARNING: specific logging configurations (example: network) can lead to
    a blocking system. Nothing is done here to prevent that, so be sure to not
    use this: code within Twisted, such as twisted.web, assumes that logging
    does not block.
    �twistedcCst|
�
|_
d
S)zi
        @param loggerName: identifier used for getting logger.
        @type loggerName: C{str}
        N)�NewSTDLibLogObserver�_newObserver)rBZ
loggerNamerrr rS2szPythonLoggingObserver.__init__Nr"cCsd
|
krt|j
|
t�
dS)a(

        Receive a twisted log entry, format it and bridge it to python.

        By default the logging level used is info; log.err produces error
        level, and you can customize the level by using the C{logLevel} key::

            >>> log.msg('debugging', logLevel=logging.DEBUG)
        �
log_formatN)rer�rfr~rrr r9s	
zPythonLoggingObserver.emit)
r�)rrrrrSr&rrrrr r�(s
	
r�c@sjeZ
dZd
ZdZdZdZdZddd�
Zdd	�Z	d
d�Z
dd
�Zdd�ZeZ
eZeZeZdd�Zdd�ZdS)�StdioOnnaStickaP

    Class that pretends to be stdout/err, and turns writes into log messages.

    @ivar isError: boolean indicating whether this is stderr, in which cases
                   log messages will be logged as errors.

    @ivar encoding: unicode encoding used to encode any unicode strings
                    written to this object.
    r
�wbz
<stdio (log)>NcCs&|
|_|dkrt
��}||_d
|_dS)N�)r;rI�getdefaultencoding�encoding�buf)rBr;r�rrr rSVs





zStdioOnnaStick.__init__c


CsdSr)rrArrr �close]s
zStdioOnnaStick.closec


Csd
S)N���rrArrr �fileno`s
zStdioOnnaStick.filenoc


CsdSr)rrArrr r�cs
zStdioOnnaStick.flushc

Cstd
�
�
dS)Nzcan't read from the log!)
�OSErrorrArrr �readfs
zStdioOnnaStick.readcCsD|j|
�
d
�
}|d|_|dd�}|D]}t|d|jd�
q*dS)Nrsr�r
r9�Zprintedr;)r��splitr>r;)rB�data�
dZmessagesrcrrr r�ns






zStdioOnnaStick.writecCs|
D]}t|d
|j
d�
qdS)Nr9r�)r>r;)rB�lines�linerrr �
writelinesus

zStdioOnnaStick.writelines)r
N)rrrr�closed�	softspace�mode�namerSr�r�r�r��readline�	readlines�seek�tellr�r�rrrr r�Fs 








r�c
Os,t|t
�rd
St|�
}t|jf
|
�|�

|S)z�
    Initialize logging to a specified file.

    @return: A L{FileLogObserver} if a new observer is added, None otherwise.
    N)r=r
r��startLoggingWithObserverr)�file�
ar1Zflorrr �startLoggingzs





r�r9cCst�
||
�
td
�

dS)z�
    Initialize logging to a specified observer. If setStdout is true
    (defaults to yes), also redirect sys.stdout and sys.stderr
    to the specified file.
    zLog opened.N)rhr^r>)rbr\rrr r��s
r�c@s4eZ
dZd
ZdZdd�Zdd�Zdd�Zd	d
�ZdS)rHz6
    A file-like object that discards everything.
    r
c


Csd
S�z
        Do nothing.
        NrrArrr r��s
z
NullFile.readc
Csd
S)zW
        Do nothing.

        @param bytes: data
        @type bytes: L{bytes}
        Nr)rB�bytesrrr r��s
zNullFile.writec


Csd
Sr�rrArrr r��s
zNullFile.flushc


Csd
Sr�rrArrr r��s
zNullFile.closeN)	rrrrr�r�r�r�r�rrrr rH�s
rHc
Cs
t�a
d
S)zC
    Discard messages logged via the global C{logfile} object.
    N)rH�logfilerrrr �discardLogs�sr�r�r�)r7�levelr�c@s&eZ
dZd
ZejZedd�dd�ZdS)�DefaultObserverz�
    Default observer.

    Will ignore all non-error messages and send error messages to sys.stderr.
    Will be removed when startLogging() is called for the first time.
    Nr"cCs2|
d
r.t|
�
}|dk	r$|j
�|�

|j
��
dS)zN
        Emit an event dict.

        @param eventDict: an event dict
        r;N)rf�stderrr�r�)rBr#rqrrr r�s




zDefaultObserver.emit)rrrrrIr�r&rrrrr r��s
r��defaultObserver)NN)
r9)NrrIrdrJ�abcrrr�typingrrrrr	�zope.interfacer
�twisted.loggerrrZ	NewLoggerr
rZNewLogLevelrrCrr�rZnewGlobalLogBeginnerrZnewGlobalLogPublisherZtwisted.logger._globalrZtwisted.logger._legacyrre�twisted.pythonrrrrZtwisted.python.threadablerrvr&rr!Z
setDefaultr2r8r6�deferr�globalsrlrhrGrar>rMrrrfr}r�r�r�r�r�rHr��info�getattr�stdoutr��errorr��logerrr�r�rrrr �<module>s~




(



	



�










,)U4

	



�


�