from operator import itemgetter from typing import TYPE_CHECKING, Callable, NamedTuple, Optional, Sequence from . import errors from .protocol import is_renderable, rich_cast if TYPE_CHECKING: from .console import Console, ConsoleOptions, RenderableType class Measurement(NamedTuple): """Stores the minimum and maximum widths (in characters) required to render an object.""" minimum: int """Minimum number of cells required to render.""" maximum: int """Maximum number of cells required to render.""" @property def span(self) -> int: """Get difference between maximum and minimum.""" return self.maximum - self.minimum def normalize(self) -> "Measurement": """Get measurement that ensures that minimum <= maximum and minimum >= 0 Returns: Measurement: A normalized measurement. """ minimum, maximum = self minimum = min(max(0, minimum), maximum) return Measurement(max(0, minimum), max(0, max(minimum, maximum))) def with_maximum(self, width: int) -> "Measurement": """Get a RenderableWith where the widths are <= width. Args: width (int): Maximum desired width. Returns: Measurement: New Measurement object. """ minimum, maximum = self return Measurement(min(minimum, width), min(maximum, width)) def with_minimum(self, width: int) -> "Measurement": """Get a RenderableWith where the widths are >= width. Args: width (int): Minimum desired width. Returns: Measurement: New Measurement object. """ minimum, maximum = self width = max(0, width) return Measurement(max(minimum, width), max(maximum, width)) def clamp( self, min_width: Optional[int] = None, max_width: Optional[int] = None ) -> "Measurement": """Clamp a measurement within the specified range. Args: min_width (int): Minimum desired width, or ``None`` for no minimum. Defaults to None. max_width (int): Maximum desired width, or ``None`` for no maximum. Defaults to None. Returns: Measurement: New Measurement object. """ measurement = self if min_width is not None: measurement = measurement.with_minimum(min_width) if max_width is not None: measurement = measurement.with_maximum(max_width) return measurement @classmethod def get( cls, console: "Console", options: "ConsoleOptions", renderable: "RenderableType" ) -> "Measurement": """Get a measurement for a renderable. Args: console (~rich.console.Console): Console instance. options (~rich.console.ConsoleOptions): Console options. renderable (RenderableType): An object that may be rendered with Rich. Raises: errors.NotRenderableError: If the object is not renderable. Returns: Measurement: Measurement object containing range of character widths required to render the object. """ _max_width = options.max_width if _max_width < 1: return Measurement(0, 0) if isinstance(renderable, str): renderable = console.render_str( renderable, markup=options.markup, highlight=False ) renderable = rich_cast(renderable) if is_renderable(renderable): get_console_width: Optional[ Callable[["Console", "ConsoleOptions"], "Measurement"] ] = getattr(renderable, "__rich_measure__", None) if get_console_width is not None: render_width = ( get_console_width(console, options) .normalize() .with_maximum(_max_width) ) if render_width.maximum < 1: return Measurement(0, 0) return render_width.normalize() else: return Measurement(0, _max_width) else: raise errors.NotRenderableError( f"Unable to get render width for {renderable!r}; " "a str, Segment, or object with __rich_console__ method is required" ) def measure_renderables( console: "Console", options: "ConsoleOptions", renderables: Sequence["RenderableType"], ) -> "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
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
__pycache__ | Folder | 0755 |
|
|
__init__.py | File | 5.95 KB | 0644 |
|
__main__.py | File | 8.28 KB | 0644 |
|
_cell_widths.py | File | 9.97 KB | 0644 |
|
_emoji_codes.py | File | 136.95 KB | 0644 |
|
_emoji_replace.py | File | 1.04 KB | 0644 |
|
_export_format.py | File | 2.08 KB | 0644 |
|
_extension.py | File | 265 B | 0644 |
|
_fileno.py | File | 799 B | 0644 |
|
_inspect.py | File | 9.47 KB | 0644 |
|
_log_render.py | File | 3.15 KB | 0644 |
|
_loop.py | File | 1.21 KB | 0644 |
|
_null_file.py | File | 1.35 KB | 0644 |
|
_palettes.py | File | 6.9 KB | 0644 |
|
_pick.py | File | 423 B | 0644 |
|
_ratio.py | File | 5.34 KB | 0644 |
|
_spinners.py | File | 19.45 KB | 0644 |
|
_stack.py | File | 351 B | 0644 |
|
_timer.py | File | 417 B | 0644 |
|
_win32_console.py | File | 22.29 KB | 0644 |
|
_windows.py | File | 1.88 KB | 0644 |
|
_windows_renderer.py | File | 2.72 KB | 0644 |
|
_wrap.py | File | 3.32 KB | 0644 |
|
abc.py | File | 890 B | 0644 |
|
align.py | File | 10.13 KB | 0644 |
|
ansi.py | File | 6.74 KB | 0644 |
|
bar.py | File | 3.19 KB | 0644 |
|
box.py | File | 10.58 KB | 0644 |
|
cells.py | File | 4.67 KB | 0644 |
|
color.py | File | 17.8 KB | 0644 |
|
color_triplet.py | File | 1.03 KB | 0644 |
|
columns.py | File | 6.96 KB | 0644 |
|
console.py | File | 96.85 KB | 0644 |
|
constrain.py | File | 1.26 KB | 0644 |
|
containers.py | File | 5.37 KB | 0644 |
|
control.py | File | 6.47 KB | 0644 |
|
default_styles.py | File | 7.89 KB | 0644 |
|
diagnose.py | File | 972 B | 0644 |
|
emoji.py | File | 2.44 KB | 0644 |
|
errors.py | File | 642 B | 0644 |
|
file_proxy.py | File | 1.64 KB | 0644 |
|
filesize.py | File | 2.45 KB | 0644 |
|
highlighter.py | File | 9.36 KB | 0644 |
|
json.py | File | 4.91 KB | 0644 |
|
jupyter.py | File | 3.18 KB | 0644 |
|
layout.py | File | 13.68 KB | 0644 |
|
live.py | File | 13.94 KB | 0644 |
|
live_render.py | File | 3.58 KB | 0644 |
|
logging.py | File | 11.62 KB | 0644 |
|
markup.py | File | 8.25 KB | 0644 |
|
measure.py | File | 5.18 KB | 0644 |
|
padding.py | File | 4.85 KB | 0644 |
|
pager.py | File | 828 B | 0644 |
|
palette.py | File | 3.32 KB | 0644 |
|
panel.py | File | 10.45 KB | 0644 |
|
pretty.py | File | 35.01 KB | 0644 |
|
progress.py | File | 58.32 KB | 0644 |
|
progress_bar.py | File | 7.97 KB | 0644 |
|
prompt.py | File | 11.04 KB | 0644 |
|
protocol.py | File | 1.36 KB | 0644 |
|
py.typed | File | 0 B | 0644 |
|
region.py | File | 166 B | 0644 |
|
repr.py | File | 4.33 KB | 0644 |
|
rule.py | File | 4.49 KB | 0644 |
|
scope.py | File | 2.78 KB | 0644 |
|
screen.py | File | 1.55 KB | 0644 |
|
segment.py | File | 23.68 KB | 0644 |
|
spinner.py | File | 4.24 KB | 0644 |
|
status.py | File | 4.32 KB | 0644 |
|
style.py | File | 26.44 KB | 0644 |
|
styled.py | File | 1.23 KB | 0644 |
|
syntax.py | File | 34.64 KB | 0644 |
|
table.py | File | 38.75 KB | 0644 |
|
terminal_theme.py | File | 3.29 KB | 0644 |
|
text.py | File | 46.2 KB | 0644 |
|
theme.py | File | 3.69 KB | 0644 |
|
themes.py | File | 102 B | 0644 |
|
traceback.py | File | 28.91 KB | 0644 |
|
tree.py | File | 8.95 KB | 0644 |
|