pip._vendor.rich.measure Namespace Reference

Data Structures
class	Measurement

Functions
"Measurement"	measure_renderables ("Console" console, "ConsoleOptions" options, Sequence["RenderableType"] renderables)

Function Documentation

measure_renderables()

"Measurement" measure_renderables	(	"Console"	console,
		"ConsoleOptions"	options,
		Sequence["RenderableType"]	renderables
	)

Get a measurement that would fit a number of renderables.

Args:
    console (~rich.console.Console): Console instance.
    options (~rich.console.ConsoleOptions): Console options.
    renderables (Iterable[RenderableType]): One or more renderable objects.

Returns:
    Measurement: Measurement object containing range of character widths required to
        contain all given renderables.

Definition at line 125 of file measure.py.

) -> "Measurement":
    """Get a measurement that would fit a number of renderables.
 
    Args:
        console (~rich.console.Console): Console instance.
        options (~rich.console.ConsoleOptions): Console options.
        renderables (Iterable[RenderableType]): One or more renderable objects.
 
    Returns:
        Measurement: Measurement object containing range of character widths required to
            contain all given renderables.
    """
    if not renderables:
        return Measurement(0, 0)
    get_measurement = Measurement.get
    measurements = [
        get_measurement(console, options, renderable) for renderable in renderables
    ]
    measured_width = Measurement(
        max(measurements, key=itemgetter(0)).minimum,
        max(measurements, key=itemgetter(1)).maximum,
    )
    return measured_width

References i.