pip._vendor.rich.highlighter.Highlighter Class Reference

Inheritance diagram for pip._vendor.rich.highlighter.Highlighter:

Collaboration diagram for pip._vendor.rich.highlighter.Highlighter:

Public Member Functions
Text	__call__ (self, Union[str, Text] text)
None	highlight (self, Text text)

Detailed Description

Abstract base class for highlighters.

Member Function Documentation

__call__()

Text pip._vendor.rich.highlighter.Highlighter.__call__	(		self,
		Union[str, Text]	text
	)

Highlight a str or Text instance.

Args:
    text (Union[str, ~Text]): Text to highlight.

Raises:
    TypeError: If not called with text or str.

Returns:
    Text: A test instance with highlighting applied.

highlight()

None pip._vendor.rich.highlighter.Highlighter.highlight	(		self,
		Text	text
	)

Apply highlighting in place to text.

Args:
    text (~Text): A text object highlight.

Reimplemented in pip._vendor.rich.highlighter.NullHighlighter, pip._vendor.rich.highlighter.RegexHighlighter, and pip._vendor.rich.highlighter.JSONHighlighter.

---

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

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/rich/highlighter.py