mirror of
https://github.com/pre-commit/pre-commit-hooks.git
synced 2026-04-09 04:54:16 +00:00
[pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
This commit is contained in:
pre-commit-ci[bot]
parent
72ad6dc953
commit
f4cd1ba0d6
813 changed files with 66015 additions and 58839 deletions
|
|
@ -1,19 +1,21 @@
|
|||
# Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0
|
||||
# For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt
|
||||
|
||||
"""Summary reporting"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import sys
|
||||
from typing import Any
|
||||
from typing import IO
|
||||
from typing import Iterable
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
from typing import Any, IO, Iterable, TYPE_CHECKING
|
||||
|
||||
from coverage.exceptions import ConfigError, NoDataError
|
||||
from coverage.exceptions import ConfigError
|
||||
from coverage.exceptions import NoDataError
|
||||
from coverage.misc import human_sorted_items
|
||||
from coverage.plugin import FileReporter
|
||||
from coverage.report_core import get_analysis_to_report
|
||||
from coverage.results import Analysis, Numbers
|
||||
from coverage.results import Analysis
|
||||
from coverage.results import Numbers
|
||||
from coverage.types import TMorf
|
||||
|
||||
if TYPE_CHECKING:
|
||||
|
|
@ -28,9 +30,9 @@ class SummaryReporter:
|
|||
self.config = self.coverage.config
|
||||
self.branches = coverage.get_data().has_arcs()
|
||||
self.outfile: IO[str] | None = None
|
||||
self.output_format = self.config.format or "text"
|
||||
if self.output_format not in {"text", "markdown", "total"}:
|
||||
raise ConfigError(f"Unknown report format choice: {self.output_format!r}")
|
||||
self.output_format = self.config.format or 'text'
|
||||
if self.output_format not in {'text', 'markdown', 'total'}:
|
||||
raise ConfigError(f'Unknown report format choice: {self.output_format!r}')
|
||||
self.fr_analysis: list[tuple[FileReporter, Analysis]] = []
|
||||
self.skipped_count = 0
|
||||
self.empty_count = 0
|
||||
|
|
@ -40,11 +42,11 @@ class SummaryReporter:
|
|||
"""Write a line to the output, adding a newline."""
|
||||
assert self.outfile is not None
|
||||
self.outfile.write(line.rstrip())
|
||||
self.outfile.write("\n")
|
||||
self.outfile.write('\n')
|
||||
|
||||
def write_items(self, items: Iterable[str]) -> None:
|
||||
"""Write a list of strings, joined together."""
|
||||
self.write("".join(items))
|
||||
self.write(''.join(items))
|
||||
|
||||
def _report_text(
|
||||
self,
|
||||
|
|
@ -63,34 +65,36 @@ class SummaryReporter:
|
|||
"""
|
||||
# Prepare the formatting strings, header, and column sorting.
|
||||
max_name = max([len(line[0]) for line in lines_values] + [5]) + 1
|
||||
max_n = max(len(total_line[header.index("Cover")]) + 2, len(" Cover")) + 1
|
||||
max_n = max([max_n] + [len(line[header.index("Cover")]) + 2 for line in lines_values])
|
||||
max_n = max(len(total_line[header.index('Cover')]) + 2, len(' Cover')) + 1
|
||||
max_n = max([max_n] + [len(line[header.index('Cover')]) + 2 for line in lines_values])
|
||||
formats = dict(
|
||||
Name="{:{name_len}}",
|
||||
Stmts="{:>7}",
|
||||
Miss="{:>7}",
|
||||
Branch="{:>7}",
|
||||
BrPart="{:>7}",
|
||||
Cover="{:>{n}}",
|
||||
Missing="{:>10}",
|
||||
Name='{:{name_len}}',
|
||||
Stmts='{:>7}',
|
||||
Miss='{:>7}',
|
||||
Branch='{:>7}',
|
||||
BrPart='{:>7}',
|
||||
Cover='{:>{n}}',
|
||||
Missing='{:>10}',
|
||||
)
|
||||
header_items = [
|
||||
formats[item].format(item, name_len=max_name, n=max_n)
|
||||
for item in header
|
||||
]
|
||||
header_str = "".join(header_items)
|
||||
rule = "-" * len(header_str)
|
||||
header_str = ''.join(header_items)
|
||||
rule = '-' * len(header_str)
|
||||
|
||||
# Write the header
|
||||
self.write(header_str)
|
||||
self.write(rule)
|
||||
|
||||
formats.update(dict(Cover="{:>{n}}%"), Missing=" {:9}")
|
||||
formats.update(dict(Cover='{:>{n}}%'), Missing=' {:9}')
|
||||
for values in lines_values:
|
||||
# build string with line values
|
||||
line_items = [
|
||||
formats[item].format(str(value),
|
||||
name_len=max_name, n=max_n-1) for item, value in zip(header, values)
|
||||
formats[item].format(
|
||||
str(value),
|
||||
name_len=max_name, n=max_n - 1,
|
||||
) for item, value in zip(header, values)
|
||||
]
|
||||
self.write_items(line_items)
|
||||
|
||||
|
|
@ -99,8 +103,10 @@ class SummaryReporter:
|
|||
self.write(rule)
|
||||
|
||||
line_items = [
|
||||
formats[item].format(str(value),
|
||||
name_len=max_name, n=max_n-1) for item, value in zip(header, total_line)
|
||||
formats[item].format(
|
||||
str(value),
|
||||
name_len=max_name, n=max_n - 1,
|
||||
) for item, value in zip(header, total_line)
|
||||
]
|
||||
self.write_items(line_items)
|
||||
|
||||
|
|
@ -123,22 +129,23 @@ class SummaryReporter:
|
|||
|
||||
"""
|
||||
# Prepare the formatting strings, header, and column sorting.
|
||||
max_name = max((len(line[0].replace("_", "\\_")) for line in lines_values), default=0)
|
||||
max_name = max(max_name, len("**TOTAL**")) + 1
|
||||
max_name = max((len(line[0].replace('_', '\\_')) for line in lines_values), default=0)
|
||||
max_name = max(max_name, len('**TOTAL**')) + 1
|
||||
formats = dict(
|
||||
Name="| {:{name_len}}|",
|
||||
Stmts="{:>9} |",
|
||||
Miss="{:>9} |",
|
||||
Branch="{:>9} |",
|
||||
BrPart="{:>9} |",
|
||||
Cover="{:>{n}} |",
|
||||
Missing="{:>10} |",
|
||||
Name='| {:{name_len}}|',
|
||||
Stmts='{:>9} |',
|
||||
Miss='{:>9} |',
|
||||
Branch='{:>9} |',
|
||||
BrPart='{:>9} |',
|
||||
Cover='{:>{n}} |',
|
||||
Missing='{:>10} |',
|
||||
)
|
||||
max_n = max(len(total_line[header.index("Cover")]) + 6, len(" Cover "))
|
||||
max_n = max(len(total_line[header.index('Cover')]) + 6, len(' Cover '))
|
||||
header_items = [formats[item].format(item, name_len=max_name, n=max_n) for item in header]
|
||||
header_str = "".join(header_items)
|
||||
rule_str = "|" + " ".join(["- |".rjust(len(header_items[0])-1, "-")] +
|
||||
["-: |".rjust(len(item)-1, "-") for item in header_items[1:]],
|
||||
header_str = ''.join(header_items)
|
||||
rule_str = '|' + ' '.join(
|
||||
['- |'.rjust(len(header_items[0]) - 1, '-')] +
|
||||
['-: |'.rjust(len(item) - 1, '-') for item in header_items[1:]],
|
||||
)
|
||||
|
||||
# Write the header
|
||||
|
|
@ -147,23 +154,23 @@ class SummaryReporter:
|
|||
|
||||
for values in lines_values:
|
||||
# build string with line values
|
||||
formats.update(dict(Cover="{:>{n}}% |"))
|
||||
formats.update(dict(Cover='{:>{n}}% |'))
|
||||
line_items = [
|
||||
formats[item].format(str(value).replace("_", "\\_"), name_len=max_name, n=max_n-1)
|
||||
formats[item].format(str(value).replace('_', '\\_'), name_len=max_name, n=max_n - 1)
|
||||
for item, value in zip(header, values)
|
||||
]
|
||||
self.write_items(line_items)
|
||||
|
||||
# Write the TOTAL line
|
||||
formats.update(dict(Name="|{:>{name_len}} |", Cover="{:>{n}} |"))
|
||||
formats.update(dict(Name='|{:>{name_len}} |', Cover='{:>{n}} |'))
|
||||
total_line_items: list[str] = []
|
||||
for item, value in zip(header, total_line):
|
||||
if value == "":
|
||||
if value == '':
|
||||
insert = value
|
||||
elif item == "Cover":
|
||||
insert = f" **{value}%**"
|
||||
elif item == 'Cover':
|
||||
insert = f' **{value}%**'
|
||||
else:
|
||||
insert = f" **{value}**"
|
||||
insert = f' **{value}**'
|
||||
total_line_items += formats[item].format(insert, name_len=max_name, n=max_n)
|
||||
self.write_items(total_line_items)
|
||||
for end_line in end_lines:
|
||||
|
|
@ -182,9 +189,9 @@ class SummaryReporter:
|
|||
self.report_one_file(fr, analysis)
|
||||
|
||||
if not self.total.n_files and not self.skipped_count:
|
||||
raise NoDataError("No data to report.")
|
||||
raise NoDataError('No data to report.')
|
||||
|
||||
if self.output_format == "total":
|
||||
if self.output_format == 'total':
|
||||
self.write(self.total.pc_covered_str)
|
||||
else:
|
||||
self.tabular_report()
|
||||
|
|
@ -194,12 +201,12 @@ class SummaryReporter:
|
|||
def tabular_report(self) -> None:
|
||||
"""Writes tabular report formats."""
|
||||
# Prepare the header line and column sorting.
|
||||
header = ["Name", "Stmts", "Miss"]
|
||||
header = ['Name', 'Stmts', 'Miss']
|
||||
if self.branches:
|
||||
header += ["Branch", "BrPart"]
|
||||
header += ["Cover"]
|
||||
header += ['Branch', 'BrPart']
|
||||
header += ['Cover']
|
||||
if self.config.show_missing:
|
||||
header += ["Missing"]
|
||||
header += ['Missing']
|
||||
|
||||
column_order = dict(name=0, stmts=1, miss=2, cover=-1)
|
||||
if self.branches:
|
||||
|
|
@ -221,17 +228,17 @@ class SummaryReporter:
|
|||
lines_values.append(args)
|
||||
|
||||
# Line sorting.
|
||||
sort_option = (self.config.sort or "name").lower()
|
||||
sort_option = (self.config.sort or 'name').lower()
|
||||
reverse = False
|
||||
if sort_option[0] == "-":
|
||||
if sort_option[0] == '-':
|
||||
reverse = True
|
||||
sort_option = sort_option[1:]
|
||||
elif sort_option[0] == "+":
|
||||
elif sort_option[0] == '+':
|
||||
sort_option = sort_option[1:]
|
||||
sort_idx = column_order.get(sort_option)
|
||||
if sort_idx is None:
|
||||
raise ConfigError(f"Invalid sorting option: {self.config.sort!r}")
|
||||
if sort_option == "name":
|
||||
raise ConfigError(f'Invalid sorting option: {self.config.sort!r}')
|
||||
if sort_option == 'name':
|
||||
lines_values = human_sorted_items(lines_values, reverse=reverse)
|
||||
else:
|
||||
lines_values.sort(
|
||||
|
|
@ -240,25 +247,25 @@ class SummaryReporter:
|
|||
)
|
||||
|
||||
# Calculate total if we had at least one file.
|
||||
total_line = ["TOTAL", self.total.n_statements, self.total.n_missing]
|
||||
total_line = ['TOTAL', self.total.n_statements, self.total.n_missing]
|
||||
if self.branches:
|
||||
total_line += [self.total.n_branches, self.total.n_partial_branches]
|
||||
total_line += [self.total.pc_covered_str]
|
||||
if self.config.show_missing:
|
||||
total_line += [""]
|
||||
total_line += ['']
|
||||
|
||||
# Create other final lines.
|
||||
end_lines = []
|
||||
if self.config.skip_covered and self.skipped_count:
|
||||
file_suffix = "s" if self.skipped_count>1 else ""
|
||||
file_suffix = 's' if self.skipped_count > 1 else ''
|
||||
end_lines.append(
|
||||
f"\n{self.skipped_count} file{file_suffix} skipped due to complete coverage.",
|
||||
f'\n{self.skipped_count} file{file_suffix} skipped due to complete coverage.',
|
||||
)
|
||||
if self.config.skip_empty and self.empty_count:
|
||||
file_suffix = "s" if self.empty_count > 1 else ""
|
||||
end_lines.append(f"\n{self.empty_count} empty file{file_suffix} skipped.")
|
||||
file_suffix = 's' if self.empty_count > 1 else ''
|
||||
end_lines.append(f'\n{self.empty_count} empty file{file_suffix} skipped.')
|
||||
|
||||
if self.output_format == "markdown":
|
||||
if self.output_format == 'markdown':
|
||||
formatter = self._report_markdown
|
||||
else:
|
||||
formatter = self._report_text
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue