File: //lib/python3/dist-packages/sphinx/util/__pycache__/logging.cpython-310.pyc
o
u�a�G �
@ s� U d Z ddlZddlZddlmZ ddlmZ ddlmZm Z m
Z
m Z m Z m
Z
mZmZmZmZ ddlmZ ddlmZ ddlmZ dd lmZ dd
lmZ e rUdd l m Z d Z d
Z edd� �Z e e!e"f e#d< e �$ej%ej%ej&ej'ej(e ej)d�� edd� �Z*e e"e"f e#d< e*�$ej(e ej)d�� edd� ej&dej'dej)di�Z+de!ddfd d �Z,d e
ej- ddfd d �Z.G d!d"� d"ej-�Z/G d#d$� d$e/�Z0G d%d&� d&e/�Z1G d'd� dej2�Z3G d(d)� d)ej4�Z5G d*d+� d+ej4�Z6G d,d-� d-ej7j8�Z9ede ej:ddf fd.d/��Z;ede e9ddf fd0d1��Z<ede e9ddf fd2d3��Z=eddd5e>de d6 fd7d8��Z?ed9e!de d6 fd:d;��Z@G d<d=� d=�ZAG d>d?� d?ejB�ZCd@e!dAe!dBe
e! de>fdCdD�ZDG dEdF� dFejB�ZEG dGdH� dHejB�ZFG dIdJ� dJejB�ZGG dKdL� dLejB�ZHG dMdN� dNejB�ZIG dOdP� dPejB�ZJG dQdR� dReJ�ZKG dSdT� dTeJ�ZLdUedee! fdVdW�ZMG dXdY� dYejN�ZOG dZd[� d[�ZPG d\d]� d]�ZQd^d_d`edaeddfdbdc�ZRdS )ez�
sphinx.util.logging
~~~~~~~~~~~~~~~~~~~
Logging utility functions for Sphinx.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� N)� defaultdict)�contextmanager)
�IO�
TYPE_CHECKING�Any�Dict� Generator�List�Optional�Tuple�Type�Union)�nodes)�Node��get_source_line)�
SphinxWarning)�colorize)�Sphinx�sphinx� c C s t jS �N)�logging�WARNING� r r �5/usr/lib/python3/dist-packages/sphinx/util/logging.py�<lambda> s r � LEVEL_NAMES)�CRITICAL�SEVERE�ERRORr �INFO�VERBOSE�DEBUGc C � dS )Nr r r r r r r * � �
VERBOSITY_MAP)r � � c C r$ )N�bluer r r r r r 1 r% �darkred�red�darkgray�name�return�SphinxLoggerAdapterc C s" t �td | �}d|_t|i �S )a� Get logger wrapped by :class:`sphinx.util.logging.SphinxLoggerAdapter`.
Sphinx logger always uses ``sphinx.*`` namespace to be independent from
settings of root logger. It ensures logging is consistent even if a
third-party extension or imported application resets logger settings.
Example usage::
>>> from sphinx.util import logging
>>> logger = logging.getLogger(__name__)
>>> logger.info('Hello, this is an extension!')
Hello, this is an extension!
�.F)r � getLogger� NAMESPACE�disabledr/ )r- �loggerr r r r1 9 s
r1 �recordsc C s@ | D ]}|� � |_d|_t|dd�}t|tj�r t|�|_qdS )z Convert LogRecord serializable.r �locationN) �
getMessage�msg�args�getattr�
isinstancer r �get_node_locationr6 )r5 �rr6 r r r �convert_serializableO s
��r> c s8 e Zd ZU dZdZdZeed< def� fdd� Z � Z
S )�SphinxLogRecordz$Log record class supporting location� Nr6 r. c sF t � �� }t| dd �}|rd|| j|f }|S | j|vr!| j| }|S )Nr6 z%s: %s%s)�superr7 r: �prefix)�self�messager6 �� __class__r r r7 ` s
�
zSphinxLogRecord.getMessage) �__name__�
__module__� __qualname__�__doc__rB r6 r �__annotations__�strr7 �
__classcell__r r rE r r? [ s
r? c @ � e Zd ZdZdZdS )�SphinxInfoLogRecordz)Info log record class supporting locationr@ N�rG rH rI rJ rB r r r r rO k � rO c @ rN )�SphinxWarningLogRecordz,Warning log record class supporting locationz WARNING: NrP r r r r rR p rQ rR c
s� e Zd ZdZg d�Zdeeef dedededdf
� fd d
� Z dedededdfd d �Z
dede de ee f fd
d�Z
dejddfdd�Z� ZS )r/ z9LoggerAdapter allowing ``type`` and ``subtype`` keywords.)�type�subtyper6 �nonl�color�once�levelr8 r9 �kwargsr. Nc sR t |t�rt� j||g|�R i |�� d S t| }t� j||g|�R i |�� d S r )r; �intrA �logr )rC rX r8 r9 rY �levelnorE r r r[ y s
zSphinxLoggerAdapter.logc O s | j t|g|�R i |�� d S r )r[ r" )rC r8 r9 rY r r r �verbose� s zSphinxLoggerAdapter.verbosec C s6 |� di �}| jD ]
}||v r|�|�||< q ||fS )N�extra)�
setdefault�KEYWORDS�pop)rC r8 rY r^ �keywordr r r �process� s
�zSphinxLoggerAdapter.process�recordc C s | j �|� d S r )r4 �handle�rC rd r r r re � � zSphinxLoggerAdapter.handle)rG rH rI rJ r` r
rZ rL r r[ r] r r rc r � LogRecordre rM r r rE r r/ u s * c @ s e Zd ZdZdS )�WarningStreamHandlerzStreamHandler for warnings.N)rG rH rI rJ r r r r ri � s ri c s, e Zd ZdZdejddf� fdd� Z� ZS )�NewLineStreamHandlerzAStreamHandler which switches line terminator by record.nonl flag.rd r. Nc sL z | � � t|dd�rd| _t� �|� W d| _| �� d S d| _| �� w )NrU Fr@ �
)�acquirer: �
terminatorrA �emit�releaserf rE r r rn � s �
zNewLineStreamHandler.emit)rG rH rI rJ r rh rn rM r r rE r rj � s rj c sx e Zd ZU dZeej ed< d� fdd� Zdejde fdd �Z
dd
d �Z d ej ddfd
d�Z
deej fdd�Z� ZS )�
MemoryHandlerzHandler buffering all logs.�bufferr. Nc s t � �d� d S )N���)rA �__init__�rC rE r r rs � rg zMemoryHandler.__init__rd c C r$ )NFr rf r r r � shouldFlush� s zMemoryHandler.shouldFlushc C s d S r r rt r r r �flush� s zMemoryHandler.flushr4 c C s> | � � z| jD ]}|�|� qg | _W | �� d S | �� w r )rl rq re ro )rC r4 rd r r r �flushTo� s
zMemoryHandler.flushToc C s | j g }| _ |S r )rq )rC rq r r r �clear� s zMemoryHandler.clear�r. N)rG rH rI rJ r r rh rK rs �boolru rv �Loggerrw rx rM r r rE r rp � s
rp c
c s� � t �t�} t� }|�t j� z:g }| jdd� D ]}t|t�r*| � |� |�
|� q| � |� |V W | � |� |D ]}| � |� q;|� | � dS | � |� |D ]}| � |� qQ|� | � w )zgContext manager to postpone logging warnings temporarily.
Similar to :func:`pending_logging`.
N)
r r1 r2 rp �setLevelr �handlersr; ri �
removeHandler�append�
addHandlerrw �r4 �
memhandlerr} �handlerr r r �pending_warnings� s* �
�
� r� c
c s� � t �t�} t� }z0g }| jdd� D ] }| �|� |�|� q| �|� |V W | �|� |D ]}| �|� q0dS | �|� |D ]}| �|� qAw )z�Context manager to suppress logging all logs temporarily.
For example::
>>> with suppress_logging():
>>> logger.warning('Warning message!') # suppressed
>>> some_long_process()
>>>
N)r r1 r2 rp r} r~ r r� r� r r r �suppress_logging� s$ �
�
� �r� c c sf � t �t�} z&t� � }|V W d � n1 sw Y W |�| � dS W |�| � dS |�| � w )a$ Context manager to postpone logging all logs temporarily.
For example::
>>> with pending_logging():
>>> logger.warning('Warning message!') # not flushed yet
>>> some_long_process()
>>>
Warning message! # the warning is flushed here
N)r r1 r2 r� rw )r4 r� r r r �pending_logging� s �
��r� T�skip�NNNc
c sz � t �t�}| du rdV dS z!t� }|jD ] }|j�d|� qdV W |jD ]}|�|� q'dS |jD ]}|�|� q4w )z9Context manager to skip WarningIsErrorFilter temporarily.FNr )r r1 r2 �DisableWarningIsErrorFilterr} �filters�insert� removeFilter)r� r4 �disablerr� r r r �skip_warningiserror s �
� �r� rB c c s� � t �t�}d}|jD ] }t|t�r|} nq dV dS d}|jD ] }t|t�r,|} nq!|rCz|j}| |_dV W ||_dS ||_w t| �}z|� |� dV W |�
|� dS |�
|� w )z�Context manager to prepend prefix to all warning log records temporarily.
For example::
>>> with prefixed_warnings("prefix:"):
>>> logger.warning('Warning message!') # => prefix: Warning message!
.. versionadded:: 2.0
N) r r1 r2 r} r; ri r� �MessagePrefixFilterrB � addFilterr� )rB r4 �warning_handlerr� �
prefix_filter�_filter�previousr r r �prefixed_warnings" s6 �
�
�
r� c @ s, e Zd Zddd�Zeded fdd��ZdS ) � LogCollectorr. Nc C s
g | _ d S r )�logsrt r r r rs Q �
zLogCollector.__init__r� c c s> � t � �}d V |�� | _W d � d S 1 sw Y d S r )r� rx r� )rC r� r r r �collectT s
� "�zLogCollector.collectry )rG rH rI rs r r r� r r r r r� P s
r� c @ �$ e Zd ZdZdejdefdd�ZdS )�
InfoFilterz"Filter error and warning messages.rd r. c C s |j tjk rdS dS )NTF)r\ r r rf r r r �filter_ s zInfoFilter.filterN�rG rH rI rJ r rh rz r� r r r r r� \ � r� rS rT �suppress_warningsc C st | du rdS |D ]/}d|v r|� dd�\}}n|d}}|| kr7|du r(|du s4|du s4||ks4|dkr7 dS qdS )z/Check whether the warning is suppressed or not.NFr0 r' �*T)�split)rS rT r� � warning_type�target� subtargetr r r �is_suppressed_warningf s
�r� c �6 e Zd ZdZd � fdd� Zdejdefd d
�Z� Z S ) �WarningSuppressorz#Filter logs by `suppress_warnings`.�appr r. Nc � || _ t� �� d S r �r� rA rs �rC r� rE r r rs � � zWarningSuppressor.__init__rd c C sb t |dd �}t |dd �}z| jjj}W n ty g }Y nw t|||�r'dS | j jd7 _dS )NrS rT Fr' T)r: r� �configr� �AttributeErrorr� �
_warncount)rC rd rS rT r� r r r r� � s � zWarningSuppressor.filter�r� r r. N�
rG rH rI rJ rs r rh rz r� rM r r rE r r� } � r� c r� ) �WarningIsErrorFilterz#Raise exception if warning emitted.r� r r. Nc r� r r� r� rE r r rs � r� z WarningIsErrorFilter.__init__rd c C s� t |dd�rdS | jjrGt |dd�}z|j|j }W n ttfy( |j}Y nw |r6t|d t|� �}nt|�}|j d urE||j d �|�dS )N�skip_warningsiserrorFTr6 r@ �:r' )
r: r� �warningiserrorr8 r9 � TypeError�
ValueErrorr rL �exc_info)rC rd r6 rD �excr r r r� � s
�
zWarningIsErrorFilter.filterr� r� r r rE r r� � r� r� c @ r� )r� z6Disable WarningIsErrorFilter if this filter installed.rd r. c C s
d|_ dS )NT)r� rf r r r r� � s z"DisableWarningIsErrorFilter.filterNr� r r r r r� � r� r� c s> e Zd ZdZdeddf� fdd� Zdejdefdd �Z � Z
S )
r� z"Prepend prefix to all log records.rB r. Nc r� r )rB rA rs )rC rB rE r r rs � r� z MessagePrefixFilter.__init__rd c C s | j r | j d |j |_dS )N� T)rB r8 rf r r r r� � s zMessagePrefixFilter.filter� rG rH rI rJ rL rs r rh rz r� rM r r rE r r� � s r� c s@ e Zd ZdZd deddf� fdd�
Zdejdefd d
�Z � Z
S ) �
OnceFilterzShow the message only once.r@ r- r. Nc s t � �|� i | _d S r )rA rs �messages)rC r- rE r r rs � s
zOnceFilter.__init__rd c C sB t |dd�}|s
dS | j�|jg �}|j|v rdS |�|j� dS )NrW r@ TF)r: r� r_ r8 r9 r )rC rd rW �paramsr r r r� � s
zOnceFilter.filter)r@ r� r r rE r r� � s r� c sD e Zd ZU dZeej ed< d � fdd� Zd e de
fd
d �Z � Z S )
�SphinxLogRecordTranslatorz�Converts a log record to one Sphinx expects
* Make a instance of SphinxLogRecord
* docname to path if location given
�LogRecordClassr� r r. Nc r� r r� r� rE r r rs � r� z"SphinxLogRecordTranslator.__init__rd c C s� t |tj�r
| j|_t|dd �}t |t�r>|\}}|r+|r+d| jj� |�|f |_
dS |r9d| jj� |� |_
dS d |_
dS t |t j �rKt
|�|_
dS |r[d|vr[d| jj� |� |_
dS )Nr6 �%s:%sz%sr� T)r; r rh r� rF r: �tupler� �env�doc2pathr6 r r r< )rC rd r6 �docname�linenor r r r� � s&
�� �
�z SphinxLogRecordTranslator.filterr� )
rG rH rI rJ r r rh rK rs rR rz r� rM r r rE r r� � s
r� c @ � e Zd ZdZeZdS )�InfoLogRecordTranslatorz/LogRecordTranslator for INFO level log records.N)rG rH rI rJ rO r� r r r r r� � rQ r� c @ r� )�WarningLogRecordTranslatorz2LogRecordTranslator for WARNING level log records.N)rG rH rI rJ rR r� r r r r r� rQ r� �nodec C s< t | �\}}|r|rd||f S |rd| S |r d| S d S )Nr� z%s:z <unknown>:%sr )r� �source�liner r r r< s r< c s( e Zd Zdejdef� fdd� Z� ZS )�ColorizeFormatterrd r. c s> t � �|�}t|dd �}|d u rt�|j�}|r t||�S |S )NrV )rA �formatr: � COLOR_MAP�getr\ r )rC rd rD rV rE r r r� s
zColorizeFormatter.format)rG rH rI r rh rL r� rM r r rE r r� s r� c @ s> e Zd ZdZdeddfdd�Zdeddfdd �Zd d
d �ZdS )
�SafeEncodingWriterz7Stream writer which ignores UnicodeEncodeError silently�streamr. Nc C s || _ t|dd�p
d| _d S )N�encoding�ascii)r� r: r� )rC r� r r r rs # s zSafeEncodingWriter.__init__�datac C sF z | j �|� W d S ty" | j �|�| jd��| j�� Y d S w )N�replace)r� �write�UnicodeEncodeError�encoder� �decode�rC r� r r r r� ' s
$�zSafeEncodingWriter.writec C s t | jd�r
| j�� d S d S )Nrv )�hasattrr� rv rt r r r rv / s �zSafeEncodingWriter.flushry ) rG rH rI rJ r rs rL r� rv r r r r r� ! s
r� c @ s8 e Zd ZdZdddeddfdd�Zd eddfd
d �ZdS ) �LastMessagesWriterzBStream writer storing last 10 messages in memory to save trackbackr� r r� r. Nc C s
|| _ d S r )r� )rC r� r� r r r rs 6 r� zLastMessagesWriter.__init__r� c C s | j j�|� d S r )r� �
messagelogr r� r r r r� 9 s zLastMessagesWriter.write)rG rH rI rJ r rs rL r� r r r r r� 4 s r� r� r �status�warningc C s0 t �t�}|�t j� d|_|jdd� D ]}|�|� qtt |��}|�
t � � |�
t | �� |�t
| j � |�t� � tt |��}|�
t| �� |�
t| �� |�
t| �� |�
t� � |�t j� |�t� � t �t| |��}|�
t � � |�t
| j � |�t� � |�|� |�|� |�|� dS )z Setup root logger for SphinxFN)r r1 r2 r| r# � propagater} r~ rj r� r� r� r� r& � verbosity� setFormatterr� ri r� r� r� r� r �
StreamHandlerr� r� )r� r� r� r4 r� � info_handlerr� �messagelog_handlerr r r �setup= s0
r� )T)SrJ r �logging.handlers� collectionsr �
contextlibr �typingr r r r r r r
r r r
�docutilsr �docutils.nodesr �docutils.utilsr �
sphinx.errorsr �sphinx.util.consoler �sphinx.applicationr r2 r" r rL rZ rK �updater r r r! r# r& r� r1 rh r> r? rO rR �
LoggerAdapterr/ r� ri rj r} �BufferingHandlerrp �Handlerr� r� r� rz r� r� r� �Filterr� r� r� r� r� r� r� r� r� r� r< � Formatterr� r� r� r� r r r r �<module> s�
0 �
��� -
"