3
T'ícUG ã @ 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 rªdd l m Z d Z d
Z edd Z e e!e"f e j#ej$ej$ej%ej&ej'e ej(d edd Z)e e"e"f )e)j#ej'e ej(d edd ej%dej&dej(diZ*e!ddddZ+e
ej, ddd d Z-G d d d ej,Z.G d d! d!e.Z/G d"d# d#e.Z0G d$d dej1Z2G d%d& d&ej3Z4G d'd( d(ej3Z5G d)d* d*ej6j7Z8ee ej9ddf d+d,d-Z:ee e8ddf d+d.d/Z;ee e8ddf d+d0d1Z<ed]e=e d^ d3d4d5Z>ee!e d_ d6d7d8Z?G d9d: d:Z@G d;d< d<ejAZBe!e!e
e! e=d=d>d?ZCG d@dA dAejAZDG dBdC dCejAZEG dDdE dEejAZFG dFdG dGejAZGG dHdI dIejAZHG dJdK dKejAZIG dLdM dMeIZJG dNdO dOeIZKeee! dPdQdRZLG dSdT dTejMZNG dUdV dVZOG dWdX dXZPdYeeddZd[d\ZQdS )`z%Logging utility functions for Sphinx.é N)Ú defaultdict)Úcontextmanager)
ÚIOÚ
TYPE_CHECKINGÚAnyÚDictÚ GeneratorÚListÚOptionalÚTupleÚTypeÚUnion)Únodes)ÚNode)Úget_source_line)Ú
SphinxWarning)Úcolorize)ÚSphinxZsphinxé c C s t jS )N)ÚloggingÚWARNING© r r ú5/tmp/pip-build-gk9425m9/sphinx/sphinx/util/logging.pyÚ<lambda> s r )ÚCRITICALZSEVEREÚERRORr ÚINFOÚVERBOSEÚDEBUGc C s dS )Nr r r r r r r " s )r é é c C s dS )NZbluer r r r r r ) s ZdarkredZredZdarkgrayÚSphinxLoggerAdapter)ÚnameÚreturnc C s" t jtd | }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 r% 1 s r% )Úrecordsr# c C sD x>| D ]6}|j |_f |_t|dd}t|tjrt||_qW dS )z Convert LogRecord serializable.ÚlocationN) Ú
getMessageÚmsgÚargsÚgetattrÚ
isinstancer r Úget_node_locationr* )r) Úrr* r r r Úconvert_serializableG s
r2 c s4 e Zd ZU dZdZdZeed fdd Z Z S )ÚSphinxLogRecordz$Log record class supporting locationÚ N)r# c sD t j }t| dd }|r,d|| j|f }n| j|kr@| j| }|S )Nr* z%s: %s%s)Úsuperr+ r. Úprefix)ÚselfÚmessager* )Ú __class__r r r+ X s
zSphinxLogRecord.getMessage)
Ú__name__Ú
__module__Ú __qualname__Ú__doc__r6 r* r Ústrr+ Ú
__classcell__r r )r9 r r3 S s
r3 c @ s e Zd ZdZdZdS )ÚSphinxInfoLogRecordz)Info log record class supporting locationr4 N)r: r; r< r= r6 r r r r r@ c s r@ c @ s" e Zd ZdZeedddZdS )ÚSphinxWarningLogRecordz,Warning log record class supporting location)r# c C s( | j tjkrdS | j tjkr dS dS d S )Nz
CRITICAL: zERROR: z WARNING: )Úlevelnor r r )r7 r r r r6 j s
z SphinxWarningLogRecord.prefixN)r: r; r< r= Úpropertyr> r6 r r r r rA h s rA c s e Zd ZdZddddddgZeeef eeedd fd
d Z eeedd d
dZ
ee e ee f dddZ
ejddddZ ZS )r! z9LoggerAdapter allowing ``type`` and ``subtype`` keywords.ÚtypeÚsubtyper* ÚnonlÚcolorÚonceN)Úlevelr, r- Úkwargsr# c sD t |tr"t j||f|| n t| }t j||f|| d S )N)r/ Úintr5 ÚlogÚ LEVEL_NAMES)r7 rI r, r- rJ rB )r9 r r rL x s
zSphinxLoggerAdapter.log)r, r- rJ r# c O s | j t|f|| d S )N)rL r )r7 r, r- rJ r r r Úverbose s zSphinxLoggerAdapter.verbose)r, rJ r# c C s: |j di }x$| jD ]}||kr|j|||< qW ||fS )NÚextra)Ú
setdefaultÚKEYWORDSÚpop)r7 r, rJ rO Úkeywordr r r Úprocess s
zSphinxLoggerAdapter.process)Úrecordr# c C s | j j| d S )N)r( Úhandle)r7 rU r r r rV s zSphinxLoggerAdapter.handle)r: r; r< r= rQ r
rK r> r rL rN r r rT r Ú LogRecordrV r? r r )r9 r r! t s "c @ s e Zd ZdZdS )ÚWarningStreamHandlerzStreamHandler for warnings.N)r: r; r< r= r r r r rX s rX c s* e Zd ZdZejdd fdd Z ZS )ÚNewLineStreamHandlerzAStreamHandler which switches line terminator by record.nonl flag.N)rU r# c s@ z*| j t|ddr d| _t j| W d d| _| j X d S )NrF Fr4 Ú
)Úacquirer. Ú
terminatorr5 ÚemitÚrelease)r7 rU )r9 r r r] s zNewLineStreamHandler.emit)r: r; r< r= r rW r] r? r r )r9 r rY s rY c sx e Zd ZU dZeej dd fdd Zeje dddZ
ddd d
Z ej dd d d
Z
eej dddZ ZS )Ú
MemoryHandlerzHandler buffering all logs.N)r# c s t jd d S )Nr éÿÿÿÿ)r5 Ú__init__)r7 )r9 r r ra § s zMemoryHandler.__init__)rU r# c C s dS )NFr )r7 rU r r r Ú shouldFlushª s zMemoryHandler.shouldFlushc C s d S )Nr )r7 r r r Úflush s zMemoryHandler.flush)r( r# c
C s< | j z$x| jD ]}|j| qW g | _W d | j X d S )N)r[ ÚbufferrV r^ )r7 r( rU r r r ÚflushTo² s
zMemoryHandler.flushToc C s | j g }| _ |S )N)rd )r7 rd r r r Úclear» s zMemoryHandler.clear)r: r; r< r= r r rW rd ra Úboolrb rc ÚLoggerre rf r? r r )r9 r r_ ¢ s
r_ )r# c c s t jt} t }|jt j zNg }x4| jdd
D ]"}t|tr2| j | |j
| q2W | j | |V W d| j | x|D ]}| j | q|W |j | X dS )zgContext manager to postpone logging warnings temporarily.
Similar to :func:`pending_logging`.
N)
r r% r& r_ ÚsetLevelr Úhandlersr/ rX Ú
removeHandlerÚappendÚ
addHandlerre )r( Ú
memhandlerrj Úhandlerr r r Úpending_warningsÀ s
rp c c s~ t jt} t }zDg }x*| jdd
D ]}| j| |j| q&W | j| |V W d| j| x|D ]}| j| qfW X dS )zèContext manager to suppress logging all logs temporarily.
For example::
>>> with suppress_logging():
>>> logger.warning('Warning message!') # suppressed
>>> some_long_process()
>>>
N)r r% r& r_ rj rk rl rm )r( rn rj ro r r r Úsuppress_loggingÜ s
rq c c s8 t jt} z t }|V W dQ R X W d|j| X dS )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 r% r& rq re )r( rn r r r Úpending_loggingù s
rr T)Úskipr# c c sj t jt}| dkrdV nLz.t }x |jD ]}|jjd| q*W dV W dx|jD ]}|j| qRW X dS )z9Context manager to skip WarningIsErrorFilter temporarily.FNr )r r% r& ÚDisableWarningIsErrorFilterrj ÚfiltersÚinsertÚ removeFilter)rs r( Zdisablerro r r r Úskip_warningiserror
s
rx )r6 r# c c s° t jt}d}x(|jD ]}t|tr|}P qW dV dS d}x |jD ]}t|trD|}P qDW |rz|j}| |_dV W d||_X n*t| }z|j | dV W d|j
| X dS )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 r% r& rj r/ rX ru ÚMessagePrefixFilterr6 Ú addFilterrw )r6 r( Úwarning_handlerro Z
prefix_filterZ_filterÚpreviousr r r Úprefixed_warnings! s0
r} c @ s0 e Zd ZddddZeed dddZdS )Ú LogCollectorN)r# c C s
g | _ d S )N)Úlogs)r7 r r r ra P s zLogCollector.__init__c c s& t }d V |j | _W d Q R X d S )N)rr rf r )r7 rn r r r ÚcollectS s zLogCollector.collect)NNN)r: r; r< ra r r r r r r r r~ O s r~ c @ s" e Zd ZdZejedddZdS )Ú
InfoFilterz"Filter error and warning messages.)rU r# c C s |j tjk rdS dS d S )NTF)rB r r )r7 rU r r r Úfilter^ s zInfoFilter.filterN)r: r; r< r= r rW rg r r r r r r [ s r )rD rE Úsuppress_warningsr# c C s\ | dkr dS xJ|D ]B}d|kr0|j dd\}}n
|d }}|| kr|d|dfkrdS qW dS )z/Check whether the warning is suppressed or not.NFr$ r Ú*T)Úsplit)rD rE r Z warning_typeÚtargetZ subtargetr r r Úis_suppressed_warninge s
r c s: e Zd ZdZddd fdd Zejeddd Z Z S )
ÚWarningSuppressorz#Filter logs by `suppress_warnings`.r N)Úappr# c s || _ t j d S )N)r r5 ra )r7 r )r9 r r ra { s zWarningSuppressor.__init__)rU r# c C sh t |dd }t |dd }y| jjj}W n tk
r> g }Y nX t|||rPdS | j jd7 _dS d S )NrD rE Fr T)r. r Úconfigr ÚAttributeErrorr Z
_warncount)r7 rU rD rE r r r r r s
zWarningSuppressor.filter)
r: r; r< r= ra r rW rg r r? r r )r9 r r x s r c s: e Zd ZdZddd fdd Zejeddd Z Z S )
ÚWarningIsErrorFilterz#Raise exception if warning emitted.r N)r r# c s || _ t j d S )N)r r5 ra )r7 r )r9 r r ra s z WarningIsErrorFilter.__init__)rU r# c C s t |ddrdS | jjrt |dd}y|j|j }W n ttfk
rR |j}Y nX |rnt|d t| }nt|}|j d k r||j d q|ndS d S )NÚskip_warningsiserrorFTr* r4 ú:r )
r. r Zwarningiserrorr, r- Ú TypeErrorÚ
ValueErrorr r> Úexc_info)r7 rU r* r8 Úexcr r r r s
zWarningIsErrorFilter.filter)
r: r; r< r= ra r rW rg r r? r r )r9 r r s r c @ s" e Zd ZdZejedddZdS )rt z6Disable WarningIsErrorFilter if this filter installed.)rU r# c C s
d|_ dS )NT)r )r7 rU r r r r ± s z"DisableWarningIsErrorFilter.filterN)r: r; r< r= r rW rg r r r r r rt ® s rt c s: e Zd ZdZedd fdd ZejedddZ Z
S ) ry z"Prepend prefix to all log records.N)r6 r# c s || _ t j d S )N)r6 r5 ra )r7 r6 )r9 r r ra ¹ s z MessagePrefixFilter.__init__)rU r# c C s | j r| j d |j |_dS )Nú T)r6 r, )r7 rU r r r r ½ s zMessagePrefixFilter.filter) r: r; r< r= r> ra r rW rg r r? r r )r9 r ry ¶ s ry c s< e Zd ZdZd
edd fdd
Zejeddd Z Z
S ) Ú
OnceFilterzShow the message only once.r4 N)r" r# c s t j| i | _d S )N)r5 ra Úmessages)r7 r" )r9 r r ra Æ s zOnceFilter.__init__)rU r# c C sF t |dd}|sdS | jj|jg }|j|kr2dS |j|j dS d S )NrH r4 TF)r. r rP r, r- rl )r7 rU rH Úparamsr r r r Ê s
zOnceFilter.filter)r4 ) r: r; r< r= r> ra r rW rg r r? r r )r9 r r às r c sD e Zd ZU dZeej ddd fdd Ze e
ddd Z Z S )
ÚSphinxLogRecordTranslatorzConverts a log record to one Sphinx expects
* Make a instance of SphinxLogRecord
* docname to path if location given
r N)r r# c s || _ t j d S )N)r r5 ra )r7 r )r9 r r ra ß s z"SphinxLogRecordTranslator.__init__)rU r# c C s² t |tjr| j|_t|dd }t |trv|\}}|rT|rTd| jjj ||f |_
q®|rnd| jjj | |_
q®d |_
n8t |t j rt
||_
n |r®d|kr®d| jjj | |_
dS )Nr* z%s:%sz%sr T)r/ r rW ÚLogRecordClassr9 r. Útupler ÚenvZdoc2pathr* r r r0 )r7 rU r* ZdocnameÚlinenor r r r ã s
z SphinxLogRecordTranslator.filter)
r: r; r< r= r r rW r ra rA rg r r? r r )r9 r r × s
r c @ s e Zd ZdZeZdS )ÚInfoLogRecordTranslatorz/LogRecordTranslator for INFO level log records.N)r: r; r< r= r@ r r r r r r ù s r c @ s e Zd ZdZeZdS )ÚWarningLogRecordTranslatorz2LogRecordTranslator for WARNING level log records.N)r: r; r< r= rA r r r r r r þ s r )Únoder# c C s@ t | \}}|r |r d||f S |r,d| S |r8d| S d S d S )Nz%s:%sz%s:z <unknown>:%s)r )r ÚsourceÚliner r r r0 s r0 c s& e Zd Zejed fdd Z ZS )ÚColorizeFormatter)rU r# c sB t j|}t|dd }|d kr,tj|j}|r:t||S |S d S )NrG )r5 Úformatr. Ú COLOR_MAPÚgetrB r )r7 rU r8 rG )r9 r r r¢ s
zColorizeFormatter.format)r: r; r< r rW r> r¢ r? r r )r9 r r¡ s r¡ c @ s> e Zd ZdZeddddZeddddZdd d
d ZdS ) ÚSafeEncodingWriterz7Stream writer which ignores UnicodeEncodeError silentlyN)Ústreamr# c C s || _ t|ddpd| _d S )NÚencodingÚascii)r¦ r. r§ )r7 r¦ r r r ra s zSafeEncodingWriter.__init__)Údatar# c C sH y| j j| W n2 tk
rB | j j|j| jdj| j Y nX d S )NÚreplace)r¦ ÚwriteÚUnicodeEncodeErrorÚencoder§ Údecode)r7 r© r r r r« " s zSafeEncodingWriter.write)r# c C s t | jdr| jj d S )Nrc )Úhasattrr¦ rc )r7 r r r rc * s zSafeEncodingWriter.flush) r: r; r< r= r ra r> r« rc r r r r r¥ s r¥ c @ s2 e Zd ZdZdeddddZedddd ZdS )
ÚLastMessagesWriterzBStream writer storing last 10 messages in memory to save trackbackr N)r r¦ r# c C s
|| _ d S )N)r )r7 r r¦ r r r ra 1 s zLastMessagesWriter.__init__)r© r# c C s | j jj| d S )N)r Z
messagelogrl )r7 r© r r r r« 4 s zLastMessagesWriter.write)r: r; r< r= r ra r> r« r r r r r° / s r° r )r ÚstatusÚwarningr# c C s4 t jt}|jt j d|_x |jdd
D ]}|j| q,W tt |}|j
t |j
t | |jt
| j |jt tt |}|j
t| |j
t| |j
t| |j
t |jt j |jt t jt| |}|j
t |jt
| j |jt |j| |j| |j| dS )z Setup root logger for SphinxFN)r r% r& ri r Ú propagaterj rk rY r¥ rz r r Ú
VERBOSITY_MAPÚ verbosityÚ setFormatterr¡ rX r r r r r Ú
StreamHandlerr° rm )r r± r² r( ro Z info_handlerr{ Zmessagelog_handlerr r r Úsetup8 s0
r¸ )T)NNN)NNN)Rr= r Úlogging.handlersÚ collectionsr Ú
contextlibr Útypingr r r r r r r
r r r
Zdocutilsr Zdocutils.nodesr Zdocutils.utilsr Z
sphinx.errorsr Zsphinx.util.consoler Zsphinx.applicationr r& r rM r> rK Úupdater r r r r r´ r£ r% rW r2 r3 r@ rA Ú
LoggerAdapterr! r· rX rY rj ÚBufferingHandlerr_ ÚHandlerrp rq rr rg rx r} r~ ÚFilterr r r r rt ry r r r r r0 Ú Formatterr¡ r¥ r° r¸ r r r r Ú<module> s 0 -
"