qҶdX d Z ddlZddlZddlZddlmZ ddlmZ ddlmZ ddlmZ ddl m
Z
ddl m Z dd l
mZ G d
d ZdS ) z8The base class and interface for all formatting plugins. N)IO)List)Optional)Tuple)_windows_color)
Statistics) Violationc e Zd ZdZdej ddfdZddZdeddfdZ deddfd Z
dd
Z d d
Z d d de
e fdZd dZdeeeef ddfdZd d de
e fdZdeddfdZde
e de
e ddfdZddZdS )
BaseFormattera" Class defining the formatter interface.
.. attribute:: options
The options parsed from both configuration files and the command-line.
.. attribute:: filename
If specified by the user, the path to store the results of the run.
.. attribute:: output_fd
Initialized when the :meth:`start` is called. This will be a file
object opened for writing.
.. attribute:: newline
The string to add to the end of a line. This is only used when the
output filename has been specified.
optionsreturnNc || _ |j | _ d| _ d| _ |j dk p4|j dk o)t j o t j
| _ | dS )aM Initialize with the options parsed from config and cli.
This also calls a hook, :meth:`after_init`, so subclasses do not need
to call super to call this method.
:param options:
User specified configuration parsed from both configuration files
and the command-line interface.
N
alwaysauto) r output_filefilename output_fdnewlinecolorsysstdoutisattyr terminal_supports_color
after_init)selfr s h/builddir/build/BUILD/cloudlinux-venv-1.0.10/venv/lib/python3.11/site-packages/flake8/formatting/base.py__init__zBaseFormatter.__init__% s| +
,0 ]h.
MV #
7
!!##
7 6
c dS )z!Initialize the formatter further.N r s r r zBaseFormatter.after_init: r r c dS )zNotify the formatter that we're starting to process a file.
:param filename:
The name of the file that Flake8 is beginning to report results
from.
Nr! r r s r beginningzBaseFormatter.beginning= r# r c dS )zNotify the formatter that we've finished processing a file.
:param filename:
The name of the file that Flake8 has finished reporting results
from.
Nr! r% s r finishedzBaseFormatter.finishedE r# r c | j rst j t j | j }t j |d t
| j d | _ dS dS )z}Prepare the formatter to receive input.
This defaults to initializing :attr:`output_fd` if :attr:`filename`
T)exist_okaN)r ospathdirnameabspathmakedirsopenr )r r. s r startzBaseFormatter.startM sg
= 6goobgoodm&D&DEEG K$ / / / / !$- 5 5DNNN 6 6r errorr c | | }| | }| || dS )aD Handle an error reported by Flake8.
This defaults to calling :meth:`format`, :meth:`show_source`, and
then :meth:`write`. To extend how errors are handled, override this
method.
:param error:
This will be an instance of
:class:`~flake8.violation.Violation`.
N)format show_sourcewrite)r r3 linesources r handlezBaseFormatter.handleW sB {{5!!!!%((
4 r c t d )a Format an error reported by Flake8.
This method **must** be implemented by subclasses.
:param error:
This will be an instance of
:class:`~flake8.violation.Violation`.
:returns:
The formatted error string.
z3Subclass of BaseFormatter did not implement format.)NotImplementedError)r r3 s r r5 zBaseFormatter.formatf s " D
r
statisticsr c | D ]l}| | }t | }|j }|t d |D z
}| |dd| d|j mdS )z Format and print the statistics.c 3 $ K | ] }|j V d S )N)count).0stats r z0BaseFormatter.show_statistics..{ s$ EEEEEEEEr z<5 N) error_codesstatistics_fornextr@ sum_writemessage)r r=
error_codestats_for_error_code statisticr@ s r show_statisticsz BaseFormatter.show_statisticsu s $0022 H HJ#-#<#. sG
%AA#
r ^)r r6
physical_linejoin
column_number)r r3 indents r r6 zBaseFormatter.show_source s~ |' 5+>+F2
()B5+>+B)BC
%0v0000r outputc " | j "| j || j z | j | j j rRt
j j | | j z dS dS )z9Handle logic of whether to use an output file or print().N) r r7 r r teer r bufferencode)r rc s r rI zBaseFormatter._write s{ > % N $,!6 7 7 7 > !T\%5 ! J # #FMMOOdl6I6I6K6K$K L L L L L " !r r8 r9 c f |r| | |r| | dS dS )a Write the line either to the output file or stdout.
This handles deciding whether to write to a file or print to standard
out for subclasses. Override this if you want behaviour that differs
from the default.
:param line:
The formatted string to print or write.
:param source:
The source code that has been formatted and associated with the
line of output.
N)rI )r r8 r9 s r r7 zBaseFormatter.write sH KK KK r c X | j "| j d| _ dS dS )z%Clean up after reporting is finished.N)r closer" s r stopzBaseFormatter.stop s1 > % N " " " !DNNN & %r )r
N)r3 r r
N)r= r r
N)__name__
__module__ __qualname____doc__argparse Namespacer r strr& r( r2 r: r r5 rN r r floatrW r6 rI r7 rk r! r r r r s * 2 t *0 0 0 0 # $ 6 6 6 6
!
!
!
!
K
HSM
H H H H#$uS%Z/@*A #d # # # #*1 1# 1 1 1 16MS MT M M M M (3- # 4 $" " " " " "r r )ro rp r, r typingr r r r flake8.formattingr flake8.statisticsr flake8.violationr r r! r r rx s > >
, , , , , , ( ( ( ( ( ( & & & & & &|" |" |" |" |" |" |" |" |" |"r