pip._vendor.rich.text.Span Class Reference

Inheritance diagram for pip._vendor.rich.text.Span:

Collaboration diagram for pip._vendor.rich.text.Span:

Public Member Functions
str	__repr__ (self)
bool	__bool__ (self)
Tuple["Span", Optional["Span"]]	split (self, int offset)
"Span"	move (self, int offset)
"Span"	right_crop (self, int offset)

Static Public Attributes
int	start
int	end
Union	style [str, Style]

Detailed Description

A marked up region in some text.

Member Function Documentation

move()

"Span" pip._vendor.rich.text.Span.move	(		self,
		int	offset
	)

Move start and end by a given offset.

Args:
    offset (int): Number of characters to add to start and end.

Returns:
    TextSpan: A new TextSpan with adjusted position.

right_crop()

"Span" pip._vendor.rich.text.Span.right_crop	(		self,
		int	offset
	)

Crop the span at the given offset.

Args:
    offset (int): A value between start and end.

Returns:
    Span: A new (possibly smaller) span.

split()

Tuple["Span", Optional["Span"]] pip._vendor.rich.text.Span.split	(		self,
		int	offset
	)

Split a span in to 2 from a given offset.

---

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

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