pip._internal.exceptions.DiagnosticPipError Class Reference

Inheritance diagram for pip._internal.exceptions.DiagnosticPipError:

Collaboration diagram for pip._internal.exceptions.DiagnosticPipError:

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)

Public Attributes
	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`.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/pip/_internal/exceptions.py