�
Ϫ�f�W � � � d Z ddlZddlZddlZddlmZmZ ddlmZmZ ddl m
Z
m Z m Z m
Z
mZ ddlmZ ddlmZmZmZmZmZmZm Z m Z ddl m!Z! dd l"m#Z$ dd
l%m&Z&m'Z'm(Z(m)Z) dd l*m+Z+ e e,e
f Z- G d � d
� Z. G d� de� Z/ e&j` e.ddi� d� Z1d� Z2d9d�Z3e3Z4 G d� d� Z G d� d� Z e+e� d e5� vrnd� Z6 ee e e �� Z7 e6e7jp � d � � Z8 e6e7jr � d � � Z9 e6e7jt � d � � Z: e6e7jv � d � � Z;d e,d!e e,e
f d"e,fd#�Z<d$e-d"e
e, fd%�Z= G d&� d'e� Z> G d(� d)e>� Z? G d*� d+e>� Z@ G d,� d-� ZAd.� ZBd:d/�ZC G d0� d1� ZDd2� ZEd3 e5� vrX e e� ej� eGej� d4d� �5� aI e e� ej� eGej� d4d� �5� ZL G d6� d7e>� ZMd8 e5� vr eM� ZNyy);z%
Logging and metrics infrastructure.
� N)�ABC�abstractmethod)�datetime�timezone)�Any�BinaryIO�Dict�Optional�cast)� Interface)�LegacyLogObserverWrapper�Logger� LoggingFile�LogLevel� LogPublisher�STDLibLogObserver�globalLogBeginner�globalLogPublisher)� LogBeginner)�publishToNewObserver)�context�failure�reflect�util)� synchronizec � � e Zd ZdZy)� 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__� � �4/usr/lib/python3/dist-packages/twisted/python/log.pyr r % s � �r# r c � � e Zd ZdZdeddfd�Zy)� 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.
� eventDict�returnNc � � y)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' s r$ �__call__zILogObserver.__call__6 � � r# )r r r r! � EventDictr* r" r# r$ r& r& . s � �� �I� �$� r# r& �system�-c � � t j t � j � }|j | � t j
t |i|g|��i |��S �N)r �getr �copy�update�call)�ctx�func�args�kw�newCtxs r$ �callWithContextr: M sE � �
�[�[��
%�
*�
*�
,�F�
�M�M�#�� �<�<��f�-�t� A�d� A�b� A�Ar# c �� � | j � } t d|i|g|��i |��S # t $ r � t $ r d}t |�� Y �5w xY w# t $ r � t $ r t |�� Y yw xY w)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�errr: )�loggerr6 r7 r8 �lps r$ �callWithLoggerrB S s � �
�
�
�
�
�� � ��"�~�t�A�d�A�b�A�A��
� �
� � �
'�� �2����
� �
� � � �2���s �% �A � A�A� A,�+A,c � � | �t j � } t | t j � rt d| |dd�|�� yt | t � r#t dt j | � |dd�|�� yt t | � f|dd�|�� y)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)rE rF r" )r �Failure�
isinstance�msg� Exception�repr)�_stuff�_whyr8 s r$ r? r? g sv � �( �~�� � �"���&�'�/�/�*� �6�F��a�6�2�6� �F�I� &� �G�G�O�O�F�+��q�G�B�G� �D��L�4�d�A�4��4r# c � � e Zd ZdZd� Zy)r zM
This represents a class which may 'own' a log. Used by subclassing.
c � � y)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" ��selfs r$ r< zLogger.logPrefix� s � � r# N)r r r r! r< r" r# r$ r r � s � ��r# r c �T � e Zd ZdZdgZdddefd�Zed� � Zd� Z d� Z
d� Z d � Z d
� Z
y) r z5
Class for singleton log message publishing.
rI Nc �l � |�t � }|�|}|�
t � }|| _ || _ g | _ |�Gt � }|j |� t |t
t t � � t t � }|| _ || _ |j | _ | j j | _
y r0 )� NewPublisher�_observerPublisher�_publishPublisher�_legacyObservers� addObserverr r r �NullFile�sys�warnings� _logBeginner�_warningsModule� showwarning�_oldshowwarning)rQ �observerPublisher�publishPublisher� logBeginner�warningsModule�beginnerPublishers r$ �__init__zLogPublisher.__init__� s� � � � #� +�~� � �(�$4�!� � $� ,�� �"3�� �!1�� � "�� � � � ,�� � � )� )�*;� <�%�!�4��(�*�#=�s�H��K� (��� -�� � -� 9� 9�� � �,�,�8�8��r# c �T � | j D �cg c] }|j �� c}S c c}w )z�
Property returning all observers registered on this L{LogPublisher}.
@return: observers previously added with L{LogPublisher.addObserver}
@rtype: L{list} of L{callable}
)rW �legacyObserver)rQ �xs r$ � observerszLogPublisher.observers� s$ � � +/�*?�*?�@�Q�� � �@�@��@s �%c � � t |� }| j j |� | j j |gd|� y)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)r
rW �appendr\ �beginLoggingTo)rQ �other� setStdout�wrappeds r$ �
_startLoggingzLogPublisher._startLogging� s< � � +�5�1�� � � �$�$�W�-� ���(�(�'��D�)�Dr# c � � | j j | j k( r | j | j _ yy)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)r] r^ r_ rP s r$ � _stopLoggingzLogPublisher._stopLogging� s8 � � � � � +� +�t�/?�/?� ?�/3�/C�/C�D� � � ,� @r# c � � t |� }| j j |� | j j |� y)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)r
rW rk rU rX )rQ rm ro s r$ rX zLogPublisher.addObserver� s6 � � +�5�1�� � � �$�$�W�-� � � �+�+�G�4r# c � � | j D ]I }|j |k( s�| j j |� | j j |� y y)z%
Remove an observer.
N)rW rg �removerU �removeObserver)rQ rm �observers r$ rv zLogPublisher.removeObserver� sR � � �-�-� �H��&�&�%�/��%�%�,�,�X�6��'�'�6�6�x�@�� r# c � � t t t j t � xs i j � � }|j
|� ||d< t j � |d< d|vrd|d< t | j |t � y)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�timerF r N) r r, r r1 r r2 r3 rz � _publishNewrV �textFromEventDict)rQ ry r8 �actualEventDicts r$ rI zLogPublisher.msg� st � �8 �y�7�;�;�{�+C�+I�r�*O�*O�*Q�R��� � �r�"�%,�� �"�"&�)�)�+��� � �O� +�)*�O�I� &��D�*�*�O�=N�Or# )r r r r! � synchronizedr[ re �propertyri rp rr rX rv rI r" r# r$ r r � sU � �� �7�L� � �� � 9�8 �A� �A�
E� D�
5��#Pr# r �theLogPublisherc � � � � fd�}|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 r0 r" )�thingWithADocstring� somethings �r$ �decoratez_actually.<locals>.decorate, s �� � � r# r" )r� r� s ` r$ � _actuallyr� s �� � � �r# )r` ra rb c � � y)z�
Add a log observer to the global publisher.
@see: L{LogPublisher.addObserver}
@param observer: a log observer
@type observer: L{callable}
Nr" �rw s r$ rX rX 7 r+ r# c � � y)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}
Nr" r� s r$ rv rv B r+ r# c � � y)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" )ry �events r$ rI rI M r+ r# c � � y)zw
Publish a Python warning through the global log publisher.
@see: L{LogPublisher.showwarning}
Nr" r" r# r$ r^ r^ [ r+ r# � fmtString�fmtDictr( c � � | |z }|S # t $ r � t $ r5 d| �d|��}Y |S # t $ r d| �d�}n# t $ r d}Y nw xY wY Y |S w xY ww xY w)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}.
z>Invalid format string or unformattable object in log message: z, z-UNFORMATTABLE OBJECT WRITTEN TO LOG with fmt z, MESSAGE LOSTzJPATHOLOGICAL ERROR IN BOTH FORMAT STRING AND MESSAGE DETAILS, MESSAGE LOST)r= r> )r� r� �texts r$ � _safeFormatr� d s� � �&��7�"��* �K��) � �
� � � � *3�G�=�
� �K�� �
�
� '0�2� �� !�
�4� �
�� �K�
��
�sD � �A�&� A �6�A � A�A �A�A �A� A � Ar' c �� � | d }|s�| d rsd| v rot t | j d� � }|rt j |� }nd} t t
j | d � j � }|dz |z }|S d | v rt | d | � }|S yd
j t t j |� � }|S # t $ r}dt |� z }Y d}~�gd}~ww xY w) 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.
ry rF r rE zUnhandled Errorz (unable to obtain traceback): N�
�format� ) r �strr1 r �safe_strr rG � getTracebackrJ r� �join�map)r' �edmrE � traceback�er� s r$ r| r| � s� � �$ �I�
�C� � �Y� �I��$:��s�I�M�M�%� 0�1�C�� �&�&�s�+��'��
F� �� � �)�I�2F� G� T� T� V� � ��:� �)�D� �K� ��
"� �y�� 2�I�>�D� �K� ��x�x��G� ,� ,�c�2�3�� �K�� �
F� <�s�1�v� E� ��
F�s � +C � C"�
C � C"c �: � e Zd ZdZededdfd�� Zdd�Zdd�Zy) �_GlobalStartStopObserverzB
Mix-in for global log observers that can start and stop.
r' r( Nc � � y)zR
Emit the given log event.
@param eventDict: a log event
Nr" �rQ r' s r$ �emitz _GlobalStartStopObserver.emit� r+ r# c �. � t | j � y)z-
Start observing log events.
N)rX r� rP s r$ �startz _GlobalStartStopObserver.start� s � � �D�I�I� r# c �. � t | j � y)z,
Stop observing log events.
N)rv r� rP s r$ �stopz _GlobalStartStopObserver.stop� s � � �t�y�y�!r# )r( N) r r r r! r r, r� r� r� r" r# r$ r� r� � s3 � �� � �i� �D� � � � � "r# r� c �H � e Zd ZU dZdZee ed< d� Zd� Z d� Z
de ddfd �Z y)
�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�
timeFormatc �H � |j | _ |j | _ y r0 )�write�flush)rQ �fs r$ re zFileLogObserver.__init__� s � ��W�W��
��W�W��
r# c �� � t j |t j � j d�� t j |� z
}|j
dz |j z S )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.
N��tzinfoi�Q )r �
fromtimestampr �utc�replace�days�seconds)rQ �when�offsets r$ �getTimezoneOffsetz!FileLogObserver.getTimezoneOffset� s[ � � �'�'��h�l�l�;�C�C�� D�
� � "� "�4� (�)�� �{�{�l�+�f�n�n�<�<r# c
� � | j �.t j |� j | j � S | j |� }t j ||z t
j � j d�� }t t |dz dz � � }t t |dz dz � � }|dk rd}nd}d|j |j |j |j |j |j |||f z 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}
Nr� �< r r. �+z%%d-%02d-%02d %02d:%02d:%02d%s%02d%02d)r� r r� �strftimer� r r� r� �abs�int�year�month�day�hour�minute�second)rQ r� �tzOffset�tzHour�tzMin�tzSigns r$ �
formatTimezFileLogObserver.formatTime� s� � � �?�?� &��)�)�$�/�8�8�� � �I� I��*�*�4�0�0���%�%�d�X�o�x�|�|�D�L�L�� M�
�� �S��B� ��+�,�-���C��2�
��*�+�,�� �a�<��F��F�6� �I�I� �J�J� �H�H� �I�I� �K�K� �K�K� � � �
:
�
�
r# r' r( c � � t |� }|�y| j |d � }|d |j dd� d�}t d|� }t j
| j |dz |z � t j
| j � y) z|
Format the given log event as text and write it to the output file.
@param eventDict: a log event
Nrz r- r� z
)r- r� z[%(system)s] %(text)s
r� )r| r� r� r� r �untilConcludesr� r� )rQ r' r� �timeStrr� �msgStrs r$ r� zFileLogObserver.emit s � � !��+�� �<� ��/�/�)�F�"3�4�� &�x� 0�$�,�,�t�V�:T�U�� � 6��@�� ���D�J�J��#�
��(>�?� ���D�J�J�'r# )
r r r r! r� r
r� �__annotations__re r� r� r, r� r" r# r$ r� r� � s: � �� !%�J���
�$� �
=� &
�P(�i� (�D� (r# r� c �( � e Zd ZdZdd�Zdeddfd�Zy)�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.
c �$ � t |� | _ y)zi
@param loggerName: identifier used for getting logger.
@type loggerName: C{str}
N)�NewSTDLibLogObserver� _newObserver)rQ �
loggerNames r$ re z PythonLoggingObserver.__init__6 s � �
1�� <��r# r' r( Nc �D � d|v r t | j |t � yy)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)r{ r� r| r� s r$ r� zPythonLoggingObserver.emit= s$ � � �9� $� ��)�)�9�6G� H� %r# )�twisted)r r r r! re r, r� r" r# r$ r� r� , s" � ��=�
I�i�
I�D�
Ir# r� c �\ � e Zd ZdZdZdZdZdZd
d�Zd� Z d� Z
d � Z d
� Z e Z
e Ze Ze Zd � Zd � Zy)�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)>Nc �Z � || _ |�t j � }|| _ d| _ y )N� )rF rZ �getdefaultencoding�encoding�buf)rQ rF r� s r$ re zStdioOnnaStick.__init__Z s+ � � �� � � ��-�-�/�H� ��
���r# c � � y r0 r" rP s r$ �closezStdioOnnaStick.closea � � � r# c � � y)N���r" rP s r$ �filenozStdioOnnaStick.filenod s � �r# c � � y r0 r" rP s r$ r� zStdioOnnaStick.flushg r� r# c � � t d� �)Nzcan't read from the log!)�OSErrorrP s r$ �readzStdioOnnaStick.readj s � ��0�1�1r# c � � | j |z j d� }|d | _ |dd }|D ] }t |d| j �� � y )Nr� r� r rD ��printedrF )r� �splitrI rF )rQ �data�d�messagesry s r$ r� zStdioOnnaStick.writer sO � �
�X�X��_� #� #�D� )���R�5����Q�r�7�� � :�G� ���D�L�L� 9� :r# c �B � |D ] }t |d| j �� � y )NrD r� )rI rF )rQ �lines�lines r$ �
writelineszStdioOnnaStick.writelinesy s! � �� 7�D� ��a�� � � 6� 7r# )r N)r r r r! �closed� softspace�mode�namere r� r� r� r� �readline� readlines�seek�tellr� r� r" r# r$ r� r� J sV � �� �F��I� �D� �D��
��
�2� �H��I� �D� �D�:�7r# r� c �p � t | t � ryt | � }t |j g|��i |�� |S )z�
Initialize logging to a specified file.
@return: A L{FileLogObserver} if a new observer is added, None otherwise.
N)rH r r� �startLoggingWithObserverr� )�file�ar8 �flos r$ � startLoggingr ~ s6 � � �$� �$��
�$�
�C� �S�X�X�0��0�R�0� �Jr# c �F � t j | |� t d� y)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.
z Log opened.N)r� rp rI )rw rn s r$ r� r� � s � � �!�!�(�I�6��
�r# c �, � e Zd ZdZdZd� Zd� Zd� Zd� Zy)rY z6
A file-like object that discards everything.
r c � � y�z
Do nothing.
Nr" rP s r$ r� z
NullFile.read� r+ r# c � � y)zW
Do nothing.
@param bytes: data
@type bytes: L{bytes}
Nr" )rQ �bytess r$ r� zNullFile.write� r+ r# c � � yr r" rP s r$ r� zNullFile.flush� r+ r# c � � yr r" rP s r$ r� zNullFile.close� r+ r# N) r r r r! r� r� r� r� r� r" r# r$ rY rY � s" � �� �I� �
� �
r# rY c � � t � ay)zC
Discard messages logged via the global C{logfile} object.
N)rY �logfiler" r# r$ � discardLogsr
� s � �
�j�Gr# r r� )r@ �levelr� c �8 � e Zd ZdZej
Zdeddfd�Zy)�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.
r' r( Nc � � |d rCt |� }|�| j j |� | j j � yy)zN
Emit an event dict.
@param eventDict: an event dict
rF N)r| �stderrr� r� )rQ r' r� s r$ r� zDefaultObserver.emit� sC � � �Y� �$�Y�/�D�� �� � �!�!�$�'� �K�K� � � � r# )r r r r! rZ r r, r� r" r# r$ r r � s% � �� �Z�Z�F�
�i�
�D�
r# r �defaultObserver)NN)rD )Or! rZ rz r[ �abcr r r r �typingr r r r
r �zope.interfacer �twisted.loggerr
r � NewLoggerr r � NewLogLevelr rT r r� r �newGlobalLogBeginnerr �newGlobalLogPublisher�twisted.logger._globalr �twisted.logger._legacyr r{ �twisted.pythonr r r r �twisted.python.threadabler r� r, r r& �
setDefaultr: rB r? �deferr�globalsr� r� rX rv rI r^ r� r| r� r� r� r� r r� rY r
�info�getattr�stdoutr �errorr �logerrr r r" r# r$ �<module>r( si ��
�
� � � #� '� 6� 6� $� � � � /� F� :� :� 1� ��c��N� �� � �9� �8 �� � �;��3�� 0�B� �(5�<
�� � � ~P� ~P�B �L� � �G�I�%��* #�/�.�(��O� ��*�*�+� � ,� � ��-�-�.� � /� � ��"�"�#� � $� � ��*�*�+� � ,� �)�3� )��c�3�h� � )�C� )�X&�� &�x��}� &�R"�s� "�4V(�.� V(�rI� 4� I�<17� 17�h
�� � �>�
�G�I� ���{�� � �����Z��6��G�
��{�� � �����Z��6��F� �.� �. �G�I�%�%�'�O� &r# |