Inheritance diagram for DiagnosticPipError:

[legend]

Collaboration diagram for DiagnosticPipError:

[legend]

Public Member Functions
None	__init__ (self, *'Literal["error", "warning"]' kind="error", Optional[str] reference=None, Union[str, Text] message, Optional[Union[str, Text]] context, Optional[Union[str, Text]] hint_stmt, Optional[Union[str, Text]] note_stmt=None, Optional[str] link=None)

str	__repr__ (self)

RenderResult	__rich_console__ (self, Console console, ConsoleOptions options)

Data Fields
	kind

	reference

	message

	context

	note_stmt

	hint_stmt

	link

Static Public Attributes
str	reference

Detailed Description

An error, that presents diagnostic information to the user.

This contains a bunch of logic, to enable pretty presentation of our error
messages. Each error gets a unique reference. Each error can also include
additional context, a hint and/or a note -- which are presented with the
main error message in a consistent style.

This is adapted from the error output styling in `sphinx-theme-builder`.

Definition at line 61 of file exceptions.py.

Constructor & Destructor Documentation

◆ init()

None __init__	(		self,
		*'Literal["error", "warning"]'	kind = `"error"`,
		Optional[str]	reference = `None`,
		Union[str, Text]	message,
		Optional[Union[str, Text]]	context,
		Optional[Union[str, Text]]	hint_stmt,
		Optional[Union[str, Text]]	note_stmt = `None`,
		Optional[str]	link = `None`
	)

Reimplemented in InstallationSubprocessError, MissingPyProjectBuildRequires, InvalidPyProjectBuildRequires, MetadataGenerationFailed, and ExternallyManagedEnvironment.

Definition at line 74 of file exceptions.py.

    ) -> None:
        # Ensure a proper reference is provided.
        if reference is None:
            assert hasattr(self, "reference"), "error reference not provided!"
            reference = self.reference
        assert _is_kebab_case(reference), "error reference must be kebab-case!"
 
        self.kind = kind
        self.reference = reference
 
        self.message = message
        self.context = context
 
        self.note_stmt = note_stmt
        self.hint_stmt = hint_stmt
 
        self.link = link
 
        super().__init__(f"<{self.__class__.__name__}: {self.reference}>")
 

References pip._internal.exceptions._is_kebab_case(), i, DiagnosticPipError.reference, MissingPyProjectBuildRequires.reference, InvalidPyProjectBuildRequires.reference, InstallationSubprocessError.reference, MetadataGenerationFailed.reference, and ExternallyManagedEnvironment.reference.

Referenced by Protocol.__init_subclass__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ repr()

str __repr__ ( self )

Definition at line 104 of file exceptions.py.

    def __repr__(self) -> str:
        return (
            f"<{self.__class__.__name__}("
            f"reference={self.reference!r}, "
            f"message={self.message!r}, "
            f"context={self.context!r}, "
            f"note_stmt={self.note_stmt!r}, "
            f"hint_stmt={self.hint_stmt!r}"
            ")>"
        )
 

◆ __rich_console__()

RenderResult __rich_console__	(		self,
		Console	console,
		ConsoleOptions	options
	)

Definition at line 115 of file exceptions.py.

    ) -> RenderResult:
        colour = "red" if self.kind == "error" else "yellow"
 
        yield f"[{colour} bold]{self.kind}[/]: [bold]{self.reference}[/]"
        yield ""
 
        if not options.ascii_only:
            # Present the main message, with relevant context indented.
            if self.context is not None:
                yield _prefix_with_indent(
                    self.message,
                    console,
                    prefix=f"[{colour}]×[/] ",
                    indent=f"[{colour}]│[/] ",
                )
                yield _prefix_with_indent(
                    self.context,
                    console,
                    prefix=f"[{colour}]╰─>[/] ",
                    indent=f"[{colour}]   [/] ",
                )
            else:
                yield _prefix_with_indent(
                    self.message,
                    console,
                    prefix="[red]×[/] ",
                    indent="  ",
                )
        else:
            yield self.message
            if self.context is not None:
                yield ""
                yield self.context
 
        if self.note_stmt is not None or self.hint_stmt is not None:
            yield ""
 
        if self.note_stmt is not None:
            yield _prefix_with_indent(
                self.note_stmt,
                console,
                prefix="[magenta bold]note[/]: ",
                indent="      ",
            )
        if self.hint_stmt is not None:
            yield _prefix_with_indent(
                self.hint_stmt,
                console,
                prefix="[cyan bold]hint[/]: ",
                indent="      ",
            )
 
        if self.link is not None:
            yield ""
            yield f"Link: {self.link}"
 
 
#
# Actual Errors
#