2 d dl mZ d dlmZ d dlmZmZmZmZm Z m
Z
m Z d dl Z d dlZd dl
Z
d dlmZ ddlmZmZ ddlmZ G d d
ej Z G d d e Zd
efdZdS ) ) defaultdict) LogRecord)ListUnionTupleSequenceCallableAnyOptionalN)pformat )SequenceComparisoncompare)wrapc e Zd ZU dZee ed< ee ed< e Z
dZ dZ e
j Z d&d eeee f d
ed ed ed
eee eegef f dedefdZed Zd Zd Zd Z d Z d Z d'd efdZ de
j fdZ d Z!d Z"ed Z#d Z$d efd Z%d Z&d Z'dd!d"efd#Z(d$ Z)d% Z*dS )(
LogCapturea
These are used to capture entries logged to the Python logging
framework and make assertions about what was logged.
:param names: A string (or tuple of strings) containing the dotted name(s)
of loggers to capture. By default, the root logger is
captured.
:param install: If `True`, the :class:`LogCapture` will be
installed as part of its instantiation.
:param propagate: If specified, any captured loggers will have their
`propagate` attribute set to the supplied value. This can
be used to prevent propagation from a child logger to a
parent logger that has configured handlers.
:param attributes:
The sequence of attribute names to return for each record or a callable
that extracts a row from a record.
If a sequence of attribute names, those attributes will be taken from the
:class:`~logging.LogRecord`. If an attribute is callable, the value
used will be the result of calling it. If an attribute is missing,
``None`` will be used in its place.
If a callable, it will be called with the :class:`~logging.LogRecord`
and the value returned will be used as the row.
:param recursive_check:
If ``True``, log messages will be compared recursively by
:meth:`LogCapture.check`.
:param ensure_checks_above:
The log level above which checks must be made for logged events.
See :meth:`ensure_checked`.
recordsensure_checks_aboveFNTr
name levelname
getMessagenamesinstalllevel propagate
attributesrecursive_checkc p t j | t |t s|f}|| _ || _ || _ || _ || _ t t | _ |
| j
| _ n|| _ | |r| d S d S N)loggingHandler__init__
isinstancetupler r r r r r dictolddefault_ensure_checks_abover clearr )selfr r r r r r r s i/builddir/build/BUILD/cloudlinux-venv-1.0.10/venv/lib/python3.11/site-packages/testfixtures/logcapture.pyr# zLogCapture.__init__A s &&&%'' IE
"$ . t$$ &'+'GD $ $':D $
LLNNNNN c | j r;t j dd d | j D z d S d S )NzFLogCapture instances not uninstalled by shutdown, loggers captured:
%s
c 3 > K | ]}t |j V d S r )strr ).0is r+ z$LogCapture.atexit..d s* "G"GA3qw<<"G"G"G"G"G"Gr, ) instanceswarningswarnjoin)clss r+ atexitzLogCapture.atexit^ s_ = M "G"G "G"G"GHHJ
r, c * t | j S r )lenr r* s r+ __len__zLogCapture.__len__g s 4< r, c B | | j | S r ) _actual_rowr )r* indexs r+ __getitem__zLogCapture.__getitem__j s U 3444r, c f t | D ] \ }}||k rd| j | _ dS !d S )NT) enumerater checked)r* whatr2 items r+ __contains__zLogCapture.__contains__m sH GAtt||*. Q'tt r, c g | _ dS )z*Clear any entries that have been captured.N)r r< s r+ r) zLogCapture.clears s
r, c ( | j D ] }d|_
dS )z
Mark all captured events as checked.
This should be called if you have made assertions about logging
other than through :class:`LogCapture` methods.
TN)r rD r* records r+ mark_all_checkedzLogCapture.mark_all_checkedw s( l " "F !FNN " "r, c
|| j }|t j k rdS g }| j D ]<}|j |k r/|j s(| | | =|r t dt | z dS )z
Ensure every entry logged above the specified `level` has been checked.
Raises an :class:`AssertionError` if this is not the case.
:param level: the logging level, defaults to :attr:`ensure_checks_above`.
Nz Not asserted ERROR log(s): %s)
r r! NOTSETr levelnorD appendr? AssertionErrorr )r* r
un_checkedrK s r+ ensure_checkedzLogCapture.ensure_checked s =,E GN " " F
l < 4 ~* / ODK ( ( (*.DN ' ' ' / /r, c | | j v r| j D ]}t j | }| | j d | | j d | |_ | j d | |_ | j d | |_ | j d | |_ | j
| dS dS )a&
Un-install this :class:`LogCapture` from the Python logging
framework for the named loggers.
This will re-instate any existing handlers for those loggers
that were removed during installation and restore their level
that prior to installation.
rW rX rY rZ r N) r4 r r! r[ r\ r' rX rY rZ r removera s r+ uninstallzLogCapture.uninstall s 4> ! !
?
? *400 24 8999!%)!4T!:"&(:"6t"<"&(:"6t"<#'8K#8#> N ! !$ ' ' ' ' ' " !r, c \ t | j D ]}| dS )z=This will uninstall all existing :class:`LogCapture` objects.N)r% r4 re )r8 r2 s r+
uninstall_allzLogCapture.uninstall_all s6 s}%% A
KKMMMM r, c > t | j r| | S g }| j D ]A}t ||d }t | r
| }| | Bt | dk r|d S t | S )Nr
r )callabler getattrrP r; r% )r* rK valuesavalues r+ r? zLogCapture._actual_row s DO $ $ %??6** *F_
%
% 400E?? $ !EGGE
e$$$$6{{a ay V}}$r, returnc n g }| j D ]*}| | | +|S )a
The sequence of actual records logged, having had their attributes
extracted as specified by the ``attributes`` parameter to the
:class:`LogCapture` constructor.
This can be useful for making more complex assertions about logged
records. The actual records logged can also be inspected by using the
:attr:`records` attribute.
)r rP r? )r* actualrs r+ rp zLogCapture.actual sB / /A MM$**1-- . . . .
r, c v | j sdS d d | D S )NzNo logging capturedr. c g | ]}d |z S )z
%s %s
%s )r1 rq s r+
z&LogCapture.__str__.. s CCC-!+CCCr, )r r7 rp r< s r+ __str__zLogCapture.__str__ s; | )((yyCCT[[]]CCCDDDr, c t || | j | dS )a7
This will compare the captured entries with the expected
entries provided and raise an :class:`AssertionError` if they
do not match.
:param expected:
A sequence of entries of the structure specified by the ``attributes``
passed to the constructor.
)rp recursiveN)r rp r rL )r* expecteds r+ checkzLogCapture.check sI ;;==*
r, )
order_mattersr{ c | }t ||d| j d}||k rt |j |j D ]}d| j | _ dS )as
This will check if the captured entries contain all of the expected
entries provided and raise an :class:`AssertionError` if not.
This will ignore entries that have been captured but that do not
match those in ``expected``.
:param expected:
A sequence of entries of the structure specified by the ``attributes``
passed to the constructor.
:param order_matters:
A keyword-only parameter that controls whether the order of the
captured entries is required to match those of the expected entries.
Defaults to ``True``.
T)orderedpartialrx N)rp r r rQ failedchecked_indicesr rD )r* r{ ry rp r@ s r+
check_presentzLogCapture.check_present s| $ %
}ddFZ
v 11 1 - / /E*.DL ' ' / /r, c | S r rt r< s r+ __enter__zLogCapture.__enter__" s r, c V | | d S r )re rS )r* typerm tracebacks r+ __exit__zLogCapture.__exit__% s* r, )NTr
Nr FNr )+__name__
__module__ __qualname____doc__r r __annotations__r intsetr4 r_ installedr! rN r( r r0 r boolr r r
r# classmethodr9 r= rA rG r) rL rS rU r re rg r? rp rv rz r r r rt r, r+ r r
sq ' 'T )_ !# &&&ILI"). -1 "L %*'+ eCj )
hsmXyk36F-G GH
" "% : [! ! !5 5 5 " " "+ +C + + + +($7, $ $ $ $/ / /6( ( (& [
% % %$
E E E
$ >B / / /d / / / /6 r, r c e Zd Zd ZdS )LogCaptureForDecoratorc b t | | | S r )r r r) r< s r+ r z LogCaptureForDecorator.install, s( 4
r, N)r r r r rt r, r+ r r * s# r, r r c X t | pdfddi|}t |j |j S )a
A decorator for making a :class:`LogCapture` installed and
available for the duration of a test function.
:param names: An optional sequence of names specifying the loggers
to be captured. If not specified, the root logger
will be captured.
Keyword parameters other than ``install`` may also be supplied and will be
passed on to the :class:`LogCapture` constructor.
Nr F)r r r re )r kwls r+ log_capturer 2 s6 u}BBeBrBBA 1; ' ''r, ) collectionsr r! r typingr r r r r r
r r9 r5 pprintr
comparisonr r utilsr r" r r r0 r rt r, r+ r s: # # # # # # H H H H H H H H H H H H H H H H H H
3 3 3 3 3 3 3 3 Z Z Z Z Z Z Z Z z Z
(
(
(
(
(
(
(r,