Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve presentation of diagnostic errors using rich #10703

Merged
merged 10 commits into from
Dec 14, 2021
Merged

Improve presentation of diagnostic errors using rich #10703

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
03a87c2
Improve DiagnosticPipError presentation
pradyunsg Nov 12, 2021
8feb24f
Enable the use of rich for presenting output
pradyunsg Nov 14, 2021
9f4117f
Replace {attention -> note}_stmt
pradyunsg Dec 3, 2021
d517dae
Clean up where `Text` is used to wrap diagnostic messages.
pradyunsg Dec 3, 2021
6a20f5b
Add news fragment
pradyunsg Dec 3, 2021
e857d0f
Properly handle newlines in diagnostic error tests
pradyunsg Dec 3, 2021
b82dfd1
Restore colors in regular logging messages
pradyunsg Dec 4, 2021
961eb6f
Stop stylizing PEP **518**
pradyunsg Dec 12, 2021
6b31f83
Escape the package name, allowing rich to stylize URLs and links
pradyunsg Dec 12, 2021
fd45825
Apply suggestions from code review
pradyunsg Dec 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Escape the package name, allowing rich to stylize URLs and links
  • Loading branch information
@pradyunsg
pradyunsg committed Dec 12, 2021
commit 6b31f83187edf1c566269bc276309091fe8a6509
5 changes: 3 additions & 2 deletions src/pip/_internal/exceptions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

from pip._vendor.requests.models import Request, Response
from pip._vendor.rich.console import Console, ConsoleOptions, RenderResult
from pip._vendor.rich.markup import escape
from pip._vendor.rich.text import Text

if TYPE_CHECKING:
Expand Down Expand Up @@ -182,7 +183,7 @@ class MissingPyProjectBuildRequires(DiagnosticPipError):

def __init__(self, *, package: str) -> None:
super().__init__(
message=Text(f"Can not process {package}"),
message=f"Can not process {escape(package)}",
context=Text(
"This package has an invalid pyproject.toml file.\n"
"The [build-system] table is missing the mandatory `requires` key."
Expand All @@ -199,7 +200,7 @@ class InvalidPyProjectBuildRequires(DiagnosticPipError):

def __init__(self, *, package: str, reason: str) -> None:
super().__init__(
message=Text(f"Can not process {package}"),
message=f"Can not process {escape(package)}",
context=Text(
"This package has an invalid `build-system.requires` key in "
f"pyproject.toml.\n{reason}"
Expand Down