o h@sjdZddlmZddlZddlZddlZddlmZddlm Z ddl m Z ddl m Z Gdd d ZdS) z8The base class and interface for all formatting plugins.) annotationsN)IO)_windows_color) Statistics) Violationc@seZdZdZd-ddZd.dd Zd/d d Zd/ddZd.ddZd0ddZ d1ddZ d2ddZ d3dd Z d1d!d"Z d4d$d%Zd5d(d)Zd.d*d+Zd,S)6 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. optionsargparse.NamespacereturnNonecCsL||_|j|_d|_d|_|jdkp|jdkotjot j |_| dS)aMInitialize 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_fdnewlinecolorsysstdoutisattyrterminal_supports_color after_init)selfrrL/var/www/html/ai/venv/lib/python3.10/site-packages/flake8/formatting/base.py__init__$s    zBaseFormatter.__init__cCdS)z!Initialize the formatter further.Nrrrrrr9zBaseFormatter.after_initrstrcCr)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. Nrrrrrr beginning<rzBaseFormatter.beginningcCr)zNotify the formatter that we've finished processing a file. :param filename: The name of the file that Flake8 has finished reporting results from. Nrr!rrrfinishedDrzBaseFormatter.finishedcCs@|jrtjtj|j}tj|ddt|jd|_dSdS)z}Prepare the formatter to receive input. This defaults to initializing :attr:`output_fd` if :attr:`filename` T)exist_okaN)rospathdirnameabspathmakedirsopenr)rr(rrrstartLs zBaseFormatter.starterrorrcCs$||}||}|||dS)aDHandle 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)rr-linesourcerrrhandleVs zBaseFormatter.handle str | NonecCstd)aFormat 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)rr-rrrr.es zBaseFormatter.format statisticsrcCs^|D](}||}t|}|j}|tdd|D7}||dd|d|jqdS)z Format and print the statistics.css|]}|jVqdS)N)count).0statrrr zsz0BaseFormatter.show_statistics..z<5 N) error_codesstatistics_fornextr7sum_writemessage)rr6 error_codestats_for_error_code statisticr7rrrshow_statisticsts   zBaseFormatter.show_statistics benchmarkslist[tuple[str, float]]cCsLdj}dj}|D]\}}t|tr|||d}n|||d}||qdS)z Format and print the benchmarks.z{value:<10.3} {statistic}z{value:<10} {statistic})rDvalueN)r. isinstanceintr@)rrF float_format int_formatrDrH benchmarkrrrshow_benchmarks}s     zBaseFormatter.show_benchmarkscCsJ|jjr |jdur dSddd|jd|jdD}|j|dS)aShow the physical line generating the error. This also adds an indicator for the particular part of the line that is reported as generating the problem. :param error: This will be an instance of :class:`~flake8.violation.Violation`. :returns: The formatted error string if the user wants to show the source. If the user does not want to show the source, this will return ``None``. Ncss |] }|r |ndVqdS)r;N)isspace)r8crrrr:s  z,BaseFormatter.show_source..^)rr/ physical_linejoin column_number)rr-indentrrrr/s  zBaseFormatter.show_sourceoutputcCsR|jdur|j||j|jdus|jjr'tjj||jdSdS)z9Handle logic of whether to use an output file or print().N) rr0rrteerrbufferencode)rrXrrrr@s  zBaseFormatter._writer1r2cCs$|r|||r||dSdS)aWrite 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)r@)rr1r2rrrr0s  zBaseFormatter.writecCs"|jdur|jd|_dSdS)z%Clean up after reporting is finished.N)rcloserrrrstops   zBaseFormatter.stopN)rr r r )r r )rr r r )r-rr r )r-rr r4)r6rr r )rFrGr r )rXr r r )r1r4r2r4r r )__name__ __module__ __qualname____doc__rrr"r#r,r3r.rErNr/r@r0r]rrrrrs          r)ra __future__rargparser&rtypingrflake8.formattingrflake8.statisticsrflake8.violationrrrrrrs