May 10, 2024 · Oct 24, 2021 · Oct 25, 2021 · Oct 27, 2021 · Oct 27, 2021 · Oct 27, 2021
diff --git a/mypy/build.py b/mypy/build.py
 from mypy.checker import TypeChecker
 from mypy.indirection import TypeIndirectionVisitor
 from mypy.errors import Errors, CompileError, ErrorInfo, report_internal_error
 from mypy.error_formatter import ErrorFormatter, JSONFormatter
 from mypy.util import (
    DecodeError, decode_python_encoding, is_sub_path, get_mypy_comments, module_prefix,
    read_py_file, hash_digest, is_typeshed_file, is_stub_package_file, get_top_two_prefixes
                           plugin=plugin,
                           plugins_snapshot=snapshot,
                           errors=errors,
                           error_formatter=JSONFormatter() if options.output == 'json' else None,
                           flush_errors=flush_errors,
                           fscache=fscache,
                           stdout=stdout,
                 plugin: Plugin,
                 plugins_snapshot: Dict[str, str],
                 errors: Errors,
                 error_formatter: 'Optional[ErrorFormatter]',
                 flush_errors: Callable[[List[str], bool], None],
                 fscache: FileSystemCache,
                 stdout: TextIO,
        self.data_dir = data_dir
        self.errors = errors
        self.errors.set_ignore_prefix(ignore_prefix)
        self.error_formatter = error_formatter
        self.search_paths = search_paths
        self.source_set = source_set
        self.reports = reports
        for id in stale:
            graph[id].transitive_error = True
    for id in stale:
        manager.flush_errors(manager.errors.file_messages(graph[id].xpath), False)
        errors = manager.errors.file_messages(
            graph[id].xpath, formatter=manager.error_formatter)
        manager.flush_errors(errors, False)
        graph[id].write_cache()
        graph[id].mark_as_rechecked()

diff --git a/mypy/error_formatter.py b/mypy/error_formatter.py
 import json
 from abc import ABC, abstractmethod
 from typing import TYPE_CHECKING

 if TYPE_CHECKING:
    from mypy.errors import ErrorTuple


 class ErrorFormatter(ABC):
    """Defines how errors are formatted before being printed."""
    @abstractmethod
    def report_error(self, error: 'ErrorTuple') -> str:
        raise NotImplementedError

 class JSONFormatter(ErrorFormatter):
    def report_error(self, error: 'ErrorTuple') -> str:
        file, line, column, severity, message, _, errorcode = error
        return json.dumps({
            'file': file,
            'line': line,
            'column': column,
            'severity': severity,
            'message': message,
            'code': None if errorcode is None else errorcode.code,
        })
diff --git a/mypy/errors.py b/mypy/errors.py

 from typing import Tuple, List, TypeVar, Set, Dict, Optional, TextIO, Callable
 from typing_extensions import Final
 from mypy.error_formatter import ErrorFormatter

 from mypy.scope import Scope
 from mypy.options import Options
                    a.append(' ' * (DEFAULT_SOURCE_OFFSET + column) + '^')
        return a

    def file_messages(self, path: str) -> List[str]:
    def file_messages(self, path: str, formatter: ErrorFormatter = None) -> List[str]:
        """Return a string list of new error messages from a given file.

        Use a form suitable for displaying to the user.
        """
        if path not in self.error_info_map:
            return []

        error_info = self.error_info_map[path]
        if formatter is not None:
            error_info = [info for info in error_info if not info.hidden]
            errors = self.render_messages(self.sort_messages(error_info))
            errors = self.remove_duplicates(errors)
            return [formatter.report_error(err) for err in errors]

        self.flushed_files.add(path)
        source_lines = None
        if self.pretty:
            assert self.read_source
            source_lines = self.read_source(path)
        return self.format_messages(self.error_info_map[path], source_lines)
        return self.format_messages(error_info, source_lines)

    def new_messages(self) -> List[str]:
        """Return a string list of new error messages.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -33,6 +33,7 @@
		from mypy.checker import TypeChecker
		from mypy.indirection import TypeIndirectionVisitor
		from mypy.errors import Errors, CompileError, ErrorInfo, report_internal_error
		from mypy.error_formatter import ErrorFormatter, JSONFormatter
		from mypy.util import (
		DecodeError, decode_python_encoding, is_sub_path, get_mypy_comments, module_prefix,
		read_py_file, hash_digest, is_typeshed_file, is_stub_package_file, get_top_two_prefixes
Expand DownExpand Up		@@ -243,6 +244,7 @@ def _build(sources: List[BuildSource],
		plugin=plugin,
		plugins_snapshot=snapshot,
		errors=errors,
		error_formatter=JSONFormatter() if options.output == 'json' else None,
		flush_errors=flush_errors,
		fscache=fscache,
		stdout=stdout,
Expand DownExpand Up		@@ -577,6 +579,7 @@ def __init__(self, data_dir: str,
		plugin: Plugin,
		plugins_snapshot: Dict[str, str],
		errors: Errors,
		error_formatter: 'Optional[ErrorFormatter]',
		flush_errors: Callable[[List[str], bool], None],
		fscache: FileSystemCache,
		stdout: TextIO,
Expand All		@@ -589,6 +592,7 @@ def __init__(self, data_dir: str,
		self.data_dir = data_dir
		self.errors = errors
		self.errors.set_ignore_prefix(ignore_prefix)
		self.error_formatter = error_formatter
		self.search_paths = search_paths
		self.source_set = source_set
		self.reports = reports
Expand DownExpand Up		@@ -3154,7 +3158,9 @@ def process_stale_scc(graph: Graph, scc: List[str], manager: BuildManager) -> No
		for id in stale:
		graph[id].transitive_error = True
		for id in stale:
		manager.flush_errors(manager.errors.file_messages(graph[id].xpath), False)
		errors = manager.errors.file_messages(
		graph[id].xpath, formatter=manager.error_formatter)
		manager.flush_errors(errors, False)
		graph[id].write_cache()
		graph[id].mark_as_rechecked()

Expand Down
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,25 @@
		import json
		from abc import ABC, abstractmethod
		from typing import TYPE_CHECKING

		if TYPE_CHECKING:
		from mypy.errors import ErrorTuple


		class ErrorFormatter(ABC):
		"""Defines how errors are formatted before being printed."""
		@abstractmethod
		def report_error(self, error: 'ErrorTuple') -> str:
		raise NotImplementedError

		class JSONFormatter(ErrorFormatter):
		def report_error(self, error: 'ErrorTuple') -> str:
		file, line, column, severity, message, _, errorcode = error
		return json.dumps({
		'file': file,
		'line': line,
		'column': column,
Copy link Contributor intgrOct 28, 2021 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. `line`,`column` seems short-sighed. Maybe`startLine`,`startColumn`, which would leave room to later add`endLine`,`endColumn`. This information is useful for IDEs to know how what span to highlight. Copy link ContributorAuthor tusharsadhwaniOct 28, 2021 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Yeah, good point. But mypy currently only does line and column, and it might be very long before spans are added in. It could be argued that the change to`startLine` and`startColumn` can be made when the feature exists. Copy link Contributor intgrOct 28, 2021• edited Loading Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Changing the field names later will break tools though. And`startLine`,`startColumn` would already be accurate right now, because mypy currently points out the start of the span. tusharsadhwani, agoncharov-reef, and antonagestam reacted with thumbs up emoji Copy link ContributorAuthor tusharsadhwaniJan 19, 2022 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. I'll leave this convention for the separate`--output=sarif` format.
		'severity': severity,
		'message': message,
		'code': None if errorcode is None else errorcode.code,
		})
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,6 +6,7 @@

		from typing import Tuple, List, TypeVar, Set, Dict, Optional, TextIO, Callable
		from typing_extensions import Final
		from mypy.error_formatter import ErrorFormatter

		from mypy.scope import Scope
		from mypy.options import Options
Expand DownExpand Up		@@ -575,19 +576,27 @@ def format_messages(self, error_info: List[ErrorInfo],
		a.append(' ' * (DEFAULT_SOURCE_OFFSET + column) + '^')
		return a

		def file_messages(self, path: str) -> List[str]:
		def file_messages(self, path: str, formatter: ErrorFormatter = None) -> List[str]:
		"""Return a string list of new error messages from a given file.

		Use a form suitable for displaying to the user.
		"""
		if path not in self.error_info_map:
		return []

		error_info = self.error_info_map[path]
		if formatter is not None:
		error_info = [info for info in error_info if not info.hidden]
Copy link Collaborator hauntsaninjaMay 9, 2023 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Let's not duplicate this and instead pass`error_tuples` into`format_messages` tusharsadhwani reacted with thumbs up emoji
		errors = self.render_messages(self.sort_messages(error_info))
		errors = self.remove_duplicates(errors)
		return [formatter.report_error(err) for err in errors]

		self.flushed_files.add(path)
		source_lines = None
		if self.pretty:
		assert self.read_source
		source_lines = self.read_source(path)
		return self.format_messages(self.error_info_map[path], source_lines)
		return self.format_messages(error_info, source_lines)

		def new_messages(self) -> List[str]:
		"""Return a string list of new error messages.
Expand Down