summaryrefslogtreecommitdiffstats
path: root/rich/screen.py
diff options
context:
space:
mode:
Diffstat (limited to 'rich/screen.py')
-rw-r--r--rich/screen.py40
1 files changed, 40 insertions, 0 deletions
diff --git a/rich/screen.py b/rich/screen.py
new file mode 100644
index 0000000..3ca5355
--- /dev/null
+++ b/rich/screen.py
@@ -0,0 +1,40 @@
+from typing import TYPE_CHECKING
+
+from .segment import Segment
+from .style import StyleType
+from ._loop import loop_last
+
+
+if TYPE_CHECKING:
+ from .console import Console, ConsoleOptions, RenderResult, RenderableType
+
+
+class Screen:
+ """A renderable that fills the terminal screen and crops excess.
+
+ Args:
+ renderable (RenderableType): Child renderable.
+ style (StyleType, optional): Optional background style. Defaults to None.
+ """
+
+ def __init__(
+ self, renderable: "RenderableType" = None, style: StyleType = None
+ ) -> None:
+ self.renderable = renderable
+ self.style = style
+
+ def __rich_console__(
+ self, console: "Console", options: "ConsoleOptions"
+ ) -> "RenderResult":
+ width, height = options.size
+ style = console.get_style(self.style) if self.style else None
+ render_options = options.update(width=width, height=height)
+ lines = console.render_lines(
+ self.renderable or "", render_options, style=style, pad=True
+ )
+ lines = Segment.set_shape(lines, width, height, style=style)
+ new_line = Segment.line()
+ for last, line in loop_last(lines):
+ yield from line
+ if not last:
+ yield new_line